Button group
Button group renders a series of buttons.
On this page
Description
Use ButtonGroup to render a series of buttons.
Arguments
| Name | Type | Default | Description |
|---|---|---|---|
scheme | Symbol |
| DEPRECATED. One of |
size | Symbol |
| One of |
system_arguments | Hash | N/A |
Examples
Slots
buttons
List of buttons to be rendered. Add buttons via the #with_button, #with_menu_button, and #with_clipboard_copy_button methods (see below).
Methods
with_button(icon: Symbol, system_arguments: Hash)
Adds a button.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
icon | Symbol |
| If included, adds a IconButton with the given Octicons. Otherwise, a Button is added instead. |
system_arguments | Hash | N/A | The arguments accepted by Button or IconButton, depending on the value of the |
with_menu_button(system_arguments: Hash)
Adds a button that activates a menu when clicked.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
system_arguments | Hash | N/A | The arguments accepted by ButtonGroup::MenuButton. |
with_clipboard_copy_button(system_arguments: Hash)
Adds a ClipboardCopyButton.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
system_arguments | Hash | N/A | The arguments accepted by ClipboardCopyButton. |
ButtonGroup::MenuButton
Renders a button in a ButtonGroup that displays an ActionMenu when clicked.
This component should not be used outside of a ButtonGroup context.
This component yields both the button and the list to the block when rendered.
<%= render(Primer::Beta::ButtonGroup.new) do |group| %><% group.with_menu_button do |menu, button| %><% menu.with_item(label: "Item 1") %><% button.with_trailing_visual_icon(icon: "triangle-down") %><% end %><% end %>
Arguments
| Name | Type | Default | Description |
|---|---|---|---|
menu_arguments | Hash |
| The arguments accepted by ActionMenu. |
button_arguments | Hash |
| The arguments accepted by Button or IconButton, depending on the value of the |