Toggle

Toggle is a component that has two states: on or off.

<Toggle icon={<LetterBIcon />} aria-label="Toggle bold" />

Usage

import { Toggle, ToggleGroup } from "@yamada-ui/react"

import { Toggle, ToggleGroup } from "@/components/ui"

import { Toggle, ToggleGroup } from "@workspaces/ui"

<Toggle />

<ToggleGroup.Root>
  <ToggleGroup.Item />
</ToggleGroup.Root>

If you want to perform an action rather than toggle a state, use IconButton or Button.

If there are multiple Toggle components that can be grouped together, use ToggleGroup.

With Text

<Toggle aria-label="Toggle italic" px="4">
  <ItalicIcon />
  <Text as="span" fontSize="md">
    Italic
  </Text>
</Toggle>

Change Variant

<Wrap gap="md">
  <For each={["ghost", "subtle", "surface", "outline", "solid"]}>
    {(variant) => (
      <Toggle
        key={variant}
        icon={<LetterBIcon />}
        aria-label="Toggle bold"
        variant={variant}
      />
    )}
  </For>
</Wrap>

Change Size

<Wrap gap="md" alignItems="flex-start">
  <For each={["xs", "sm", "md", "lg", "xl"]}>
    {(size) => (
      <Toggle
        key={size}
        icon={<LetterBIcon />}
        aria-label="Toggle bold"
        size={size}
      />
    )}
  </For>
</Wrap>

Change Color Scheme

<Wrap gap="md">
  <For each={["success", "warning"]}>
    {(colorScheme) => (
      <Toggle
        key={colorScheme}
        colorScheme={colorScheme}
        aria-label="Toggle bold"
        icon={<LetterBIcon />}
      />
    )}
  </For>
</Wrap>

Change Shape

To change the shape, set the rounded prop.

<Wrap gap="md">
  <For each={["ghost", "subtle", "surface", "outline", "solid"]}>
    {(variant) => (
      <Toggle
        key={variant}
        icon={<LetterBIcon />}
        aria-label="Toggle bold"
        variant={variant}
        fullRounded
      />
    )}
  </For>
</Wrap>

Disable

To disable, set disabled to true.

<Wrap gap="md">
  <For each={["ghost", "subtle", "surface", "outline", "solid"]}>
    {(variant) => (
      <Toggle
        key={variant}
        icon={<LetterBIcon />}
        aria-label="Toggle bold"
        variant={variant}
        disabled
      />
    )}
  </For>
</Wrap>

Read-Only

To read-only, set readOnly to true.

<Wrap gap="md">
  <For each={["ghost", "subtle", "surface", "outline", "solid"]}>
    {(variant) => (
      <Toggle
        key={variant}
        icon={<LetterBIcon />}
        aria-label="Toggle bold"
        variant={variant}
        readOnly
      />
    )}
  </For>
</Wrap>

Invalid

To set invalid state, set invalid to true.

<Wrap gap="md">
  <For each={["ghost", "subtle", "surface", "outline", "solid"]}>
    {(variant) => (
      <Toggle
        key={variant}
        icon={<LetterBIcon />}
        aria-label="Toggle bold"
        variant={variant}
        invalid
      />
    )}
  </For>
</Wrap>

Change Invalid Border Color

To change the border color, set errorBorderColor to the color.

<Toggle
  aria-label="Toggle bold"
  errorBorderColor="orange.500"
  icon={<LetterBIcon />}
  defaultChecked
  invalid
/>

Control

const [checked, setChecked] = useState<boolean>(false)

return (
  <Toggle
    icon={<LetterBIcon />}
    aria-label="Toggle bold"
    checked={checked}
    onChange={setChecked}
  />
)

If you use this code, you need to add "use client" to the top of the file.

Grouping

<ToggleGroup.Root>
  <ToggleGroup.Item
    value="bold"
    icon={<LetterBIcon />}
    aria-label="Toggle bold"
  />
  <ToggleGroup.Item
    value="italic"
    icon={<ItalicIcon />}
    aria-label="Toggle italic"
  />
  <ToggleGroup.Item
    value="underline"
    icon={<UnderlineIcon />}
    aria-label="Toggle underline"
  />
</ToggleGroup.Root>

For multiple selections, set value or defaultValue to an array.

const [value, setValue] = useState<string[]>([])

return (
  <ToggleGroup.Root value={value} onChange={setValue}>
    <ToggleGroup.Item
      value="bold"
      icon={<LetterBIcon />}
      aria-label="Toggle bold"
    />
    <ToggleGroup.Item
      value="italic"
      icon={<ItalicIcon />}
      aria-label="Toggle italic"
    />
    <ToggleGroup.Item
      value="underline"
      icon={<UnderlineIcon />}
      aria-label="Toggle underline"
    />
  </ToggleGroup.Root>
)

