# @starcier/builder-shell 中文文档

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

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

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

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

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

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

## 中文简介

Starcier构建器的应用框架：围绕协作层的登录、共享和邀请页面、访问感知目录和原型路由。

## 安装

```sh
npm install @starcier/builder-shell
```

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

## README

# @starcier / builder-shell

整个Starcier原型构建器围绕着你的原型：登录，目录，原型 路由，密码共享和邀请页面，以及协作层（评论和引导） 旅游)。你提供你的调色板，你的原型和你的配置；这里没有人知道 你的设计系统。

## 安装

```bash
npm install @starcier/collab-core@next @starcier/collab-ui@next @starcier/builder-shell@next react-router @auth0/auth0-react
```

直到 `1.0.0` 已发布，版本为预发布(`1.0.0-next.N`)：总是安装 `@next`． 没有它，npm会安装第一个预发布版，而不是最新的。需要React 18或19； React-router 7或8，以及 `@auth0/auth0-react` 2.

## 使用

在你的路由器中渲染它：

```tsx
import { BuilderShell } from '@starcier/builder-shell';

<BrowserRouter>
  <BuilderShell
    palette={palette}               // a BuilderPalette resolved from your design tokens
    prototypes={prototypes}         // [{ slug, title, component }, …]
    apiBaseUrl={API_BASE_URL}       // the API origin, without /v1
    tenant={TENANT_SLUG}            // your builder's tenant slug
    auth={{ domain, clientId, audience }}
  />
</BrowserRouter>
```

离开了 `apiBaseUrl` 和 `auth` 与…竞争 `localStorage`，没有登录，也没有后台 -对设计工作有用。保持 `tenant` 设置：它保留了这个构建器的本地注释 和图尔不同于其他的建筑商，比如 `localhost`． Auth0的代码是 仅在以下情况下加载 `auth` 是集。

壳起作用 `/share/:id` 和 `/invite/:token`，所以您的主机必须发送未知路径到 `index.html`，就像任何单页应用程序一样。

### 堆垛顺序

| `z-index` | 什么 |
| --- | --- |
| 200 | 壳的顶条 |
| 9140 - 10000 | 意见及参观 |

给出你自己的情态动词和抽屉 `z-index` 两者之间：上面的条，所以一个对话框覆盖 它和下面的9140，所以评论和旅游出现在你的对话框上面。

查看按钮位于栏中，因此在打开对话框时无法触及。这和什么相符 复习模式可以做到： **无法查看对话框内容**，而评论则直接显示在页面上。

在Next.js应用中，或者有自己的路由器和登录的应用中，使用 `@starcier/collab-core` 和 `@starcier/collab-ui` 直接代替。

## 许可证

麻省理工学院

## 常见问题

### @starcier/builder-shell 是什么？

Starcier构建器的应用框架：围绕协作层的登录、共享和邀请页面、访问感知目录和原型路由。

### 如何安装 @starcier/builder-shell？

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

### @starcier/builder-shell 支持 TypeScript 吗？

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

### @starcier/builder-shell 支持 ESM 还是 CommonJS？

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

### @starcier/builder-shell 可以商用吗？

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

### @starcier/builder-shell 还在维护吗？

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