Skip to content

useBooleanState ​

useBooleanState 是一个简化布尔状态管理的 React Hook。它提供函数来将状态设置为 true、设置为 false 以及切换其值。

接口 ​

ts
function useBooleanState(
  initialValue: boolean | (() => boolean) = false
): readonly [
  state: boolean,
  setTrue: () => void,
  setFalse: () => void,
  toggle: () => void,
];

参数 ​

  • initialValueboolean | (() => boolean)

    状态的初始值。默认值为 false。

返回值 ​

  • readonly [state: boolean, setTrue: () => void, setFalse: () => void, toggle: () => void]

    包含以下内容的元组:

    • stateboolean

      当前的状态值。

    • setTrue() => void

      将状态设置为 true 的函数。

    • setFalse() => void

      将状态设置为 false 的函数。

    • toggle() => void

      切换状态的函数。

示例 ​

tsx
const [open, openBottomSheet, closeBottomSheet, toggleBottomSheet] =
  useBooleanState(false);

基于 MIT 许可证发布。