# @biom3/design-tokens 中文文档

规范地址：https://npmcn.com/package/%40biom3/design-tokens/

版本：0\.4\.8
npm 元数据更新时间：2025-08-12T03:57:19.894Z
中文译文更新时间：2026-11-08T03:22:06.364Z
软件包许可：Apache-2\.0

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

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

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

- 包体积（解压后）：213 kB，11 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：1 个
- 首次发布：2022-12-02T05:10:12.995Z
- 最新版本发布：2025-08-12T03:57:19.636Z
- 近 30 天下载量：2762（2026-10-08 至 2026-11-06，npm 官方下载统计）
- 已发布版本数：52（近 12 个月 0 个）

## 中文简介

![BIOM3-textured-logos-10](https://user-images.githubusercontent.com/1452237/205792502-2b1e7d79-6f0e-42dc-a455-dbcb5506cef1.png)

## 安装

```sh
npm install @biom3/design-tokens
```

也可以使用：`pnpm add @biom3/design-tokens`、`yarn add @biom3/design-tokens`、`bun add @biom3/design-tokens`

## README

![BIOM3-textured-logos-10](https://user-images.githubusercontent.com/1452237/205792502-2b1e7d79-6f0e-42dc-a455-dbcb5506cef1.png)

# @ biom3/ 设计指针

本套件通过CIDCD向公众npm组件发布: `@biom3/design-tokens`。要读取更多信息,请查看主题和标识 [建议文件](https://immutable.atlassian.net/wiki/spaces/DS/pages/2031452551/Proposal+Theming+Tokenisation)。 。 。 .

要了解整个设计-托肯分类学的概况,看看这个 [文档](https://immutable.atlassian.net/wiki/spaces/DS/pages/2032304280/Development+of+Design+Token+Taxonomy)。 。 。 .

## 里面有什么东西?

通过这个组件,我们暴露了我们完整的BIOME设计符文库. 它们是作为以下两种用途提供的:

1.  导出类型字符串,以及
2.  css 可导入的 cs 文件内的可变定义

### 使用 ts Const 设计符号:

要使用打字机的设计-托盘,只需从pakakge的根部导入. 例如:

```typescript
import { base } from '@biom3/design-tokens';
```

BIOME的默认颜色方案是"Light". 因此,当您导入 `base`,或 `onLightBase` 设计指针,只有灯光颜色和梯度.

要使用这些设计到的变量 :

```typescript
import {
  onDarkBase,
  onLightBase,
  smartPickTokenValue,
} from '@biom3/design-tokens';
const DemoComponent = () => (
  <div
    style={{
      fontSize: onLightBase.text.body.medium.regular.fontSize,
      color: smartPickTokenValue(onDarkBase, 'base.color.brand.1'),
    }}
  >
    test component text
  </div>
);
```

### 使用 Cs-可变设计托盘:

通过从您的 App 代码导入 cs 文件,所有 BIOME 设计- tokens 都可以被导入并用作简单的 cs- 可变文件 。 例如:

```typescript
import '@biom3/design-tokens/css/base-onLight.global.css'; // contains all "onLight" BASE design-tokens
// import "@biom3/design-tokens/css/base-onDark.global.css"; // contains all "onDark" BASE design-tokens
import '@biom3/design-tokens/css/text.global.css'; // contains all fonts (@font-face) imports
```

**\\ N注** 所有cs-可变声明都是全局样式被范围化到正文选择器上,因此基站设计-token文件会互相覆盖,因此每次只应该使用1个基站设计-token css文件. 根据您是否计划在"OnDark"或"onLight"中显示UI(或者添加您自己的!)来选择主题 Css 文件.

要看到所有可用的可变设计-token css-vatables的完整列表,您可以检查您浏览器的dev工具中的身体元素. 例如:

![Screenshot 2022-12-07 at 11 32 00 am](https://user-images.githubusercontent.com/1452237/206057460-40555c71-5089-476d-a853-3ec48f8718b5.png)

然后,为了使用这些cs-可变设计托盘:

```css
/* some custom styles.css file: */
@import '@biom3/design-tokens/css/base-onDark.global.css';
@import '@biom3/design-tokens/css/text.global.css';

/* your bespoke item class styles */
.headingText {
  color: var(--base-color-brand-1);
}
```

## 常见问题

### 如何安装 @biom3/design-tokens？

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

### @biom3/design-tokens 支持 TypeScript 吗？

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

### @biom3/design-tokens 支持 ESM 还是 CommonJS？

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

### @biom3/design-tokens 可以商用吗？

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

### @biom3/design-tokens 的下载量有多少？

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

### @biom3/design-tokens 还在维护吗？

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