Form

Toggle

Represents a pressed or unpressed command state.

Imports

Use the same component slug for React, Vue, and style token lookup. Do not import components from package roots.

import { Toggle, toggleVariants } from "@line/abc-def-react/toggle";
<script setup lang="ts">
import { Toggle, toggleVariants } from "@line/abc-def-vue/toggle";
</script>

Shadcn references

Compare the corresponding shadcn React and Vue documentation for the same component slug.

Basic usage

import { Toggle } from "@line/abc-def-react/toggle";

export function Example() {
  return <Toggle defaultPressed>Bold</Toggle>;
}
<script setup lang="ts">
import { Toggle } from "@line/abc-def-vue/toggle";
</script>

<template>
  <Toggle default-pressed>Bold</Toggle>
</template>

Component tokens

Component TokenSemantic TokenDefault Primitive Token
--toggle-ring--ring--color-zinc-400
--toggle-border-destructive--destructive--color-red-50
--toggle-bg-hover--muted--color-zinc-100
--toggle-fg-hover--foreground--color-zinc-950
--toggle-bg-active--muted--color-zinc-100
--toggle-fg-active--foreground--color-zinc-950
--toggle-border-outline--border-input--color-zinc-200
--toggle-border-destructive-shadow--destructive--color-red-50

Composition exports

ToggletoggleVariants

Usage notes

  • Use for toolbar states.
  • Use switch for persistent settings.
  • Related component tokens use the `toggle` token group in `@line/abc-def-styles/css`.