Leave Yamada UI a star
StarToggle is a component that has two states: on or off.
Description
The visual color appearance of the component.
Type
"blackAlpha" | "whiteAlpha" | "amber" | "blue" | "info" | "link" | "primary" | "cyan" | "emerald" | "flashy" | "fuchsia" | "gray" | "green" | "success" | "indigo" | "lime" | "neutral" | "orange" | "warning" | "pink" | "purple" | "red" | "danger" | "rose" | "sky" | "teal" | "violet" | "secondary" | "yellow"Default
"gray"Description
If true, the toggle button will be initially selected.
Type
booleanDefault
falseDescription
If true, disable ripple effects when pressing a element.
Type
booleanDefault
falseDescription
The icon to be used in the button.
Type
ReactElement<any, string | JSXElementConstructor<any>>Description
If true, the toggle button is represented as active.
Type
booleanDefault
falseDescription
If true, the toggle button will be disabled.
Type
booleanDefault
falseDescription
If true, the toggle button will be readonly.
Type
booleanDefault
falseDescription
If true, the toggle button is full rounded. Else, it'll be slightly round.
Type
booleanDefault
falseDescription
If true, the toggle button will be selected.
Type
booleanDescription
The callback invoked when selected state changes.
Type
(isSelected: boolean) => voidDescription
The size of the Toggle.
Type
"xs" | "sm" | "md" | "lg"Default
"md"Description
The value of the toggle button.
Type
YDescription
The variant of the Toggle.
Type
"outline" | "solid" | "subtle" | "unstyled"Default
"subtle"Description
The initial value of the toggle button group.
Type
NonNullable<Y extends any[] ? Y : Y | undefined>Description
The CSS flex-direction property.
Type
"-moz-initial" | "inherit" | "initial" | "revert" | "revert-layer" | "unset" | "column" | "column-reverse" | "row" | "row-reverse" | [FlexDirection | { [x: string]: FlexDirection | undefined; ... 5 more ...; xl?: FlexDirection | undefined; }, FlexDirection | { ...; }] | { ...; } | [...] | { ...; } | ((theme: StyledT...Description
If true, all wrapped toggle button will be disabled.
Type
booleanDefault
falseDescription
If true, all wrapped toggle button will be readonly.
Type
booleanDefault
falseDescription
The callback fired when any children toggle button is selected or unselected.
Type
(value: Y extends any[] ? Y : Y | undefined) => voidDescription
The value of the toggle button group.
Type
NonNullable<Y extends any[] ? Y : Y | undefined>Edit this page on GitHub