Template:Clickable button 2/doc: Difference between revisions
Jump to navigation
Jump to search
en>CabbagePotato (I got it wrong the first time... it's the other way around.) |
m (42 revisions imported) |
||
| (20 intermediate revisions by 16 users not shown) | |||
| Line 1: | Line 1: | ||
{{template shortcut|CLB2}} | {{Documentation subpage}} | ||
{{template shortcut|CLB2|Click}} | |||
{{lua|Module:Clickable button 2}} | {{lua|Module:Clickable button 2}} | ||
This template | 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> | *'''Code: '''<code><nowiki>{{Clickable button 2|Main Page}}</nowiki></code> | ||
| Line 16: | Line 17: | ||
'''Note: '''After the changes outlined in Phabricator task {{Phab|T110555}} were implemented, <code><nowiki>{{Clickable button 2|Main Page|class=mw-ui-constructive}}</nowiki></code> produces the same output as <code><nowiki>{{Clickable button 2|Main Page|class=mw-ui-progressive}}</nowiki></code>. | '''Note: '''After the changes outlined in Phabricator task {{Phab|T110555}} were implemented, <code><nowiki>{{Clickable button 2|Main Page|class=mw-ui-constructive}}</nowiki></code> produces the same output as <code><nowiki>{{Clickable button 2|Main Page|class=mw-ui-progressive}}</nowiki></code>. | ||
=== 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" | |||
}, | |||
"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", | |||
"example": "mw-ui-progressive, mw-ui-destructive" | |||
}, | |||
"style": { | |||
"type": "string" | |||
}, | |||
"category": { | |||
"type": "boolean" | |||
} | |||
}, | |||
"description": "Styles a link like a button, using the mediawiki.ui.button module", | |||
"format": "inline" | |||
} | |||
</templatedata> | |||
=== See also === | === See also === | ||
* [[commons:Template:Clickable button]], corresponding clickable button at Commons. | * [[commons:Template:Clickable button]], corresponding clickable button at Commons. | ||
* [https://design.wikimedia.org/style-guide/components/buttons.html Wikimedia design style guide advice on buttons] | |||
{{Button templates}} | {{Button templates}} | ||
<includeonly>{{ | <includeonly>{{Sandbox other|| | ||
<!-- Categories and interwikis go here: --> | <!-- Categories and interwikis go here: --> | ||
[[Category:Wikipedia formatting and function templates]] | [[Category:Wikipedia formatting and function templates]] | ||
Latest revision as of 19:32, 8 June 2022
 | This is a documentation subpage for Template:Terminate sentence It may contain usage information, categories and other content that is not part of the original template page. |
 | This template uses Lua: |
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-progressive}}- Result:
Note: After the changes outlined in Phabricator task T110555 were implemented, {{Clickable button 2|Main Page|class=mw-ui-constructive}} produces the same output as {{Clickable button 2|Main Page|class=mw-ui-progressive}}.
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 |
| style | style | no description | String | optional |
| category | category | no description | Boolean | optional |
See also
- commons:Template:Clickable button, corresponding clickable button at Commons.
- Wikimedia design style guide advice on buttons
Button templates | |
|---|---|
| General button templates |
|
| WikiProject-specific buttons |
|
