Template:Key/doc: Difference between revisions

Latest revision as of 04:47, 21 April 2026

Displays keybinds as rectangle or circle buttons.

{{Key|Ctrl|Control|rect}} will make: Ctrl

{{Key|A|A|circle}} will make: A


Name	Variable	Description
Text	`1`	The text to display inside the button
Hover-Text	`2`	(Optional) the full name of the button to show when hovered (defaults to parameter 1)
Shape	`3`	(Optional) shape of the button. rect/circle (defaults to rect)

For displaying a keybind as a rectangle or circle

Template parameters
Parameter		Description	Type	Status
Text	`1`	The text to display inside the button Example Ctrl	String	required
Hover-text	`2`	(Optional) the full name of the button to show when hovered (defaults to whatever Text is set to) Example Control	String	suggested
Shape	`3`	(Optional) shape of the button. rect/circle (defaults to rect) Suggested values `rect` `circle` Default rect Example circle	String	suggested

@@ Line 1: / Line 1: @@
+== Documentation ==
+Displays keybinds as rectangle or circle buttons.
+=== Example Usage ===
+<code><nowiki>{{Key|Ctrl|Control|rect}}</nowiki></code> will make: {{Key|Ctrl|Control|rect}}
+<code><nowiki>{{Key|A|A|circle}}</nowiki></code> will make: {{Key|A|A|circle}}
+=== Template parameters ===
+{| class="wikitable"
+|+
+|-
+! Name !! Variable !! Description
+|-
+| Text || <code>1</code>|| The text to display inside the button
+|-
+| Hover-Text|| <code>2</code> || (Optional) the full name of the button to show when hovered (defaults to parameter 1)
+|-
+| Shape || <code>3</code> || (Optional) shape of the button. rect/circle (defaults to rect)
+|}
 <templatedata>
 {
@@ Line 37: / Line 56: @@
 }
 </templatedata>
+<includeonly>[[Category:Inline templates{{#translation:}}]]</includeonly>
+<noinclude>[[Category:Template documentation{{#translation:}}]]</noinclude>