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. |
This template uses Lua: |
Buttons should typically not be used in the main 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 mostly used within Wikiversity 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
edit- 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=
acceptsblue
andred
,|class=
acceptsmw-ui-progressive
andmw-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
editWikilinks
edit{{Clickable button|Main Page}}
→{{Clickable button|Main Page|Click here to visit the main page}}
→{{Clickable button|Click here|link=no}}
→
Colors
edit{{Clickable button|Main Page}}
→ – without defined|color=
and|class=
, the default is a white button{{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}}
→
URLs
edit{{Clickable button|url=https://example.com}}
→{{Clickable button|Example|url=https://example.com}}
→{{Clickable button|2=Example|url=https://example.com}}
→
Template data
editStyles a link like a button, using the mediawiki.ui.button module
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
| Page name | required |
Label | 2 | Defines the text that appears on the button
| Unknown | suggested |
URL | url | Defines a web address for the button to link to
| URL | optional |
class | class | Defines the visual type of the button
| String | optional |
Custom CSS styling | style | Allows custom CSS styling to be applied to the button
| String | optional |
Category switch | category | Whether or not categories should be on
| Boolean | optional |
color | color | no description
| Unknown | optional |
See also
edit- commons:Template:Clickable button, corresponding clickable button at Commons.
- Wikimedia design style guide advice on buttons