Skip to main content

API

This page groups public exports from src/exports.ts by purpose as a quick lookup entry. The topic docs remain the source of detailed behavior.

Components

Primary React entry points for rendering standard config or compiler/adapter output.

DynamicFormCompiledDynamicFormDynamicFormProviderFormChainEffectEngineWrapper
Related docs

Hooks

Initialize effect handlers, access context, and reuse store initialization logic.

useInitHandlersuseFormChainContextuseStoreInit
Related docs

Config / Types

Describe form config, field config, UI config, render hook parameters, and core value types.

FormConfigBaseFieldConfigDynamicFormPropsUIConfigFormValues
Related docs

Component Registry

Register or extend field components and access the default Ant Design component set.

ComponentRegistryManagerDefaultRegistryFieldComponentsComponentRegistryConfig
Related docs

Compiler / Modules

Compile domain field modules into standard FormConfig while preserving the runtime rendering pipeline.

compileFormConfigModuleRegistryManagerdefaultModuleRegistryFieldModule
Related docs

Adapters

Normalize ModuleConfig, JsonSchema, OpenAPI, or metadata inputs into module configs.

adaptModuleConfigscompileAdaptedFormConfigJsonSchemaAdapterOpenApiAdapterMetadataAdapter
Related docs

Rules

Declarative synchronous rule layer that compiles to standard effects and reuses the existing handler pipeline.

RuleEnginecreateRuleEnginecompileRulesToEffectevaluateRule
Related docs

Field Address

Separates stable field ids from Ant Design NamePath and supports nested value paths.

getFieldNameresolveFieldAddressFieldAddress
Related docs

Utilities

Default config and config processing entry points for advanced integrations and tests.

getDefaultConfigprocessFormConfig
Related docs