# @boxyhq/react-ui 中文文档

规范地址：https://npmcn.com/package/%40boxyhq/react-ui/

版本：3\.6\.0
npm 元数据更新时间：2026-09-11T13:36:07.253Z
中文译文更新时间：2026-11-08T12:52:51.762Z
软件包许可：Apache-2\.0

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

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

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

- 包体积（解压后）：1.1 MB，102 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：3 个
- peer 依赖：react ^16\.8\.0 \|\| ^17\.0\.0 \|\| ^18\.0\.0 \|\| ^19\.0\.0，react-dom ^16\.8\.0 \|\| ^17\.0\.0 \|\| ^18\.0\.0 \|\| ^19\.0\.0
- 首次发布：2022-12-13T17:31:14.777Z
- 最新版本发布：2026-09-11T13:36:06.914Z
- 近 30 天下载量：27685（2026-10-09 至 2026-11-07，npm 官方下载统计）
- 已发布版本数：107（近 12 个月 3 个）

## 中文简介

BoxyHQ 的 UI 组件

## 安装

```sh
npm install @boxyhq/react-ui
```

也可以使用：`pnpm add @boxyhq/react-ui`、`yarn add @boxyhq/react-ui`、`bun add @boxyhq/react-ui`

## README

# @boxyhq/反应-ui

UI 组件来自 [总部](https://boxyhq.com/) 用于插件和游戏的企业特性.

## 安装

`npm install @boxyhq/react-ui --save`

## 使用量

### SSO 登录组件

使用SSO登录组件主要有两种方式,概述如下:

#### 预设值 `ssoIdentifier`

如果一个值被传递到 `ssoIdentifier`中,它会生成一个按钮,在点击时用 `ssoIdentifier` 数值。 处理器然后可以启动重定向到SSO服务,转发求解器的值.

```tsx
import { Login as SSOLogin } from '@boxyhq/react-ui/sso';

const onSSOSubmit = async (ssoIdentifier: string) => {
  // Below calls signIn from next-auth. Replace this with whatever auth lib that you are using.
  await signIn('boxyhq-saml', undefined, { client_id: ssoIdentifier });
};

<SSOLogin
  buttonText={'Login with SSO'}
  ssoIdentifier={`tenant=${tenant}&product=${product}`}
  onSubmit={onSSOSubmit}
  classNames={{
    container: 'mt-2',
    button: 'btn-primary btn-block btn rounded-md active:-scale-95',
  }}
/>;
```

#### 接受用户输入 `ssoIdentifier`

如果一个值没有传递到 `ssoIdentifier`,它将为用户输入 `ssoIdentifier` 数值。 然后在提交时,数值被传递给处理者. 处理器然后可以启动重定向到SSO服务,转发求解器的值.

```tsx
import { Login as SSOLogin } from '@boxyhq/react-ui/sso';

const onSSOSubmit = async (ssoIdentifier: string) => {
  // Below calls signIn from next-auth. Replace this with whatever auth lib that you are using.
  await signIn('boxyhq-saml', undefined, { client_id: ssoIdentifier });
};

<SSOLogin
  buttonText={'Login with SSO'}
  onSubmit={onSSOSubmit}
  classNames={{
    container: 'mt-2',
    label: 'text-gray-400',
    button: 'btn-primary btn-block btn rounded-md active:-scale-95',
    input: 'input-bordered input mb-5 mt-2 w-full rounded-md',
  }}
/>;
```

#### 样式

如果类名道具被传入, 我们可以覆盖每个内元素的默认样式 。 如果在类名道具中省略出一个内在元素,则为该元素设置默认样式。 例如: 在下面的片段中,所有内元素的样式都是通过每个内元素在类名中的相传来来进行.

```tsx
<SSOLogin
  buttonText={'Login with SSO'}
  onSubmit={onSSOSubmit}
  classNames={{
    container: 'mt-2',
    label: 'text-gray-400',
    button: 'btn-primary btn-block btn rounded-md active:-scale-95',
    input: 'input-bordered input mb-5 mt-2 w-full rounded-md',
  }}
/>
```

通过风格属性的造型也被支持每个内元素.

## 常见问题

### @boxyhq/react-ui 是什么？

BoxyHQ 的 UI 组件

### 如何安装 @boxyhq/react-ui？

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

### @boxyhq/react-ui 支持 TypeScript 吗？

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

### @boxyhq/react-ui 支持 ESM 还是 CommonJS？

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

### @boxyhq/react-ui 可以商用吗？

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

### @boxyhq/react-ui 的下载量有多少？

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

### @boxyhq/react-ui 还在维护吗？

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