useToggle
用于在两个状态值间切换的 Hook
- Import
- import { useToggle } from '@kubed/hooks;'
- Source
- View source code
- Docs
- Edit this page
- npm
- @kubed/hooks
用法
useToggle 用于在两个状态值间切换的 Hook
useBooleanToggle 用于在 true
,false
值间切换的 Hook
API
useToggle 钩子接受两个参数:
initialValue
– 初始值options
– 用于切换的两个选项
Hook 返回切换后的新值和用于切换的函数。
1function useToggle<T>(2initialValue: T,options: [T, T]3): readonly [T, (value?: React.SetStateAction<T>) => void]
Params
参数 | 默认值 | 类型 | 描述 |
---|---|---|---|
initialValue | - | T | 初始值 |
generateId | - | [T, T] | 用于切换的两个选项 |
Result
参数 | 默认值 | 类型 | 描述 |
---|---|---|---|
state | - | T | 切换后的值 |
toggle | - | React.SetStateAction<T> | 切换后的值 |