useToggle
A hook that toggle states.
Overview
A hook that toggle states.
Installation
Open inpnpm dlx shadcn@latest add https://shadcn-ahooks.vercel.app/r/useToggle.jsonnpx shadcn@latest add https://shadcn-ahooks.vercel.app/r/useToggle.jsonyarn shadcn@latest add https://shadcn-ahooks.vercel.app/r/useToggle.jsonbun shadcn@latest add https://shadcn-ahooks.vercel.app/r/useToggle.jsonA hook that toggle states.
Examples
Default usage
Advanced usage
API
const [state, { toggle, set, setLeft, setRight }] = useToggle(defaultValue?: boolean);
const [state, { toggle, set, setLeft, setRight }] = useToggle<T>(defaultValue: T);
const [state, { toggle, set, setLeft, setRight }] = useToggle<T, U>(defaultValue: T, reverseValue: U)Params
| Property | Description | Type | Default |
| | - | - |
| defaultValue | The default value. Optional | T | false |
| reverseValue | The reverse value. Optional | U | - |
Result
| Property | Description | Type |
|---|---|---|
| toggle | Toggle state | () => void |
| set | Set state | (state: T | U) => void |
| setLeft | Set state to defaultValue | () => void |
| setRight | Set state to reverseValue if reverseValue is available. Otherwise set it to the reverse of defaultValue | () => void |