Back to Hooks

useBoolean

packages/hooks/src/useBoolean/index.zh-CN.md

3.9.71013 B
Original Source

useBoolean

优雅的管理 boolean 状态的 Hook。

代码演示

基础用法

<code src="./demo/demo1.tsx" />

API

typescript
const [state, { toggle, set, setTrue, setFalse }] = useBoolean(
  defaultValue?: boolean,
);

Params

参数说明类型默认值
defaultValue可选项,传入默认的状态值booleanfalse

Result

参数说明类型
state状态值boolean
actions操作集合Actions

Actions

参数说明类型
toggle切换 state() => void
set设置 state(value: boolean) => void
setTrue设置为 true() => void
setFalse设置为 false() => void