# @teamkeel/client-react 中文文档

规范地址：https://npmcn.com/package/%40teamkeel/client-react/

版本：0\.501\.0
npm 元数据更新时间：2026-11-02T14:21:12.294Z
中文译文更新时间：2026-11-02T15:48:05.170Z
软件包许可：ASL \(Apache 2\.0\)

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

原始 npm 页面：https://www.npmjs.com/package/%40teamkeel/client-react
原文对照：https://npmcn.com/package/%40teamkeel/client-react/?lang=original

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

- 包体积（解压后）：7.8 kB，6 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- 运行依赖：0 个
- 首次发布：2023-07-20T21:14:40.693Z
- 最新版本发布：2026-11-02T14:21:12.074Z
- 已发布版本数：453（近 12 个月 101 个）

## 中文简介

龙骨客户端的React助手

## 安装

```sh
npm install @teamkeel/client-react
```

也可以使用：`pnpm add @teamkeel/client-react`、`yarn add @teamkeel/client-react`、`bun add @teamkeel/client-react`

## README

# @teamkeel / client-react

创建一个完全类型的 `useKeel()` 从生成的龙骨客户端。

## 安装

```
npm i @teamkeel/client-react
```

## 使用

创建 `KeelProvider` 和 `useKeel` 组件，方法是将生成的apicclient传递到 `keel` 函数。

注意: [在这里看到的](https://docs.keel.so/apis/client) 有关生成客户机的文档

```ts
import { APIClient } from "../keelClient";
import { keel } from "@teamkeel/client-react";
export const { KeelProvider, useKeel } = keel(APIClient);

```

用导出的文件包装应用程序 `KeelProvider` 并为您的API设置端点。

端点是基本URL + api名称（如果您没有手动设置api名称，则是这样） `api`）. 这个url可以在Keel web控制台或 `keel run` 在你的终端。

```tsx

<KeelProvider endpoint="https://myproject.keelapps.xyz/api/">
    <App />
</KeelProvider>

```

现在您可以使用键入 `useKeel` 你可以在应用中的任何组件中 [点击这里阅读更多](https://docs.keel.so/apis/client) 如何使用客户端。

```ts
function MyComponent() {
    const keel = useKeel();
}
```

## 常见问题

### @teamkeel/client-react 是什么？

龙骨客户端的React助手

### 如何安装 @teamkeel/client-react？

在项目目录运行 npm install @teamkeel/client-react，或使用 pnpm add / yarn add / bun add。

### @teamkeel/client-react 支持 TypeScript 吗？

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

### @teamkeel/client-react 支持 ESM 还是 CommonJS？

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

### @teamkeel/client-react 可以商用吗？

@teamkeel/client-react 使用 ASL \(Apache 2\.0\) 许可。声明的许可为 ASL \(Apache 2\.0\)，请阅读许可原文确认使用条件。以上为概括，不构成法律意见，请以许可原文为准。

### @teamkeel/client-react 还在维护吗？

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