Template:Clickable button 2/doc

This is a documentation subpage for Template:Clickable button 2.
It may contain usage information, categories and other content that is not part of the original template page.

Shortcuts

{{CLB2}}
{{Click}}

This template uses Lua:

Module:Clickable button 2

This template is used in system messages, and on approximately 911,000 pages, or roughly 58174% of all pages.
Changes to it can cause immediate changes to the Wikipedia user interface.
To avoid major disruption and server load, any changes should be tested in the template's /sandbox or /testcases subpages, or in your own user subpage. The tested changes can be added to this page in a single edit. Please discuss changes on the talk page before implementing them.

This template styles a link like a button, using the mediawiki.ui.button module. This expands the clickable area and tap target for the link. It can be used in the following ways,

Code: {{Clickable button 2|Main Page}}
- Result: Main Page
Code: {{Clickable button 2|Main Page|Cover page}}
- Result: Cover page
Code: {{Clickable button 2|Main Page|url=http://en.wikipedia.org}}
- Result: Main Page
Code: {{Clickable button 2|Main Page|class=mw-ui-destructive}}
- Result: Main Page
Code: {{Clickable button 2|Main Page|class=mw-ui-constructive}}
- Result: Main Page
Code: {{Clickable button 2|Main Page|class=mw-ui-progressive}}
- Result: Main Page
Code: {{Clickable button 2|Main Page|Red|color=red}}
- Result: Red
Code: {{Clickable button 2|Main Page|Green|color=green}}
- Result: Green
Code: {{Clickable button 2|Main Page|Blue|color=blue}}
- Result: {{Clickable button 2|Main Page|Blue|color=blue}

Template data

Styles a link like a button, using the mediawiki.ui.button module

Template parameters
This template prefers inline formatting of parameters.
Parameter		Description	Type	Status
Link/Label	`1`	Defines the page to link to, and uses that page's title as the text for the button Example Foobar	Page name	required
Label	`2`	Defines the text that appears on the button Default the page being linked to	Unknown	suggested
URL	`url`	Defines a web address for the button to link to Example https://www.example.com	URL	optional
class	`class`	Defines the visual type of the button Example mw-ui-progressive, mw-ui-constructive, mw-ui-destructive	String	optional
color	`color`	Alias of class Example red, green, blue	String	optional
Custom CSS styling	`style`	Allows custom CSS styling to be applied to the button Default None Example border: 2px solid red;	String	optional
Category switch	`category`	Whether or not categories should be on Default yes Example no Auto value `0`	Boolean	optional

Template data

See also