1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100
|
= Button Macro Category Keys
:description: Reference list of the available button UI macro category keys and their value types.
:navtitle: Button
:source-language: yaml
[#button]
== button
The keys in the `button` category apply to a button reference generated from the inline button macro.
[cols="3,4,6a"]
|===
|Key |Value Type |Example
|background-color
|xref:color.adoc[Color] +
(default: _not set_)
|[source]
button:
background-color: #0000FF
|<<border-color,border-color>>
|xref:color.adoc[Color] +
(default: _not set_)
|[source]
button:
border-color: #CCCCCC
|<<border-offset,border-offset>>
|xref:language.adoc#values[Number] +
(default: `0`)
|[source]
button:
border-offset: 1.5
|border-radius
|xref:measurement-units.adoc[Measurement] +
(default: `0`)
|[source]
button:
border-radius: 2
|border-width
|xref:measurement-units.adoc[Measurement] +
(default: `$base-border-width`)
|[source]
button:
border-width: 0.5
|<<content,content>>
|xref:quoted-string.adoc[Quoted string] +
(default: `"%s"`)
|[source]
button:
content: "[\u2009%s\u2009]"
|font-color
|xref:color.adoc[Color] +
(default: _inherit_)
|[source]
button:
font-color: #FFFFFF
|font-family
|xref:font-support.adoc[Font family name] +
(default: `Courier`)
|[source]
button:
font-family: M+ 1mn
|font-size
|xref:text.adoc#font-size[Font size] +
(default: _inherit_)
|[source]
button:
font-size: 12
|font-style
|xref:text.adoc#font-style[Font style] +
(default: `bold`)
|[source]
button:
font-style: normal
|===
[#border-color]
== border-color
A border is only applied to a button reference if the `border-color` key is specified and the `border-width` key isn't explicitly set to zero.
[#border-offset]
== border-offset
The border offset is the amount that the background and border swells around the button text.
The value assigned to `border-offset` doesn't affect the distance between the formatted button phrase and the phrases that surround it.
[#content]
== content
The character sequence `%s` assigned to the `content` key gets replaced with the button label.
|