eo-n/ui
UIComponentsToggle Group

Toggle Group

Groups multiple toggles for combined or independent control.

Installation

CLI

npx shadcn@latest add "https://eo-n.vercel.app/r/toggle-group"

Manual

Copy and paste the following code into your project.

"use client";
 
import * as React from "react";
import { ToggleGroup as ToggleGroupRoot } from "@base-ui-components/react/toggle-group";
import { type VariantProps } from "class-variance-authority";
 
import { cn } from "@/lib/utils";
import { Toggle, toggleVariants } from "@/components/ui/toggle";
 
const ToggleGroupContext = React.createContext<
  VariantProps<typeof toggleVariants>
>({
  size: "default",
  variant: "default",
});
 
function ToggleGroup({
  className,
  size,
  variant,
  children,
  ...props
}: React.ComponentProps<typeof ToggleGroupRoot> &
  VariantProps<typeof toggleVariants>) {
  const contextValue = React.useMemo(
    () => ({
      size: size ?? "default",
      variant: variant ?? "default",
    }),
    [size, variant]
  );
 
  return (
    <ToggleGroupRoot
      data-slot="toggle-group"
      className={cn(
        "flex items-center justify-center gap-1 data-[disabled]:pointer-events-none data-[disabled]:opacity-50",
        className
      )}
      {...props}
    >
      <ToggleGroupContext.Provider value={contextValue}>
        {children}
      </ToggleGroupContext.Provider>
    </ToggleGroupRoot>
  );
}
 
function ToggleGroupItem({
  className,
  variant,
  size,
  children,
  ...props
}: React.ComponentProps<typeof Toggle>) {
  const context = React.useContext(ToggleGroupContext);
  return (
    <Toggle
      className={cn(
        toggleVariants({
          variant: context.variant || variant,
          size: context.size || size,
        }),
        className
      )}
      {...props}
    >
      {children}
    </Toggle>
  );
}
 
export { ToggleGroup, ToggleGroupItem };
Update the import paths to match your project setup.

Usage

Import all parts and piece them together.

import { ToggleGroup, ToggleGroupItem } from "@/components/ui/toggle-group";
<ToggleGroup>
  <ToggleGroupItem value="1">Option 1</ToggleGroupItem>
  <ToggleGroupItem value="2">Option 2</ToggleGroupItem>
  <ToggleGroupItem value="3">Option 3</ToggleGroupItem>
</ToggleGroup>

Examples

Default

Outline

Multiple

Large

Small

Disabled

On this page