跳到主要内容

导出API

这里按用途整理 packages/dynamic-form/src/exports.ts 的公共导出API,作为快速查找入口。完整行为说明仍以专题文档为准。

Components

用于渲染标准配置或 compiler/adapter 产物的主要 React 入口。

DynamicFormCompiledDynamicFormDynamicFormProviderFormChainEffectWrapper
相关文档

Hooks

初始化 effect handlers、访问上下文和复用 store 初始化逻辑。

useInitHandlersuseFormChainContextuseStoreInit
相关文档

Config / Types

描述表单配置、字段配置、UI 配置、render hooks 参数和核心值类型。

FormConfigBaseFieldConfigDynamicFormPropsUIConfigFormValuesDesignerMetadata
相关文档

Core Package

4.2 起可从 @whynotsnow/dynamic-form-core 直接消费的配置、编译、规则、诊断和 Runtime 纯能力。

@whynotsnow/dynamic-form-coreprocessFormConfigvalidateFormConfigcompileFormConfigRuleEngineresolveRuntimeState
相关文档

Form / Renderer Adapters

接入不同 Form runtime 或 UI 外壳的 adapter contract 与默认实现。

assertFormAdaptercreateAntdFormAdaptercreateMemoryFormAdapterassertRendererAdapterantdRendererheadlessRenderer
相关文档

Component Registry

注册或扩展字段组件,并访问默认 Ant Design 组件集合。

ComponentRegistryManagerDefaultRegistryFieldComponentsComponentRegistryConfig
相关文档

Compiler / Modules

把领域字段模块编译为标准 FormConfig,保留运行时渲染管线不变。

compileFormConfigModuleRegistryManagerdefaultModuleRegistryFieldModule
相关文档

Adapters

把 ModuleConfig、JsonSchema、OpenAPI 或 metadata 输入归一化为模块配置。

adaptModuleConfigscompileAdaptedFormConfigJsonSchemaAdapterOpenApiAdapterMetadataAdapter
相关文档

Rules

声明式同步规则层,可编译为标准 effects 并复用现有处理管线。

RuleEnginecreateRuleEnginecompileRulesToEffectevaluateRule
相关文档

Field Address

分离稳定字段 id 与 Ant Design NamePath,支持嵌套值路径。

getFieldNameresolveFieldAddressFieldAddress
相关文档

Runtime Inspection

读取 Runtime 快照中的渲染、提交和校验参与状态,用于调试和设计器预览。

getFieldRuntimeSnapshotgetRenderedFieldIdsgetSubmitableFieldIdsgetValidatableFieldIds
相关文档

Utilities

默认配置和配置处理入口,主要服务高级集成与测试场景。

getDefaultConfigprocessFormConfiggetFormConfigDiagnosticsvalidateFormConfig
相关文档