Template:Button

From Cosmoteer Wiki
Jump to navigation Jump to search

{{{1}}}

Template documentation
View or edit this documentation. (About template documentation)
CalloutIconNote.pngNote
Portions of the template sample may not be visible without values provided.

Examples

Basic usage

{{Button|Space}}Space

Color combo parameter

Button Button code
Space {{Button|Space|color combo=gray bg - light blue text}}
Space {{Button|Space|color combo=light blue bg - black text}}
Space {{Button|Space|color combo=light blue bg - black text}}
Space {{Button|Space|color combo=blue bg - light blue text}}
Space {{Button|Space|color combo=blue bg - black text}}
Space {{Button|Space|color combo=transparent bg - light blue text}}
Space {{Button|Space|color combo=transparent bg - green text}}
Space {{Button|Space|color combo=transparent bg - blue text}}

Separate background and text color parameters

Button Button code
Space {{Button|Space|bg color = gray|text color = light blue}}
Space {{Button|Space|bg color = light blue|text color = black}}
Space {{Button|Space|bg color = light blue|text color = black}}
Space {{Button|Space|bg color = blue|text color = light blue}}
Space {{Button|Space|bg color = blue|text color = black}}
Space {{Button|Space|bg color = transparent|text color = light blue}}
Space {{Button|Space|bg color = transparent|text color = green}}
Space {{Button|Space|bg color = transparent|text color = blue}}

With anonymous params instead

Color combo parameter

{{Button|Space|blue bg - light blue text}}

Space

Separate background and text color parameters

{{Button|Space|blue|light blue}}

Space

Inline usage example

Using button {{Button|inside|blue|light blue}} a text.

Using button inside a text.


Displays the text looking like a "button". Used to convey that the string of text is button (keyboard, UI, etc.).

Template parameters

This template prefers inline formatting of parameters.

ParameterDescriptionTypeStatus
Buttontext 1

A button key to display. You can either choose a button from the list or enter your own.

Suggested values
Left Mouse Button Middle Mouse Button Right Mouse Button Mouse Button 4 Mouse Button 5 Mouse Scroll Wheel Down Mouse Scroll Wheel Up 0 1 2 3 4 5 6 7 8 9 A B C D E F G H I J K L M N O P Q R S T U V W X Y Z F1 F2 F3 F4 F5 F6 F7 F8 F9 F10 F11 F12 Backspace Tab Enter Shift Ctrl Alt Pause/Break Caps Lock Esc Space Page Up Page Down End Home Left arrow Up arrow Right arrow Down arrow Print Screen Insert Delete Left Win Right Win Popup Num Lock Scroll Lock Left Shift Right Shift Left Ctrl Right Ctrl * + - . / Numpad 0 Numpad 1 Numpad 2 Numpad 3 Numpad 4 Numpad 5 Numpad 6 Numpad 7 Numpad 8 Numpad 9 Numpad * Numpad + Numpad - Numpad . Numpad /
Example
Space
Stringrequired
Color combocolor combo

Choose one of the predefined button color combinations to use. if you also use the separate params for bg and text colors, they each will override the value defined here.

Suggested values
gray bg - light blue text light blue bg - black text blue bg - light blue text blue bg - black text transparent bg - light blue text transparent bg - green text transparent bg - blue text
Default
gray bg - light blue text
Auto value
gray bg - light blue text
Stringsuggested
Background colorbg color 2

The color of the button's background. Must be one of the predefined values, otherwise the button won't render.

Suggested values
gray light blue blue green transparent
Default
gray
Example
gray
Auto value
gray
Lineoptional
Text colortext color 3

The color of the button's text. Must be one of the predefined values, otherwise the button won't render.

Suggested values
light blue blue green black
Default
light blue
Auto value
light blue
Stringoptional