Template:Clickable button/doc

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

Shortcuts

{{CLB}}
{{clickb}}
{{CLB2}}
{{Click}}

This template uses Lua:

Module:Clickable button 2

This template is used in system messages, and on approximately 15,000 pages.
Changes to it can cause immediate changes to the Wikipedia user interface.
To avoid major disruption, 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.

Usage

All parameters:

{{Clickable button|wikilink|display|color=color|url=url|class=class|link=}}

wikilink: Unnamed first parameter. The title of the page being linked. Brackets are not necessary
display (optional): Optional unnamed second parameer. The text to display. Not needed if the text to display is the wikilink itself
|color= or |class=: Color to display. |color= accepts blue and red, |class= accepts mw-ui-progressive and mw-ui-destructive
|url=: URL to link through the button. If no wikilink/display text is provided, will show the URL, otherwise will show the wikilink/display text
|link=no: Use this parameter set to "no" to display a button without linking to anything

Examples

Wikilinks

{{Clickable button|Main Page}} →

{{Clickable button|Main Page|Click here to visit the main page}} →

{{Clickable button|Click here|link=no}} →

Colors

{{Clickable button|Main Page|color=blue}} →

{{Clickable button|Main Page|color=red}} →

{{Clickable button|Main Page|class=mw-ui-progressive}} →

{{Clickable button|Main Page|class=mw-ui-destructive}} →

Any other color will default to

URLs

{{Clickable button|url=https://example.com}} →

{{Clickable button|Example|url=https://example.com}} →

{{Clickable button|2=Example|url=https://example.com}} →

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-destructive	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