# @aglyn/plugins-mui 中文文档

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

版本：1\.19\.0
npm 元数据更新时间：2026-11-07T14:00:12.574Z
中文译文更新时间：2026-11-05T23:32:06.668Z
软件包许可：Apache-2\.0

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

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

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

- 包体积（解压后）：2.6 MB，246 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：10 个
- peer 依赖：react ^19\.2\.8，@mui/utils ^9\.2\.0，@mui/material ^9\.3\.1，@mui/x-date-pickers ^9\.15\.0
- 首次发布：2026-09-20T23:53:40.770Z
- 最新版本发布：2026-11-07T14:00:12.270Z
- 近 30 天下载量：9436（2026-10-05 至 2026-11-03，npm 官方下载统计）
- 已发布版本数：162（近 12 个月 162 个）

## 中文简介

Aglyn地点的组件调色板,以材料UI为基础。 它是一个基础元素库,每个 Aglyn 网站都绘制有: 版式、文本、导航、媒体、内容收藏, 以及更多, 每一个在核心组件登记册上注册, 及其 s

## 安装

```sh
npm install @aglyn/plugins-mui
```

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

## README

# @aglyn/plugins-mui (英语)

Aglyn地点的组件调色板,以材料UI为基础。 它是一个基础元素库,每个Aglyn站点都绘制有:布局,文本,导航,媒体,内容收藏等,每个库在核心组件登记册上注册,并配有其图案和预设. 如果您要提供 Aglyn 文档或运行 Besigner , 请安装它; 它是一端插件, 通过 Aglyn 的插件管理器装入 .

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

## 安装

```
npm install @aglyn/plugins-mui
```

同伴依赖性 : `react`, (中文(简体) ), `@mui/material`, (中文(简体) ), `@mui/utils`。 。 。 .

## 里面有什么东西

插件有一个登记员, `registerMuiPlugin` (单位:千美元) `site` 书记官长 `plugins.config.json`)),并被标记为始终:它没有控制台页面,没有导航项目和API路线. 来自其他插件的特性捆绑会声明对它的依赖,并等待到它出现在插件管理器中.

**要件.** 插件登记册的组件 ID 列在下面 `contributes.site.components` 内 `plugins.config.json` 和作为 `MUI_COMPONENT_SOURCES`按组:

-   布局 : `section`, (中文(简体) ), `muiContainer`, (中文(简体) ), `muiStack`, (中文(简体) ), `muiBox`, (中文(简体) ), `muiGrid`, (中文(简体) ), `muiPaper`, (中文(简体) ), `layoutSlot`。 。 。 .
-   案文和行动: `muiTypography`, (中文(简体) ), `muiInlineText`, (中文(简体) ), `muiButton`, (中文(简体) ), `markdown`, (中文(简体) ), `tableOfContents`, (中文(简体) ), `icon`。 。 。 .
-   导航 : `muiAppBar`, (中文(简体) ), `muiToolbar`, (中文(简体) ), `muiNavMenu`, (中文(简体) ), `muiMegaMenu`, (中文(简体) ), `muiDrawer`, (中文(简体) ), `muiDrawerToggle`, (中文(简体) ), `muiScreenLink`, (中文(简体) ), `muiLinkBox`, (中文(简体) ), `muiBreadcrumbs`, (中文(简体) ), `muiPagination`, (中文(简体) ), `searchBox`, (中文(简体) ), `languageSwitcher`, (中文(简体) ), `themeModeSwitcher`。 。 。 .
-   表面 : `muiCard` 及其标题、内容和行动, `muiAccordion` 及其摘要和细节, `muiTabs`, (中文(简体) ), `muiTabPanel`, (中文(简体) ), `muiList`, (中文(简体) ), `muiListItem`, (中文(简体) ), `muiListItemText`。 。 。 .
-   媒体: `image`, (中文(简体) ), `video`, (中文(简体) ), `videoEmbed`, (中文(简体) ), `muiImageList`, (中文(简体) ), `muiImageListItem`, (中文(简体) ), `socialLinks`。 。 。 .
-   数据和内容: `dataTable`, (中文(简体) ), `collectionEntries`, (中文(简体) ), `collectionEntryBody`, (中文(简体) ), `collectionEntryMeta`, (中文(简体) ), `collectionEntryAuthor`, (中文(简体) ), `collectionRelated`, (中文(简体) ), `collectionShare`, (中文(简体) ), `collectionCategories`, (中文(简体) ), `collectionSearch`, (中文(简体) ), `contentAuthorProfile`, (中文(简体) ), `product`。 。 。 .
-   其他情况: `reusableInstance`, (中文(简体) ), `custom-html`, (中文(简体) ), `marketplacePlugin`,以及 `div`,文档的根.

