WUI logo

Toggle

Allows user to activate or deactivate an option.

version

5.0.0

install

yarn add @welcome-ui/toggle

usage

import { Toggle } from '@welcome-ui/toggle'

Usage #

Use checked property

Label #

Use Field component to add a label

Hint #

Use Field component to add a hint

Variants #

Use hint, warning, error, info or success properties on Field component to add a variant status on your checkbox. The label, hint or border color are set by magic 🪄

Properties #

NameType(s)DefaultRequired
checked
Boolean
disabled
Boolean
name
string
size
"xs"
"sm"
"md"
"lg"
onChange
(event: ChangeEvent<HTMLInputElement>) => void
variant
"error"
"focused"
"info"
"success"
"warning"
transparent
Boolean
isClearable
Boolean
hasIcon
Boolean
iconPlacement
"right"
"left"
"both"
indeterminate
Boolean

Packages #

Dependencies #
Peer dependencies #
```