# @aglyn/besigner-ui 中文文档

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

版本：1\.19\.0
npm 元数据更新时间：2026-11-07T13:57:36.443Z
中文译文更新时间：2026-11-05T23:06:04.943Z
软件包许可：Apache-2\.0

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

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

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

- 包体积（解压后）：4.8 MB，558 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：32 个
- peer 依赖：next ^16\.3\.3，react ^19\.2\.8，@mui/lab ^9\.0\.0-beta\.8，firebase ^13\.0\.0，react-dom ^19\.2\.8，@mui/system ^9\.2\.0，@mui/material ^9\.3\.1
- 首次发布：2026-09-20T23:52:55.760Z
- 最新版本发布：2026-11-07T13:57:36.069Z
- 近 30 天下载量：9880（2026-10-05 至 2026-11-03，npm 官方下载统计）
- 已发布版本数：162（近 12 个月 162 个）

## 中文简介

Besigner的回放UI,Aglyn的视觉编辑器,在Aglyn控制台上行驶时:工作空间,帆布取景所,元素树,检查表单,工具栏,拖放,以及工作草稿. 如果您想要在自己的应用程序中挂载 Aglyn 编辑器, 请安装它

## 安装

```sh
npm install @aglyn/besigner-ui
```

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

## README

# @aglyn/ 签名人- ii

Aglyn的影视编辑 Aglyn在Aglyn号上航行 控制台:工作空间、帆布取景口、元素树、检查表、, 工具栏、拖放和工作草稿。 如果您想要挂载, 请安装 aglyn编辑器在您的应用程序。 如果你想建立一个不同的UI over the 相同的编辑逻辑, 接受 `@aglyn/besigner` 换句话说.

