ui/docs/content/3.components/button-group.md

title, description, category, links

title	description	category	links
ButtonGroup	Group multiple button-like elements together.	element	label icon to GitHub i-simple-icons-github https://github.com/nuxt/ui/tree/v3/src/runtime/components/ButtonGroup.vue

Usage

Wrap multiple Button within a ButtonGroup to group them together.

::component-code

prettier: true slots: default: |

<UButton color="neutral" variant="subtle" label="Button" />
<UButton color="neutral" variant="outline" icon="i-lucide-chevron-down" />

---

:u-button{color="neutral" variant="subtle" label="Button"} :u-button{color="neutral" variant="outline" icon="i-lucide-chevron-down"} ::

Size

Use the size prop to change the size of all the buttons.

::component-code

prettier: true props: size: xl slots: default: |

<UButton color="neutral" variant="subtle" label="Button" />
<UButton color="neutral" variant="outline" icon="i-lucide-chevron-down" />

---

:u-button{color="neutral" variant="subtle" label="Button"} :u-button{color="neutral" variant="outline" icon="i-lucide-chevron-down"} ::

Orientation

Use the orientation prop to change the orientation of the buttons. Defaults to horizontal.

::component-code

prettier: true props: orientation: vertical slots: default: |

<UButton color="neutral" variant="subtle" label="Submit" />
<UButton color="neutral" variant="outline" label="Cancel" />

---

:u-button{color="neutral" variant="subtle" label="Submit"} :u-button{color="neutral" variant="outline" label="Cancel"} ::

Examples

With input

You can use components like Input, InputMenu, Select SelectMenu, etc. within a button group.

::component-code

prettier: true slots: default: |

<UInput color="neutral" variant="outline" placeholder="Enter token" />

<UButton color="neutral" variant="subtle" icon="i-lucide-clipboard" />

---

:u-input{color="neutral" variant="outline" placeholder="Enter token"} :u-button{color="neutral" variant="subtle" icon="i-lucide-clipboard"} ::

With tooltip

You can use a Tooltip within a button group.

:component-example{name="button-group-tooltip-example"}

With dropdown

You can use a DropdownMenu within a button group.

:component-example{name="button-group-dropdown-example"}

With badge

You can use a Badge within a button group.

:component-example{name="button-group-badge-example"}

API

Props

:component-props

Slots

:component-slots

Theme

:component-theme