Skip to content

useBoolean

一个简单的布尔值状态管理 Hook,提供布尔状态的设置和控制功能。相比 useToggle,useBoolean 更专注于状态设置而非切换操作。

基础用法

🔄 加载状态管理

✅ 加载完成
当前状态: false

表单验证示例

📝 表单验证

验证状态:
用户名错误: false
邮箱错误: false
表单有效:

API 参考

参数

参数类型默认值说明
initialValuebooleanfalse初始布尔值

返回值

useBoolean 返回一个数组,包含以下元素:

typescript
const [state, setValue, setTrue, setFalse] = useBoolean(initialValue);
索引名称类型说明
0stateComputedRef<boolean>只读的响应式布尔状态
1setValue(value: boolean) => void设置布尔值的函数
2setTrue() => void设置为 true 的函数
3setFalse() => void设置为 false 的函数

类型定义

typescript
export type SetValueFunction = (value: boolean) => void;
export type SetTrueFunction = () => void;
export type SetFalseFunction = () => void;

export type UseBooleanReturn = [ComputedRef<boolean>, SetValueFunction, SetTrueFunction, SetFalseFunction];

使用场景

  1. 加载状态 - 控制加载、提交等状态
  2. 表单验证 - 管理表单字段的错误状态
  3. UI 控制 - 控制组件的显示/隐藏状态
  4. 权限控制 - 管理用户权限相关的布尔状态

与 useToggle 的区别

特性useBooleanuseToggle
主要用途状态设置状态切换
切换函数
设置函数
使用场景加载状态、验证错误开关、显示隐藏

注意事项

  1. 返回的 state 是只读的计算属性,只能通过提供的函数修改
  2. setValue 函数接受布尔值参数,可以直接设置状态
  3. setTruesetFalse 是便捷函数,等同于 setValue(true)setValue(false)
  4. 所有状态变化都是响应式的,会自动触发视图更新

基于 MIT 协议发布