# @custom-react-hooks/use-permission 中文文档

规范地址：https://npmcn.com/package/%40custom-react-hooks/use-permission/

版本：1\.5\.2
npm 元数据更新时间：2025-12-11T07:14:09.730Z
中文译文更新时间：2026-11-13T05:53:32.006Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40custom-react-hooks/use-permission
原文对照：https://npmcn.com/package/%40custom-react-hooks/use-permission/?lang=original
项目主页：https://custom-react-hooks-live.vercel.app/
源码仓库：https://github.com/djkepa/custom-react-hooks

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：13.9 kB，8 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- 运行依赖：0 个
- peer 依赖：react \>=16
- 首次发布：2023-12-01T23:51:21.478Z
- 最新版本发布：2025-12-11T07:14:09.546Z
- 近 30 天下载量：2168（2026-10-11 至 2026-11-09，npm 官方下载统计）
- 已发布版本数：9（近 12 个月 1 个）

## 中文简介

`usePermission` 是一种反应钩子,旨在查询并监测各种浏览器API的用户权限状况,例如地理定位、通知、麦克风和相机.

## 安装

```sh
npm install @custom-react-hooks/use-permission
```

也可以使用：`pnpm add @custom-react-hooks/use-permission`、`yarn add @custom-react-hooks/use-permission`、`bun add @custom-react-hooks/use-permission`

## README

# 使用 Permission 钩

`usePermission` 是一种反应钩子,旨在查询并监测各种浏览器API的用户权限状况,例如地理定位、通知、麦克风和相机.

## 特征

-   **权限查询**:查询指定权限的状况.
-   **实时更新**:如果更改,则实时监视并更新许可状态.
-   **处理错误**: 如果权限 API 不支持,或在查询过程中发生错误,则提供错误消息.
-   **SSR 兼容性**:在服务器侧渲染环境中执行安全,在SSY期间避免直接浏览器API调用.

## 安装

### 只安装当前钩

```bash
npm install @custom-react-hooks/use-permission
```

或者说

```bash
yarn add @custom-react-hooks/use-permission
```

### 安装全部钩

```sh
npm install @custom-react-hooks/all
```

或者说

```sh
yarn add @custom-react-hooks/all
```

## 导入虎克

这个 `usePermission` 钩必须使用下列命名的导入方式导入:

**已命名的导入 :**

```javascript
import { usePermission } from '@custom-react-hooks/use-permission';
```

这种方法确保了钩子无缝地融入到您的项目中,在您如何使用我们的包时保持一致性和可预测性.

## 使用量

```tsx
import React, { useState } from 'react';
import { usePermission } from '@custom-react-hooks/all';

const PermissionComponent = () => {
  const [selectedPermission, setSelectedPermission] = useState('geolocation');
  const { state, isLoading, error } = usePermission(selectedPermission);

  return (
    <div>
      <h2>Check Browser Permission Status</h2>
      <label htmlFor="permission-select">Choose a permission: </label>
      <select
        id="permission-select"
        value={selectedPermission}
        onChange={(e) => setSelectedPermission(e.target.value)}
      >
        <option value="geolocation">Geolocation</option>
        <option value="notifications">Notifications</option>
        <option value="microphone">Microphone</option>
        <option value="camera">Camera</option>
        <option value="local-network-access">Local Network Access</option>
      </select>

      <div>
        {isLoading ? (
          <p>Loading...</p>
        ) : (
          <p>
            Permission status for {selectedPermission}:
            <span> {state}</span>
          </p>
        )}
        {error && <p>Error: {error}</p>}
      </div>
    </div>
  );
};

export default PermissionComponent;
```

## API 参考

### 参数

-   `permissionName`: 代表查询权限的字符串。 它必须是由权限 API 定义的支持权限名称之一 .

### 支持的权限

-   `geolocation` - 用户的地理位置
-   `notifications` - 显示通知
-   `push` - 推动通知
-   `microphone` - 音频输入访问
-   `camera` - 视频输入访问
-   `speaker` - 音频输出访问
-   `device-info` - 设备信息
-   `background-sync` - 背景同步
-   `bluetooth` - 蓝牙设备接入
-   `persistent-storage` - 长期储存
-   `ambient-light-sensor` - 环境光传感器
-   `accelerometer` - 加速计传感器
-   `gyroscope` - 陀螺仪传感器
-   `magnetometer` - 磁强计传感器
-   `clipboard-read` - 从剪贴板读取
-   `clipboard-write` - 写入剪贴板
-   `payment-handler` - 付款管理人
-   `local-network-access` - 本地网络接入(Chrome 142+)

### 回返

-   `state`: 代表权限状态的字符串 (`'prompt'`, (中文(简体) ), `'granted'`,或 `'denied'`) (中文(简体) ).
-   `isLoading`: 布尔表示权限查询是否在进行中 .
-   `error`: 如果查询失败或权限 API 不支持, 包含错误消息的字符串 .

## 使用大小写

-   **特性检查**: 检查用户是否对地理定位,通知,或相机访问等特性给予许可.
-   **有条件的特性访问**: 根据许可状态启用或禁用特性.
-   **用户权限管理**: 提示用户获得必要的许可或提供对其状态的反馈.
-   **隐私遵守**:通过在访问敏感特性之前检查权限,确保遵守隐私做法.

## 捐款

我们欢迎各方对 `usePermission`。请通过问题报告错误或建议加强功能,或将请求拉入项目存储库.

## 常见问题

### @custom-react-hooks/use-permission 是什么？

usePermission 是一种反应钩子,旨在查询并监测各种浏览器API的用户权限状况,例如地理定位、通知、麦克风和相机\.

### 如何安装 @custom-react-hooks/use-permission？

在项目目录运行 npm install @custom-react-hooks/use-permission，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：react（\>=16）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @custom-react-hooks/use-permission 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @custom-react-hooks/use-permission 支持 ESM 还是 CommonJS？

以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。

### @custom-react-hooks/use-permission 可以商用吗？

@custom-react-hooks/use-permission 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @custom-react-hooks/use-permission 的下载量有多少？

根据 npm 官方下载统计，@custom-react-hooks/use-permission 在 2026/10/11 – 2026/11/09 这 30 天内被下载 2,168 次，日均约 72 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @custom-react-hooks/use-permission 还在维护吗？

最新版本 1\.5\.2 发布于 2025/12/11（11 个月前）；至今共发布 9 个版本，其中过去 12 个月发布了 1 个；首次发布于 2023/12/02。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。