{"slug":"button-group","name":"ButtonGroup","category":"Form & Input","summary":"Joins related buttons into one segmented control.","status":"stable","since":"0.2.0","import":"import { ButtonGroup } from '@elluzion/iv-ui';","usage":["`mode=\"none\"` is a plain toolbar; `single` and `multiple` track selection.","Items may be strings or `{ value, label, icon, disabled }`.","`variant` applies to every button; `size` keeps the row consistent."],"props":[{"name":"items","type":"ButtonGroupItem[]","default":"[]","description":"Buttons to render. Items may be strings or `{ value, label, icon, disabled }`.","required":false,"bindable":false},{"name":"mode","type":"ButtonGroupMode","default":"'none'","description":"Selection behaviour: one value, many values, or none.","required":false,"bindable":false},{"name":"value","type":"string | string[]","default":"mode === 'multiple' ? [] : ''","description":"Selected value(s). Bind with `bind:value`.","required":false,"bindable":true},{"name":"label","type":"string","default":"''","description":"Accessible name for the group.","required":false,"bindable":false},{"name":"className","type":"string","default":"''","description":"Extra classes merged onto the root element.","required":false,"bindable":false},{"name":"size","type":"'sm' | 'md' | 'lg'","default":"'md'","description":"Control size.","required":false,"bindable":false},{"name":"variant","type":"ButtonGroupVariant","default":"'secondary'","description":"Visual emphasis for every button in the group.","required":false,"bindable":false},{"name":"orientation","type":"'horizontal' | 'vertical'","default":"'horizontal'","description":"Stacking direction.","required":false,"bindable":false},{"name":"disabled","type":"boolean","default":"false","description":"Disables interaction and applies the disabled treatment.","required":false,"bindable":false},{"name":"fullWidth","type":"boolean","default":"false","description":"Stretches the group to the container width.","required":false,"bindable":false}],"events":[{"name":"change","type":"(e: CustomEvent<{ value: string | string[] }>) => void","default":null,"description":"Called with `{ value }` after a selection changes.","required":false,"bindable":false}],"snippets":[{"name":"children","type":"Snippet","default":null,"description":"Content rendered inside the component.","required":false,"bindable":false}],"types":[{"name":"ButtonGroupMode","kind":"type","code":"type ButtonGroupMode = 'single' | 'multiple' | 'none';","description":"Selection behaviour of a button group."},{"name":"ButtonGroupVariant","kind":"type","code":"type ButtonGroupVariant = 'primary' | 'secondary' | 'outline' | 'ghost' | 'danger';","description":"Emphasis applied to every button in the group."},{"name":"ButtonGroupItem","kind":"type","code":"type ButtonGroupItem =\n\t| string\n\t| {\n\t\t\tvalue: string;\n\t\t\tlabel?: string;\n\t\t\ticon?: Icon;\n\t\t\tdisabled?: boolean;\n\t  };","description":"A button description or a plain string label."}],"manual":[],"tokens":["--iv_cursor","--iv_radius-sm","--iv_reverse-bg","--iv_reverse-fg","--iv_reverse-hover","--iv_surface"],"cssHooks":["iv-btn","iv-btn-group","iv-disabled","iv-full-width","iv-selected","iv-vertical"],"accessibility":{"keyboard":[["Tab","Moves focus through the group."],["Space / Enter","Activates the focused button."]],"notes":["The container uses `role=\"group\"` and is named by `label`.","Selectable options expose `aria-pressed`; toolbar mode leaves it off.","`disabled` disables every button in the group."]},"related":[{"title":"Button","summary":"Triggers an action or submits a form.","url":"/components/button","kind":"Component"},{"title":"ToggleGroup","summary":"A row of toggles with single or multiple selection.","url":"/components/toggle-group","kind":"Component"},{"title":"Toggle","summary":"A pressable button that keeps a checked state.","url":"/components/toggle","kind":"Component"},{"title":"Tabs","summary":"Switches between panels that share one context.","url":"/components/tabs","kind":"Component"}],"examples":[{"id":"single","title":"Single","description":"A segmented control with one active option.","code":"<script lang=\"ts\">\n\timport { ButtonGroup } from '@elluzion/iv-ui';\n\n\tlet period = $state('week');\n</script>\n\n<div class=\"stack\">\n\t<ButtonGroup label=\"Period\" mode=\"single\" items={['day', 'week', 'month']} bind:value={period} />\n\t<p class=\"readout\">period: {period}</p>\n</div>\n\n<style>\n\t.stack {\n\t\tdisplay: flex;\n\t\tflex-direction: column;\n\t\talign-items: start;\n\t\tgap: var(--iv_spacing-sm);\n\t}\n\n\t.readout {\n\t\tmargin: 0;\n\t\tfont-family: var(--iv_font-mono);\n\t\tfont-size: var(--iv_text-sm);\n\t\tcolor: var(--iv_foreground-dim);\n\t}\n</style>"},{"id":"multiple","title":"Multiple","description":"Toggle several options and read the array value.","code":"<script lang=\"ts\">\n\timport { ButtonGroup } from '@elluzion/iv-ui';\n\n\tlet filters = $state<string[]>(['errors']);\n</script>\n\n<div class=\"stack\">\n\t<ButtonGroup\n\t\tlabel=\"Filters\"\n\t\tmode=\"multiple\"\n\t\titems={['errors', 'warnings', 'info']}\n\t\tbind:value={filters}\n\t/>\n\t<p class=\"readout\">active: {filters.join(', ') || '—'}</p>\n</div>\n\n<style>\n\t.stack {\n\t\tdisplay: flex;\n\t\tflex-direction: column;\n\t\talign-items: start;\n\t\tgap: var(--iv_spacing-sm);\n\t}\n\n\t.readout {\n\t\tmargin: 0;\n\t\tfont-family: var(--iv_font-mono);\n\t\tfont-size: var(--iv_text-sm);\n\t\tcolor: var(--iv_foreground-dim);\n\t}\n</style>"},{"id":"vertical","title":"Vertical","description":"`orientation=\"vertical\"` stacks the buttons.","code":"<script lang=\"ts\">\n\timport { ButtonGroup } from '@elluzion/iv-ui';\n\n\tlet action = $state('deploy');\n</script>\n\n<ButtonGroup\n\tlabel=\"Run\"\n\tmode=\"single\"\n\torientation=\"vertical\"\n\tvariant=\"outline\"\n\titems={['deploy', 'rollback', 'restart']}\n\tbind:value={action}\n/>"}],"markdown":"/components/button-group.md","page":"/components/button-group"}