Toggle Group

Installation

Copy editable source into an initialized application:

pnpm dlx @simurgh-ui/cli add toggle-group

For package consumption, import from the component subpath and load its optional recipe CSS:

React

import {
  ToggleGroup,
  ToggleGroupItem,
} from '@simurgh-ui/react/toggle-group';
import '@simurgh-ui/styles/toggle-group.css';

Vue

import {
  ToggleGroup,
  ToggleGroupItem,
} from '@simurgh-ui/vue/toggle-group';
import '@simurgh-ui/styles/toggle-group.css';

Angular

import {
  ToggleGroupComponent,
  ToggleGroupItemDirective,
} from '@simurgh-ui/angular/toggle-group';
import '@simurgh-ui/styles/toggle-group.css';

Omit the component stylesheet for fully headless styling. CLI-copied components use the local path written to simurgh.json and the copied application styles instead of these package imports.

Purpose

Toggle Group coordinates related toggle buttons, selection state, and orientation-aware focus movement.

Default presentation: styled

The optional component stylesheet provides a complete default recipe, including visual hierarchy and interaction states. Consumers can override semantic tokens or omit the recipe.

Basic usage

Live component Toggle Group ◆

StartCenterEnd

Anatomy

The public component parts are listed in API surface below. Use only the parts needed by the example; compound components depend on their documented parent/child nesting.

State model

Controlled state remains the application’s source of truth and must be updated from every change event. Uncontrolled state reads its default only when the component mounts. Do not pass both forms of the same state at once.

Framework	Exact state contract and reset behavior
React	Controlled: value + onValueChange. Uncontrolled: defaultValue. Reset controlled state by assigning the initial value; reset uncontrolled state by changing a React key.
Vue	Controlled: v-model (modelValue + update:modelValue). Uncontrolled: defaultValue. Reset the model ref to its initial value; reset uncontrolled state with a changed Vue :key.
Angular	Controlled two-way binding: [(value)] (value + valueChange). Angular exposes no separate default input; initialize and reset the bound class field explicitly.

React

const initialValue = '';
const [value, setValue] = useState(initialValue);
const [resetKey, setResetKey] = useState(0);

<ToggleGroup value={value} onValueChange={setValue}>…</ToggleGroup>
<button onClick={() => setValue(initialValue)}>Reset controlled</button>
<ToggleGroup key={resetKey} defaultValue={initialValue}>…</ToggleGroup>
<button onClick={() => setResetKey((key) => key + 1)}>Reset uncontrolled</button>

Vue

<script setup lang="ts">
import { ref } from 'vue';
const initial = '';
const state = ref(initial);
const resetKey = ref(0);
</script>

<ToggleGroup v-model="state">…</ToggleGroup>
<button @click="state = initial">Reset controlled</button>
<ToggleGroup :key="resetKey" :defaultValue="initial">…</ToggleGroup>
<button @click="resetKey++">Reset uncontrolled</button>

Angular

initial = '';
value = this.initial;
reset() { this.value = this.initial; }

<simurgh-toggle-group [(value)]="value">…</simurgh-toggle-group>
<button type="button" (click)="reset()">Reset</button>

Use type="multiple" when more than one option may be active. Every icon-only item needs an accessible name.

Examples

React

<ToggleGroup aria-label="Alignment"><ToggleGroupItem value="start">Start</ToggleGroupItem><ToggleGroupItem value="center">Center</ToggleGroupItem></ToggleGroup>

Vue

<ToggleGroup v-model="alignment" aria-label="Alignment"><ToggleGroupItem value="start">Start</ToggleGroupItem><ToggleGroupItem value="center">Center</ToggleGroupItem></ToggleGroup>

Angular

<simurgh-toggle-group [(value)]="alignment" aria-label="Alignment"><button simurghToggleGroupItem="start">Start</button><button simurghToggleGroupItem="center">Center</button></simurgh-toggle-group>

Keyboard interactions

These keys describe behavior implemented by the adapters. Native Tab, Enter, and Space behavior still applies to descendant links, buttons, and form controls unless the component overrides it.

