useToggle
A hook that toggle states.
Examples
Default usage
Effects：false
Basic usage
Default value is boolean，alike useBoolean.
Advanced usage
Effects："Hello"
Toggle between any two values
Accept two optional parameters and toggle between them.
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)
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 |
|---|---|---|
| state | Current state | - |
| actions | A set of methods to update state value | Actions |
Actions
| 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 |