Template:Key: Difference between revisions

From VRChat Wiki
m Text replacement - "\[\[(?!(Special:|File:|Media:))([^\|\]]+)\]\]" to "$2"
~Pausbe (talk | contribs)
move docs and template categories to doc page
 
(2 intermediate revisions by one other user not shown)
Line 16: Line 16:
</span>
</span>
}}
}}
<noinclude>
<noinclude>
== Documentation ==
{{Documentation}}
Displays keybinds as rectangle or circle buttons.
=== Example Usage ===
<nowiki>{{Key|Ctrl|Control|rect}}</nowiki>
 
will make: </br>
{{Key|Ctrl|Control|rect}}
 
<nowiki>{{Key|A|A|circle}}</nowiki>
 
will make: </br>
{{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)
|}
 
[[Special:MyLanguage/Category:Templates|Category:Templates]]
[[Special:MyLanguage/Category:Templates/inline icons|Category:Templates/inline icons]]
</noinclude>
</noinclude>

Latest revision as of 04:48, 21 April 2026

{{{1}}}

Documentation

Displays keybinds as rectangle or circle buttons.

Example Usage

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


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


Template parameters

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[Edit template data]

ParameterDescriptionTypeStatus
Text1

The text to display inside the button

Example
Ctrl
Stringrequired
Hover-text2

(Optional) the full name of the button to show when hovered (defaults to whatever Text is set to)

Example
Control
Stringsuggested
Shape3

(Optional) shape of the button. rect/circle (defaults to rect)

Suggested values
rect circle
Default
rect
Example
circle
Stringsuggested