Skip to Content

Switch

On/off toggle. onChange reports (checked, event).

import { Switch } from '@gg-software/ui'; <Switch label="Notifications" defaultChecked /> <Switch label="Small" size="sm" /> <Switch checked={enabled} onChange={(checked) => setEnabled(checked)} label="Enabled" />

Props

PropTypeDefaultDescription
checkedboolean
defaultCheckedboolean
disabledbooleanfalse
loadingbooleanfalse
size"sm" | "md"md
labelReactNode
childrenReactNodecontent rendered inside the component
valuestring
namestring
idstring
classNamestring
onChange((checked: boolean, event: ChangeEvent<HTMLInputElement, Element>) => void)

* required · generated from packages/ui/src/input/Switch/Switch.tsx