# @epilot/base-elements 中文文档

规范地址：https://npmcn.com/package/%40epilot/base-elements/

版本：4\.0\.2
npm 元数据更新时间：2026-11-10T09:27:54.394Z
中文译文更新时间：2026-11-13T19:41:49.703Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40epilot/base-elements
原文对照：https://npmcn.com/package/%40epilot/base-elements/?lang=original

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

- 包体积（解压后）：4.8 MB，511 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- Node.js 要求：\>=18
- 运行依赖：15 个
- peer 依赖：react \>=16，react-dom \>=16
- 首次发布：2021-01-07T12:34:11.919Z
- 最新版本发布：2026-09-09T07:11:23.896Z
- 近 30 天下载量：22810（2026-10-14 至 2026-11-12，npm 官方下载统计）
- 已发布版本数：264（近 12 个月 4 个）

## 中文简介

通用 反应 epilot UI 元素的组件.

## 安装

```sh
npm install @epilot/base-elements
```

也可以使用：`pnpm add @epilot/base-elements`、`yarn add @epilot/base-elements`、`bun add @epilot/base-elements`

## README

# @ epilot/ base- 要素

通用 反应 epilot UI 元素的组件.

[(原始内容存档于2018-09-28) (英语). dev.epilot.io](https://base-elements.dev.epilot.io/)

依据 [材料界面](https://material-ui.com/)

## 快开始

```bash
yarn
yarn start
```

## 故事书

```bash
yarn run storybook
yarn run build-storybook
```

## 本地运行 `http://localhost:5500/bundle.js`

## 贡献 MDX( 标记下文档)

添加一个 `.stories.mdx` 文件与故事并列(例如: [故事/进步. 设计. stories.mdx](https://npmcn.com/package/%40epilot/base-elements/stories/Progress.design.stories.mdx)(中文(简体) )

添加一个 `<Meta>` 标记如下:

```jsx
import { Meta } from '@storybook/addon-docs';
import { Progress } from '../src';

<Meta title='Elements/Feedback/Progress/Design' component={Progress} />;
```

通过 `component` 你正在记录,还有 `title` 根据你希望你的故事在导航中出现的地方:

![Example navigation](https://npmcn.com/package/%40epilot/base-elements/public/img/navi-example.png)

然后您可以添加您的文档, 包含下调、 嵌入式故事和图像, 如此所示 [完整实例](https://npmcn.com/package/%40epilot/base-elements/stories/Progress.design.stories.mdx)数字 :

```jsx
import { Canvas, Meta, Story } from '@storybook/addon-docs';
import { Progress } from '../src'

<Meta
  title="Elements/Feedback/Progress/Design"
  component={Progress}
/>

# Progress Indicator

Embedded story
<Canvas>
  <Story id="elements-feedback-progress--circular-progress-indeterminade-story" />
</Canvas>

Here is an image using Markdown:

![My image](/img/progress-image-demo.png)

Here is an image using MDX:

<img src="/img/progress-image-demo.png" alt="My image" />
```

## 常见问题

### @epilot/base-elements 是什么？

通用 反应 epilot UI 元素的组件\.

### 如何安装 @epilot/base-elements？

在项目目录运行 npm install @epilot/base-elements，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：react（\>=16）、react-dom（\>=16）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @epilot/base-elements 支持 TypeScript 吗？

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

### @epilot/base-elements 支持 ESM 还是 CommonJS？

以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。

### @epilot/base-elements 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>=18。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @epilot/base-elements 可以商用吗？

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

### @epilot/base-elements 的下载量有多少？

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

### @epilot/base-elements 还在维护吗？

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