# @canva/app-ui-kit 中文文档

规范地址：https://npmcn.com/package/%40canva/app-ui-kit/

版本：5\.15\.0
npm 元数据更新时间：2026-10-07T02:11:23.625Z
中文译文更新时间：2026-11-09T01:23:09.835Z
软件包许可：SEE LICENSE IN LICENSE\.md

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

原始 npm 页面：https://www.npmjs.com/package/%40canva/app-ui-kit
原文对照：https://npmcn.com/package/%40canva/app-ui-kit/?lang=original

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

- 包体积（解压后）：8.4 MB，4442 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：14 个
- peer 依赖：mobx ^6\.16\.0，react ^19\.2\.3，react-dom ^19\.2\.3
- 首次发布：2023-06-08T01:54:00.695Z
- 最新版本发布：2026-10-07T02:11:23.272Z
- 近 30 天下载量：108875（2026-10-09 至 2026-11-07，npm 官方下载统计）
- 已发布版本数：55（近 12 个月 19 个）

## 中文简介

Canva 开发者 SDK UI 组件库用于 Canva 内部的应用程序

## 安装

```sh
npm install @canva/app-ui-kit
```

也可以使用：`pnpm add @canva/app-ui-kit`、`yarn add @canva/app-ui-kit`、`bun add @canva/app-ui-kit`

## README

# @canva/ app- ui- kit (英语)

基于反应的组件库用于创建Canva Apps来模仿Canva的外观和感觉.