If you use this code, you need to add "use client" to the top of the file.

Props

Toggle

Prop	Default	Type / Description
`as`	-	`As` The HTML element to render.
`asChild`	-	`boolean` Merges its props onto its immediate child.
`css`	-	`CSSObject \| CSSObject[]` The CSS object.
`colorScheme`	-	`"amber" \| "black" \| "blackAlpha" \| "blue" \| "cyan" \| "danger" \| "emerald" \| "error" \| "flashy" \| "fuchsia" ...` Set color scheme variables.
`size`	`"md"`	`"2xl" \| "lg" \| "md" \| "sm" \| "xl" \| "xs"` The size of the component.
`variant`	`"ghost"`	`"ghost" \| "outline" \| "solid" \| "subtle" \| "surface" ...` The variant of the component.
`active`	`false`	`boolean` If `true`, the button is represented as active.
`checked`	-	`boolean` If `true`, the toggle button will be checked.
`disabled`	`false`	`boolean` If `true`, the button is disabled.
`disableRipple`	`false`	`boolean` If `true`, disable ripple effects when pressing a element.
`errorBorderColor`	-	`"-moz-initial" \| "AccentColor" \| "AccentColorText" \| "ActiveBorder" \| "ActiveCaption" \| "ActiveText" \| "aliceblue" \| "amber.100" \| "amber.200" \| "amber.300" ...` The border color when the input is invalid.
`icon`	-	`string \| number \| bigint \| boolean \| ReactElement<unknown, string \| JSXElementConstructor<any>> \| Iterable<ReactNode> \| ReactPortal \| Promise<...>` The icon to be used in the button.
`invalid`	`false`	`boolean` If `true`, the field will be invalid.
`loading`	`false`	`boolean` If `true`, the loading state of the button is represented.
`onChange`	-	`(checked: boolean) => void` The callback invoked when checked state changes.
`readOnly`	`false`	`boolean` If `true`, the field will be readonly.
`required`	`false`	`boolean` If `true`, the field will be required.
`type`	`"button"`	`"button" \| "reset" \| "submit"` The type of button. Accepts `button`, `reset`, or `submit`.
`value`	-	`Y` The value of the toggle button.

ToggleGroup.Root

Prop	Default	Type / Description
`as`	-	`As` The HTML element to render.
`asChild`	-	`boolean` Merges its props onto its immediate child.
`css`	-	`CSSObject \| CSSObject[]` The CSS object.
`colorScheme`	-	`"amber" \| "black" \| "blackAlpha" \| "blue" \| "cyan" \| "danger" \| "emerald" \| "error" \| "flashy" \| "fuchsia" ...` Set color scheme variables.
`size`	`"md"`	`"2xl" \| "lg" \| "md" \| "sm" \| "xl" \| "xs"` The size of the component.
`variant`	`"ghost"`	`"ghost" \| "outline" \| "solid" \| "subtle" \| "surface" ...` The variant of the component.
`align`	-	`"-moz-initial" \| "anchor-center" \| "baseline" \| "center" \| "end" \| "flex-end" \| "flex-start" \| "inherit" \| "initial" \| "normal" ...` The CSS `align-items` property.
`basis`	-	`"-moz-fit-content" \| "-moz-initial" \| "-moz-max-content" \| "-moz-min-content" \| "-webkit-auto" \| "0.5" \| "1.5" \| "1" \| "1/12" \| "1/2" ...` The CSS `flex-basis` property.
`defaultValue`	-	`Y extends any[] ? Y : undefined \| Y` The initial value of the toggle button group.
`direction`	-	`"-moz-initial" \| "column-reverse" \| "column" \| "inherit" \| "initial" \| "revert-layer" \| "revert" \| "row-reverse" \| "row" \| "unset" ...` The CSS `flex-direction` property.
`disabled`	`false`	`boolean` If `true`, all wrapped toggle button will be disabled.
`justify`	-	`"-moz-initial" \| "center" \| "end" \| "flex-end" \| "flex-start" \| "inherit" \| "initial" \| "left" \| "normal" \| "revert-layer" ...` The CSS `justify-content` property.
`onChange`	-	`(value: Y extends any[] ? Y : undefined \| Y) => void` The callback fired when any children toggle button is selected or unselected.
`readOnly`	`false`	`boolean` If `true`, all wrapped toggle button will be readonly.
`shrink`	-	`"-moz-initial" \| "inherit" \| "initial" \| "revert-layer" \| "revert" \| "unset" \| AnyString \| number & {} ...` The CSS `flex-shrink` property.
`value`	-	`Y extends any[] ? Y : undefined \| Y` The value of the toggle button group.
`wrap`	-	`"-moz-initial" \| "inherit" \| "initial" \| "nowrap" \| "revert-layer" \| "revert" \| "unset" \| "wrap-reverse" \| "wrap" \| AnyString ...` The CSS `flex-wrap` property.

