@getsoren/treege-consumer

中文文档
2.9.1发布于 2026/05/16TypeScriptESM + CJS近 30 天下载 3908

A React library to consume easily form generated from Tree

原始使用文档
文档目录10 节
  1. Installation
  2. Usage
  3. Provide tree data
  4. Provide options
  5. Components
  6. TreegeConsumer
  7. TreegeViewer
  8. Provider
  9. Provide options
  10. Type Definitions

@getsoren/treege-consumer

A React library to consume easily form generated from Treege

Installation

npm:

npm install @getsoren/treege-consumer

bun:

bun add @getsoren/treege-consumer

yarn:

yarn add @getsoren/treege-consumer

pnpm:

pnpm add @getsoren/treege-consumer

Usage

Provide tree data

Give tree data to <TreegeForm> component. Data can be fetched from your API.

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;

Provide options

Some options can be provided. For example if you want to use place predictions from address field.

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;

Components

TreegeConsumer

Render a form based on Treege data

PropsTypeDefaultRequiredDetail
treeTreeNodeundefinedfalseTreege data
theme"light"
"dark"
ThemeOptions
"light"falseTheme color mode
onSubmitdata: JsonFormValue[];
formData: [string, FormDataEntryValue][];
fieldValues: FieldValues;
undefinedfalseCallback fired form is validate
options"countryAutocompleteService"
"googleApiKey"
"prefixResponseImageUriAutocomplete"
undefinedfalseConsumer options
styleCSSPropertiesundefinedfalseCustom form style
initialValues{ [key: string]: unknown; }undefinedfalseSet initial value to form
ignoreFieldsstring[]undefinedfalseIgnored fields to render
debugbooleanundefinedfalseDebug in console on form submit
readOnlybooleanundefinedfalseRead only mode
disabledSubmitButtonbooleanundefinedfalseDisable submit button
isSubmittingbooleanundefinedfalseDisable submit button while submitting
renderFormValidationfunction({ disabled, isLoading }: RenderFormValidationParams): ReactElementundefinedfalseCustom form validation renderer

Options

OptionsTypeDefaultRequiredDetail
countryAutocompleteServicestring or string[]falseDefine country restrictions for autocomplete
googleApiKeystringfalseIf you want use some google service like autocomplete address, then you want provide Google Api Key
prefixResponseImageUriAutocompletestringfalsePrefix response image uri for autocomplete image
licenseMuiXstringfalseLicense MUI X to enable pro and premium feature
adapterLocalestringfalseAdapter local for locale format
disablePastDateRangePickerbooleanfalseDisable past for date range picker
disablePastDatePickerbooleanfalseDisable past for date picker
noValidatebooleanfalseIndicate that the form is not to be validated on submit

TreegeViewer

Display values from form based on Treege

PropsTypeDefaultRequiredDetail
values{
label: string;
name: string;
type: string;
tag?: string;
value: string; | { label: string; value: string }
}
undefinedtrueObject of data
renderFieldsfunction(input: JsonFormValue): ReactElement | undefinedundefinedfalseCustom fields rendering
excludedFieldsstring[]undefinedfalseExcluded fields
collapsebooleanundefinedfalseEnable collapse or note
collapseVisibleItemNumbernumber4falseNumber of visible item before collapse. Works only if collapse is true
collapseStyleCSSPropertiesundefinedfalseCustom collapse style
collapseSxSxPropsundefinedfalseCustom collapse sx
styleCSSPropertiesundefinedfalseContainer style
sxSxPropsundefinedfalseContainer sx

Provider

Provide options

You can provide options to the consumer by using the TreegeConsumerProvider provider.

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;

Type Definitions

This library uses type definitions from @getsoren/types-treege

版本与发布记录

@getsoren/treege-consumer 共发布 2 个版本,首次发布于 2026/05/16;过去 12 个月发布了 2 个版本。

版本发布日期距今
2.9.1latest2026/05/166 个月前
2.9.02026/05/156 个月前

关于 @getsoren/treege-consumer 的常见问题

@getsoren/treege-consumer 是什么?

A React library to consume easily form generated from Tree

如何安装 @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 和提交记录判断。