# @casbinjs/react 中文文档

规范地址：https://npmcn.com/package/%40casbinjs/react/

版本：0\.0\.2
npm 元数据更新时间：2026-03-18T18:27:33.710Z
中文译文更新时间：2026-11-09T05:49:30.653Z
软件包许可：ISC

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

原始 npm 页面：https://www.npmjs.com/package/%40casbinjs/react
原文对照：https://npmcn.com/package/%40casbinjs/react/?lang=original
项目主页：https://github.com/proveo-ca/casbinjs/tree/main/packages/react
源码仓库：https://github.com/proveo-ca/casbinjs

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

- 包体积（解压后）：24.4 kB，6 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：1 个
- peer 依赖：react \>=18\.0\.0
- 首次发布：2026-03-18T03:13:15.021Z
- 最新版本发布：2026-03-18T18:27:33.389Z
- 近 30 天下载量：5874（2026-10-09 至 2026-11-07，npm 官方下载统计）
- 已发布版本数：3（近 12 个月 3 个）

## 中文简介

卡斯宾JS 反应绑定

## 安装

```sh
npm install @casbinjs/react
```

也可以使用：`pnpm add @casbinjs/react`、`yarn add @casbinjs/react`、`bun add @casbinjs/react`

## README

# @casbinjs/反应

反应约束 [卡斯宾JS](https://github.com/proveo-ca/casbinjs)。在 React 应用程序中为权限检查提供上下文提供者和钩子。 包括Casbin模型设置、基于角色的存取、资源分组和政策变异模式在内的详尽实例,见 [主读取器](https://github.com/proveo-ca/casbinjs#readme)。 。 。 .

## 安装

```bash
npm install @casbinjs/react @casbinjs/core
```

## 设置

包装您的应用程序 `CasbinProvider`。通过一个预建 `authorizer` 或者说 `options` 自动创建 :

```tsx
import { CasbinProvider } from '@casbinjs/react';

// Option A — pass options, provider creates the authorizer
function App() {
  return (
    <CasbinProvider
      options={{
        subject: 'alice',
        organization: 'org-1',
        model: MY_MODEL,
        policies: fetchedPolicies,
      }}
    >
      <Routes />
    </CasbinProvider>
  );
}

// Option B — pass a pre-built authorizer
const authorizer = await createAuthorizer({ ... });

function App() {
  return (
    <CasbinProvider authorizer={authorizer}>
      <Routes />
    </CasbinProvider>
  );
}
```

## 钩子

### `useCan(action, resource)`

请检查access-date=中的日期值 (帮助) 回返 `{ allowed, isLoading, error }`。 。 。 .

```tsx
import { useCan } from '@casbinjs/react';

function DeleteButton() {
  const { allowed, isLoading } = useCan('delete', 'document:123');

  if (isLoading) return null;
  return allowed ? <button>Delete</button> : null;
}
```

### `useCanAny(actions, resource)`

回返 `allowed: true` 如果用户有 **至少一个** 行动.

```tsx
const { allowed } = useCanAny(['read', 'write'], 'document:123');
```

### `useCanAll(actions, resource)`

回返 `allowed: true` 只有用户有 **全部** 行动.

```tsx
const { allowed } = useCanAll(['read', 'write'], 'document:123');
```

### `useCasbin()`

获取全部上下文值——用于政策变异或直接执行者访问.

```tsx
import { useCasbin } from '@casbinjs/react';

function PolicyManager() {
  const { addPolicy, removePolicy, replacePolicies, isLoading, error } = useCasbin();

  const grant = () =>
    addPolicy(['p', 'alice', 'document:123', 'org-1', 'write', 'allow']);

  return <button onClick={grant}>Grant write access</button>;
}
```

## API 密码

### `CasbinProvider`

| Prop | 类型 | 说明 |
| --- | --- | --- |
| `authorizer` | `Authorizer | null` | 预建授权实例. |
| `options` | `AuthorizerOptions` | 创建授权方的选项 。 使用时 `authorizer` 未提供. |
| `children` | `ReactNode` |  |

### `CasbinPermissionResult`

| 外地 | 类型 | 说明 |
| --- | --- | --- |
| `allowed` | `boolean` | 是否允许行动. |
| `isLoading` | `boolean` | `true` ,而许可检查或授权者正在初始化. |
| `error` | `Error | null` | 设定初始化失败或权限检查失败 . |

## 常见问题

### @casbinjs/react 是什么？

卡斯宾JS 反应绑定

### 如何安装 @casbinjs/react？

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

### @casbinjs/react 支持 TypeScript 吗？

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

### @casbinjs/react 支持 ESM 还是 CommonJS？

同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。

### @casbinjs/react 可以商用吗？

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

### @casbinjs/react 的下载量有多少？

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

### @casbinjs/react 还在维护吗？

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