# @contentful/react-apps-toolkit 中文文档

规范地址：https://npmcn.com/package/%40contentful/react-apps-toolkit/

版本：3\.0\.1
npm 元数据更新时间：2026-10-26T15:23:57.485Z
中文译文更新时间：2026-11-10T16:35:43.995Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40contentful/react-apps-toolkit
原文对照：https://npmcn.com/package/%40contentful/react-apps-toolkit/?lang=original
项目主页：https://github.com/contentful/create-contentful-app/tree/master/packages/contentful--react-apps-toolkit#readme
源码仓库：https://github.com/contentful/create-contentful-app

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

- 包体积（解压后）：39.8 kB，24 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- 运行依赖：1 个
- peer 依赖：react \>=16\.8\.0，@contentful/app-sdk \>=4\.54\.0
- 首次发布：2022-02-22T17:08:18.158Z
- 最新版本发布：2026-10-26T15:23:57.239Z
- 近 30 天下载量：1440442（2026-10-11 至 2026-11-09，npm 官方下载统计）
- 已发布版本数：60（近 12 个月 14 个）

## 中文简介

在 React 中建立内容性应用程序的工具包

## 安装

```sh
npm install @contentful/react-apps-toolkit
```

也可以使用：`pnpm add @contentful/react-apps-toolkit`、`yarn add @contentful/react-apps-toolkit`、`bun add @contentful/react-apps-toolkit`

## README

# 内容应用程序反应工具箱

对 App Framework 的回放 Hooks 提供了一个简单的方式, 将经常需要的功能带入您的基于反应的功能 [内容丰富的应用程序](https://npmcn.com/developers/docs/extensibility/app-framework/)。 。 。 .

它们可用于与 [`create-contentful-app`](https://www.npmjs.com/package/@contentful/create-contentful-app),以及使用 Contentful 的任何其他反应应用程序 [应用 SDK](https://www.npmjs.com/package/@contentful/app-sdk)。 。 。 .

## 安装

```shell
npm install @contentful/react-apps-toolkit
# or
yarn add @contentful/react-apps-toolkit
```

## 可用特性

以下车钩和公用设施均由包出口: 1

### SDKProvider 软件

这个 `SDKProvider` 是折叠组件,自动使内容 [应用 SDK](https://www.npmjs.com/package/@contentful/app-sdk) 用于任何使用反应环境的儿童组件。 要使用本包中包含的任何钩子,它们必须被包裹在 `<SDKProvider>`因为所有的钩都依赖于App SDK.

用法 :

```tsx
import { SDKProvider, useSDK } from '@contentful/react-apps-toolkit';

function ChildComponentUsingHook() {
  const sdk = useSDK<FieldExtensionSDK>();

  return <>App Id: {sdk.ids.app}</>;
}

function App() {
  return (
    <SDKProvider>
      <ChildComponentUsingHook />
    </SDKProvider>
  );
}
```

### 使用SDK

`useSDK` 返回内容的示例 [应用 SDK](https://www.npmjs.com/package/@contentful/app-sdk)。 。 。 .

它必须包裹在 `SDKProvider`否则,它就会出错.

用法 :

```tsx
import { SDKProvider, useSDK } from '@contentful/react-apps-toolkit';

function ComponentUsingSDK() {
  const sdk = useSDK<FieldExtensionSDK>();

  return <>App Id: {sdk.ids.app}</>;
}

function App() {
  return (
    <SDKProvider>
      <ChildComponentUsingSDK />
    </SDKProvider>
  );
}
```

### 使用CMA

> : 警告: **被否决** 如果您正在使用 App SDK v4. 20 或更多使用 `sdk.cma` 换句话说.

`useCMA` 返回已初始化的 [内容管理 API 客户端](https://www.npmjs.com/package/contentful-management)。这可以立即用于与应用中的环境通信. [内容管理 API 文件](https://npmcn.com/developers/docs/references/content-management-api/)。 。 。 .

**说明**: 此钩子返回的 CMA 客户端实例会自动被扩展到它被调用的内容空间和环境.

用法 :

```tsx
import { SDKProvider, useCMA } from '@contentful/react-apps-toolkit';

function ComponentUsingCMA() {
  const cma = useCMA();
  const [entries, setEntries] = useState();

  useEffect(() => {
    cma.entry.getMany().then((data) => setEntries(data.items));
  }, [cma]);

  return <>{entries?.length}</>;
}

function App() {
  return (
    <SDKProvider>
      <ComponentUsingCMA />
    </SDKProvider>
  );
}
```

### 使用字段值

`useFieldValue` 提供用于更新Contentful中给定字段当前值的当前值和设置函数。 如果在 [实地位置](https://npmcn.com/developers/docs/extensibility/app-framework/locations/#entry-field),它将默认使用当前字段 id 初始化.

如果在 [输入边栏位置](https://npmcn.com/developers/docs/extensibility/app-framework/locations/#entry-sidebar),或 [条目编辑器位置](https://npmcn.com/developers/docs/extensibility/app-framework/locations/#entry-editor),必须经过一个字段ID才能初始化.

`useFieldValue` 如果字段有多个地块,也可以选择接受一个地块。 如果没有通过地语,它将使用环境默认地语.

用法 :

外地部分:

```tsx
import { SDKProvider, useFieldValue } from '@contentful/react-apps-toolkit';

function FieldComponentUsingFieldValue() {
  const [localizedValue, setLocalizedValue] = useFieldValue(sdk.field.id, sdk.field.locale); // specifies the current field and locale

  return <input value={localizedValue} onChange={(e) => setLocalizedValue(e.target.value)} />;
}

function App() {
  return (
    <SDKProvider>
      <FieldComponentUsingFieldValue />
    </SDKProvider>
  );
}
```

边栏或条目编辑器组件 :

```tsx
import { SDKProvider, useFieldValue } from '@contentful/react-apps-toolkit';

function ComponentUsingFieldValue() {
  const [defaultValue, setDefaultValue] = useFieldValue('slug', sdk.locales.default); // specifies the "slug" field and the environment's default locale

  return <input value={defaultValue} onChange={(e) => setDefaultValue(e.target.value)} />;
}

function App() {
  return (
    <SDKProvider>
      <ComponentUsingFieldValue />
    </SDKProvider>
  );
}
```

### 自动响应器

`useAutoResizer` 监听 DOM 更改,并在大小改变时更新应用程序的高度.

用法 :

```tsx
import { SDKProvider, useAutoResizer } from '@contentful/react-apps-toolkit';

function ComponentUsingAutoResizer() {
  useAutoResizer();

  return <div>Component will be auto-resized</div>;
}

function App() {
  return (
    <SDKProvider>
      <ComponentUsingAutoResizer />
    </SDKProvider>
  );
}
```

### 资源

-   [创建内容应用程序](https://www.npmjs.com/package/create-contentful-app):一个启动器,可以方便地为Contentful提供"靴子"应用.

## 常见问题

### @contentful/react-apps-toolkit 是什么？

在 React 中建立内容性应用程序的工具包

### 如何安装 @contentful/react-apps-toolkit？

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

### @contentful/react-apps-toolkit 支持 TypeScript 吗？

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

### @contentful/react-apps-toolkit 支持 ESM 还是 CommonJS？

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

### @contentful/react-apps-toolkit 可以商用吗？

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

### @contentful/react-apps-toolkit 的下载量有多少？

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

### @contentful/react-apps-toolkit 还在维护吗？

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