# @risklab/ui 中文文档

规范地址：https://npmcn.com/package/%40risklab/ui/

版本：1\.1\.0
npm 元数据更新时间：2026-11-02T07:42:40.149Z
中文译文更新时间：2026-11-02T08:26:36.036Z
软件包许可：Apache-2\.0

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

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

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

- 包体积（解压后）：1.2 MB，648 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- Node.js 要求：\>=20\.0\.0
- 运行依赖：0 个
- 首次发布：2026-11-02T07:40:31.549Z
- 最新版本发布：2026-11-02T07:42:39.973Z
- 已发布版本数：3（近 12 个月 3 个）

## 中文简介

@risklab/ui -独立的香草Web组件ui库。根安装用于无框架包表面。

## 安装

```sh
npm install @risklab/ui
```

也可以使用：`pnpm add @risklab/ui`、`yarn add @risklab/ui`、`bun add @risklab/ui`

## README

# @risklab / ui

`@risklab/ui` 是独立的香草RiskLab UI包。

当你需要的时候使用它：

-   与框架无关的Web组件
-   零运行时依赖项
-   一个可以放入静态站点、指示板、信息亭或混合堆栈的包
-   与其他RiskLab UI包使用的CSS令牌系统相同

如果您正在构建React应用程序，请选择 `@risklab/ui-react`.

## 安装

```bash
npm install @risklab/ui
```

## 快速启动

```ts
import "@risklab/ui/auto";
import "@risklab/ui/css";

document.body.innerHTML = `
  <div class="ui-root">
    <ui-button variant="filled" color="primary">Run report</ui-button>
    <ui-text-field label="Search" placeholder="Find assets"></ui-text-field>
  </div>
`;
```

使用 `@risklab/ui/auto` 当您希望注册所有内置自定义元素时。 如果需要更多的控制，请从 `@risklab/ui/inputs`， `@risklab/ui/layout`， `@risklab/ui/data-display`，和 其他类别入口点。

## 样式和标记

```ts
import "@risklab/ui/css";
```

RiskLab UI使用CSS自定义属性，因此它可以存在于现有的设计中 系统没有强制一个视觉识别。

```css
:root {
  --ui-color-primary: #0057d9;
  --ui-color-surface: #ffffff;
  --ui-color-text: #111827;
  --ui-font-family: "Segoe UI", sans-serif;
  --ui-radius-md: 6px;
}
```

暗模式是通过选择加入的 `[data-ui-theme="dark"]` 或者 `.ui-dark`.

## 包笔记

-   `@risklab/ui` 是默认的香草包。
-   `@risklab/ui-vanilla` 为喜欢显式的团队提供相同的模型 包命名对称 `@risklab/ui-react`， `@risklab/ui-vue`，和 其他框架包。
-   发布的包表面没有安装时依赖项。

## 常见问题

### @risklab/ui 是什么？

@risklab/ui -独立的香草Web组件ui库。根安装用于无框架包表面。

### 如何安装 @risklab/ui？

在项目目录运行 npm install @risklab/ui，或使用 pnpm add / yarn add / bun add。

### @risklab/ui 支持 TypeScript 吗？

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

### @risklab/ui 支持 ESM 还是 CommonJS？

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

### @risklab/ui 需要什么版本的 Node\.js？

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

### @risklab/ui 可以商用吗？

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

### @risklab/ui 还在维护吗？

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