Docs
Toggle Group
Toggle Group
A set of two-state buttons that can be toggled on or off.
<script lang="ts">
import Bold from "lucide-svelte/icons/bold";
import Italic from "lucide-svelte/icons/italic";
import Underline from "lucide-svelte/icons/underline";
import * as ToggleGroup from "$lib/components/ui/toggle-group/index.js";
</script>
<ToggleGroup.Root type="multiple">
<ToggleGroup.Item value="bold" aria-label="Toggle bold">
<Bold />
</ToggleGroup.Item>
<ToggleGroup.Item value="italic" aria-label="Toggle italic">
<Italic />
</ToggleGroup.Item>
<ToggleGroup.Item value="strikethrough" aria-label="Toggle strikethrough">
<Underline />
</ToggleGroup.Item>
</ToggleGroup.Root>
<script lang="ts">
import Bold from "lucide-svelte/icons/bold";
import Italic from "lucide-svelte/icons/italic";
import Underline from "lucide-svelte/icons/underline";
import * as ToggleGroup from "$lib/components/ui/toggle-group/index.js";
</script>
<ToggleGroup.Root type="multiple">
<ToggleGroup.Item value="bold" aria-label="Toggle bold">
<Bold class="size-4" />
</ToggleGroup.Item>
<ToggleGroup.Item value="italic" aria-label="Toggle italic">
<Italic class="size-4" />
</ToggleGroup.Item>
<ToggleGroup.Item value="strikethrough" aria-label="Toggle strikethrough">
<Underline class="size-4" />
</ToggleGroup.Item>
</ToggleGroup.Root>
Installation
npx shadcn-svelte@next add toggle-group
Install bits-ui
:
npm i bits-ui -D
Copy and paste the component source files linked at the top of this page into your project.
Usage
<script lang="ts">
import * as ToggleGroup from "$lib/components/ui/toggle-group/index.js";
</script>
<ToggleGroup.Root type="single">
<ToggleGroup.Item value="a">A</ToggleGroup.Item>
<ToggleGroup.Item value="b">B</ToggleGroup.Item>
<ToggleGroup.Item value="c">C</ToggleGroup.Item>
</ToggleGroup.Root>
Examples
Default
<script lang="ts">
import Bold from "lucide-svelte/icons/bold";
import Italic from "lucide-svelte/icons/italic";
import Underline from "lucide-svelte/icons/underline";
import * as ToggleGroup from "$lib/components/ui/toggle-group/index.js";
</script>
<ToggleGroup.Root type="multiple">
<ToggleGroup.Item value="bold" aria-label="Toggle bold">
<Bold />
</ToggleGroup.Item>
<ToggleGroup.Item value="italic" aria-label="Toggle italic">
<Italic />
</ToggleGroup.Item>
<ToggleGroup.Item value="strikethrough" aria-label="Toggle strikethrough">
<Underline />
</ToggleGroup.Item>
</ToggleGroup.Root>
<script lang="ts">
import Bold from "lucide-svelte/icons/bold";
import Italic from "lucide-svelte/icons/italic";
import Underline from "lucide-svelte/icons/underline";
import * as ToggleGroup from "$lib/components/ui/toggle-group/index.js";
</script>
<ToggleGroup.Root type="multiple">
<ToggleGroup.Item value="bold" aria-label="Toggle bold">
<Bold class="size-4" />
</ToggleGroup.Item>
<ToggleGroup.Item value="italic" aria-label="Toggle italic">
<Italic class="size-4" />
</ToggleGroup.Item>
<ToggleGroup.Item value="strikethrough" aria-label="Toggle strikethrough">
<Underline class="size-4" />
</ToggleGroup.Item>
</ToggleGroup.Root>
Outline
<script lang="ts">
import Bold from "lucide-svelte/icons/bold";
import Italic from "lucide-svelte/icons/italic";
import Underline from "lucide-svelte/icons/underline";
import * as ToggleGroup from "$lib/components/ui/toggle-group/index.js";
</script>
<ToggleGroup.Root variant="outline" type="multiple">
<ToggleGroup.Item value="bold" aria-label="Toggle bold">
<Bold />
</ToggleGroup.Item>
<ToggleGroup.Item value="italic" aria-label="Toggle italic">
<Italic />
</ToggleGroup.Item>
<ToggleGroup.Item value="strikethrough" aria-label="Toggle strikethrough">
<Underline />
</ToggleGroup.Item>
</ToggleGroup.Root>
<script lang="ts">
import Bold from "lucide-svelte/icons/bold";
import Italic from "lucide-svelte/icons/italic";
import Underline from "lucide-svelte/icons/underline";
import * as ToggleGroup from "$lib/components/ui/toggle-group/index.js";
</script>
<ToggleGroup.Root variant="outline" type="multiple">
<ToggleGroup.Item value="bold" aria-label="Toggle bold">
<Bold class="size-4" />
</ToggleGroup.Item>
<ToggleGroup.Item value="italic" aria-label="Toggle italic">
<Italic class="size-4" />
</ToggleGroup.Item>
<ToggleGroup.Item value="strikethrough" aria-label="Toggle strikethrough">
<Underline class="size-4" />
</ToggleGroup.Item>
</ToggleGroup.Root>
Single
<script lang="ts">
import Bold from "lucide-svelte/icons/bold";
import Italic from "lucide-svelte/icons/italic";
import Underline from "lucide-svelte/icons/underline";
import * as ToggleGroup from "$lib/components/ui/toggle-group/index.js";
</script>
<ToggleGroup.Root type="single">
<ToggleGroup.Item value="bold" aria-label="Toggle bold">
<Bold />
</ToggleGroup.Item>
<ToggleGroup.Item value="italic" aria-label="Toggle italic">
<Italic />
</ToggleGroup.Item>
<ToggleGroup.Item value="strikethrough" aria-label="Toggle strikethrough">
<Underline />
</ToggleGroup.Item>
</ToggleGroup.Root>
<script lang="ts">
import Bold from "lucide-svelte/icons/bold";
import Italic from "lucide-svelte/icons/italic";
import Underline from "lucide-svelte/icons/underline";
import * as ToggleGroup from "$lib/components/ui/toggle-group/index.js";
</script>
<ToggleGroup.Root type="single">
<ToggleGroup.Item value="bold" aria-label="Toggle bold">
<Bold class="size-4" />
</ToggleGroup.Item>
<ToggleGroup.Item value="italic" aria-label="Toggle italic">
<Italic class="size-4" />
</ToggleGroup.Item>
<ToggleGroup.Item value="strikethrough" aria-label="Toggle strikethrough">
<Underline class="size-4" />
</ToggleGroup.Item>
</ToggleGroup.Root>
Small
<script lang="ts">
import Bold from "lucide-svelte/icons/bold";
import Italic from "lucide-svelte/icons/italic";
import Underline from "lucide-svelte/icons/underline";
import * as ToggleGroup from "$lib/components/ui/toggle-group/index.js";
</script>
<ToggleGroup.Root size="sm" type="multiple">
<ToggleGroup.Item value="bold" aria-label="Toggle bold">
<Bold />
</ToggleGroup.Item>
<ToggleGroup.Item value="italic" aria-label="Toggle italic">
<Italic />
</ToggleGroup.Item>
<ToggleGroup.Item value="strikethrough" aria-label="Toggle strikethrough">
<Underline />
</ToggleGroup.Item>
</ToggleGroup.Root>
<script lang="ts">
import Bold from "lucide-svelte/icons/bold";
import Italic from "lucide-svelte/icons/italic";
import Underline from "lucide-svelte/icons/underline";
import * as ToggleGroup from "$lib/components/ui/toggle-group/index.js";
</script>
<ToggleGroup.Root size="sm" type="multiple">
<ToggleGroup.Item value="bold" aria-label="Toggle bold">
<Bold class="size-4" />
</ToggleGroup.Item>
<ToggleGroup.Item value="italic" aria-label="Toggle italic">
<Italic class="size-4" />
</ToggleGroup.Item>
<ToggleGroup.Item value="strikethrough" aria-label="Toggle strikethrough">
<Underline class="size-4" />
</ToggleGroup.Item>
</ToggleGroup.Root>
Large
<script lang="ts">
import Bold from "lucide-svelte/icons/bold";
import Italic from "lucide-svelte/icons/italic";
import Underline from "lucide-svelte/icons/underline";
import * as ToggleGroup from "$lib/components/ui/toggle-group/index.js";
</script>
<ToggleGroup.Root size="lg" type="multiple">
<ToggleGroup.Item value="bold" aria-label="Toggle bold">
<Bold />
</ToggleGroup.Item>
<ToggleGroup.Item value="italic" aria-label="Toggle italic">
<Italic />
</ToggleGroup.Item>
<ToggleGroup.Item value="strikethrough" aria-label="Toggle strikethrough">
<Underline />
</ToggleGroup.Item>
</ToggleGroup.Root>
<script lang="ts">
import Bold from "lucide-svelte/icons/bold";
import Italic from "lucide-svelte/icons/italic";
import Underline from "lucide-svelte/icons/underline";
import * as ToggleGroup from "$lib/components/ui/toggle-group/index.js";
</script>
<ToggleGroup.Root size="lg" type="multiple">
<ToggleGroup.Item value="bold" aria-label="Toggle bold">
<Bold class="size-4" />
</ToggleGroup.Item>
<ToggleGroup.Item value="italic" aria-label="Toggle italic">
<Italic class="size-4" />
</ToggleGroup.Item>
<ToggleGroup.Item value="strikethrough" aria-label="Toggle strikethrough">
<Underline class="size-4" />
</ToggleGroup.Item>
</ToggleGroup.Root>
Disabled
<script lang="ts">
import Bold from "lucide-svelte/icons/bold";
import Italic from "lucide-svelte/icons/italic";
import Underline from "lucide-svelte/icons/underline";
import * as ToggleGroup from "$lib/components/ui/toggle-group/index.js";
</script>
<ToggleGroup.Root disabled type="single">
<ToggleGroup.Item value="bold" aria-label="Toggle bold">
<Bold />
</ToggleGroup.Item>
<ToggleGroup.Item value="italic" aria-label="Toggle italic">
<Italic />
</ToggleGroup.Item>
<ToggleGroup.Item value="strikethrough" aria-label="Toggle strikethrough">
<Underline />
</ToggleGroup.Item>
</ToggleGroup.Root>
<script lang="ts">
import Bold from "lucide-svelte/icons/bold";
import Italic from "lucide-svelte/icons/italic";
import Underline from "lucide-svelte/icons/underline";
import * as ToggleGroup from "$lib/components/ui/toggle-group/index.js";
</script>
<ToggleGroup.Root disabled type="single">
<ToggleGroup.Item value="bold" aria-label="Toggle bold">
<Bold class="size-4" />
</ToggleGroup.Item>
<ToggleGroup.Item value="italic" aria-label="Toggle italic">
<Italic class="size-4" />
</ToggleGroup.Item>
<ToggleGroup.Item value="strikethrough" aria-label="Toggle strikethrough">
<Underline class="size-4" />
</ToggleGroup.Item>
</ToggleGroup.Root>
On This Page