ToggleGroup.Item

Prop	Default	Type / Description
`as`	-	`As` The HTML element to render.
`asChild`	-	`boolean` Merges its props onto its immediate child.
`css`	-	`CSSObject \| CSSObject[]` The CSS object.
`colorScheme`	-	`"amber" \| "black" \| "blackAlpha" \| "blue" \| "cyan" \| "danger" \| "emerald" \| "error" \| "flashy" \| "fuchsia" ...` Set color scheme variables.
`size`	`"md"`	`"2xl" \| "lg" \| "md" \| "sm" \| "xl" \| "xs"` The size of the component.
`variant`	`"ghost"`	`"ghost" \| "outline" \| "solid" \| "subtle" \| "surface" ...` The variant of the component.
`active`	`false`	`boolean` If `true`, the button is represented as active.
`checked`	-	`boolean` If `true`, the toggle button will be checked.
`disabled`	`false`	`boolean` If `true`, the button is disabled.
`disableRipple`	`false`	`boolean` If `true`, disable ripple effects when pressing a element.
`errorBorderColor`	-	`"-moz-initial" \| "AccentColor" \| "AccentColorText" \| "ActiveBorder" \| "ActiveCaption" \| "ActiveText" \| "aliceblue" \| "amber.100" \| "amber.200" \| "amber.300" ...` The border color when the input is invalid.
`icon`	-	`string \| number \| bigint \| boolean \| ReactElement<unknown, string \| JSXElementConstructor<any>> \| Iterable<ReactNode> \| ReactPortal \| Promise<...>` The icon to be used in the button.
`invalid`	`false`	`boolean` If `true`, the field will be invalid.
`loading`	`false`	`boolean` If `true`, the loading state of the button is represented.
`onChange`	-	`(checked: boolean) => void` The callback invoked when checked state changes.
`readOnly`	`false`	`boolean` If `true`, the field will be readonly.
`required`	`false`	`boolean` If `true`, the field will be required.
`type`	`"button"`	`"button" \| "reset" \| "submit"` The type of button. Accepts `button`, `reset`, or `submit`.
`value`	-	`Y` The value of the toggle button.

Accessibility

Setting an aria-label on Toggle or ToggleGroup.Root allows screen readers to announce it, helping users understand the purpose and functionality of the control or group.

<Toggle icon={<LetterBIcon />} aria-label="Toggle bold" />

<ToggleGroup.Root aria-label="Text formatting options">
  <ToggleGroup.Item
    value="bold"
    icon={<LetterBIcon />}
    aria-label="Toggle bold"
  />
  <ToggleGroup.Item
    value="italic"
    icon={<ItalicIcon />}
    aria-label="Toggle italic"
  />
  <ToggleGroup.Item
    value="underline"
    icon={<UnderlineIcon />}
    aria-label="Toggle underline"
  />
</ToggleGroup.Root>

When combining Toggle with text, set an aria-label that includes the visible text. If omitted, the default aria-label is used, which may cause a mismatch between the text and the accessible name.

<Toggle aria-label="Toggle italic" px="4">
  <ItalicIcon />
  <Text as="span" fontSize="md">
    Italic
  </Text>
</Toggle>

Key	Description	State
`Tab`	Focuses the element.	-
`Space`, `Enter`	Toggles the focused element.	-

ARIA Roles and Attributes

Element	Roles and Attributes	Usage
`div.ui-toggle__group`	`role="group"`	Indicates that it's a group.
`button.ui-toggle__root`	`aria-pressed`	Set to `true` if the element is pressed, or `false` if it is not pressed.
	`aria-disabled`	Set to `"true"` if `disabled` or `readOnly` is set.
	`aria-label`	Set `value` if provided, otherwise default to `"Toggle button"`.

Similar Components

Checkbox is a component used for allowing users to select multiple values from multiple options.

NativeSelect is a component used for allowing users to select one value from a list of options. It displays a native dropdown list provided by the browser (user agent).

Radio is a component used for allowing users to select one option from multiple choices.

Rating is a component used to allow users to provide ratings.

SegmentedControl is a component used for allowing users to select one option from multiple choices.

Switch is a component used to toggle between on and off states.

CheckboxCard is a component used for allowing users to select multiple values from multiple options.

FileButton is a button component used for users to select files.

Uses Components & Hooks

Group is a component that groups and attaches multiple elements together.

Button is an interactive component that allows users to perform actions such as submitting forms and toggling modals.

Input is a component used to obtain text input from the user.

Portal is a component that renders elements outside of the current DOM hierarchy.

Field is a component used to group form elements with label, helper message, error message, etc.