Toggle

A two-state button, like bold in a text toolbar.

Toggle rendered by Tarve Toggle rendered by Tarve
Native render. The live version loads when this comes into view.

Import

import { Toggle } from "@tarve/core";

Usage

Toggle.tsx
import { Row, Toggle } from "@tarve/core";

let bold = true;
let italic = false;

<Row gap={6}>
  <Toggle
    label="Bold"
    variant="outline"
    pressed={bold}
    onPressedChange={(pressed) => {
      bold = pressed;
    }}
  >
    B
  </Toggle>
  <Toggle
    label="Italic"
    variant="outline"
    pressed={italic}
    onPressedChange={(pressed) => {
      italic = pressed;
    }}
  >
    I
  </Toggle>
</Row>

Props

PropTypeDefault
pressed required boolean—
disabled boolean—
glass

Liquid Glass capsule; pressed, it fills with the tint (default: the theme's primary).

GlassProp—
label string—
onPressedChange (pressed: boolean) => void—
size ButtonProps["size"]"default"
variant "default" | "outline""default"

Common props

Shared by every component. See descriptions →

childrenclassclassNamehighlightidkeymotionFromonHighlightonPasteonPointerLeaveonPointerMoveonSizeonTransitionEndrovingGroupstyle

Types

ButtonProps
interface ButtonProps extends BaseProps {
  variant?: ButtonVariant;
  size?: "sm" | "default" | "lg";
  disabled?: boolean;
  control?: Control;
  onClick?: () => void;
  onHover?: (hovered: boolean) => void;
  /**
   * Liquid Glass capsule: `true`, a variant or options. `destructive` tints it red,
   * `ghost` is clear glass without a shadow, `glass={{ tint }}` makes a prominent coloured one.
   */
  glass?: GlassProp;
}
GlassProp
type GlassProp = boolean | GlassVariant | GlassOptions;