Skip to main content

useSwitch

useSwitch is a hook that manages an on or off value, such as whether a menu or panel is open.

Import

import { useSwitch } from '@vortexlabs/vortex';

Other links

useSwitch parameters
PropTypeDefaultAttributes
defaultValue
boolean
false

Return value

useSwitch return value
PropTypeDefaultAttributes
isOn
boolean
No default value
turnOn
callback
No default value
turnOff
callback
No default value
flipSwitch
callback
No default value