Template:Clickable button 2/doc: Difference between revisions
Jump to navigation
Jump to search
en>Paine Ellsworth m update /doc |
en>Sdkb Expanded TemplateData |
||
| Line 26: | Line 26: | ||
"1": { | "1": { | ||
"required": true, | "required": true, | ||
"label": "Link/Label" | "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": { | "2": { | ||
"suggested": true, | "suggested": true, | ||
"label": "Label" | "label": "Label", | ||
"description": "Defines the text that appears on the button" | |||
}, | }, | ||
"url": { | "url": { | ||
"type": "url", | "type": "url", | ||
"label": "URL" | "label": "URL", | ||
"description": "Defines a web address for the button to link to", | |||
"example": "https://www.example.com" | |||
}, | }, | ||
"class": { | "class": { | ||
"type": "string", | "type": "string", | ||
" | "description": "Defines the visual type of the button", | ||
"example": "mw-ui-progressive, mw-ui-destructive" | |||
}, | }, | ||
"style": { | "style": { | ||
Revision as of 09:03, 8 April 2020
 | 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 is used on approximately 1,020,000 pages, or roughly 8536% of all pages. 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. Consider discussing changes on the talk page before implementing them. |
 | This template is used in system messages, and on approximately 1,020,000 pages, or roughly 8536% 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 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.
Button templates | |
|---|---|
| General button templates |
|
| WikiProject-specific buttons |
|
