# @cds/core 中文文档

规范地址：https://npmcn.com/package/%40cds/core/

版本：6\.17\.0
npm 元数据更新时间：2026-02-18T12:40:08.610Z
中文译文更新时间：2026-11-09T06:45:03.070Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40cds/core
原文对照：https://npmcn.com/package/%40cds/core/?lang=original
项目主页：https://core.clarity.design/
源码仓库：https://github.com/vmware-clarity/core

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

- 包体积（解压后）：7.1 MB，2340 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：5 个
- 首次发布：2020-12-02T17:38:15.578Z
- 最新版本发布：2026-02-02T11:56:59.549Z
- 近 30 天下载量：99237（2026-10-10 至 2026-11-08，npm 官方下载统计）
- 已发布版本数：98（近 12 个月 1 个）

## 中文简介

清晰设计系统 -- -- 共同组件、主题和用途

## 安装

```sh
npm install @cds/core
```

也可以使用：`pnpm add @cds/core`、`yarn add @cds/core`、`bun add @cds/core`

## README

# 清晰的核心网络组件 [![npm version](https://badge.fury.io/js/%40clr%2Fcore.svg)](https://badge.fury.io/js/%40clr%2Fcore)

清晰核心是用于 [清晰设计系统](https://clarity.design/storybook/core)。 。 。 .

## 快速启动安装

1.  首先从 npm 安装 Clarity Core 包 .
    
    ```bash
    npm install @cds/core --save
    ```
    
2.  将想要的 Web 组件导入到您的 JavaScript 或 TypeScript
    
    ```typescript
    import '@cds/core/modal/register.js';
    ```
    

完整的安装步骤可见于 [核心启动指南](https://clarity.design/storybook/core/?path=/story/documentation-getting-started--page)。 。 。 .

## 使用量

### 无框架

```html
<cds-modal size="lg">
  <p>slot content</p>
</cds-modal>
<script>
  const modal = document.querySelector('cds-modal');
  modal.addEventListener('closeChange', event => console.log(event));
  modal.closable = true;
</script>
```

### 角质

```html
<!--
  - `size` is set as an HTML attribute so no binding syntax is used
  - [closable] is setting a property on the element
  - (closeChange) is listening for the `closeChange` custom event
-->

<cds-modal size="lg" [closable]="booleanValue" (closeChange)="log($event.detail)">
  <p>slot content</p>
</cds-modal>
```

### 阴道

```html
<!--
  - `size` is set as an HTML attribute so no binding syntax is used
  - :closable is setting a property on the element
  - @closeChange is listening for the `closeChange` custom event
-->

<cds-modal size="lg" :closable="booleanValue" @closeChange="log($event.detail)">
  <p>slot content</p>
</cds-modal>
```

### 通过 `@cds/react` 软件包

```jsx
/*
  - `size` unlike the examples above `size` is set as a property
  - closable is setting a property on the element
  - onCloseChange is listening for the `closeChange` custom event
*/
<CdsModal size="lg" closable={this.state.booleanValue} onCloseChange={this.log}>
  <p>slot content</p>
</CdsModal>
```

## 常见问题

### @cds/core 是什么？

清晰设计系统 -- -- 共同组件、主题和用途

### 如何安装 @cds/core？

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

### @cds/core 支持 TypeScript 吗？

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

### @cds/core 支持 ESM 还是 CommonJS？

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

### @cds/core 可以商用吗？

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

### @cds/core 的下载量有多少？

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

### @cds/core 还在维护吗？

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