# @box/metadata-editor 中文文档

规范地址：https://npmcn.com/package/%40box/metadata-editor/

版本：2\.11\.34
npm 元数据更新时间：2026-11-06T18:03:38.550Z
中文译文更新时间：2026-11-08T12:45:01.999Z
软件包许可：SEE LICENSE IN LICENSE

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

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

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

- 包体积（解压后）：850 kB，403 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：0 个
- peer 依赖：react ^17\.0\.0 \|\| ^18\.0\.0，formik ^2\.0\.3，lodash ^4\.17\.15，react-dom ^17\.0\.0 \|\| ^18\.0\.0，react-intl ^6\.4\.2，@ariakit/react 0\.4\.21，@box/blueprint-web ^18\.10\.3，@box/user-selector ^3\.1\.39，@box/combobox-with-api ^2\.3\.39，@box/blueprint-web-assets ^5\.15\.0，@box/box-ai-agent-selector ^2\.3\.41，@box/metadata-taxonomy-picker ^3\.5\.0，@box/metadata-template-browser ^3\.1\.6
- 首次发布：2024-09-12T18:18:54.668Z
- 最新版本发布：2026-11-06T18:03:38.179Z
- 近 30 天下载量：61096（2026-10-09 至 2026-11-07，npm 官方下载统计）
- 已发布版本数：1008（近 12 个月 519 个）

## 中文简介

暂无中文简介

## 安装

```sh
npm install @box/metadata-editor
```

也可以使用：`pnpm add @box/metadata-editor`、`yarn add @box/metadata-editor`、`bun add @box/metadata-editor`

## README

-   [元编辑器](https://npmcn.com/package/%40box/metadata-editor/#readme-metadata-editor)
    -   [运行命令](https://npmcn.com/package/%40box/metadata-editor/#readme-running-commands)
    -   [可用命令](https://npmcn.com/package/%40box/metadata-editor/#readme-available-commands)
    -   [所有权](https://npmcn.com/package/%40box/metadata-editor/#readme-ownership)
    -   [项目类型](https://npmcn.com/package/%40box/metadata-editor/#readme-item-type)
    -   [翻译](https://npmcn.com/package/%40box/metadata-editor/#readme-translations)

# 元编辑器

这个库是用 [@ box/ 自定义](https://npmcn.com/package/automation//README.md)。关于如何在生成的库中执行任务的概况可见于 [运行任务](https://nx.dev/core-features/run-tasks) Nx文档.

## 运行命令

您的终端应该留在寄存器根目录的位置, 即 `frontend-mono`。允许 Nx 运行针对您的项目的行动,或者在必要时运行多个项目. 不导航到 `packages/group-shared-features/metadata-editor` 以运行命令.

项目的命令使用 Nx 使用的语法运行 :

```
Syntax: yarn nx <target name> <project name> <option overrides>
                      |              |                |
Example: yarn nx    test         products         --watch
```

## 可用命令

所有使用 Nx 的命令都可以在 `project.json` 文档.

-   `nx storybook metadata-editor` - 发射UI组件的开发环境.
-   `nx build-storybook metadata-editor` - 建立静态版本的故事书 与所有的故事.
-   `nx build metadata-editor` - 使用 `shared-feature-builder` 执行器从 `automation` 软件包.
-   `nx lint metadata-editor` - 运行linter过包文件.
-   `nx test metadata-editor` - 进行故事书测试(视觉/互动)和笑话测试,最后编写报道报告.
-   `nx test-storybook metadata-editor` - 做故事书测试 需要先在单独的终端开始故事本才能成功.
-   `nx test-storybook-local-coverage metadata-editor` - 进行故事书测试,并在最后制作报道报告。 需要运行的故事书实例.
-   `nx test-storybook-ci metadata-editor` - 建立故事书,并进行故事书测试,提供覆盖产出。 设计为CI使用.
-   `nx test-jest metadata-editor` - 运行滑稽单元测试, 产生代码覆盖结尾.
-   `nx sonar metadata-editor` - 使用声纳Qube工具对代码进行静态分析,以检测出臭虫和代码的气味。 集成为CI进程的步骤之一.
-   `nx chromatic metadata-editor` - 上传故事书,供审查 [框色调](https://box.chromatic.com/) ,并进行目视比较.
-   `nx prepare metadata-editor` - 在Nx Release安排的软件包发布过程中运行命令.

## 所有权

该特性的代码属于@Box/role metadata. 拥有团队的职责包括控制代码质量,提供修改指南,并与其他团队在修改方面保持一致.

如果您有任何与此功能相关的问题或需要,请联系Slack上的元数据组: [{\\fn方正黑体简体\\fs18\\b1\\bord1\\shad1\\3ch2f2f](https://grid-box.enterprise.slack.com/archives/C16HCR4QG)

## 项目类型

`itemType` 选择特定项目的副本。 自动填充,信心分数评分,和边框保留在自己的旗帜上,只支持文件,所以文件夹主机应该将那些旗帜放出.

`folder` 还显示级联政策编辑器。 当用户可能编辑此政策时, `onSubmit` 接收 `cascadePolicySelection` (单位:千美元)`id`, (中文(简体) ), `isEnabled`, (中文(简体) ), `overwrite`, (中文(简体) ), `canEdit`,以及应用的 AI 提取设置). 文件保存省略了此参数 。 一个政策与 `canEdit: false` 显示为只读通知,而不保存.

`MetadataInstanceForm` 接受可选选项 `itemType` 联 合 国 `'file' | 'folder'`默认 `'file'` 并传递到 `DeleteConfirmationModal`。 。 。 . `MetadataInstanceList` 不带 `itemType`; 当文件夹实例已有策略时, 列表会显示它自己的级联通知 .

文件夹空态复制是一个单独的道具. 过 `level="folder"` 打开 `MetadataEmptyState` 合并 `itemType="folder"` 在表格上,所以删除模式和空状态描述相同的项目.

```tsx
import { MetadataEmptyState, MetadataInstanceForm } from '@box/metadata-editor';

<MetadataInstanceForm itemType="folder" {...formProps} />
<MetadataEmptyState level="folder" />
```

## 翻译

每个地方 `i18n/*.js` 档案由莫吉·詹金斯管道生成和完成。 共享特性构建器复制到 `dist/i18n/` 期间 `build`中的软件包 `i18n.config.js` 下级 `translationDependencies`。 。 。 .

## 常见问题

### 如何安装 @box/metadata-editor？

在项目目录运行 npm install @box/metadata-editor，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：react（^17\.0\.0 \|\| ^18\.0\.0）、formik（^2\.0\.3）、lodash（^4\.17\.15）、react-dom（^17\.0\.0 \|\| ^18\.0\.0）、react-intl（^6\.4\.2）、@ariakit/react（0\.4\.21）、@box/blueprint-web（^18\.10\.3）、@box/user-selector（^3\.1\.39）、@box/combobox-with-api（^2\.3\.39）、@box/blueprint-web-assets（^5\.15\.0）、@box/box-ai-agent-selector（^2\.3\.41）、@box/metadata-taxonomy-picker（^3\.5\.0）、@box/metadata-template-browser（^3\.1\.6）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @box/metadata-editor 支持 TypeScript 吗？

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

### @box/metadata-editor 支持 ESM 还是 CommonJS？

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

### @box/metadata-editor 可以商用吗？

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

### @box/metadata-editor 的下载量有多少？

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

### @box/metadata-editor 还在维护吗？

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

