# @getsoren/treege-consumer 中文文档

规范地址：https://npmcn.com/package/%40getsoren/treege-consumer/

版本：2\.9\.1
npm 元数据更新时间：2026-05-15T22:03:52.456Z
中文译文更新时间：2026-11-16T06:53:58.470Z
软件包许可：未声明

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

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

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

- 包体积（解压后）：231 kB，50 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：8 个
- peer 依赖：@mui/x-date-pickers-pro \*，@mui/x-license \*，@tanstack/react-query \>=5，@getsoren/design-system \>=4，@getsoren/react-utils \>=1\.23\.0，dayjs \>=1，react ^17\.0\.0 \|\| ^18\.0\.0 \|\| ^19\.0\.0，react-dom ^17\.0\.0 \|\| ^18\.0\.0 \|\| ^19\.0\.0
- 首次发布：2026-05-15T22:03:51.988Z
- 最新版本发布：2026-05-15T22:03:52.228Z
- 近 30 天下载量：3908（2026-10-17 至 2026-11-15，npm 官方下载统计）
- 已发布版本数：2（近 12 个月 2 个）

## 中文简介

一个反应库,以轻松地消耗由树生成的形式

## 安装

```sh
npm install @getsoren/treege-consumer
```

也可以使用：`pnpm add @getsoren/treege-consumer`、`yarn add @getsoren/treege-consumer`、`bun add @getsoren/treege-consumer`

## README

# @ getsoren/ 树上消费

