# @budibase/client 中文文档

规范地址：https://npmcn.com/package/%40budibase/client/

版本：3\.38\.1
npm 元数据更新时间：2026-08-17T11:14:54.714Z
中文译文更新时间：2026-11-08T18:31:40.860Z
软件包许可：MPL-2\.0

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

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

弃用说明：Package no longer supported\. Contact Support at https://www\.npmjs\.com/support for more info\.

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

- 包体积（解压后）：2.4 MB，5 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：未声明
- 运行依赖：20 个
- 首次发布：2019-09-10T08:56:57.550Z
- 最新版本发布：2026-05-12T06:32:30.608Z
- 近 30 天下载量：5473（2026-10-09 至 2026-11-07，npm 官方下载统计）
- 已发布版本数：3159（近 12 个月 113 个）

## 中文简介

这个 `manifest.json` 文件导出此版本客户端库中所有可用组件的定义。 运算表被构建者用来正确显示组件及其设置,并知道如何正确与它们互动.

## 安装

```sh
npm install @budibase/client
```

也可以使用：`pnpm add @budibase/client`、`yarn add @budibase/client`、`bun add @budibase/client`

## README

## 声明

这个 `manifest.json` 文件导出此版本中所有可用组件的定义 客户端图书馆。 运算表被构建者用来正确显示组件和 他们的设置, 并知道如何正确与他们互动.

### 构成部分定义

对象键是组件的名称,导出者为 `index.js`。 。 。 .

-   **名称** - 建筑商中显示的名称
-   **说明** - 目前没有使用
-   **图标** - 在构建器中显示的图标
-   **拥有孩子** - 组成部分是否接受儿童
-   **可样式** - 部件是否接受设计道具
-   **数据提供者** - 组件是否提供数据上下文
-   **可约束** - 部件是否提供可约束价值
-   **设置** - 构建器中显示的设置阵列

### 设置定义

这个 `type` 每个设置中的字段被构建者用来知道用于显示的组件 因此,重要的是这个字段是正确的。 有效的选项是:

-   **文本** - 一个文本字段
-   **选择** - 有选择的下降。 带着这些 `options` 字段以提供选项
-   **数据源** - 数据来源(如表格或视图)
-   **布尔** - 一个布尔地
-   **编号** - 数字文本字段
-   **细节** - 显示一行细节的网页的URL. 仅用于链接行细节的网格.

每个设定定义中可用的字段是:

-   **类型** - 确定构建者将使用的组件的字段类型 显示设置
-   **键** - 组件中此设置的关键
-   **标签** - 在构建器中显示的标签
-   **默认值** - 设置的默认值
-   **占位符** - 设定的占位符

## 常见问题

### @budibase/client 是什么？

这个 manifest\.json 文件导出此版本客户端库中所有可用组件的定义。 运算表被构建者用来正确显示组件及其设置,并知道如何正确与它们互动\.注意：该包已被作者标记为弃用——Package no longer supported\. Contact Support at https://www\.npmjs\.com/support for more info\.

### 如何安装 @budibase/client？

在项目目录运行 npm install @budibase/client，或使用 pnpm add / yarn add / bun add。

### @budibase/client 支持 TypeScript 吗？

该包的 package\.json 没有声明类型入口。需要类型提示时，可以在 npm 上查找社区维护的 @types/budibase\_\_client 是否存在。

### @budibase/client 支持 ESM 还是 CommonJS？

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

### @budibase/client 可以商用吗？

@budibase/client 使用 MPL-2\.0 许可。弱 Copyleft：可以商用，也可以和闭源代码一起使用；但如果分发时修改了 MPL 授权的文件，这些文件的修改需以 MPL 开源。以上为概括，不构成法律意见，请以许可原文为准。

### @budibase/client 的下载量有多少？

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

### @budibase/client 还在维护吗？

最新版本 3\.38\.1 发布于 2026/05/12（5 个月前）；至今共发布 3159 个版本，其中过去 12 个月发布了 113 个；首次发布于 2019/09/10。作者已将其标记为弃用，新项目建议寻找替代方案。