![](https://img.shields.io/badge/React-20232A?style=for-the-badge&logo=react&logoColor=61DAFB) ![](https://img.shields.io/badge/TypeScript-007ACC?style=for-the-badge&logo=typescript&logoColor=white)

## 目录

-   [导言](https://npmcn.com/package/%40canva/app-ui-kit/#readme-introduction)
-   [特征](https://npmcn.com/package/%40canva/app-ui-kit/#readme-features)
-   [安装](https://npmcn.com/package/%40canva/app-ui-kit/#readme-installation)
-   [使用量](https://npmcn.com/package/%40canva/app-ui-kit/#readme-usage)
-   [组件和图标](https://npmcn.com/package/%40canva/app-ui-kit/#readme-components-and-icons)
-   [设计符号](https://npmcn.com/package/%40canva/app-ui-kit/#readme-design-tokens)
    -   [CSS 变量](https://npmcn.com/package/%40canva/app-ui-kit/#readme-css-variables)
    -   [JavaScript 变量](https://npmcn.com/package/%40canva/app-ui-kit/#readme-javascript-variables)
    -   [设计符号列表](https://npmcn.com/package/%40canva/app-ui-kit/#readme-list-of-design-tokens)
-   [更改日志](https://npmcn.com/package/%40canva/app-ui-kit/#readme-changelog)
-   [捐款](https://npmcn.com/package/%40canva/app-ui-kit/#readme-contributing)
-   [许可证](https://npmcn.com/package/%40canva/app-ui-kit/#readme-license)

## 导言

App UI Kit 是一个基于反应的组件库,用于设计和开发 [Canva 应用程序](https://www.canva.com/your-apps/) 模仿着外表和感觉 [彩绘](https://www.canva.com/)。 。 。 .

<table><tbody><tr><td>要更多地了解Canva上的应用开发情况,请参见:</td><td><a href="https://www.canva.dev/docs/apps/" rel="nofollow noopener noreferrer"><img alt="Canva dev" src="https://img.shields.io/badge/Canva%20Dev-00C4CC?style=for-the-badge&amp;logo=Canva&amp;logoColor=fff" loading="lazy" decoding="async" referrerpolicy="no-referrer"></a></td></tr><tr><td>要浏览App UI Kit中的所有组件,请参见:</td><td><a href="https://www.canva.dev/docs/apps/app-ui-kit/storybook/" rel="nofollow noopener noreferrer"><img alt="Canva dev" src="https://img.shields.io/badge/Storybook-FE4785?style=for-the-badge&amp;logo=storybook&amp;logoColor=fff" loading="lazy" decoding="async" referrerpolicy="no-referrer"></a></td></tr></tbody></table>

**说明:** 如果你打算向公众发布一个 Canva App, **我们强烈建议使用 App UI Kit**我们期望应用软件能达到某些设计标准 没有组件就很难做到.

## 特征

-   基于Canva自己的工程师所使用的组件.
-   以可访问性,可使用性,和跨平台相容而建.
-   包括用于创建自定义组件的设计符号 .

## 安装

```bash
npm install @canva/app-ui-kit
```

## 使用量

**说明:** 如果你在用的话 [启动工具箱](https://github.com/canva-sdks/canva-apps-sdk-starter-kit)这些步骤已经为你做了.

应用的基础,例如: `index.tsx` 文件 :

1.  导入样式表 :
    
    ```tsx
    import '@canva/app-ui-kit/styles.css';
    ```
    
2.  导入 `AppUiProvider` 组件 :
    
    ```tsx
    import { AppUiProvider } from '@canva/app-ui-kit';
    ```
    
3.  将应用程序包入 `AppUiProvider` 组件 :
    
    ```tsx
    <AppUiProvider>
      <App />
    </AppUiProvider>
    ```
    
    此组件只应在应用程序组件树上使用一次 .
    

完成这些步骤后,从 `@canva/app-ui-kit` 软件包 :

```tsx
import { Button, Rows, Text, Title } from '@canva/app-ui-kit';
import * as React from 'react';

export function App() {
  return (
    <Rows spacing="2u">
      <Rows spacing="1u">
        <Title>Hello world</Title>
        <Text>This is a paragraph of text.</Text>
      </Rows>
      <Button variant="primary">Click me</Button>
    </Rows>
  );
}
```

这些组成部分必须作为土著人民后裔存在 `AppUiProvider` 组件.

## 组件和图标

App UI Kit 输出一些 **构成部分** (例如:. `Button`, (中文(简体) ), `Text`, (中文(简体) ), `Rows`等)和 (中文(简体) ) **图标** (例如:. `PlusIcon`, (中文(简体) ), `SearchIcon`用于您的应用程序 .

关于所有组件和图标的完整列表和文件,见我们的故事书实例:

[![](https://img.shields.io/badge/Storybook-FE4785?style=for-the-badge&logo=storybook&logoColor=fff)](https://www.canva.dev/docs/apps/app-ui-kit/storybook/)

## 设计符号

设计符是用于存储与设计相关的数值如颜色等的变量. 它们作为设计属性的单一真理来源,使得UI更加容易保持一致性和可维护性.

App UI Kit将设计符号暴露为JavaScript和CSS变量. Apps可以使用这些符号来创建或自定义符合Canva外观和感觉的组件. 如果 Canva 更改了令牌的值, 这些更改会自动反映在应用程序中 .

### CSS 变量

您可以使用全局样式表中的 CSS 变量, CSS 模块, 或者应用的源代码 :

```css
.button {
  background-color: var(--ui-kit-color-primary);
}
```

变量以 kebab 大小写,并带有前缀 `--ui-kit-`。 。 。 .

### JavaScript 变量

您可以使用应用程序源代码中的 JavaScript 变量 :

```tsx
import { tokens } from '@canva/app-ui-kit';

function App() {
  return <div style={{ backgroundColor: tokens.colorPrimary }}>Hello world.</div>;
}
```

变量用骆驼案来写出,没有前缀.

### 设计符号列表

您可以在 Canva 开发者文档网站上找到设计符的参考文档 :

-   [颜色](https://www.canva.dev/docs/apps/app-ui-kit/colors/)
-   [阴影](https://www.canva.dev/docs/apps/app-ui-kit/shadows/)
-   [间距](https://www.canva.dev/docs/apps/app-ui-kit/spacing/)
-   [过渡](https://www.canva.dev/docs/apps/app-ui-kit/transitions/)
-   [单位](https://www.canva.dev/docs/apps/app-ui-kit/units/)

## 更改日志

见 `CHANGELOG.md` 文档或查看到我们 [文档网站](https://www.canva.dev/docs/apps/app-ui-kit/changelog/)。 。 。 .

## 捐款

我们正在积极开发这个一揽子计划,但目前不接受第三方的捐款. 如果您想要求修改或添加软件包,请通过 [Canva 开发者社区](https://community.canva.dev/)。 。 。 .

## 许可证

见 `LICENSE.md` 文档.

## 常见问题

### @canva/app-ui-kit 是什么？

Canva 开发者 SDK UI 组件库用于 Canva 内部的应用程序

### 如何安装 @canva/app-ui-kit？

在项目目录运行 npm install @canva/app-ui-kit，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：mobx（^6\.16\.0）、react（^19\.2\.3）、react-dom（^19\.2\.3）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @canva/app-ui-kit 支持 TypeScript 吗？

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

### @canva/app-ui-kit 支持 ESM 还是 CommonJS？

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

### @canva/app-ui-kit 可以商用吗？

@canva/app-ui-kit 使用 SEE LICENSE IN LICENSE\.md 许可。许可条款写在包内的独立文件中，请阅读该文件确认可否商用。以上为概括，不构成法律意见，请以许可原文为准。

### @canva/app-ui-kit 的下载量有多少？

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

### @canva/app-ui-kit 还在维护吗？

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

