# @lincyaw/aegis-ui 中文文档

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

版本：0\.7\.0
npm 元数据更新时间：2026-11-01T16:36:53.164Z
中文译文更新时间：2026-11-01T17:48:48.974Z
软件包许可：未声明

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

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

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

- 包体积（解压后）：3.3 MB，927 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：25 个
- peer 依赖：antd ^5\.25\.0，vite \>=5，react ^18\.0\.0，react-dom ^18\.0\.0，react-router-dom ^6\.0\.0，@ant-design/icons ^5\.0\.0
- 首次发布：2026-05-17T07:08:52.645Z
- 最新版本发布：2026-11-01T16:36:52.871Z
- 已发布版本数：4（近 12 个月 4 个）

## 中文简介

AegisLab共享设计系统：标记、原语、布局、主题。

## 安装

```sh
npm install @lincyaw/aegis-ui
```

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

## README

# @lincyaw / aegis-ui

为AegisLab前端设计系统和多应用程序外壳：设计令牌； 表示性React组件； `PageWrapper`，路由器感知 `AegisShell`，以及遵循相同标记的Ant Design主题。

该包不包含API客户端、业务状态或页面。应用程序 提供自己的数据并通过插件插入到shell中 `AegisApp` 合同。

## 安装

```bash
pnpm add @lincyaw/aegis-ui
```

同行依赖性: `react` 18， `react-dom` 18， `react-router-dom` 6， `antd` 5.25或以后； `@ant-design/icons` 5.

字体没有捆绑。安装 `@fontsource-variable/geist`， `@fontsource-variable/hanken-grotesk`， `@fontsource-variable/noto-sans-sc` 和 `@fontsource/google-sans-code`，并在应用程序入口中导入它们 (谷歌Sans Code `400.css` 和 `500.css` 重量)。

## 使用

```tsx
import {
  type AegisApp,
  AegisShell,
  ThemeProvider,
  getAegisTheme,
  useTheme,
} from '@lincyaw/aegis-ui';
import '@lincyaw/aegis-ui/style.css';
import { ConfigProvider } from 'antd';
import { BrowserRouter } from 'react-router-dom';

const containersApp: AegisApp = {
  id: 'containers',
  label: 'Containers',
  icon: <HddOutlined />,
  basePath: '/containers',
  sidebar: [{ items: [{ to: '', label: 'List', end: true }] }],
  routes: [{ path: '', element: <ContainerList /> }],
};

function Root() {
  const { resolved } = useTheme();
  return (
    <ConfigProvider theme={getAegisTheme(resolved)}>
      <BrowserRouter>
        <AegisShell
          brand={{ name: 'AegisLab', href: '/' }}
          apps={[containersApp]}
          fallbackPath="/containers"
        />
      </BrowserRouter>
    </ConfigProvider>
  );
}

export function App() {
  return (
    <ThemeProvider>
      <Root />
    </ThemeProvider>
  );
}
```

外壳将每条路线包裹起来 `PageWrapper`，因此页面只呈现内容：

```tsx
import { DataTable, PageHeader, Panel } from '@lincyaw/aegis-ui';

export function ContainerList() {
  return (
    <>
      <PageHeader title="Containers" />
      <Panel>
        <DataTable columns={columns} data={rows} rowKey={(row) => row.id} />
      </Panel>
    </>
  );
}
```

## 文档

这个 [库的自述](https://github.com/Lincyaw/aegis-ui#readme) 涵盖了 包的全部内容、开发工作流程和发布版本 的过程。这个 [组件库](https://profile.aoyangfang.top/aegis-ui/) 显示每个组件及其变体，在光明和黑暗的主题。

## 常见问题

### @lincyaw/aegis-ui 是什么？

AegisLab共享设计系统：标记、原语、布局、主题。

### 如何安装 @lincyaw/aegis-ui？

在项目目录运行 npm install @lincyaw/aegis-ui，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：antd（^5\.25\.0）、react（^18\.0\.0）、react-dom（^18\.0\.0）、react-router-dom（^6\.0\.0）、@ant-design/icons（^5\.0\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @lincyaw/aegis-ui 支持 TypeScript 吗？

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

### @lincyaw/aegis-ui 支持 ESM 还是 CommonJS？

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

### @lincyaw/aegis-ui 可以商用吗？

@lincyaw/aegis-ui 使用 未声明 许可。package\.json 没有声明许可证。没有许可证的代码默认保留全部权利，商用前请联系作者或查看仓库中的 LICENSE 文件。以上为概括，不构成法律意见，请以许可原文为准。

### @lincyaw/aegis-ui 还在维护吗？

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