**一个反应库,可以轻松地消耗从 [树形](https://github.com/Tracktor/treege)**

-   [安装](https://npmcn.com/package/%40getsoren/treege-consumer/#readme-Installation)
-   [使用量](https://npmcn.com/package/%40getsoren/treege-consumer/#readme-Usage)
    -   [提供树数据](https://npmcn.com/package/%40getsoren/treege-consumer/#readme-Provide-tree-data)
    -   [提供选项](https://npmcn.com/package/%40getsoren/treege-consumer/#readme-Provide-options)
-   [构成部分](https://npmcn.com/package/%40getsoren/treege-consumer/#readme-Components)
    -   [树基消耗器](https://npmcn.com/package/%40getsoren/treege-consumer/#readme-TreegeConsumer)
    -   [树基维耶尔](https://npmcn.com/package/%40getsoren/treege-consumer/#readme-TreegeViewer)

## 安装

**无 :**

```bash
npm install @getsoren/treege-consumer
```

**包子 :**

```bash
bun add @getsoren/treege-consumer
```

**线条**数字 :

```bash
yarn add @getsoren/treege-consumer
```

**小时**数字 :

```bash
pnpm add @getsoren/treege-consumer
```

## 使用量

### 提供树数据

给 `tree data` 改为 `<TreegeForm>` 组件. 数据可以从您的 API 中获取 .

```typescript
import tree from "./tree.json";
import { TreegeConsumer } from "@getsoren/treege-consumer";

const App = () => {
  const handleSubmit = (data: [string, FormDataEntryValue][]) => {
    console.log(data);
  };

  return <TreegeConsumer tree={tree} onSubmit={handleSubmit}/>;
};

export default App;
```

### 提供选项

可以提供一些选项。 例如,如果您想要使用来自 `address` 字段.

```typescript
import tree from "./tree.json";
import { TreegeConsumer } from "@getsoren/treege-consumer";

const App = () => {
  const handleSubmit = (data: [string, FormDataEntryValue][]) => {
    console.log(data);
  };

  return (
    <TreegeConsumer
      tree={tree}
      onSubmit={handleSubmit}
      options={{ googleApiKey: "YOUR_API_KEY" }}/>
  );
};

export default App;
```

## 构成部分

### 树基消耗器

以窗体为基础渲染 打开 [树形](https://github.com/Tracktor/treege) 数据

| 道具 | 类型 | 默认 | 需求 | 细节 |
| --- | --- | --- | --- | --- |
| 树 | [树节点](https://npmcn.com/package/%40getsoren/treege-consumer/src/types/TreeNode.ts) | 未定义 | 虚假 | 树种数据 |
| 主题 | "轻"  
"黑暗"(暗语)  
主题选项 | "轻" | 虚假 | 主题颜色模式 |
| 投递 | `data: JsonFormValue[];`  
`formData: [string, FormDataEntryValue][];`  
`fieldValues: FieldValues;` | 未定义 | 虚假 | 回调已开火的表单被验证 |
| 选项 | "国家自动完成服务"  
"谷歌阿皮凯"  
"前缀 ResponseImageUriAutocomplete" (前缀 ResponseImage UriAuto complete) 互联网档案馆的存檔,存档日期2011-12-20 | 未定义 | 虚假 | 消费者选择 |
| 样式 | CSS 财产 | 未定义 | 虚假 | 自定义窗体样式 |
| 初始数值 | {\[键:字符串\]:未知;} | 未定义 | 虚假 | 设定初始值为窗体 |
| 忽略字段 | 字符串 \[\] | 未定义 | 虚假 | 忽略要渲染的字段 |
| 调试 | 布尔 | 未定义 | 虚假 | 在提交表单时调试控制台 |
| 仅读 | 布尔 | 未定义 | 虚假 | 仅读模式 |
| 已禁用字幕按钮 | 布尔 | 未定义 | 虚假 | 禁用提交按钮 |
| 正在提交 | 布尔 | 未定义 | 虚假 | 提交时禁用提交按钮 |
| 公式校正 | 函数( {已禁用, is Loading} ): [变形图](https://npmcn.com/package/%40getsoren/treege-consumer/src/types/RenderFormValidationParams.ts): 反应元素 | 未定义 | 虚假 | 自定义窗体验证渲染器 |

#### 选项

| 选项 | 类型 | 默认 | 需求 | 细节 |
| --- | --- | --- | --- | --- |
| 自动完成服务 | 字符串或字符串 \[\] |  | 虚假 | 定义国家对自动完成的限制 |
| 谷歌ApiKey 游戏 | 字符串 |  | 虚假 | 如果你想使用谷歌服务,比如 **自动完整地址**,然后你想提供 [Google Api 密钥](https://cloud.google.com/docs/authentication/api-keys) |
| 前缀 ResponseImageUriAuto 完成 | 字符串 |  | 虚假 | 自动完整图像的前缀响应图像 uri |
| 许可证MuiX | 字符串 |  | 虚假 | 许可证MUI X 使职业和溢价特性成为可能 |
| 适配器本地化 | 字符串 |  | 虚假 | 本地语言格式的适应器 |
| 禁用PastDate Range 选择器 | 布尔 |  | 虚假 | 禁用日期范围拾取器的过去 |
| 禁用快捷键 | 布尔 |  | 虚假 | 禁用摘取日期的过去 |
| 无参数 | 布尔 |  | 虚假 | 说明该表格在提交时不予验证 |

### 树基维耶尔

以 [树形](https://github.com/Tracktor/treege)

| 道具 | 类型 | 默认 | 需求 | 细节 |
| --- | --- | --- | --- | --- |
| 数值 | {  
标签:字符串;  
名称:字符串;  
类型:字符串;  
标记 ?: 字符串;  
值:字符串; {{标签:字符串; 值:字符串}  
{\\fn黑体\\fs22\\bord1\\shad0\\3aHBE\\4aH00\\fscx67\\fscy66\\2cHFFFFFF\\3cH808080}你觉得呢 | 未定义 | 真实 | 数据对象 |
| 成为字段 | 函数( 输入: JsonFormValue): reactElement QQ 未定义 | 未定义 | 虚假 | 自定义字段渲染 |
| 排除字段 | 字符串 \[\] | 未定义 | 虚假 | 排除的字段 |
| 崩溃 | 布尔 | 未定义 | 虚假 | 启用倒塌或注释 |
| 可视化项目数 | 编号 | 页:1 | 虚假 | 倒塌前可见项数 。 只有崩溃是真的才有用 |
| 崩溃样式 | CSS 财产 | 未定义 | 虚假 | 自定义倒塌样式 |
| 折叠Sx | 函数 | 未定义 | 虚假 | 自定义崩溃 sx |
| 样式 | CSS 财产 | 未定义 | 虚假 | 容器样式 |
| 轴 | 函数 | 未定义 | 虚假 | 集装箱轴 |

## 提供者

### 提供选项

您可以通过使用 `TreegeConsumerProvider` 供养.

```typescript
import tree from "./tree.json";
import { TreegeConsumer, TreegeConsumerProvider } from "@getsoren/treege-consumer";

const App = () => {
  const handleSubmit = (data: [string, FormDataEntryValue][]) => {
    console.log(data);
  };

  return (
    <TreegeConsumerProvider licenseMuiX={"YOUR_LICENCE"}>
      <TreegeConsumer
        tree={tree}
        onSubmit={handleSubmit}
        options={{googleApiKey: "YOUR_API_KEY"}}/>
    </TreegeConsumerProvider>
  );
};

export default App;
```

## 类型定义

此库使用类型定义来自 [@ getsoren/ types- streege (英语)](https://github.com/getsoren/types-treege)

## 常见问题

### @getsoren/treege-consumer 是什么？

一个反应库,以轻松地消耗由树生成的形式

### 如何安装 @getsoren/treege-consumer？

在项目目录运行 npm install @getsoren/treege-consumer，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：@mui/x-date-pickers-pro（\*）、@mui/x-license（\*）、@tanstack/react-query（\>=5）、@getsoren/design-system（\>=4）、@getsoren/react-utils（\>=1\.23\.0）、dayjs（\>=1）、react（^17\.0\.0 \|\| ^18\.0\.0 \|\| ^19\.0\.0）、react-dom（^17\.0\.0 \|\| ^18\.0\.0 \|\| ^19\.0\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @getsoren/treege-consumer 支持 TypeScript 吗？

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

### @getsoren/treege-consumer 支持 ESM 还是 CommonJS？

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

### @getsoren/treege-consumer 可以商用吗？

@getsoren/treege-consumer 使用 未声明 许可。package\.json 没有声明许可证。没有许可证的代码默认保留全部权利，商用前请联系作者或查看仓库中的 LICENSE 文件。以上为概括，不构成法律意见，请以许可原文为准。

### @getsoren/treege-consumer 的下载量有多少？

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

### @getsoren/treege-consumer 还在维护吗？

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

