Button
Button is used to initiate actions on a page or form.
On this page
Description
Use Button
for actions (e.g. in forms). Use links for destinations, or moving from one page to another.
Arguments
Name | Type | Default | Description |
---|---|---|---|
scheme | Symbol |
| One of |
variant | Symbol |
| DEPRECATED. One of |
size | Symbol |
| One of |
tag | Symbol |
| One of |
type | Symbol |
| One of |
group_item | Boolean |
| Whether button is part of a ButtonGroup. |
block | Boolean |
| Whether button is full-width with |
dropdown | Boolean |
| Whether or not to render a dropdown caret. |
system_arguments | Hash | N/A |
Slots
leading_visual
Leading visuals appear to the left of the button text.
Use:
leading_visual_icon
for a Octicon.
Name | Type | Default | Description |
---|---|---|---|
system_arguments | Hash | N/A | Same arguments as Octicon. |
trailing_visual
Trailing visuals appear to the right of the button text.
Use:
trailing_visual_counter
for a Counter.
Name | Type | Default | Description |
---|---|---|---|
system_arguments | Hash | N/A | Same arguments as Counter. |
tooltip
Tooltip
that appears on mouse hover or keyboard focus over the button. Use tooltips sparingly and as a last resort.
Important: This tooltip defaults to type: :description
. In a few scenarios, type: :label
may be more appropriate.
Consult the Tooltip documentation for more information.
Name | Type | Default | Description |
---|---|---|---|
type | Symbol |
| One of |
system_arguments | Hash | N/A | Same arguments as Tooltip. |
Methods
icon
remove alias when all buttons are migrated to new slot names
counter
remove alias when all buttons are migrated to new slot names