将一个站点功能放入页面的计算器元素不在这里:它们是计算器市场插件(`libs/plugins/calculator`编号 `aglyn.calculator.*`) (中文(简体) ).

**构成部分标识持续存在.** 保存的屏幕文档中的每个节点都会存储其 `componentId` 旁边 `pluginId: 'mui'`,所以上面的标识,包括遗产 `mui`\- 前置的,不移入文档,不得更改.

**每个组件加载.** 每个元素都生活在自己的模块中,以动态导入为后盾. `registerMuiPlugin(use)` 接受一个 `PluginUse` 从 `@aglyn/aglyn`; 当 `use.componentIds` 将元素命名为页面位置,只获取这些模块。 它毫无争议地登记了整个库, 这是控制台和设计师需要的调色板。 以进一步的身份再次拨打,增加了已经登记的内容.

**从 `.`**

-   `registerMuiPlugin`, (中文(简体) ), `loadMuiBundle`, (中文(简体) ), `MUI_COMPONENT_SOURCES`,则 `MuiBundleEntry` 财务报告和审定财务报表 `MuiComponentSource` 类型,以及 `BUNDLE_ID` (单位:千美元)`'mui'`) (中文(简体) ).
-   `PluginFrame` 财务报告和审定财务报表 `PluginFrameProps`: 沙盒的主机一侧一个已安装的市场插件运行在其中. 它使插件在跨发源地的沙盒 Iframe 中,只通过能力范围与之交谈 `postMessage` 当插件无法安全运行时, 显示占位符 .
-   `muiPluginInstallToPreset`, (中文(简体) ), `PluginInstallLike`, (中文(简体) ), `PLUGIN_DRAWER_CATEGORY`: 已安装的市场插件如何成为放入调色板条目 `marketplacePlugin` 节点.
-   `sanitizeCustomHtml`: 消毒剂 `custom-html` 元素适用于作者标记.

## 使用量

```ts
import { registerMuiPlugin } from '@aglyn/plugins-mui'

// An editor or console: the whole palette.
await registerMuiPlugin()

// A published page: only the elements this page places.
await registerMuiPlugin({ componentIds: ['section', 'muiTypography', 'muiButton'] })
```

在Aglyn的应用程序中,您自己不叫这个:生成的加载器清单给登记员打电话,并通过从页面文档读取的组件ID。 元件从未被注册的元素不会产生任何效果,所以无法说出其位置的表层应该登记整个库.

## 怎样才合适

一个插件软件包( E)`scope:plugin`) (中文(简体) ). 取决于核心`@aglyn/aglyn`)和通用共享软件包(`@aglyn/shared-ui-jsx`, (中文(简体) ), `@aglyn/shared-ui-theme`, (中文(简体) ), `@aglyn/shared-data-enums`, (中文(简体) ), `@aglyn/shared-data-mdi`, (中文(简体) ), `@aglyn/shared-util-vendor`)和使用 `mobx` 进行分批登记。 它没有进口其他插件,也没有进口设计师UI. 没有其它插件导入它: 特性捆绑名称 `mui` 作为插件管理器中的依赖性 id 而不是导入软件包, 曾经住在这里的窗体元素在其中 `@aglyn/plugins-forms`。 。 。 .

## 许可证

阿帕奇2.0 (英语). 资料来源: [https://github.com/aglyn/aglyn/tree/main/libs/plugins/mui 页面存档备份,存于互联网档案馆](https://github.com/aglyn/aglyn/tree/main/libs/plugins/mui)

## 常见问题

### @aglyn/plugins-mui 是什么？

Aglyn地点的组件调色板,以材料UI为基础。 它是一个基础元素库,每个 Aglyn 网站都绘制有: 版式、文本、导航、媒体、内容收藏, 以及更多, 每一个在核心组件登记册上注册, 及其 s

### 如何安装 @aglyn/plugins-mui？

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

### @aglyn/plugins-mui 支持 TypeScript 吗？

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

### @aglyn/plugins-mui 支持 ESM 还是 CommonJS？

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

### @aglyn/plugins-mui 可以商用吗？

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

### @aglyn/plugins-mui 的下载量有多少？

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

### @aglyn/plugins-mui 还在维护吗？

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