# @starcier/collab-ui 中文文档

规范地址：https://npmcn.com/package/%40starcier/collab-ui/

版本：1\.0\.0
npm 元数据更新时间：2026-11-02T12:16:09.114Z
中文译文更新时间：2026-11-02T13:38:40.924Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40starcier/collab-ui
原文对照：https://npmcn.com/package/%40starcier/collab-ui/?lang=original
项目主页：https://github.com/starcier/starcier-platform#readme
源码仓库：https://github.com/starcier/starcier-platform

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

- 包体积（解压后）：533 kB，243 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：3 个
- peer 依赖：react ^18\.0\.0 \|\| ^19\.0\.0，react-dom ^18\.0\.0 \|\| ^19\.0\.0，@starcier/collab-core ^1\.0\.0
- 首次发布：2026-10-23T09:39:00.703Z
- 最新版本发布：2026-11-02T12:16:08.814Z
- 已发布版本数：5（近 12 个月 5 个）

## 中文简介

Starcier协作层的视觉部分：回顾层和导览、BuilderPalette契约，以及基于它的chrome原语样式。

## 安装

```sh
npm install @starcier/collab-ui
```

也可以使用：`pnpm add @starcier/collab-ui`、`yarn add @starcier/collab-ui`、`bun add @starcier/collab-ui`

## README

# @starcier / collab-ui

Starcier协作层的视觉部分：将评论钉在页面上 注释抽屉，导览和工作流选择器。它在任何地方看起来和表现都是一样的 建造者，不管建造者自己的设计系统是什么。

大多数构建器不直接使用这个包。 `@starcier/builder-shell` 帮你装上。 只有当你的应用有自己的外壳时，你才可以自己去使用它；它需要React，但不需要路由器。

## 安装

```bash
npm install @starcier/collab-core@next @starcier/collab-ui@next
```

直到 `1.0.0` 已发布，版本为预发布(`1.0.0-next.N`)：总是安装 `@next`． 没有它，npm会安装第一个预发布版，而不是最新的。需要React 18或19； 和 `@starcier/collab-core`，其中保存了数据。

## 使用

山 `CollabUiProvider` 内部 `CollabProvider`，周围的一切渲染 协作组件:

```tsx
import { CollabProvider } from '@starcier/collab-core';
import { CollabUiProvider } from '@starcier/collab-ui';

<CollabProvider apiBaseUrl={API_BASE_URL} getToken={getAccessToken} tenant={TENANT_SLUG}>
  <CollabUiProvider
    overlaySelectors={['.my-modal', '.my-drawer']}   // your design system's overlay roots
    fieldWrapperSelectors={['.my-field']}            // wrappers around your form fields
  >
    {children}
  </CollabUiProvider>
</CollabProvider>
```

两个选择器列表都是可选的。他们保持记录的旅游步骤稳定，包括开放的旅游 一个对话框。

**不能查看对话。** 查看模式永远不会在匹配的元素中放置注释 `overlaySelectors`;点击这里到达对话框。评论显示在页面上。

### 堆垛顺序

协作层在两者之间进行划分 `z-index` 9140（回顾重点）和10000（参观） 工具提示)。请将您自己的情态、抽屉和弹出窗口保存在9140下方，以便随时发表评论和参观 出现在他们之上。

协作层使用自己的固定颜色和系统字体，所以它读起来像一个工具 是你产品的顶部，而不是一部分。这个 `BuilderPalette` 导出的类型是 建筑商的合同 _铬_ -目录和登录页面-其中 `@starcier/builder-shell` 从您的设计标记中提取。

## 许可证

麻省理工学院

## 常见问题

### @starcier/collab-ui 是什么？

Starcier协作层的视觉部分：回顾层和导览、BuilderPalette契约，以及基于它的chrome原语样式。

### 如何安装 @starcier/collab-ui？

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

### @starcier/collab-ui 支持 TypeScript 吗？

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

### @starcier/collab-ui 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

### @starcier/collab-ui 可以商用吗？

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

### @starcier/collab-ui 还在维护吗？

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