diff --git a/docs/useUser-hook-guide.md b/docs/useUser-hook-guide.md new file mode 100644 index 0000000..b8cdbef --- /dev/null +++ b/docs/useUser-hook-guide.md @@ -0,0 +1,277 @@ +# useUser Hook 使用指南 + +## 概述 + +`useUser` hook 是一个用于管理用户状态的自定义 React Hook,类似于项目中的 `useCart` hook。它提供了用户登录状态管理、用户信息获取和更新、权限检查等功能,方便在整个应用中全局调用。 + +## 功能特性 + +- ✅ 用户登录状态管理 +- ✅ 用户信息本地存储和同步 +- ✅ 从服务器获取最新用户信息 +- ✅ 用户信息更新 +- ✅ 权限和角色检查 +- ✅ 实名认证状态检查 +- ✅ 用户余额和积分获取 +- ✅ 自动处理登录过期 + +## 基本用法 + +### 1. 导入 Hook + +```typescript +import { useUser } from '@/hooks/useUser'; +``` + +### 2. 在组件中使用 + +```typescript +const MyComponent = () => { + const { + user, // 用户信息 + isLoggedIn, // 是否已登录 + loading, // 加载状态 + loginUser, // 登录方法 + logoutUser, // 退出登录方法 + fetchUserInfo, // 获取用户信息 + updateUser, // 更新用户信息 + getDisplayName, // 获取显示名称 + isCertified, // 是否已实名认证 + getBalance, // 获取余额 + getPoints // 获取积分 + } = useUser(); + + // 使用用户信息 + if (loading) { + return
余额:¥{getBalance()}
+积分:{getPoints()}
+ {isCertified() && 已实名认证} +