Toggle
A two-state button, like bold in a text toolbar.
Import
import { Toggle } from "@tarve/core";Usage
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
| Prop | Type | Default |
|---|---|---|
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 →
childrenclassclassNamehighlightidkeymotionFromonHighlightonPasteonPointerLeaveonPointerMoveonSizeonTransitionEndrovingGroupstyleTypes
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;
}type GlassProp = boolean | GlassVariant | GlassOptions;