Concern / keys	Behavior
Focus entry and exit (Tab / Shift+Tab)	Tab enters at the roving-tabindex item and leaves after the group.
Navigation and activation	Arrow keys move focus; Home/End move to first/last; Enter or Space toggles.
Escape	Not handled by the component.
RTL differences	Horizontal previous/next arrows reverse in RTL.
Typeahead	Not supported.

Accessibility

Preserve the documented composition and accessible names when wrapping or restyling this component. See accessibility and RTL guidance for keyboard, focus, labeling, and directionality requirements.

API surface

• React exports: ToggleGroup, ToggleGroupItem
• Vue exports: ToggleGroup, ToggleGroupItem
• Angular exports: ToggleGroupComponent, ToggleGroupItemDirective

Import these public symbols from the component subpath shown in Installation. Framework-specific props, events, slots, directives, methods, defaults, and native-attribute behavior belong in the API tables on this page; use the linked source only to verify the current implementation.

React API reference

React

An inherited-attributes entry means the component accepts the complete named React native interface, including its event handlers and ARIA and data attributes. Remaining attributes are forwarded to the rendered element unless the component behavior described on this page overrides them.

ToggleGroup

Inherited attributes: HTMLAttributes<HTMLDivElement>.

Prop	Type	Default / requirement
children	ReactNode	undefined
defaultValue	(string | number | readonly string[]) & string[]	undefined
direction	Direction	undefined
onValueChange	(value: string[]) => void	undefined
orientation	Orientation	undefined
type	"multiple" | "single"	undefined
value	string[]	undefined

ToggleGroupItem

Inherited attributes: ButtonHTMLAttributes<HTMLButtonElement>.

Prop	Type	Default / requirement
children	ReactNode	undefined
value	string | (readonly string[] & string)	Required

Vue API reference

Vue

Boolean props without explicit defaults use Vue’s false default. Undeclared attributes follow the fallthrough behavior stated for each component.

ToggleGroup

Vue attribute fallthrough is enabled for the rendered root.

Prop	Type	Default / requirement
type	'single' | 'multiple'	'single'
modelValue	string[]	undefined
defaultValue	string[]	() => []
orientation	Orientation	'horizontal'
direction	Direction	'ltr'

Event	Payload
update:modelValue	string[]

Slots: default.

Exposed methods: none.

ToggleGroupItem

Vue attribute fallthrough is enabled for the rendered root.

Prop	Type	Default / requirement
value	string	Required
disabled	boolean	false

No emitted events.

Slots: default.

Exposed methods: none.

Angular API reference

Angular

Inputs and outputs use their public template names. Public methods are callable through a template reference or ViewChild. Native attributes apply to the documented template root or directive host; they are not automatically forwarded through component hosts.

ToggleGroupComponent

Component selector: simurgh-toggle-group. The template’s first native element is ng-content. Angular host bindings: { role: 'group', 'data-slot': 'toggle-group', '[attr.aria-orientation]': 'orientation', '[attr.dir]': 'direction', }.

Input	Type	Default / requirement
type	"single" | "multiple"	'single'
value	string[]	[]
orientation	Orientation	'horizontal'
direction	Direction	'ltr'

Output	Payload
valueChange	string[]

Content projection: default.

Public method
toggle(item: string): void
onKeyDown(event: KeyboardEvent): void

ToggleGroupItemDirective

Attribute directive selector: button[simurghToggleGroupItem]; behavior applies to its host element.

Input	Type	Default / requirement
simurghToggleGroupItem	string	''
disabled	boolean	false

No outputs.

Content projection: none.

Public method
activate(): void

Composition contract

Follow the framework example as a structural contract. Root components own shared state; parts that consume that state must stay under the root (or be attached to projected descendants in Angular). Parts described as conditional are optional until their corresponding interaction or semantic region is used. Do not render a state-consuming part by itself.

Framework	Required parent/child relationship	Conditional parts	Supporting types
React	Render ToggleGroup as the ancestor. Nest the listed parts inside that root so they can read its shared state/context.	ToggleGroupItem are conditional parts: include only those needed by the documented anatomy. A trigger/control and its matching content/item are required when that interaction is used.	None.
Vue	Render ToggleGroup as the ancestor. Nest the listed parts inside that root so they can read its shared state/context.	ToggleGroupItem are conditional parts: include only those needed by the documented anatomy. A trigger/control and its matching content/item are required when that interaction is used.	None.
Angular	Create ToggleGroupComponent first. Attach listed directives to elements inside its projected content; nested component parts must remain inside it.	ToggleGroupItemDirective are conditional parts: include only those needed by the documented anatomy. A trigger/control and its matching content/item are required when that interaction is used.	None.

