# @clay-design-system/email 中文文档

规范地址：https://npmcn.com/package/%40clay-design-system/email/

版本：0\.3\.12
npm 元数据更新时间：2026-11-09T17:26:46.776Z
中文译文更新时间：2026-11-10T00:34:20.371Z
软件包许可：未声明

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

原始 npm 页面：https://www.npmjs.com/package/%40clay-design-system/email
原文对照：https://npmcn.com/package/%40clay-design-system/email/?lang=original

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

- 包体积（解压后）：3.4 MB，86 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：1 个
- 首次发布：2026-10-13T06:46:54.785Z
- 最新版本发布：2026-11-09T17:26:46.437Z
- 近 30 天下载量：2166（2026-10-10 至 2026-11-08，npm 官方下载统计）
- 已发布版本数：18（近 12 个月 18 个）

## 中文简介

这个 **生命周期/ 电子邮件** clay 设计系统的分级 —— 响应, Outlook- safe HTML 电子邮件 **MJML 战时** 由共同的克莱基金会标志物组成.

## 安装

```sh
npm install @clay-design-system/email
```

也可以使用：`pnpm add @clay-design-system/email`、`yarn add @clay-design-system/email`、`bun add @clay-design-system/email`

## README

# @clay-design-system/电子邮件

这个 **生命周期/ 电子邮件** clay 设计系统的级别——响应,Outlook-sefect HTML电子邮件 作者于 **MJML 战时** 由共同的克莱基金会标志物组成.

## 为什么 MJML + 内嵌符

电子邮件客户端(特别是Outlook) **没有** 支持 CSS 自定义属性( C)`var(--clay-*)`) (中文(简体) ). 所以这个 包件从不载运 `var()` ——取而代之的建设步骤读取已解决的字面符号值来自: `@clay-design-system/tokens` (单位:千美元) `dist/tokens.js` 出口)和 **内嵌** 他们进入MJML 在建设时间.

```
@clay-design-system/tokens (JS literals)
   ↓  src/tokens/build-email-tokens.ts   (generates)
src/generated/base-head.mjml   ← <mj-head>: fonts, mj-class roles, dark-mode
src/generated/email-tokens.ts  ← inline-able constants + px() helper
   ↓  MJML sections + container
src/build/compile.ts  (mjml2html)
   ↓
dist/emails/<name>.html         ← standalone, previewable
dist/emails/<name>.braze.html   ← Braze full-template variant (unsubscribe token)
dist/emails/<name>.static.html  ← hand-authored fallback (no MJML)
dist/catalog.json               ← Storybook + docs source
```

## 结构

-   `src/container/` 共享的电子邮件外壳(page bg ~ 640px卡 ~ 560px 内部,预发页, 响应 + 暗/光)。 每封邮件都会重用.
-   `src/sections/` —— MJML 部分(log-header,英雄,特征集,图标-feature-list, 按钮主页脚.
-   `src/emails/` ——完整的电子邮件组成(容器+部分)外加静态-HTML倒置. **吉特尼奥德/ 仅限本地 :** 每封邮件都是一代人 所以放在机器上 这使得它和贡献者 从来没有看到对方的运动。 构造将此文件夹模糊于 编译时间,从而产生它的工作没有改变——它根本不是承诺的。 一个新的克隆 在此开始为空; `src/examples/` 持有承诺的Email Love – Braze参考出口.
-   `src/tokens/` - 代号 - 电子邮件桥码源.
-   `src/build/` ——MJML编译+Braze变换+目录.

## 脚本

```bash
pnpm --filter @clay-design-system/email build          # tokens bridge → tsc → compile MJML
pnpm --filter @clay-design-system/email dev            # watch + recompile MJML
pnpm --filter @clay-design-system/email tokens:check   # fail if generated token artifacts drift
pnpm --filter @clay-design-system/email test           # vitest
```

## 什么Npm包装船

只有公众表面: `dist/index.js` + 类型(内含符号常数), `@clay-design-system/email/catalog.json`, (中文(简体) ), `…/emails/*` (已编译 HTML, Braze和静态变种. 原始地图, `dist/build`, (中文(简体) ), `dist/examples` 财务报告和审定财务报表 `dist/exports` ( " 布雷兹 " 运动的出口与 图像, ~ 11 MB) 保留在 repo 中: 它们是构建输出, 无法通过 `exports` 地图. `package.json` `files` 是一个 plainlist,所以新的构建输出在添加到那里之前不会被发布.

在故事书下记录 **生命周期/电子邮件/**。 。 。 .

## 常见问题

### @clay-design-system/email 是什么？

这个 生命周期/ 电子邮件 clay 设计系统的分级 —— 响应, Outlook- safe HTML 电子邮件 MJML 战时 由共同的克莱基金会标志物组成\.

### 如何安装 @clay-design-system/email？

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

### @clay-design-system/email 支持 TypeScript 吗？

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

### @clay-design-system/email 支持 ESM 还是 CommonJS？

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

### @clay-design-system/email 可以商用吗？

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

### @clay-design-system/email 的下载量有多少？

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

### @clay-design-system/email 还在维护吗？

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