View source for Template:Button/doc

{{Documentation}}

This template renders a generic button component.
It is commonly used by other templates and modules.

== Usage ==
=== Target ===
Must contains either the <code>page</code> or <code>url</code> parameter.

{|class="wikitable"
|-
! Internal link
| <syntaxhighlight lang="wikitext" inline>{{Button|label=Label|link=Main Page}}</syntaxhighlight>
| {{Button|label=Label|link=Main Page}}
|-
! External link
| <syntaxhighlight lang="wikitext" inline>{{Button|label=Label|url=https://example.com}}</syntaxhighlight>
| {{Button|label=Label|url=https://example.com}}
|}

=== Action & Weight ===
<syntaxhighlight lang="wikitext" inline>{{Button|label=<label>|link=<wikipage>|action=<action>|weight=<weight>}}</syntaxhighlight>

{|class="wikitable"
|-
! !! Normal !! Primary !! Quiet
|-
! Default
| {{Button|label=Label|link=Main Page|action=default}}
| {{Button|label=Label|link=Main Page|action=default|weight=primary}}
| {{Button|label=Label|link=Main Page|action=default|weight=quiet}}
|-
! Progressive
| {{Button|label=Label|link=Main Page|action=progressive}}
| {{Button|label=Label|link=Main Page|action=progressive|weight=primary}}
| {{Button|label=Label|link=Main Page|action=progressive|weight=quiet}}
|-
! Destructive
| {{Button|label=Label|link=Main Page|action=destructive}}
| {{Button|label=Label|link=Main Page|action=destructive|weight=primary}}
| {{Button|label=Label|link=Main Page|action=destructive|weight=quiet}}
|}

=== Size ===
{|class="wikitable"
|-
! Size !! Wikitext !! Text button !! Icon-only button
|-
! Small
| <syntaxhighlight lang="wikitext" inline>{{Button|label=Label|link=Main Page|size=small}}</syntaxhighlight>
| {{Button|label=Label|link=Main Page|size=small}}
| {{Button|label=Label|link=Main Page|size=small|icon=CdxIconArrowNext.svg|iconOnly=true}}
|-
! Medium
| <syntaxhighlight lang="wikitext" inline>{{Button|label=Label|link=Main Page|size=medium}}</syntaxhighlight>
| {{Button|label=Label|link=Main Page|size=medium}}
| {{Button|label=Label|link=Main Page|size=medium|icon=CdxIconArrowNext.svg|iconOnly=true}}
|-
! Large
| <syntaxhighlight lang="wikitext" inline>{{Button|label=Label|link=Main Page|size=large}}</syntaxhighlight>
| {{Button|label=Label|link=Main Page|size=large}}
| {{Button|label=Label|link=Main Page|size=large|icon=CdxIconArrowNext.svg|iconOnly=true}}
|}

=== With icon ===
{|class="wikitable"
|-
| <syntaxhighlight lang="wikitext" inline>{{Button|label=Previous|link=Main Page|icon=CdxIconArrowNext.svg}}</syntaxhighlight>
| {{Button|label=Label|link=Main Page|icon=CdxIconArrowNext.svg}}
|}

=== Icon-only button ===
{|class="wikitable"
|-
| <syntaxhighlight lang="wikitext" inline>{{Button|label=Previous|link=Main Page|icon=CdxIconArrowNext.svg|iconOnly=true}}</syntaxhighlight>
| {{Button|label=Label|link=Main Page|icon=CdxIconArrowNext.svg|iconOnly=true}}
|}

== TemplateData ==
<templatedata>
{
	"params": {
		"label": {
			"label": "Label",
			"description": "Label text",
			"type": "string",
			"required": true
		},
		"link": {
			"label": "Page name",
			"description": "Page name to link to",
			"type": "wiki-page-name",
			"suggested": true
		},
		"url": {
			"label": "URL",
			"description": "URL to link to",
			"type": "url",
			"suggested": true
		},
		"action": {
			"label": "Button action",
			"type": "string",
			"suggestedvalues": [
				"default",
				"progressive",
				"destructive"
			],
			"default": "default",
			"suggested": true
		},
		"weight": {
			"label": "Button weight",
			"type": "string",
			"suggestedvalues": [
				"normal",
				"primary"
			],
			"default": "normal",
			"suggested": true
		},
		"size": {
			"label": "Button size",
			"type": "string",
			"suggestedvalues": [
				"small",
				"medium",
				"large"
			],
			"default": "medium"
		},
		"disabled": {
			"label": "Disabled",
			"description": "Whether the button is disabled",
			"type": "boolean"
		}
	},
	"description": "Renders a generic button component",
	"format": "inline"
}
</templatedata>

<includeonly>
[[Category:Templates]]
</includeonly>