# @genesislcap/rapid-design-system 中文文档

规范地址：https://npmcn.com/package/%40genesislcap/rapid-design-system/

版本：15\.96\.2
npm 元数据更新时间：2026-11-16T09:28:21.317Z
中文译文更新时间：2026-11-16T09:13:22.662Z
软件包许可：SEE LICENSE IN license\.txt

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

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

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

- 包体积（解压后）：2.3 MB，1084 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：9 个
- peer 依赖：flexlayout-react 0\.10\.8
- 首次发布：2023-12-22T10:11:59.607Z
- 最新版本发布：2026-11-16T09:28:20.979Z
- 近 30 天下载量：33601（2026-10-16 至 2026-11-14，npm 官方下载统计）
- 已发布版本数：2121（近 12 个月 1023 个）

## 中文简介

快速设计系统

## 安装

```sh
npm install @genesislcap/rapid-design-system
```

也可以使用：`pnpm add @genesislcap/rapid-design-system`、`yarn add @genesislcap/rapid-design-system`、`bun add @genesislcap/rapid-design-system`

## README

[![lerna](https://img.shields.io/badge/maintained%20with-lerna-cc00ff.svg)](https://lerna.js.org/) [![TypeScript](https://img.shields.io/badge/%3C%2F%3E-TypeScript-%230074c1.svg)](https://www.typescriptlang.org/)

# 创世纪快速设计系统

这个包是一个设计系统(Rapid). 它建在顶上 `foundation-ui` ,并提供了一组无需附加配置即可使用的组件.

## [API 文档](https://npmcn.com/package/%40genesislcap/rapid-design-system/docs/api/index.md)

## 安装

要在应用程序中启用此模块, 请遵循以下步骤 .

1.  添加 `@genesislcap/rapid-design-system` 作为你 `package.json` 文档。 当您改变您的项目的依赖性时, 请确保您运行 `$ npm run bootstrap` 再次指挥。 您可以在 [软件包.json 基础](https://learn.genesis.global/secure/web/basics/package-json-basics/) 页 次.

```json
{
  "dependencies": {
    "@genesislcap/rapid-design-system'": "latest"
  },
}
```

## 建立设计系统

设置包括提供和登记设计系统组件 `rapid-design-system` 或其他地点。 这是你怎么做到的:

### 提供设计系统并登记所有部件

简单来说,在 `components.ts` 文件(或应用程序级设置的条目点),您提供了使用 `provideDesignSystem` 在设计系统上登记组件。 举个例子:

```typescript
import { baseComponents, provideDesignSystem } from '@genesislcap/rapid-design-system';

provideRapidDesignSystem().register(baseComponents);
```

在上述例子中, `baseComponents` 是同一设计系统组成部分的集合。 如果需要,您也可以注册额外的组件(即使来自其他设计系统,其前缀为 `rapid-` (见本报告).

### 登记特定组成部分

如果要注册特定组件,可以通过从设计系统导入并注册进行. 举个例子:

```typescript
import { rapidButton, rapidDesignSystemProvider, provideDesignSystem } from '@genesislcap/rapid-design-system';

provideRapidDesignSystem().register(
  /**
   * Design system provider element used to declaratively apply rapid config to every dom node in the host tree.
   */
  rapidDesignSystemProvider(),

  /**
   * Button component
   */
  rapidButton()
);
```

在上述例子中, `rapid-button` 将是唯一在快速设计系统中注册的组件。 YOu还可以同时注册多个组件:

```typescript
import { provideDesignSystem, rapidButton, rapidCard, rapidDesignSystemProvider, rapidnModal } from '@genesislcap/rapid-design-system';

provideDesignSystem().register(
  /**
   * Design system provider element used to declaratively apply rapid config to every dom node in the host tree.
   */
  rapidDesignSystemProvider(),

  /**
   * Components that will be registered in the Rapid Design System
   */
  rapidButton(),
  rapidCard(),
  rapidModal()
);
```

### 登记第三方部分

我们提供一些不属于设计系统包的"第三方"组件. 这些可以与其他设计系统组件一样进行注册. 举个例子:

```typescript
import { foundationLayoutComponents } from '@genesislcap/foundation-layout';
import { baseComponents, provideDesignSystem } from '@genesislcap/rapid-design-system';
import { g2plotChartsComponents } from '@genesislcap/g2plot-chart';
import { gridComponents } from '@genesislcap/grid-pro';

provideDesignSystem().register(
  baseComponents,

  /**
   * Third-party components
   */
  foundationLayoutComponents,
  g2plotChartsComponents,
  gridComponents
);
```

上面的例子记录了来自快速设计系统、基础布局、G2Plot Charts和Grid Pro的快速UI组件.

## 他们 `flexlayout-react`

[`flexlayout-react`](https://www.npmjs.com/package/flexlayout-react) 是第三方对接 应用程序安装本身的布局( 它没有被捆绑到基金会) 。 快速设计 系统拥有 **单一真相来源** 对于它的外观,所以主题永远不能掉出 跨应用程序同步。 平台主题 自成一体的样式表——出品人 `flexlayout-react` 基础主题 **加号** 快速的符号覆盖,所以应用程序应该 **永远** 导入 `flexlayout-react`本地的样式表或复制覆盖 .

从快速设计符号中解析出颜色, 所以渲染 `flexlayout-react` a 项下 `<rapid-design-system-provider>` (CSS自定义属性跨越阴影边界继承).

```typescript
// Light DOM: install once at app bootstrap (injects into document, idempotent).
import { installRapidFlexLayoutReactStyles } from '@genesislcap/rapid-design-system';

installRapidFlexLayoutReactStyles();
```

```typescript
// Shadow DOM: adopt the shared, cached stylesheet into the shadow root that hosts <Layout>.
import { getRapidFlexLayoutReactStyleSheet } from '@genesislcap/rapid-design-system';

shadowRoot.adoptedStyleSheets = [...shadowRoot.adoptedStyleSheets, getRapidFlexLayoutReactStyleSheet()];
```

也导出 : `rapidFlexLayoutReactStyleText` (滚动 CSS 字符串), `rapidFlexLayoutReactStyles` (预算外) `ElementStyles`),以及 `RAPID_FLEXLAYOUT_REACT_VERSION` (单位:千美元) `flexlayout-react` 版本 主题目标——见可选 `flexlayout-react` 相容性依赖性 范围).

### 保持主题

-   **编辑外观 :** 变动 `src/flexlayout-react-theme/flexlayout-react.overrides.css`,则 运行 `pnpm --filter @genesislcap/rapid-design-system flexlayout:generate` (软件包构建) 自动执行)。 超接被最后应用,所以它们战胜了基础主题.
-   **弹出 `flexlayout-react`数字 :** 在同一变化中重新生成主题 。 建筑的再生 `flexlayout-react-theme.generated.ts` 从已安装的版本, 所以一个没有 再生使工作树出脏,并失败了CI的"检查工作树"大门.

## 许可证

注:该项目提供前端依赖性,并使用下一节所列许可部件;因此,开发期间需要对这些部件发放许可证。 联系人 [创世纪全球](https://genesis.global/contact-us/) 更多细节.

### 许可组件

创世纪低码平台

## 常见问题

### @genesislcap/rapid-design-system 是什么？

快速设计系统

### 如何安装 @genesislcap/rapid-design-system？

在项目目录运行 npm install @genesislcap/rapid-design-system，或使用 pnpm add / yarn add / bun add。

### @genesislcap/rapid-design-system 支持 TypeScript 吗？

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

### @genesislcap/rapid-design-system 支持 ESM 还是 CommonJS？

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

### @genesislcap/rapid-design-system 可以商用吗？

@genesislcap/rapid-design-system 使用 SEE LICENSE IN license\.txt 许可。许可条款写在包内的独立文件中，请阅读该文件确认可否商用。以上为概括，不构成法律意见，请以许可原文为准。

### @genesislcap/rapid-design-system 的下载量有多少？

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

### @genesislcap/rapid-design-system 还在维护吗？

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

