Template:Clickable button/doc

Tracked in Phabricator
Task T39744

Provides a button with hover effects.

Usage

{{Clickable button |target= |text= |external= }}

---

{{Clickable button|FAQ|Frequently asked questions}} →

Frequently asked questions

---

{{Clickable button|target={{fullurl:{{FULLPAGENAME}}|withJS=MediaWiki:VisualFileChange.js}}|text=This page with '''VisualFileChange'''|external=true}} →

This page with VisualFileChange

---

{{Clickable button|:en:Wikipedia:Manual of Style/Layout|'''Wikipedia's manual of Style'''|class=ui-button-green ui-button-large}} →

Wikipedia's manual of Style

---

{{Clickable button|:en:Wikipedia:Twinkle/Preferences|'''Twinkle preferences'''|iconPrimary=ui-icon-wrench|class=ui-button-blue ui-button-large}} →

 Twinkle preferences

---

{{Clickable button|target={{fullurl:Special:Random/User talk|action=edit&section=new&preloadtitle=I+love+your+work+because}}|text=Do something good|iconSecondary=ui-icon-heart|external=true|class=ui-button-red}} →

Do something good 

Template parameters

Parameter	Description		Default	Status
target 1	The target page of the "button". For external links, however, it is recommended using the named parameter target. Please use named parameters if it is an external link because they often contain = which would confuse the parser.		empty	required
text 2	Text (caption) the button should carry. Either you specify text or an icon.		empty	required
external 3	Is this an external link? If it is, set to yes or aye, or whatever you like, except nothing.		empty	optional
iconPrimary 4	A jquery UI icon class for the primary icon (in LTR languages on the left side of the button label/text). E.g. ui-icon-gear[1]		empty	optional
iconSecondary 5	A jquery UI icon class for the secondary icon (in LTR languages on the right side of the button label/text). E.g. ui-icon-triangle-1-s		empty	optional
class	Add classes like ui-button-green ui-button-large		empty	optional
id	Unique id to be used as the button's ID-Attribute. Useful for JavaScript-binding and CSS-styling.		empty	optional

Additional information

The template is intended to be used in the following namespaces: all namespaces

The template is intended to be used by the following user groups: all users

Relies on:

• jquery.ui.button

⧼Seealso⧽

• {{button}} (works without JS enabled)
• {{Clickable button 2}} (import from de.wikipedia)
• {{key press}}
• {{Clickable button 3}}

Localization

This template is not intended to be localized.

Test suite/ Unit tests

Icon only	Parameter text is empty	Parameter text is empty	Parameter text is empty
Icon text	Abc	Abc	Abc
Text only, links	Abc	Abc	Abc
Colors	Abc	Abc	Abc