Template:Clickable button

Template documentation[view] [edit] [history] [purge]

Shortcuts: `{{CLB}}` `{{clickb}}` `{{CLB2}}` `{{Click}}`

This template uses Lua:

Module:Clickable button

This template is used in system messages, and on approximately 1,060,000 pages, or roughly 11285% 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.

Buttons should not be used in the article namespace. If the desire is to "navigate" a reader to a new page, taking them away from the current page, a link is preferred. Buttons are used within Wikipedia to trigger an "action".

This template styles a link like a button, using the deprecated 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 parameter; 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

Template:Demo inline

Colors

Template:Demo inline – without defined |color= and |class=, the default is a white button

Template:Demo inline

URLs

Template:Demo inline

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 Suggested values `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
color	`color`	no description Suggested values `blue` `red` `green`	Unknown	optional

Template:Clickable button

Contents

Usage

Examples

Wikilinks

Colors

URLs

Template data

See also