Actions & selectionExplore · Adapt · Compose
Toggle Group
Toggle Group manages modern single- or multi-select controls with a segmented, toolbar-friendly style. Make the next action easy to recognize. Use visual emphasis deliberately and distinguish an action from a persistent selection or a navigation link. Explore the live examples, inspect their source and choose the composition that fits your interface before connecting it to your application's data.
The examples use @/components/kamod-ui/toggle-group in a Preact project. Follow the live result and its source together: compare supported options in the API reference, refine presentation with the component styles guide, and use shared theme tokens for consistent colors and surfaces. Preserve keyboard behavior and meaningful labels as you replace the sample content.
In this guide 7 sections
Installation
Import ToggleGroup and ToggleGroupItem from @/components/kamod-ui/toggle-group.
pnpm add @kamod-ch/uiThe @/components/kamod-ui/… imports in these examples refer to local source files. Configure that alias when copying source, or use the corresponding exports from @kamod-ch/ui when installing the package. Connect the global theme CSS and Tailwind source detection before your first render.
Usage
Use type, variant, size, spacing, and orientation to build compact, modern segmented controls.
import { ToggleGroup } from "@/components/kamod-ui/toggle-group";Choose a complete composition from the examples below; required child components and props vary by pattern.
Component examples & variants
Explore Toggle Group in different contexts, from the starting pattern to the compositions below. Begin with Single Selection, then compare the examples that match your content, state and layout. These are working patterns to adapt, not a list of interchangeable variant values: check the API reference before using a prop or combining behaviors. Look at the surrounding labels, supporting text and spacing as well as the component itself.
Read the result and its implementation together. Use each showcase’s Code view to inspect imports and composition, or its Prompt view to prepare a setup or adaptation brief. Try the narrow preview and local theme controls before connecting real data, and use Reset to return an example to its initial state. Keep layout changes in class utilities where appropriate; follow the component styles guide for hierarchy and the theming guide for shared surfaces and colors. The accessibility notes explain what to preserve when making those changes.
Single Selection
Allow one active option at a time with a segmented control look.
import { ToggleGroup, ToggleGroupItem } from "@/components/kamod-ui/toggle-group";
import { AlignCenter, AlignLeft, AlignRight } from "lucide-preact";
export const Example = () => (
<ToggleGroup type="single" defaultValue="left" variant="outline">
<ToggleGroupItem value="left" aria-label="Align left">
<AlignLeft class="size-4" />
</ToggleGroupItem>
<ToggleGroupItem value="center" aria-label="Align center">
<AlignCenter class="size-4" />
</ToggleGroupItem>
<ToggleGroupItem value="right" aria-label="Align right">
<AlignRight class="size-4" />
</ToggleGroupItem>
</ToggleGroup>
);Sizes
Use a compact or prominent size depending on your context.
Spacing
Tune the density between items with spacing presets.
Vertical
Set orientation to vertical for stacked controls.
Disabled
Disable a full group or single items to reflect unavailable actions.
Custom Font Weight
Use custom item classes to build segmented font-weight selectors.
Icon Only
Build dense, icon-only controls for editor-like toolbars.
Multiple Selection
Allow many active options in one modern toolbar group.
Pill Style
Use variant="pill" for a modern, chip-like segmented control.
Controlled
Control selection with external state using value and onValueChange.
Props and data
Configure Toggle Group using the contracts below. Read the documented options alongside the source definitions to understand which values your application supplies and which details the component owns. Start with a prop or helper, then follow its type link to inspect the declaration without leaving the page.
Props, slots and variants for this component.
TypeScript source at build time. Props inherited through HTMLAttributes, Omit or variant helpers remain references in those declarations; their fields are not flattened here. Match the reference to your installed version, and check a package’s exports before writing an import type. A type exported by a source file is not necessarily re-exported by @kamod-ch/ui.TypeScriptComponent props
? means a field can be omitted; it does not promise a fallback value. Existing documented defaults remain alongside the descriptions. For callbacks, check the argument and return types before connecting your own state or services.Toggle Group
Toggle Group component props and accepted values.
| Prop / type | Description |
|---|---|
type | Documented type option for Toggle Group. Check its type alongside the usage examples before supplying a value. Documented default |
value / defaultValue | Documented value / defaultValue option for Toggle Group. Check its type alongside the usage examples before supplying a value. Documented default |
onValueChange | Documented onValueChange option for Toggle Group. Check its type alongside the usage examples before supplying a value. Documented default |
variant | Documented variant option for Toggle Group. Check its type alongside the usage examples before supplying a value. Documented default |
size | Documented size option for Toggle Group. Check its type alongside the usage examples before supplying a value. Documented default |
spacing | Documented spacing option for Toggle Group. Check its type alongside the usage examples before supplying a value. Documented default |
orientation | Documented orientation option for Toggle Group. Check its type alongside the usage examples before supplying a value. Documented default |
disabled | Documented disabled option for Toggle Group. Check its type alongside the usage examples before supplying a value. Documented default |
Data type reference
Expand a card to inspect and copy the exact declaration. The code header identifies its repository file; follow imported or inherited types in the implementation source when you need the complete dependency chain. Required-field summaries cover fields declared directly in that type. Source-only helpers and inferred schema outputs describe the local implementation, not additional props you can pass to every component.
ToggleGroupBasePropsSingleToggleGroupPropsMultipleToggleGroupPropstypeToggleGroupPropsToggleGroupItemPropsvalueAccessibility
Build the complete interaction, including the parts outside Toggle Group. The notes below distinguish the current implementation from the labels, content and behavior your application supplies. Start with the live preview, check the props and data reference, and test the finished composition with real content rather than assuming that an unchanged visual example covers every use case.
Built-in behavior and defaults
ToggleGroup groups toggle buttons and defaults to single selection. Each item exposes aria-pressed; the root is a group, not a radiogroup. Do not assume mutually exclusive values imply native radio keyboard behavior.
Labels and relationships
Label the choice set and every option. Use stable option names, such as List and Grid, rather than changing labels into instructions after selection. Describe whether users may choose more than one option when that is not visually obvious.
Keyboard and focus
Keep each item keyboard reachable and use the documented value shape for single or multiple selection. Decide whether an empty selection is permitted before wiring controlled state. Do not add a toolbar role unless you also implement its keyboard model.
States and integration details
A highlighted item can be pressed, focused or both; show those states distinctly. If the task requires exactly one answer with radio conventions, consider RadioGroup instead of forcing toggle semantics into that role.
Verify the complete interaction
Check behavior as well as markup. Work through these scenarios in the application where the component will be used. Automated checks can help find structural problems; also review the reading experience with a screen reader, keyboard focus and the actual feedback from your application.
- Select and deselect options using only the keyboard, including the final selected option.
- Inspect pressed states after parent-controlled updates and after disabling an item.
- Verify the group question and all option names remain readable at narrow widths.
Recheck the result after changing theme tokens, translations or class overrides. Include text enlargement, narrow layouts and reduced-motion settings where animation is present. Inspect the component source when a behavior differs from your expectation; a role or state attribute does not implement keyboard interaction by itself.
For background, read the WAI-ARIA authoring guidance and keyboard interface guidance. These explain the patterns; verify browser and assistive-technology behavior for the implementation and audience you actually support.
Build it into your interface
Use the Toggle Group examples as a starting point, then review the behavior in the context of your own screen. Layout, state and content should work together.
Connect the behavior
Use an action label that describes the result. Within a form, choose button types deliberately so a secondary action does not submit accidentally. Use the supported selected or pressed state for persistent choices, and provide an accessible name for icon-only controls.
Copy the composition, then connect its intent. Replace sample records and callbacks with your own data flow. For options such as value, defaultValue, open or onChange, use only those documented in this component's API; different components expose different contracts.
Give each piece of state one owner. Keep a temporary selection inside the interface when nothing else needs it; lift shared values into a parent when other controls depend on them. Read the prop reference before combining controlled values with defaults. A default normally initializes a control; it is not a substitute for updating its current value.
Connect requests in an event handler or your application’s data layer, never as a side effect of rendering. Keep pending, completed and failed outcomes distinct, preserve useful input after an error, and offer a clear recovery action. If the integration subscribes to an external source, remove that subscription when its owner unmounts; cancel or ignore obsolete requests so an earlier response cannot replace newer results.
Start with the live preview, then exercise the same interaction with your actual data. The type definitions describe accepted values; they do not implement persistence, navigation or server-side validation for you. Keep those responsibilities in the application that composes the UI.
Refine the presentation
Let a parent own the surrounding spacing. Keep related elements together with gap and use semantic surface/foreground pairs so the composition follows the active theme. The wrapper below changes the surrounding layout without assuming extra props on Toggle Group.
import type { ComponentChildren } from "preact";
export function ExampleSurface({ children }: { children: ComponentChildren }) {
return (
<div class="grid min-w-0 gap-4 rounded-lg border border-border bg-card p-4 text-card-foreground sm:p-6">
{children}
</div>
);
}Put the chosen example inside ExampleSurface, then refine supported variants and sizes using the API above. For application-wide changes, adjust theme tokens instead of repeating fixed colors. See Component styles for hierarchy, density and focus treatments.
Review the complete interaction
- Check hover, focus, pressed and disabled states using both pointer and keyboard.
- For asynchronous actions, prevent duplicate submissions and show a useful pending label.
- Keep the primary action recognizable when labels wrap, text is enlarged or the theme changes.
The preview's narrow control changes its container width. Also resize the browser when checking viewport-based Tailwind utilities such as sm: and md:, and test overlays in the full page where their portals render.
Compose a complete interface
Toggle Group is one part of the interaction. Choose companion components for the information or actions that still need a place on the screen. The references below are suggestions to compose deliberately, not extra dependencies you must add to every example.
Keep one source of truth for the operation and let each component communicate a different part of it. For example, waiting, no results and failure need different explanations. Avoid showing contradictory states together, and keep recovery actions close to the message that explains them.
Start with the smallest composition that explains the task. Browse the component library for individual controls or the block collections for complete layouts. Reuse shared theme tokens so these pieces feel consistent in light and dark mode.
Sources & design references
Follow Toggle Group from its implementation to the ideas behind your own composition. Start with the local API, explore a visual direction, then bring the result back to your app’s shared styles.
Bring it back to your app
A reference becomes useful when it fits your real content. Work through these decisions in order:
- Keep the behavior grounded. Start with the interactive examples, then connect your data and callbacks using the integration guidance. Preserve labels, keyboard access and disabled states as you change the presentation.
- Make the styling repeatable. Use the styles guide for local
classadjustments and theming documentation for shared color decisions. Keep semantic surface and foreground pairs together in both light and dark mode. - Check the complete screen. See how components combine in the block collections, then try long labels, loading states and narrow layouts in your own composition. The Theme Toggle guide helps you expose a scheme switch in the finished interface.