Switch
A switch between on and off. Use it for a setting that takes effect right away.
Import
Copy code
import { Switch } from '@k8ordo/ui';Usage
Copy code
<Switch
disabled={false}
invalid={false}
required={false}
label="Email notifications"
/>On by default
Copy code
<Switch
defaultChecked
disabled={false}
invalid={false}
required={false}
label="Automatic backups"
/>Controlled
Copy code
const [checked, setChecked] = useState(false);
<Switch
checked={checked}
disabled={false}
invalid={false}
required={false}
label="Controlled switch"
onChange={(next) => setChecked(next)}
/>Disabled
Copy code
<Switch disabled invalid={false} required={false} label="Airplane mode" />
<Switch defaultChecked disabled invalid={false} required={false} label="Offline sync" />Props
label- Type:
string - Default: -
checked?- Type:
boolean - Default: -
defaultChecked?- Type:
boolean - Default: -
invalid?- Type:
boolean - Default:
false onChange?- Type:
(checked: boolean, event: ChangeEvent<HTMLInputElement>) => void - Default: -
ref?- Type:
Ref<HTMLInputElement> - Default: -
| Prop | Type | Default |
|---|---|---|
label | string | - |
checked? | boolean | - |
defaultChecked? | boolean | - |
invalid? | boolean | false |
onChange? | (checked: boolean, event: ChangeEvent<HTMLInputElement>) => void | - |
ref? | Ref<HTMLInputElement> | - |
Inherited attributes (except the ones set internally): InputHTMLAttributes<HTMLInputElement>