# @blocksdiy/blocks-client-sdk 中文文档

规范地址：https://npmcn.com/package/%40blocksdiy/blocks-client-sdk/

版本：1\.28\.0
npm 元数据更新时间：2026-11-06T12:18:02.268Z
中文译文更新时间：2026-11-08T07:32:11.996Z
软件包许可：ISC

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

原始 npm 页面：https://www.npmjs.com/package/%40blocksdiy/blocks-client-sdk
原文对照：https://npmcn.com/package/%40blocksdiy/blocks-client-sdk/?lang=original

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

- 包体积（解压后）：389 kB，102 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- Node.js 要求：\>=24\.22\.1
- 运行依赖：4 个
- peer 依赖：react \>=19，react-router \>=7
- 首次发布：2026-03-04T19:46:24.138Z
- 最新版本发布：2026-11-06T12:18:02.084Z
- 近 30 天下载量：9068（2026-10-09 至 2026-11-07，npm 官方下载统计）
- 已发布版本数：132（近 12 个月 132 个）

## 中文简介

块客户端 sdk

## 安装

```sh
npm install @blocksdiy/blocks-client-sdk
```

也可以使用：`pnpm add @blocksdiy/blocks-client-sdk`、`yarn add @blocksdiy/blocks-client-sdk`、`bun add @blocksdiy/blocks-client-sdk`

## README

# 块 - 客户端 - sdk

`@blocksdiy/blocks-client-sdk`:一个Blocks的应用程序用来与平台合作,无论该应用程序运行在何处(Blocks的托管, `pnpm dev`,建筑商的沙盒,或你自己的一队人.

| 条目 | 它所持有的 |
| --- | --- |
| `@blocksdiy/blocks-client-sdk/clientSdk` | `ClientSdk`:实体,动作,文件,用户. |
| `@blocksdiy/blocks-client-sdk/reactSdk` | 反应钩在客户端之上,导航帮助者(`getRouteUrl`, (中文(简体) ), `getLoginUrl`, (中文(简体) ), `logOut`) 需求 `react-router`。 。 。 . |
| `@blocksdiy/blocks-client-sdk/app` | `BlocksApp`,该应用程序的React树,而主机合同一个页面托管 Blocks 应用程序执行 `react-router`。 。 。 . |
| `@blocksdiy/blocks-client-sdk/page` | 遗产页面-模式应用的页面类型. |
| `@blocksdiy/blocks-client-sdk` | 一切从 `clientSdk` 财务报告和审定财务报表 `reactSdk`。 。 。 . |

## 应用程序条目

一个应用 `src/main.tsx` 调制 `BlocksApp` 与它所忽略的模块. `BlocksApp` 持有任何Blocks应用程序在它运行的地方都需要的东西:路由器,登录屏幕,SDK客户端,应用的路线(文件系统路由,或遗留页)带有出错的边界,以及默认的404和加载屏幕. 在dev服务器上,它自己主机(`window.__BLOCKS_DEV__`, (中文(简体) ), `src/app/dev-server/`) (中文(简体) ).

只有Blocks自己的托管需求(建设者帆布工具,移动应用程序的接线)不在这里:它生活在 `apps/app-render`,通过主机合同插入(`src/app/host.ts`:

-   **状态** 树读取, 由主机保持当前 : `setBlocksHost`, (中文(简体) ), `updateBlocksHost`· ;
-   **扩展**,在渲染前设定一次(`setBlocksHostExtensions`(单位:千美元) `RouterLayer` 在应用程序的路由器,a `Shell` 环绕它的路线,a `SignIn` 屏幕以代替树的登录和报表 `onReady`, (中文(简体) ), `onPageChange`, (中文(简体) ), `onMissingPage`, (中文(简体) ), `onAppError`, (中文(简体) ), `onSignOut` 财务报告和审定财务报表 `onRoutesResolved`。 。 。 .

| 文件夹( E)`src/app/`(中文(简体) ) | 它所持有的 |
| --- | --- |
| `BlocksApp.tsx` | 树:路由器,主机路由器层,入站,客户端,路线. |
| `AppRoutes.tsx` | 应用程序的路径在两种模式中都有,有报告,出错边界,404和加载. |
| `host.ts` | 主持人合同. |
| `SdkProvider.tsx` | SDK客户端环绕了应用程序的路线,在主机的符和用户上. |
| `types.ts` | 应用程序和路由类型 合同和形状共享. |
| `app-shape/` | 一个应用的代码相当于:被捆绑或被被被遮盖的模块,被塑造成路由或页面. |
| `sign-in/` | 登录及其平台调用. |
| `dev-server/` | 在dev服务器上自我托管. |
| `ui/` | 该树自有屏幕风格(Shadcn's look, on the app's sorders)和图标. |
| `hooks/` | 树自取钩:在一页变化上向上滚动. |

## 常见问题

### @blocksdiy/blocks-client-sdk 是什么？

块客户端 sdk

### 如何安装 @blocksdiy/blocks-client-sdk？

在项目目录运行 npm install @blocksdiy/blocks-client-sdk，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：react（\>=19）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @blocksdiy/blocks-client-sdk 支持 TypeScript 吗？

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

### @blocksdiy/blocks-client-sdk 支持 ESM 还是 CommonJS？

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

### @blocksdiy/blocks-client-sdk 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>=24\.22\.1。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @blocksdiy/blocks-client-sdk 可以商用吗？

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

### @blocksdiy/blocks-client-sdk 的下载量有多少？

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

### @blocksdiy/blocks-client-sdk 还在维护吗？

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