# @gusto/embedded-react-sdk 中文文档

规范地址：https://npmcn.com/package/%40gusto/embedded-react-sdk/

版本：0\.59\.0
npm 元数据更新时间：2026-11-13T17:46:34.306Z
中文译文更新时间：2026-11-17T04:03:39.215Z
软件包许可：Apache-2\.0

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

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

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

- 包体积（解压后）：12.1 MB，4172 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：17 个
- peer 依赖：react ^18\.0\.0 \|\| ^19\.0\.0，react-dom ^18\.0\.0 \|\| ^19\.0\.0，typescript ^5\.8\.3，@tanstack/react-query ^5
- 首次发布：2024-10-24T18:53:29.677Z
- 最新版本发布：2026-11-13T17:46:33.900Z
- 近 30 天下载量：10684（2026-10-17 至 2026-11-15，npm 官方下载统计）
- 已发布版本数：155（近 12 个月 100 个）

## 中文简介

[![CI](https://github.com/Gusto/embedded-react-sdk/actions/workflows/ci.yaml/badge.svg)](https://github.com/Gusto/embedded-react-sdk/actions/workflows/ci.yaml)

## 安装

```sh
npm install @gusto/embedded-react-sdk
```

也可以使用：`pnpm add @gusto/embedded-react-sdk`、`yarn add @gusto/embedded-react-sdk`、`bun add @gusto/embedded-react-sdk`

## README

# Gusto 嵌入式重现 SDK

[![CI](https://github.com/Gusto/embedded-react-sdk/actions/workflows/ci.yaml/badge.svg)](https://github.com/Gusto/embedded-react-sdk/actions/workflows/ci.yaml)

要安装 :

```bash
npm add @gusto/embedded-react-sdk
```

## SDK Dev App 软件

具有活性API数据的SDK组件的建置和测试的独立开发应用 [`sdk-app/`](https://npmcn.com/package/%40gusto/embedded-react-sdk/sdk-app/)要开始 :

```bash
npm run sdk-app              # Demo environment (default)
npm run sdk-app:staging      # Staging environment
```

见 [SDK Dev 应用读取器](https://npmcn.com/package/%40gusto/embedded-react-sdk/sdk-app/README.md) 完整设置和使用细节.

## 文档

-   [决定用 SDK 建造](https://npmcn.com/package/%40gusto/embedded-react-sdk/docs/deciding-to-build-with-the-sdk/deciding-to-build-with-the-sdk.md)
    -   [构建路径 - SDK, 流和 API](https://npmcn.com/package/%40gusto/embedded-react-sdk/docs/deciding-to-build-with-the-sdk/build-pathways-sdk-flows-api.md)
    -   [组件类型](https://npmcn.com/package/%40gusto/embedded-react-sdk/docs/deciding-to-build-with-the-sdk/component-types.md)
-   [开始](https://npmcn.com/package/%40gusto/embedded-react-sdk/docs/getting-started/getting-started.md)
    -   [认证](https://npmcn.com/package/%40gusto/embedded-react-sdk/docs/getting-started/authentication.md)
-   [融合指南](https://npmcn.com/package/%40gusto/embedded-react-sdk/docs/integration-guide/integration-guide.md)
    -   [版本](https://npmcn.com/package/%40gusto/embedded-react-sdk/docs/integration-guide/versioning.md)
    -   [事件处理](https://npmcn.com/package/%40gusto/embedded-react-sdk/docs/integration-guide/event-handling.md)
    -   [事件类型](https://npmcn.com/package/%40gusto/embedded-react-sdk/docs/reference/events.md)
    -   [处理错误](https://npmcn.com/package/%40gusto/embedded-react-sdk/docs/integration-guide/error-handling.md)
    -   [组成](https://npmcn.com/package/%40gusto/embedded-react-sdk/docs/integration-guide/composition.md)
    -   [提供你自己的数据](https://npmcn.com/package/%40gusto/embedded-react-sdk/docs/integration-guide/providing-your-own-data.md)
    -   [翻译](https://npmcn.com/package/%40gusto/embedded-react-sdk/docs/integration-guide/translation.md)
    -   [路线](https://npmcn.com/package/%40gusto/embedded-react-sdk/docs/integration-guide/routing.md)
    -   [请求截取器](https://npmcn.com/package/%40gusto/embedded-react-sdk/docs/integration-guide/request-interceptors.md)
    -   [自定义 SDK 用户界面](https://npmcn.com/package/%40gusto/embedded-react-sdk/docs/integration-guide/customizing-sdk-ui.md)
    -   [观察性](https://npmcn.com/package/%40gusto/embedded-react-sdk/docs/integration-guide/observability.md)
    -   [可观察性实例](https://npmcn.com/package/%40gusto/embedded-react-sdk/docs/integration-guide/observability-examples.md)
-   [他们](https://npmcn.com/package/%40gusto/embedded-react-sdk/docs/theming/theming.md)
    -   [主题指南](https://npmcn.com/package/%40gusto/embedded-react-sdk/docs/theming/theming-guide.md)
    -   [主题变量](https://npmcn.com/package/%40gusto/embedded-react-sdk/docs/reference/theme-variables.md)
-   [组件适配器](https://npmcn.com/package/%40gusto/embedded-react-sdk/docs/component-adapter/component-adapter.md)
    -   [组件适配器如何工作](https://npmcn.com/package/%40gusto/embedded-react-sdk/docs/component-adapter/how-the-component-adapter-works.md)
    -   [组件适配器类型](https://npmcn.com/package/%40gusto/embedded-react-sdk/docs/component-adapter/component-adapter-types.md)
    -   [设置您的组件适配器](https://npmcn.com/package/%40gusto/embedded-react-sdk/docs/component-adapter/setting-up-your-component-adapter.md)
    -   [库存](https://npmcn.com/package/%40gusto/embedded-react-sdk/docs/reference/component-inventory.md)
    -   [组件适配器 FAQ](https://npmcn.com/package/%40gusto/embedded-react-sdk/docs/component-adapter/component-adapter-faq.md)
-   [附 录](https://npmcn.com/package/%40gusto/embedded-react-sdk/docs/appendix/endpoint-reference.md)
    -   [终点参考](https://npmcn.com/package/%40gusto/embedded-react-sdk/docs/appendix/endpoint-reference.md)
    -   [工作与补偿](https://npmcn.com/package/%40gusto/embedded-react-sdk/docs/appendix/jobs-and-compensations.md)
    -   [审查 SDK API 访问](https://npmcn.com/package/%40gusto/embedded-react-sdk/docs/getting-started/reviewing-sdk-api-access.md)
-   [工作流程概览](https://npmcn.com/package/%40gusto/embedded-react-sdk/docs/workflows-overview/workflows-overview.md)
    -   [公司上岗](https://npmcn.com/package/%40gusto/embedded-react-sdk/docs/workflows-overview/company-onboarding.md)
    -   [承包商登船](https://npmcn.com/package/%40gusto/embedded-react-sdk/docs/workflows-overview/contractor-onboarding.md)
    -   [承包商付款](https://npmcn.com/package/%40gusto/embedded-react-sdk/docs/workflows-overview/contractor-payments.md)
    -   [雇员上岗](https://npmcn.com/package/%40gusto/embedded-react-sdk/docs/workflows-overview/employee-onboarding/employee-onboarding.md)
        -   [雇员自职](https://npmcn.com/package/%40gusto/embedded-react-sdk/docs/workflows-overview/employee-onboarding/employee-self-onboarding.md)
    -   [雇员挂板](https://npmcn.com/package/%40gusto/embedded-react-sdk/docs/workflows-overview/employee-dashboard.md)
    -   [解雇雇员](https://npmcn.com/package/%40gusto/embedded-react-sdk/docs/workflows-overview/employee-termination.md)
    -   [索取资料](https://npmcn.com/package/%40gusto/embedded-react-sdk/docs/workflows-overview/information-requests.md)
    -   [运行薪金](https://npmcn.com/package/%40gusto/embedded-react-sdk/docs/workflows-overview/run-payroll.md)
    -   [环外薪给(Bonus和校正)](https://npmcn.com/package/%40gusto/embedded-react-sdk/docs/workflows-overview/off-cycle-payroll.md)
    -   [解雇薪金](https://npmcn.com/package/%40gusto/embedded-react-sdk/docs/workflows-overview/dismissal-payroll.md)
    -   [过渡](https://npmcn.com/package/%40gusto/embedded-react-sdk/docs/workflows-overview/transition-payroll.md)

## 许可证

依据Apache许可证2.0颁发的许可证——见 [自由主义](https://npmcn.com/package/%40gusto/embedded-react-sdk/LICENSE)使用Gusto嵌入式薪金API和相关Gusto服务另行管理;见 [分会,md](https://npmcn.com/package/%40gusto/embedded-react-sdk/DISCLAIMER.md)。 。 。 .

适用于捐款的术语见 [捐款额](https://npmcn.com/package/%40gusto/embedded-react-sdk/CONTRIBUTING.md)。 。 。 .

## 常见问题

### 如何安装 @gusto/embedded-react-sdk？

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

### @gusto/embedded-react-sdk 支持 TypeScript 吗？

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

### @gusto/embedded-react-sdk 支持 ESM 还是 CommonJS？

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

### @gusto/embedded-react-sdk 可以商用吗？

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

### @gusto/embedded-react-sdk 的下载量有多少？

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

### @gusto/embedded-react-sdk 还在维护吗？

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

