Template:Clickable button/doc

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

{{Clickable button|Main Page}} → Main Page

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

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

Colors

{{Clickable button|Main Page}} → Main Page – without defined |color= and |class=, the default is a white button

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

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

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

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

URLs

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

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

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

Adding an icon

Adding an icon to a button should be avoided. Don't forget to hide the icon from the accessibility DOM by wrapping it in a span that is aria-hidden="true" so that a screen reader doesn't read it out loud.

<span class="mw-ui-button mw-ui-progressive"><span aria-hidden="true">[[File:OOjs UI icon logo-wikimediaCommons-invert.svg|15px|link=|alt=]]</span>&nbsp;More details</span>

 More details

Template data

<templatedata> { "params": { "1": { "required": true, "label": "Link/Label", "description": "Defines the page to link to, and uses that page's title as the text for the button", "example": "Foobar", "type": "wiki-page-name" }, "2": { "suggested": true, "label": "Label", "description": "Defines the text that appears on the button", "default": "the page being linked to" }, "url": { "type": "url", "label": "URL", "description": "Defines a web address for the button to link to", "example": "https://www.example.com" }, "class": { "type": "string", "description": "Defines the visual type of the button", "suggestedvalues": [ "mw-ui-progressive", "mw-ui-destructive" ] }, "style": { "type": "string", "label": "Custom CSS styling", "description": "Allows custom CSS styling to be applied to the button", "example": "border: 2px solid red;", "default": "None" }, "category": { "type": "boolean", "label": "Category switch", "description": "Whether or not categories should be on", "example": "no", "default": "yes", "autovalue": "0" }, "color": { "suggestedvalues": [ "blue", "red" ], "description": "Defines the visual type of the button", "type": "string" } }, "description": "Styles a link like a button, using the mediawiki.ui.button module", "format": "inline" } </templatedata>

See also

• commons:Template:Clickable button, corresponding clickable button at Commons.
• phab:T146923, which dropped support for mw-ui-constructive, the CSS class for green buttons