@carbon/web-components

中文文档
2.67.0发布于 2026/11/04Apache-2.0TypeScriptES Module构建来源已验证近 30 天下载 10.9万

碳设计系统的网络组件

中文使用文档
文档目录8 节
  1. 安装
  2. 使用量
  3. 光盘N
  4. 准备为 v3
  5. 文档
  6. 捐款
  7. 许可证
  8. IBM 遥测

@ 碳/ 网络组件

碳设计系统的Web组件.

安装

npm install @carbon/web-components

使用量

这个 @carbon/web-components 包提供了碳设计组件 系统.

要使用一个组件,可以直接从包中导入:

import '@carbon/web-components/es/components/dropdown/dropdown.js';
import '@carbon/web-components/es/components/dropdown/dropdown-item.js';

一旦导入组件模块,您就可以使用其中的组件 与本地 HTML 标记相同的方式 :

<cds-dropdown trigger-content="Select an item">
  <cds-dropdown-item value="all">Option 1</cds-dropdown-item>
  <cds-dropdown-item value="cloudFoundry">Option 2</cds-dropdown-item>
  <cds-dropdown-item value="staging">Option 3</cds-dropdown-item>
  <cds-dropdown-item value="dea">Option 4</cds-dropdown-item>
  <cds-dropdown-item value="router">Option 5</cds-dropdown-item>
</cds-dropdown>

光盘N

CDN 文物也可以直接添加到页面中(开始) 版本时 v1.16.0:

<!doctype html>
<html>
  <head>
    <script
      type="module"
      src="https://1.www.s81c.com/common/carbon/web-components/version/v2.65.0/dropdown.min.js"></script>
    <style type="text/css">
      <!-- hide custom element until it has been defined //-->
      cds-dropdown:not(:defined),
      cds-dropdown-item:not(:defined) {
        visibility: hidden;
      }
    </style>
  </head>
  <body>
    <div id="app">
      <cds-dropdown trigger-content="Select an item">
        <cds-dropdown-item value="all">Option 1</cds-dropdown-item>
        <cds-dropdown-item value="cloudFoundry">Option 2</cds-dropdown-item>
        <cds-dropdown-item value="staging">Option 3</cds-dropdown-item>
        <cds-dropdown-item value="dea">Option 4</cds-dropdown-item>
        <cds-dropdown-item value="router">Option 5</cds-dropdown-item>
      </cds-dropdown>
    </div>
  </body>
</html>

准备为 v3

下一个主要发行(v3)会改变组件的注册方式. 见 v3 迁移指南 准备.

现在可以了. 选择加入的API—— defineCustomElement (单位:千美元)es/globals/register.js)和 static is 标签字段 – 在 v2 中可用 , 今天你可以写出v3准备的代码.

折旧(将在v3中删除):

  • 这个 carbonElement 装饰 (单位:千美元)es/globals/decorators/carbon-element.js, (中文(简体) ), 用于自定义元素的作者 – 迁移到 Lit 的 customElement (单位:千美元)import { customElement } from 'lit/decorators.js') (中文(简体) ).
  • 这个 es-custom 构建 (单位:千美元)cds-custom-* 元素),被自定义标签所取代 名称、前缀构建和范围登记.
  • 这个 custom-elements.json WCA 列表,替换为标准自定义 《要点宣言》.

闯入 v3 : 在 v3 中, 导入一个组件的类文件 登记其要素,例如导入 button/button.js 改为 button/index.js。使用 v3 标记 - 从 feat/web-components-v3 树枝.

文档

组成部分文件和使用指南见:

捐款

见 贡献指南。 。 。 .

许可证

凭 Apache 2.0 许可证。 。 。 .

IBM Telemetry IBM 遥测

本套件使用 IBM 遥测来收集去识别和匿名的度量衡 数据。 通过安装此包作为依赖, 您同意远程测量 藏书。 选择退出,看 选择退出IBM遥测数据收集。 。 。 . 有关所收集数据的更多信息,请参见: IBM 遥测文档。 。 。 .

版本与发布记录

@carbon/web-components 共发布 1,219 个版本,首次发布于 2022/12/07;过去 12 个月发布了 58 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
2.67.0latest2026/11/044 天前
2.67.0-rc.0next2026/11/035 天前
3.0.0-alpha.5v12-alpha2026/10/2812 天前
3.0.0-alpha.42026/10/2218 天前
2.66.02026/10/2119 天前
2.66.0-rc.02026/10/2020 天前

其他发布通道:v1-latest → 1.47.1,v12-alpha → 3.0.0-alpha.5,next → 2.67.0-rc.0。

关于 @carbon/web-components 的常见问题

@carbon/web-components 是什么?

碳设计系统的网络组件

如何安装 @carbon/web-components?

在项目目录运行 npm install @carbon/web-components,或使用 pnpm add / yarn add / bun add。它还提供命令行工具 create-prefixed-build,可以用 npx create-prefixed-build 直接运行。

@carbon/web-components 支持 TypeScript 吗?

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

@carbon/web-components 支持 ESM 还是 CommonJS?

以 ES Module 形式发布,推荐使用 import 引入。在 CommonJS 项目中,Node.js 20.19+ / 22.12+ 可以直接 require() 不含顶层 await 的 ES Module,更早的版本需要改用动态 import()。

@carbon/web-components 可以商用吗?

@carbon/web-components 使用 Apache-2.0 许可。宽松许可:允许商业使用、修改和再分发,并附带明确的专利授权;分发时需保留许可与 NOTICE 文件,修改过的文件要注明改动。以上为概括,不构成法律意见,请以许可原文为准。

@carbon/web-components 的下载量有多少?

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

@carbon/web-components 还在维护吗?

最新版本 2.67.0 发布于 2026/11/04(4 天前);至今共发布 1219 个版本,其中过去 12 个月发布了 58 个;首次发布于 2022/12/07。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。