> 从Aglyn monorepo出版到npm. 随后的版本 [语义版本](https://semver.org/)。 。 。 .

## 安装

```
npm install @aglyn/besigner-ui
```

同伴依赖关系,今天所有需要:

-   `react`
-   `@mui/material`, (中文(简体) ), `@mui/system`, (中文(简体) ), `@mui/lab`
-   `next`
-   `firebase`

`next` 财务报告和审定财务报表 `firebase` 作为同行的可嵌入编辑器不需要,他们 今天仍然需要. `next` 是一个对等点,因为视图画布和 工作空间编辑器加载自身部件 `next/dynamic`。 。 。 . `firebase` 是一个 对等点, 因为共享工作草稿存储( e)`drafts/besigner-server-draft`(中文(简体) ) 阅读和写Firestore本身。 该软件包已被证明安装和 从登记册中与在场的同行捆绑在一起,以及 `react-dom` 和MUI的情感包,没有 `firebase-admin`,任意 `@aglyn/tenant-*` 软件包或任何 `@aglyn/plugins-*` 软件包.

## 里面有什么东西

下面命名的棋子是从包根导出, 除非是子路径 给定; 每个文件下 `src/lib` 也可以通过子路径达到.

-   根和提供者 : `BesignerRootProviderComponent` 编辑 `withBesignerContext` 收尾设置编辑器应用程序上下文, 即 拖放上下文、 成品元素注册、 组件抽屉 和剪贴板快捷键.
-   工作空间和取景口 : `WorkspaceEditorComponent`, (中文(简体) ), `WorkspacePanelComponent`, (中文(简体) ), `AsidePanelComponent`, (中文(简体) ), `ViewportRootComponent`, (中文(简体) ), `ViewportCanvasComponent` 财务报告和审定财务报表 `ViewportFrameComponent`。这个框架使 画布与 `@aglyn/aglyn-node-renderer`在编辑器中互换 叶子(`NodeLeaf`)用于选择和拖动行为.
-   工具栏和控件 : `AppBarPrimaryComponent`,二级应用程序栏和 面包屑, `HistoryControlsComponent`, (中文(简体) ), `DevicePreviewControlsComponent`, (中文(简体) ), `PanelControlsComponent`,以及方案预览、缩放、互动和添加 控制系统.
-   元素树和帆布铬: `NodeTreeView`, (中文(简体) ), `NodeOverlay`, (中文(简体) ), `NodeOutline`, (中文(简体) ), `NodeContextMenu`,节点快速动作和节点卡.
-   探长: `ElementPropsForm` 对于一个组件的属性,该元素 样式窗体、属性对话框、属性值窗体和符号字段 (单位:千美元)`token-text-field`, (中文(简体) ), `token-pill`) (中文(简体) ). 框样式器( E)`BoxStyler`) 位于 子路径 `@aglyn/besigner-ui/box-styler/index`。 。 。 .
-   文件和草案: `useBesignerDocument` 装入并保存文档 通过一个来源对呼叫者提供的材料进行编辑; `useBesignerDraft`, (中文(简体) ), 浏览器草稿存储( e)`readBesignerDraft`, (中文(简体) ), `writeBesignerDraft`, (中文(简体) ), `clearBesignerDraft`)和Firestore 草稿商店(`readServerDraft`, (中文(简体) ), `writeServerDraft`, (中文(简体) ), `clearServerDraft`保持工作进展. `BesignerDraftAlertComponent` 财务报告和审定财务报表 `BesignerConflictAlertComponent` 表面 他们.
-   钩子: `useAglynBesignerFlag`, (中文(简体) ), `useAglynBesignerPanel`, (中文(简体) ), `useBesignerAppContext`, (中文(简体) ), `useLeafDrag`, (中文(简体) ), `useLeafDrop`, (中文(简体) ), `useDeleteElementCallback` 还有其他.
-   主机接合器, 由于 React 上下文, 嵌入程序会填充 : `MediaPickerContext`, (中文(简体) ), `BindingPickerContext`, (中文(简体) ), `BesignerInspectorExtrasContext`, (中文(简体) ), `BesignerToolbarExtrasContext`,则 组成部分促进、互动和编程的铬环境.

## 使用量

编辑器由这些部件组成,而不是作为一个组件挂起. 从根导入 :

```tsx
import {
  NodeTreeView,
  ViewportCanvasComponent,
  ViewportRootComponent,
  WorkspaceEditorComponent,
  useBesignerDocument,
  withBesignerContext,
} from '@aglyn/besigner-ui'
```

编辑挂起前必须先有两样东西 否则就扔了 其第一项判决:

-   编辑器应用程序: 调用 `initializeBesignerApp()` 从 `@aglyn/besigner` 一次;
-   控制台主题作为 CSS 变量: 将编辑器内置 `ThemeCssVarProvider` 从 `@aglyn/shared-ui-theme`输入 `{ light: consoleThemeLight, dark: consoleThemeDark }`. 一个简单的MUI `ThemeProvider` 还不够,因为编辑的风格读取了主题 CSS变量.

最小的工作组成是单相机中的例子应用, [`examples/consumers/besigner-ui`](https://github.com/aglyn/aglyn/tree/main/examples/consumers/besigner-ui)数字 : a 从 npm 安装这些软件包的 Vite app, 注册四个元素 类型,并挂载工作空间、视图和画布。 阿格林的线人 在每版的浏览器中构建并打开.

全部组成是控制台的屏幕编辑页,下方 `apps/console/app/(editor)/[orgSlug]/hosts/[host]/screens/[screenId]/versions/[versionId]/besigner/page.tsx`。 。 。 . 它用 `withBesignerContext`,将文档装入 `useBesignerDocument`,并列出工作空间、视图和面板。 这个 画布可以渲染的组件来自在核心中注册的插件, 例如 `@aglyn/plugins-mui`。 。 。 .

## 怎样才合适

这是 `besigner-ui` 包映射的范围, 设计者的顶端 堆栈: 它导入 `@aglyn/besigner` (逻辑), `@aglyn/aglyn-node-renderer`, (中文(简体) ), `@aglyn/aglyn-markdown-editor`,该核心 `@aglyn/aglyn`,和通用软件 `@aglyn/shared-*` 软件包。 它不导入插件, 插件从不导入 设计师UI.

## 许可证

阿帕奇2.0 (英语). 资料来源: [https://github.com/aglyn/aglyn/tree/main/libs/besigner/feature/designer 互联网档案馆的存檔,存档日期2014-12-02](https://github.com/aglyn/aglyn/tree/main/libs/besigner/feature/designer)

## 常见问题

### @aglyn/besigner-ui 是什么？

Besigner的回放UI,Aglyn的视觉编辑器,在Aglyn控制台上行驶时:工作空间,帆布取景所,元素树,检查表单,工具栏,拖放,以及工作草稿\. 如果您想要在自己的应用程序中挂载 Aglyn 编辑器, 请安装它

### 如何安装 @aglyn/besigner-ui？

在项目目录运行 npm install @aglyn/besigner-ui，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：next（^16\.3\.3）、react（^19\.2\.8）、@mui/lab（^9\.0\.0-beta\.8）、firebase（^13\.0\.0）、react-dom（^19\.2\.8）、@mui/system（^9\.2\.0）、@mui/material（^9\.3\.1）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @aglyn/besigner-ui 支持 TypeScript 吗？

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

### @aglyn/besigner-ui 支持 ESM 还是 CommonJS？

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

### @aglyn/besigner-ui 可以商用吗？

@aglyn/besigner-ui 使用 Apache-2\.0 许可。宽松许可：允许商业使用、修改和再分发，并附带明确的专利授权；分发时需保留许可与 NOTICE 文件，修改过的文件要注明改动。以上为概括，不构成法律意见，请以许可原文为准。

### @aglyn/besigner-ui 的下载量有多少？

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

### @aglyn/besigner-ui 还在维护吗？

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