Accessible names, descriptions, and form labels remain required whenever the component’s purpose cannot otherwise be determined, even when the corresponding visual part is optional.

Framework parity and differences

The adapters target the same user-visible behavior and accessibility contract. Their public shapes follow each framework’s conventions and are not expected to be symbol-for-symbol identical.

Concern	Contract
Public composition	All adapters export 2 public symbols, with framework-idiomatic names.
State and change events	React uses controlled/default props and callbacks for value; Vue uses v-model; Angular uses [(value)].
Children and content	React uses children; Vue uses the slots listed above; Angular uses the documented content projection selectors.
Native attributes	React forwards the named native interface; Vue follows the stated fallthrough rule; Angular attributes apply to the component host unless an input, directive, or documented native root consumes them.
Imperative access	React has no forwarded ref; Vue exposes no methods; Angular exposes the listed class methods through a template reference or ViewChild.

These differences are intentional adapter design. Behavioral or accessibility differences not stated on this page are parity defects rather than supported variations.

Form integration

This component is not a form control and does not contribute a named value to FormData. Use it to structure or describe a form only when its purpose and accessibility guidance apply.

Supported states

The table distinguishes component behavior from application-owned presentation. “Not supported” means there is no public state contract for that adapter; do not invent one with an undocumented attribute. Keep status and error messages accessible when they are rendered outside the component.

State	React	Vue	Angular
Loading	Not supported by this component API; handle this state in surrounding application UI.	Not supported by this component API; handle this state in surrounding application UI.	Not supported by this component API; handle this state in surrounding application UI.
Empty	Not supported by this component API; handle this state in surrounding application UI.	Not supported by this component API; handle this state in surrounding application UI.	Not supported by this component API; handle this state in surrounding application UI.
Invalid	Not supported by this component API; handle this state in surrounding application UI.	Not supported by this component API; handle this state in surrounding application UI.	Not supported by this component API; handle this state in surrounding application UI.
Read-only	Not supported by this component API; handle this state in surrounding application UI.	Not supported by this component API; handle this state in surrounding application UI.	Not supported by this component API; handle this state in surrounding application UI.
Disabled	Supported with disabled={true} on the documented control or interactive part; its interaction is blocked. Disabled form controls are omitted from submission.	Supported with :disabled="true" on the documented control or interactive part; its interaction is blocked. Disabled form controls are omitted from submission.	Supported with [disabled]="true" on the documented control or interactive part; its interaction is blocked. Disabled form controls are omitted from submission.
Error	Not supported by this component API; handle this state in surrounding application UI.	Not supported by this component API; handle this state in surrounding application UI.	Not supported by this component API; handle this state in surrounding application UI.

Styling contract

Styling contract

The selectors below are used by the published component recipe or emitted consistently by an adapter. Treat these as the supported styling surface. Element order, anonymous wrappers, and undocumented descendants are implementation details and should not be targeted.

Surface	Stable hooks
Recipe classes	No component-specific recipe class; this stylesheet currently imports shared tokens only.
Stable DOM parts	[data-slot="toggle-group"]
Stable data attributes	[data-slot], [data-state], [data-toggle-group-item]
ARIA/state selectors used by the recipe	[aria-orientation]
CSS custom properties consumed	No component-specific token consumption beyond the shared token import.

Prefer a semantic token override for theme-wide changes. Use the listed class or part selectors for a component-scoped override. When omitting recipe CSS, preserve state attributes and ARIA semantics even if your replacement styles use different selectors.

Customization

Load the optional component stylesheet for the default recipe, override semantic tokens for broad theme changes, or omit the recipe CSS for headless styling. See theming and styling hooks for import order, selectors, dark mode, RTL, and reduced-motion guidance.

Last verified on 2026-08-13 against Simurgh registry 0.1.1.

Related components

• Review the shared accessibility and RTL guidance and theming and styling hooks.
• Use the component chooser and component overview to compare related primitives.
• Inspect the registry manifest and framework source for React, Vue, or Angular.