Template:Clickable button 2/doc: Difference between revisions
Jump to navigation
Jump to search
(Created page with "{{Documentation subpage}} {{template shortcut|CLB2|Click}} {{lua|Module:Clickable button 2}} {{used in system}} 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: '''<code><nowiki>{{Clickable button 2|Main Page}}</nowiki></code> **'''Result: '''{{Clickable button 2|Main Page}} *'''Code: '''<code><nowiki>{{Clickable button 2|Main Pag...") |
No edit summary |
||
Line 46: | Line 46: | ||
"description": "Defines the visual type of the button", | "description": "Defines the visual type of the button", | ||
"example": "mw-ui-progressive, mw-ui-constructive, mw-ui-destructive" | "example": "mw-ui-progressive, mw-ui-constructive, mw-ui-destructive" | ||
}, | |||
"color": { | |||
"type": "string", | |||
"description": "Alias of class", | |||
"example": "red, green, blue" | |||
}, | }, | ||
"style": { | "style": { |
Revision as of 20:15, 20 October 2023
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. |
This template uses Lua: |
This template is used in system messages, and on approximately 911,000 pages, or roughly 58099% 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:
- Code:
{{Clickable button 2|Main Page|Cover page}}
- Result:
- Code:
{{Clickable button 2|Main Page|url=http://en.wikipedia.org}}
- Result:
- Code:
{{Clickable button 2|Main Page|class=mw-ui-destructive}}
- Result:
- Code:
{{Clickable button 2|Main Page|class=mw-ui-constructive}}
- Result:
- Code:
{{Clickable button 2|Main Page|class=mw-ui-progressive}}
- Result:
Template data
Styles 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 |
color | color | Alias of class
| 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 |
See also
- commons:Template:Clickable button, corresponding clickable button at Commons.
- Wikimedia design style guide advice on buttons