FormsInteractive playground

ToggleGroup

A toolbar for single or multiple selection.

Preparing the playground…

Text and Markdown example

ToggleGroup · Example

1<ToggleGroup type="single" defaultValue="left" aria-label="Alignment"><ToggleGroupItem value="left">Left</ToggleGroupItem><ToggleGroupItem value="center">Center</ToggleGroupItem><ToggleGroupItem value="right">Right</ToggleGroupItem></ToggleGroup>

Read documentation in Markdown

How to use it

Set type="single" or type="multiple". Each ToggleGroupItem needs a stable value.

Import

React / Next.js

1import { ToggleGroup, ToggleGroupItem } from "@kivora/nextjs";

Interactive examples run inside a component with "use client". The playground's Copy button includes the imports needed for the current example.

API reference 0.2.0

Types from the installed published version, including component properties and common HTML attributes. “Optional” does not imply a default value; omitting a property lets the component decide.

Property	Type	Description
`type`Required	`"single" \| "multiple"`	Operation type or mode; values depend on the component.
`aria-label`	`string`	Accessible name of the control.
`asChild`	`boolean`	Apply props and behavior to a single compatible child element.
`attached`	`boolean`	Configures attached. The type describes the supported values and structure.
`children`	`ReactNode`	Content or child elements of the component.
`className`	`string`	Additional CSS classes to customize the element.
`defaultChecked`	`boolean`	Initial selection of the control.
`defaultValue`	`string \| string[]`	Initial value when the component manages its own state.
`dir`	`"ltr" \| "rtl"`	Interface reading direction.
`disabled`	`boolean`	Disable interaction with the control.
`id`	`string`	Element identifier; associates labels and descriptions.
`loop`	`boolean`	Configures loop. The type describes the supported values and structure.
`onChange`	`ChangeEventHandler<HTMLDivElement, Element>`	Change event. Check the type: some controls return an object, others a DOM event.
`onClick`	`MouseEventHandler<HTMLDivElement>`	Action performed when the element is activated.
`onSubmit`	`SubmitEventHandler<HTMLDivElement>`	Form submission event.
`onValueChange`	`((value: string) => void) \| ((value: string[]) => void)`	Receives the value after an interaction.
`orientation`	`"horizontal" \| "vertical"`	Horizontal or vertical axis.
`role`	`AriaRole`	Semantic role of the element. Keep the default role unless a change is justified.
`rovingFocus`	`boolean`	Whether the group should maintain roving focus of its buttons.
`style`	`CSSProperties`	React inline styles.
`tabIndex`	`number`	Keyboard focus order and availability.
`title`	`string`	Title or supplementary information.
`value`	`string \| string[]`	Controlled value. Update it from the change callback.

Subcomponents and composition

Review each component's properties and published declaration. Native and accessibility attributes are inherited from the element specified by its type.

ToggleGroup23 properties

ToggleGroup · TypeScript

1ToggleGroup: React.ForwardRefExoticComponent<ToggleGroupProps & React.RefAttributes<HTMLDivElement>>

ToggleGroupItem20 properties

Property	Type	Description
`value`Required	`string`	Controlled value. Update it from the change callback.
`aria-label`	`string`	Accessible name of the control.
`asChild`	`boolean`	Apply props and behavior to a single compatible child element.
`children`	`ReactNode`	Content or child elements of the component.
`className`	`string`	Additional CSS classes to customize the element.
`defaultChecked`	`boolean`	Initial selection of the control.
`defaultValue`	`string \| number \| readonly string[]`	Initial value when the component manages its own state.
`disabled`	`boolean`	Disable interaction with the control.
`id`	`string`	Element identifier; associates labels and descriptions.
`name`	`string`	Name used to identify the control in forms.
`onChange`	`ChangeEventHandler<HTMLButtonElement, Element>`	Change event. Check the type: some controls return an object, others a DOM event.
`onClick`	`MouseEventHandler<HTMLButtonElement>`	Action performed when the element is activated.
`onSubmit`	`SubmitEventHandler<HTMLButtonElement>`	Form submission event.
`role`	`AriaRole`	Semantic role of the element. Keep the default role unless a change is justified.
`size`	`"default" \| "sm" \| "lg" \| "icon" \| null`	Visual size of the component.
`style`	`CSSProperties`	React inline styles.
`tabIndex`	`number`	Keyboard focus order and availability.
`title`	`string`	Title or supplementary information.
`type`	`"button" \| "submit" \| "reset"`	Operation type or mode; values depend on the component.
`variant`	`"default" \| "outline" \| "ghost" \| null`	Visual variant. Use a value supported by this component.

ToggleGroupItem · TypeScript

1ToggleGroupItem: React.ForwardRefExoticComponent<ToggleGroupItemProps & React.RefAttributes<HTMLButtonElement>>

API generated from @kivora/nextjs 0.2.0View package