Toggle Group
A group of toggle buttons supporting single or multiple selections, built on Radix UI Toggle Group.
toggleGroup.tsx
Core implementation of the ToggleGroup component.
ReactRadix UITailwindButtons
"use client";
import * as React from "react";
import * as ToggleGroupPrimitive from "@radix-ui/react-toggle-group";
import { type VariantProps } from "class-variance-authority";
import { cn } from "@/lib/utils";
import { toggleVariants } from "@/components/ui/toggle/toggle";
import { designRadius } from "@/lib/design-system";
const ToggleGroupContext = React.createContext<
VariantProps<typeof toggleVariants>
>({
size: "md",
variant: "default",
});
const ToggleGroup = React.forwardRef<
React.ComponentRef<typeof ToggleGroupPrimitive.Root>,
React.ComponentPropsWithoutRef<typeof ToggleGroupPrimitive.Root> &
VariantProps<typeof toggleVariants>
>(({ className, variant, size, children, ...props }, ref) => (
<ToggleGroupPrimitive.Root
ref={ref}
className={cn("flex items-center justify-center gap-1", className)}
{...props}
>
<ToggleGroupContext.Provider value={{ variant, size }}>
{children}
</ToggleGroupContext.Provider>
</ToggleGroupPrimitive.Root>
));
ToggleGroup.displayName = ToggleGroupPrimitive.Root.displayName;
const ToggleGroupItem = React.forwardRef<
React.ComponentRef<typeof ToggleGroupPrimitive.Item>,
React.ComponentPropsWithoutRef<typeof ToggleGroupPrimitive.Item> &
VariantProps<typeof toggleVariants> & { radius?: keyof typeof designRadius }
>(({ className, children, variant, size, radius = "lg", ...props }, ref) => {
const context = React.useContext(ToggleGroupContext);
return (
<ToggleGroupPrimitive.Item
ref={ref}
className={cn(
toggleVariants({
variant: context.variant || variant,
size: context.size || size,
}),
designRadius[radius],
className
)}
{...props}
>
{children}
</ToggleGroupPrimitive.Item>
);
});
ToggleGroupItem.displayName = ToggleGroupPrimitive.Item.displayName;
export { ToggleGroup, ToggleGroupItem };Basic Usage
Single alignment selection group.
API Reference
Props — ToggleGroup
Properties to configure the ToggleGroup component.
| Prop | Type | Default | Description |
|---|---|---|---|
| type | 'single' | 'multiple' | — | Determines whether single or multiple items can be pressed simultaneously. |
| variant | 'default' | 'outline' | 'flat' | 'default' | Visual variant style propagated to child items. |