# @castlabs/ui 中文文档

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

版本：8\.8\.1
npm 元数据更新时间：2026-10-22T10:48:28.302Z
中文译文更新时间：2026-11-09T09:48:26.928Z
软件包许可：未声明

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

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

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

- 包体积（解压后）：49.3 MB，372 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- Node.js 要求：^22\.18\.0 \|\| \>=24\.12\.0
- 运行依赖：2 个
- 首次发布：2024-11-08T13:56:21.918Z
- 最新版本发布：2026-10-22T10:48:28.016Z
- 近 30 天下载量：3064（2026-10-09 至 2026-11-07，npm 官方下载统计）
- 已发布版本数：117（近 12 个月 58 个）

## 中文简介

用于 Castlabs 的香草 HTML/CS/JS & Vue.js 组件库.

## 安装

```sh
npm install @castlabs/ui
```

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

## README

# 石板 - ui

这是用于Castlabs品牌网站的香草HTML和Vue.js组件库.

## 使用 `@castlabs/ui` npm 项目

这是一个公共的国家预防机制一揽子计划,通过下列途径补充:

-   `npm install @castlabs/ui`

## 使用 `@castlabs/ui` 3个项目

使用 `ui-boilerplate-vue` 演示项目,它预设了UI lib.

## 使用 `@castlabs/ui` 在角项目中

采取上述步骤 _使用 `@castlabs/ui` npm 项目_编辑 `angular.json` 文件并添加样式文件到您的 `projects` 节:

```
"assets": [
  { "glob": "favicon.ico", "input": "node_modules/@castlabs/ui/dist/favicon", "output": "/" },
  { "glob": "favicon.svg", "input": "node_modules/@castlabs/ui/dist/favicon", "output": "/" },
  { "glob": "*", "input": "node_modules/@castlabs/ui/dist/favicon", "output": "favicon/" },
  "src/assets"
],
"styles": [
  "src/styles.scss"
],
```

创建/编辑您的 `src/style.scss` 文件并添加:

```
@use '@castlabs/ui/src/styles/ui' with (
  $castlabs-ui-asset-prefix: '../..'
);
```

用我们的 `$cl-*` 组件中的 SCSS 变量 `*.scss` 文件,在上方添加:

```
@use '@castlabs/ui/src/styles/global' as *;
```

要使用我们的 cl\* 帮助 js 方法( cs ModalShow 在以下示例中), 请导入您的 TS 文件 :

```
import { clModalShow } from '@castlabs/ui/dist/castlabs-ui.module.js'
```

您可以使用代码/模板中的助手 :

```
<!-- TS --->
export class ... {
  ...
  clModalShow = (id: string): void => clModalShow(id)
  ...
}

<!-- HTML --->
<button class="btn cl-color-red" (click)="clModalShow('mymodal')">click me</button>
```

最后,可能或不需要复制 `node_modules/@castlabs/ui/dist/castlabs-ui.module.d.ts` 进入您的源树, 供本地的 IDE 接收所有类型 。 角构件应能够直接从节点模块取出.

## 要使用的.js 文件

我们的图书馆j有多种变体可用. 根据您的需要:

-   `castlabs-ui.core.js` 被静态/vanilla JS项目使用

## 常见问题

### @castlabs/ui 是什么？

用于 Castlabs 的香草 HTML/CS/JS & Vue\.js 组件库\.

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

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

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

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

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

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

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

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

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

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

### @castlabs/ui 的下载量有多少？

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

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

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