Template:Clickable button 2/doc: Difference between revisions

From escforumwiki
Jump to navigation Jump to search
en>Dispenser
Starting <templatedata>
Santos (talk | contribs)
m 42 revisions imported
 
(10 intermediate revisions by 9 users not shown)
Line 1: Line 1:
{{Documentation subpage}}
{{Documentation subpage}}
{{High-risk|400,000+}}
{{template shortcut|CLB2|Click}}
{{Used in system}}
{{template shortcut|CLB2}}
{{lua|Module:Clickable button 2}}
{{lua|Module:Clickable button 2}}


Line 24: Line 22:
{
{
"params": {
"params": {
"1": {},
"1": {
"2": {},
"required": true,
"url": {},
"label": "Link/Label",
"class": {},
"description": "Defines the page to link to, and uses that page's title as the text for the button",
"style": {},
"example": "Foobar",
"category": {}
"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",
"description": "Styles a link like a button, using the mediawiki.ui.button module",
Line 38: Line 59:
=== 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>{{#ifeq:{{SUBPAGENAME}}|sandbox||
<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 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}}
  • Code: {{Clickable button 2|Main Page|Cover page}}
  • Code: {{Clickable button 2|Main Page|url=http://en.wikipedia.org}}
  • Code: {{Clickable button 2|Main Page|class=mw-ui-destructive}}
  • Code: {{Clickable button 2|Main Page|class=mw-ui-progressive}}

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

Template parameters

This template prefers inline formatting of parameters.

ParameterDescriptionTypeStatus
Link/Label1

Defines the page to link to, and uses that page's title as the text for the button

Example
Foobar
Page namerequired
Label2

Defines the text that appears on the button

Unknownsuggested
URLurl

Defines a web address for the button to link to

Example
https://www.example.com
URLoptional
classclass

Defines the visual type of the button

Example
mw-ui-progressive, mw-ui-destructive
Stringoptional
stylestyle

no description

Stringoptional
categorycategory

no description

Booleanoptional

See also