# @sesamehr/react-design-system 中文文档

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

版本：3\.14\.0
npm 元数据更新时间：2026-11-02T10:33:20.789Z
中文译文更新时间：2026-11-02T11:22:40.431Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：1.7 MB，1020 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：33 个
- peer 依赖：react ^18\.3\.0 \|\| ^19\.0\.0，react-dom ^18\.3\.0 \|\| ^19\.0\.0，tailwindcss ^4\.1\.7，@tiptap/core ^2\.27\.0，@tiptap/react ^2\.27\.0，@tiptap/starter-kit ^2\.27\.0，@tiptap/extension-link ^2\.27\.0，@tiptap/extension-underline ^2\.27\.0
- 首次发布：2026-07-21T15:12:41.798Z
- 最新版本发布：2026-11-02T10:33:20.576Z
- 已发布版本数：58（近 12 个月 58 个）

## 中文简介

芝麻HR React设计系统-组件和设计令牌

## 安装

```sh
npm install @sesamehr/react-design-system
```

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

## README

# @sesamehr / react-design-system

为Sesame HR设计系统反应组件和设计令牌。

📖 **[组件的文档](https://storybook.sesametime.com/)** -这个包裹 故事书。真理的源头有它自己的方式 [vue-storybook.sesametime.com](https://vue-storybook.sesametime.com/).

## 安装

```bash
npm install @sesamehr/react-design-system react react-dom tailwindcss
```

## 使用

在应用程序入口处导入一次样式表：

```tsx
import '@sesamehr/react-design-system/style.css';
```

该样式表只绘制这个包的组件。它没有携带 重置并且没有实用程序类，因此导入它不能重新设计应用程序的样式 周围-看 [样式表不能做的事情](https://npmcn.com/package/%40sesamehr/react-design-system/#readme-what-the-stylesheet-does-not-do).

导出每个组件 `Ox` 前缀:

```tsx
import {
  OxAvatar,
  OxButton,
  OxFieldGroup,
  OxFieldLabel,
  OxFieldMessage,
  OxInputText,
} from '@sesamehr/react-design-system';
import { useState } from 'react';

export function Example() {
  const [email, setEmail] = useState('');

  return (
    <>
      <OxAvatar initials="SH" size="lg" dataTestid="user-avatar" />

      <OxFieldGroup variant="error">
        <OxFieldLabel htmlFor="email">Email</OxFieldLabel>
        <OxInputText
          id="email"
          field={email}
          onFieldChange={setEmail}
          placeholder="you@example.com"
        />
        <OxFieldMessage variant="error">Invalid email</OxFieldMessage>
      </OxFieldGroup>

      <OxButton variant="default">Save</OxButton>
    </>
  );
}
```

### 设计令牌

样式表已经包含了令牌。来 `@reference` 原始令牌层 从你自己的Tailwind设置：

```css
@import '@sesamehr/react-design-system/assets/styles/mainTheme.css';
```

### 样式表不能做的事情

`style.css` 包含此包的组件规则及其令牌。它 故意做 **不** 包含:

-   **起飞前的**，或任何其他全局重置。组件假设为1 -它们是 写对 `box-sizing: border-box`， `button { font: inherit }` 和 Rest -但是安装它是应用程序的调用，而不是库的调用。如果你的 应用程序有顺风，你已经有了。如果没有：
    
    ```ts
    import '@sesamehr/react-design-system/preflight.css';
    ```
    
-   **实用工具类。** 否 `.h-10`,没有 `.p-4`,没有 `.bg-brand`。每个组件 有它自己的 `ox`类，并将声明编译到其中， 所以这里的任何东西都不会与您自己的同名实用程序发生冲突 顺风建筑从你的天平上散发出来。
    

组件规则在内部发布 `@layer components`这是顺风应用的所在地 已经对它们进行了排序：之后 `base`之前, `utilities`。你传入一个实用程序 赢了, `<Button className="w-full">` 是全宽-不需要 `!important`.

令牌在an下发布 `--ox-` 前缀:覆盖 `--ox-color-brand-500` 重新主题，不是 `--color-brand-500`。没有前缀，这些是Tailwind的名字 自己使用，并宣布他们在 `:root` 会改变每一个 `rounded-2xl` 在您的应用程序中意味着。

## 许可证

MIT©Sesame HR

## 常见问题

### @sesamehr/react-design-system 是什么？

芝麻HR React设计系统-组件和设计令牌

### 如何安装 @sesamehr/react-design-system？

在项目目录运行 npm install @sesamehr/react-design-system，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：react（^18\.3\.0 \|\| ^19\.0\.0）、react-dom（^18\.3\.0 \|\| ^19\.0\.0）、tailwindcss（^4\.1\.7）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @sesamehr/react-design-system 支持 TypeScript 吗？

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

### @sesamehr/react-design-system 支持 ESM 还是 CommonJS？

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

### @sesamehr/react-design-system 可以商用吗？

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

### @sesamehr/react-design-system 还在维护吗？

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