@contentstack/app-sdk

中文文档
2.4.1发布于 2026/06/18MITTypeScriptCommonJS近 30 天下载 2.7万

Contentack App SDK 允许您自定义您的 Contentack 应用程序 .

中文使用文档
文档目录16 节
  1. 开始
  2. 初始化 App SDK
  3. 下载 Boilerplate
  4. UI 位置和实例
  5. 自定义字段位置
  6. 盘盘位置
  7. 资产边栏位置
  8. App 配置位置
  9. RTE 地点
  10. 侧边栏位置
  11. 字段修改器位置
  12. 全页位置
  13. 使用内存样式
  14. 更多信息
  15. 应用 SDK v 2. 0. 移徙指南
  16. 许可证

内容ack App SDK Readme

Contentack App SDK 允许您自定义您的应用程序 。 此文档将帮助您将 App SDK 与您的应用程序集成 .

开始

通过在应用程序中添加以下一行,包含扩展客户端库的编译版本.

<script
    src="https://unpkg.com/@contentstack/[email protected]/dist/index.js"
    integrity="sha512-oS3voAIrtiBqIsDI51ASg/yTDsH/cLfjlKAwqHQHMVswsHHzJw9thwb+4k6RQsk5E4OBCS96gFUtzySjkWXmQw=="
    crossorigin="anonymous"
></script>

要将 App SDK 包含在您的项目中, 您需要运行以下命令 :

npm install @contentstack/app-sdk

或者,您可以在脚本标记中使用以下命令来安装 App SDK :

<script src="https://unpkg.com/@contentstack/[email protected]/dist/index.js"></script>

初始化 App SDK

要初始化 App SDK 您需要运行以下命令 :

ContentstackAppSdk.init().then(function (appSdk) {
    // add code here
});

详情请参见我们 App SDK API 参考 文档.

下载 Boilerplate

您可以使用 Marketplace apps 扩展或自定义 CMS 的功能 。 为了简化并加快建筑过程,锅炉板描述了一个项目中的重复元素. 这个锅炉板会帮助您为您的组织或堆栈构建自定义应用程序.

下载 锅炉板。 。 。 .

UI 位置和实例

UI 位置允许您扩展 Contack 的功能 。 通过这些UI位置,可以自定义Contack的默认行为和UI. 利用不同的UI位置可以整合第三方应用程序.

Contentack App SDK目前支持以下的UI位置:

自定义字段位置

自定义字段位置允许您创建可以在内容类型中使用的自定义字段。 您可以整合各种业务应用程序,例如: 符号, (中文(简体) ), 云层, (中文(简体) ), 购买,将它们作为自定义字段添加到您堆栈的内容类型中.

盘盘位置

使用 Dashboard 位置, 您可以为您的堆栈仪表板创建部件 。 与 谷歌分析 提供对您网站的有意义的见解.

资产边栏位置

使用资产侧边栏位置,您可以创建定制的侧边栏部件来扩展您的资产的功能 .

高效使用 图像预设构建器。 。 。 .

App 配置位置

AppCifig UI 位置允许您集中管理所有应用程序设置 。 一旦配置,所有其他地点(安装了应用程序的地方)都可以访问这些设置.

RTE 地点

RTE 位置允许您创建自定义插件来扩展您的 JSON 富文本编辑器的功能. 使用观众和变量插件,您可以按照您的要求裁剪您的内容 .

侧边栏位置

侧边栏位置提供了强大的工具来分析和推荐您输入的想法. 使用 聪明 边栏位置帮助翻译您的内容.

字段修改器位置

Field 修饰器位置(英語:Field Modifier location)是一类能扩展入域能力的UI位置. 有了字段修改器UI位置,您可以允许不同的应用程序出现在定义的字段数据类型上,如文本,数字,JSON,布尔,文件,参考字段等.

全页位置

Full Page 位置是允许您查看完整页面应用程序的 UI 位置类型, 如 发布预览 在你的堆内.

使用内存样式

安装 Venus 用户界面库软件包, 以便按照“ 内容ack 用户界面” 对您的应用程序进行样式化 :

npm i @contentstack/venus-components --save

有关您申请的样式的更多信息,请参见: 样式指南。 。 。 .

更多信息

应用 SDK v 2. 0. 移徙指南

本指南提供将您的应用程序迁移到 App SDK 2.0.0 版本的指令 。 它涵盖元数据响应的变化、字段修改和整页位置更新,以及从元数据中转换 _extension 属性改为 _uiLocation。如果您正在将您的应用程序升级到最新版本,请确保遵循这些步骤实现平稳过渡.

阅读《移徙指南》

许可证

许可证根据 麻省理工学院。 。 。 .

版本与发布记录

@contentstack/app-sdk 共发布 29 个版本,首次发布于 2022/01/07;过去 12 个月发布了 4 个版本。

版本发布日期距今
2.4.1latest2026/06/184 个月前
2.4.02026/06/114 个月前
2.3.62026/03/187 个月前
2.3.52026/01/239 个月前
2.3.42025/11/101 年前
2.3.32025/10/171.1 年前

其他发布通道:beta → 1.4.0-beta.1。

关于 @contentstack/app-sdk 的常见问题

@contentstack/app-sdk 是什么?

Contentack App SDK 允许您自定义您的 Contentack 应用程序 .

如何安装 @contentstack/app-sdk?

在项目目录运行 npm install @contentstack/app-sdk,或使用 pnpm add / yarn add / bun add。

@contentstack/app-sdk 支持 TypeScript 吗?

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

@contentstack/app-sdk 支持 ESM 还是 CommonJS?

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

@contentstack/app-sdk 需要什么版本的 Node.js?

package.json 的 engines 字段要求 Node.js >=18.x。版本不符时 npm 默认只给出警告,开启 engine-strict 后会拒绝安装。

@contentstack/app-sdk 可以商用吗?

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

@contentstack/app-sdk 的下载量有多少?

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

@contentstack/app-sdk 还在维护吗?

最新版本 2.4.1 发布于 2026/06/18(4 个月前);至今共发布 29 个版本,其中过去 12 个月发布了 4 个;首次发布于 2022/01/07。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。