Toggle Group

Group of toggle buttons.

Installation

npx windelements@latest add toggle-group

Usage

Basic Example

import { createToggleGroup } from './components/ui/toggle-group';

const component = createToggleGroup({
  // Component props
});

document.body.appendChild(component.getElement());

With Custom Styling

const component = createToggleGroup({
  className: 'custom-class hover:scale-105',
  // Other props
});

Props

See the TypeScript interface in the component source file for all available props and options.

import { ToggleGroupProps } from './components/ui/toggle-group';

Examples

Check the Examples page for real-world usage patterns.

API Reference

Factory Function

const component = createToggleGroup(props);
const element = component.getElement();

Class-based API

import { ToggleGroup } from './components/ui/toggle-group';

const component = new ToggleGroup(props);
const element = component.getElement();

Accessibility

This component follows WAI-ARIA best practices for accessibility.

Related Components

Browse all Components to see related options.

Styling

Customize the component using the className prop and CSS custom properties:

const component = createToggleGroup({
  className: 'bg-primary text-primary-foreground rounded-lg'
});