ButtonGroup shares size context with nested Button children and visually joins them into one control.
Setup
<script lang="ts">
import { Button, ButtonGroup } from '.';
</script> Default
<script lang="ts">
import { Button, ButtonGroup } from '.';
</script>
<ButtonGroup>
<Button color="alternative">Profile</Button>
<Button color="alternative">Settings</Button>
<Button color="alternative">Messages</Button>
</ButtonGroup> Sizes
<script lang="ts">
import { Button, ButtonGroup } from '.';
</script>
<ButtonGroup size="sm">
<Button color="alternative">SM</Button>
<Button color="alternative">Group</Button>
</ButtonGroup> Mixed colors
<script lang="ts">
import { Button, ButtonGroup } from '.';
</script>
<ButtonGroup>
<Button color="blue">Save</Button>
<Button color="alternative">Cancel</Button>
<Button color="red">Delete</Button>
</ButtonGroup> Disabled group
disabled on the group disables all children via context.
<script lang="ts">
import { Button, ButtonGroup } from '.';
</script>
<ButtonGroup disabled>
<Button>One</Button>
<Button>Two</Button>
<Button>Three</Button>
</ButtonGroup> Props
| Prop | Type | Default | Description |
|---|---|---|---|
children | Snippet | — | Nested Button (or compatible) children (required) |
size | 'xs' | 'sm' | 'md' | 'lg' | 'xl' | 'md' | Shared child size context |
disabled | boolean | — | Disable all children via context |
class | ClassValue | — | Extra classes on the group |
...rest | HTMLAttributes<HTMLDivElement> | — | Root attributes |
Theme base: inline-flex rounded-lg shadow-xs -space-x-px.