API Reference

Container component for rendering dynamic arrays of fields. Supports add/remove/move operations via the arrayEvent() bu...

Renderer for the universal `component` addon kind. Loads the user-supplied component lazily (`addon.component()`) and r...

Layout container that wraps child fields with UI chrome. Resolves children like a row, then chains wrapper components a...

Dispatcher component that renders an addon by looking up its `kind` in `ADDON_KIND_REGISTRY` and instantiating the regis...

Dynamic form component — renders a form based on configuration. Delegates state management to `FormStateManager`.

Container component for rendering nested form groups. Creates a scoped form context with its own validation state. Chil...

Renderer for the universal `template` addon kind. Resolves the addon's `templateKey` against {@link DF_FIELD_TEMPLATES}...

Renderer for the universal `text` addon kind. Renders the addon's `text` (a `DynamicText`) inside a span. Decorative — ...

Marks an `<ng-template>` projected into `<df-dynamic-form>` content as available to template addons by name. The host f...

Injectable service for dispatching events into a DynamicForm from outside the form. ## When to use Use `EventDispatche...

Pipe that handles dynamic text resolution with support for static strings, Observables, and Signals. Supports: - Static...

Event dispatched to append a new item at the END of an array field. This is the most common array operation - adding it...

Console-based logger implementation.

Base error class for all Dynamic Forms errors. This class centralizes the `[Dynamic Forms]` prefix, ensuring consistent...

Event dispatched when the form should be cleared. This event instructs the dynamic form component to clear all field va...

Event dispatched when the form should be reset to its default values. This event instructs the dynamic form component t...

Event dispatched to insert a new item at a SPECIFIC INDEX in an array field. Use this when you need precise control ove...

Event dispatched to move an existing item from one index to another within an array field. This is an atomic reorder op...

No-operation logger implementation. All methods are no-ops - used in production by default.

Event dispatched to remove the LAST item from an array field. Equivalent to JavaScript's `Array.pop()` - removes from t...

Event dispatched to prepend a new item at the BEGINNING of an array field. Use this when new items should appear at the...

Event dispatched to remove an item at a SPECIFIC INDEX from an array field. Use this when you need precise control over...

Registry service that provides access to the root form and its values. Constructed via factory in `provideDynamicFormDI...

Event dispatched to remove the FIRST item from an array field. Equivalent to JavaScript's `Array.shift()` - removes fro...

Per-kind registration metadata. Registered via `withCustomAddon(...)` features (or adapter feature helpers like `withPr...

Minimal JSON Schema fragment used by the MCP server to surface an addon kind's shape to AI form generators. Covers the c...

Configuration for auto-generated add/remove buttons in simplified array fields.

Array context for fields rendered within arrays. Provides position and parent array information for components inside ar...

Array field interface for creating dynamic field collections that map to array values. Key concepts: - The outer `field...

Context object for array item operations (add/remove) Provides the necessary information to resolve tokens in array item...

Async custom validator configuration using Angular's resource-based API Angular's validateAsync uses the resource API f...

Base shape every addon kind extends. Public contract: - `slot` chooses where the addon renders (prefix / suffix / adapt...

Base configuration shared by all validators

Built-in validator configuration (required, email, min, max, etc.)

Context for resolving button disabled state. @public

Renders an arbitrary Angular component as the addon body. The loader returns either a component class directly or a mod...

Container field interface for wrapping child fields with UI chrome. A container field is a container that renders its c...

Configuration for the built-in 'css' wrapper type. The CSS wrapper applies CSS classes around wrapped content via a Dyn...

Signal forms adapter configuration for advanced form behavior. Provides configuration options for signal forms integrat...

Custom validator configuration using Angular's public FieldContext API. Returns ValidationError | ValidationError[] | nu...

Declarative HTTP validator configuration — fully JSON-serializable, no function registration required. Uses `HttpReques...

Module-augmentable registry of user-defined named action handlers. Users register handlers once at bootstrap with `prov...

Module-augmentable registry of adapter-specific preset names. Adapters add their canonical actions (e.g., Material's `'...

Module-augmentable registry of addon kinds. Each key is the kind discriminant; each value is the addon's full shape (ex...

Module-augmentable registry of adapter-specific addon slot names. Adapters that expose slots beyond the universal `pref...

Global interface for dynamic form field definitions with categorization This interface combines containers and leaves fr...

Per-field-type addon-support metadata declared at field registration. Source of truth for the runtime validator: which ...

One entry per field type that declares addon support. `name` is the field-type discriminant; `slots` and `allowedKinds`...

Field-bound variant — the addon is attached to a real field and has a working value-writer. The common case for `pi-butt...

Base interface for all dynamic form field definitions. This interface defines the common properties that all field type...

Base interface for native HTML attributes that can be passed to form field elements. This interface serves as the base ...

Container fields registry - augment this interface to add custom container fields

Leaf fields registry - augment this interface to add custom leaf fields

Wrapper type registry for module augmentation. Augment this interface to add type-safe wrapper type definitions.

Field signal context - the "nervous system" of the dynamic form. Provided via FIELD_SIGNAL_CONTEXT injection token. Giv...

Represents the state information of a single form field. Used in evaluation contexts to allow expressions and condition...

Configuration interface for registering custom field types. Defines how a field type should be handled by the dynamic f...

Contract that wrapper components must satisfy. Each wrapper exposes a `#fieldComponent` ViewContainerRef where the inne...

Configuration interface for defining dynamic form structure and behavior. This interface defines the complete form sche...

Base interface for all form events in the dynamic form system. All form events must implement this interface to be comp...

Result of form mode detection with validation details

Global form configuration options. Controls form-wide behavior including disabled state and button behavior configurati...

Group field interface for creating logical field groupings that map to object values Groups create nested form structure...

Condition that evaluates based on an HTTP response from a remote server. The HTTP request is resolved reactively — when...

HTTP-based validator configuration for Angular's validateHttp API Angular's validateHttp provides optimized HTTP valida...

Configuration for an HTTP request used by declarative HTTP validators, derivations, and conditions. All string values i...

HTTP request configuration for validateHttp API

Mapping configuration for interpreting HTTP responses as validation results. Expressions in `validWhen` and `errorParam...

Interface for dynamic forms logger implementations. Allows custom logging integrations (Sentry, DataDog, etc.)

Options for controlling next page button disabled behavior. @public

Context for resolving state (hidden/disabled) for non-form-bound elements. This is a generalized context that can be us...

Orphan variant — the addon is rendered outside any field component (rare; happens when consumers compose `<df-addon-slot...

Page field interface for creating top-level page layouts This is a special field type that contains other field definiti...

Optional collaborators a preset may need beyond the base context. Passed by the button kind component which has access t...

Read-only view of a single field's observable state. Whitelisted read signals copied from Angular Signal Forms' `FieldS...

Row field interface for creating horizontal layouts. A row is a synthetic field type that resolves to a Container at run...

Result of a `sanitizeFormConfig` call.

Options accepted by {@link sanitizeFormConfig}.

Configuration for applying predefined schemas

Reusable schema definition that can be referenced by name

Simplified array field interface for common use cases. Instead of manually specifying each item in `fields`, provide a ...

Configuration for form submission handling. When provided, enables integration with Angular Signal Forms' native `submi...

Options for controlling submit button disabled behavior. @public

Renders a named `<ng-template>` projected into the host `<df-dynamic-form>`. JSON-safe — backends ship the key, FE supp...

Renders text content inline. `text` is `DynamicText`, supporting plain strings, observables, and signals — so values li...

Text field definition for displaying translatable text content

Context for token resolution in event args

Configuration for when validation runs based on a field's reactive state. Currently controls whether hidden fields are ...

Configuration for excluding field values from form submission output based on their reactive state (hidden, disabled, re...

Input shape passed to a wrapper component via the `fieldInputs` input. Carries the wrapped field's mapper outputs plus ...

User-facing wrapper registration shape used with `createWrappers(...)`. Extends `WrapperTypeDefinition` with an optiona...

Branded bundle returned by `createWrappers(...)`. Carries: - `ɵkind: 'wrappers'` — discriminant recognised by `provideD...

Configuration interface for registering wrapper types. Defines how a wrapper component is loaded and identified. Wrappe...

Context handed to inline addon actions and registered handler functions. Discriminated by `form`: field-bound contexts ...

Handler signature for user-registered addon actions. Backends reference handlers by name via `actionRef: 'name'` on but...

Union of every preset name an addon may reference — universal presets plus any contributed via {@link DynamicFormAddonAc...

Typed feature returned by {@link provideAddonActions}. Carries the registered handler keys as a phantom type so consumer...

Optional shape validator a kind ships to enforce its required fields at runtime. Throws are caught by the validator and ...

Union of every valid addon slot — universal slots plus any registered via {@link DynamicFormAddonSlotRegistry} module au...

Reason an addon was dropped during validation. Each variant carries its own context fields so log messages can be both ...

Union of every registered addon shape.

Fields that are allowed as children of Array fields Arrays can contain: rows, groups, and leaf fields (but NOT pages or ...

Type representing a FieldTree for an array. Extends FieldTree to add numeric indexing for accessing item FieldTrees.

Template type for array items used in events. Canonical definition lives in {@link ArrayItemDefinition} — this alias pre...

An array item template is an array of allowed children that defines one OBJECT array item's fields. Used for object arra...

Condition that resolves asynchronously via a custom function. Two mutually exclusive forms: - `asyncFunctionName`: name...

Async function for conditions — returns boolean. The function receives the evaluation context and may return a Promise ...

Async function for derivations — returns any value. The function receives the evaluation context and may return a Promi...

Async custom validator configuration using Angular's `validateAsync` API. Returns Observable<ValidationError | Validatio...

Extract field types that are available in the registry

Built-in preset actions shared across adapters. Adapter kinds that accept a `preset` field render the corresponding beh...

Universal addon slot names supported by every adapter. Adapters render `prefix` to the leading edge of a field and `suf...

Discriminated union of all conditional expression types. Each variant only allows the properties relevant to its type, ...

Fields that are allowed as children of Container fields. Containers are pure layout primitives that flatten their childr...

Union type of all registered container field definitions

Custom function signature for conditional expressions Custom functions are used for conditional logic in: - `when` cond...

Custom validator function signature using Angular's public FieldContext API Takes FieldContext (full Angular context) a...

Generic reactive value — a static value, an Angular Signal, or an RxJS Observable. Generalises {@link DynamicText} for ...

Extract a specific field type from RegisteredFieldTypes based on the `type` discriminant. This enables proper type narro...

Extract FieldDef types from provider result

Extract form value type from provider result

Type utility for extracting component input properties from field definitions. Transforms field definition properties i...

Type helper for accessing nested field paths safely This allows accessing child paths while maintaining some type safety

Semantic grouping of interchangeable field UI alternatives. Used by tooling (e.g., openapi-generator) to discover which...

Field state context for the current field being evaluated. Used as `fieldState` in evaluation contexts. @public

Constructor type for form event classes. Defines the shape of event class constructors that can be used with the event ...

Map of field keys to their state information. Used as `formFieldState` in evaluation contexts to access state of any fi...

Form mode enumeration distinguishing between paged and non-paged forms

Special form-state conditions for button disabled logic. These conditions evaluate form or page-level state rather than...

Fields that are allowed as children of Group fields Groups can contain: rows and leaf fields (but NOT pages or other gro...

Infer form value type from fields array or FormConfig. Recursively processes nested structures and merges the results. L...

Derive the `FieldRegistryWrappers` augmentation shape from a wrapper bundle. Maps each registration's `wrapperName` to ...

Union type of all registered leaf field definitions

Union type for all logic configurations. - `StateLogicConfig`: For field state changes (hidden, readonly, disabled, req...

Mapper function that converts a field definition to component inputs. Mappers run within an injection context and can i...

Narrow a field definition based on its `type` property. Use this to get proper type inference when working with field un...

Narrow each field in an array based on its `type` property. Use with `satisfies` to get proper type inference for field ...

Logic config restricted to types valid for non-form-bound elements. This is a subset of LogicConfig that only includes h...

Allowed logic types for non-form-bound elements (buttons, text fields, etc.). These elements only support hidden and dis...

Type constraints for field nesting rules These ensure that container fields can only contain valid child field types No...

Typed string handle to a registered action handler. The empty registry resolves to `never`; augmenting `DynamicFormActio...

Union type of all registered field definitions

Fully resolved validation execution config — every property defined. @public

Fully resolved exclusion config with all properties required. Produced by the 3-tier resolution: `field ?? form ?? globa...

Row is a synthetic field type that resolves to a Container at runtime, so it accepts the same children as a Container.

Configuration for conditional field state logic. Defines how field behavior changes based on conditions. Supports hidin...

The result type for submission actions. Can be either a Promise or an Observable. For success: return `undefined`, `nul...

Text element type for rendering different HTML text elements

Properties for text field configuration

Re-export Angular's ValidationError for consistency This replaces our custom ValidationError interface

Configuration for signal forms validator functions that can be serialized from API. Discriminated union type for type-sa...

Defines how a field type handles form values and data collection. - 'include': Field contributes to form values (defaul...

Supported primitive value types for form fields. This type represents all possible value types that can be used in form ...

Resolves a wrapper type name to its registered config interface. When `TWrappers` is a specific registered key (e.g., `...

Applies meta attributes to a DOM element and tracks which attributes were applied. This utility handles: - Removing pre...

Builder for array manipulation events. Provides a fluent, discoverable API for array operations. Type `arrayEvent('key'...

Maps an array field definition to component inputs. Array components create nested form structures under the array's ke...

Base field mapper that extracts common field properties into component inputs. Returns a Signal containing the Record o...

Builds base input properties from a field definition. This is a helper function that extracts common field properties. ...

Maps a container field definition to component inputs. Container components are layout containers that don't change the...

Creates a typed field configuration with helpful error messages for common mistakes. This helper function provides earl...

Bundle wrapper registrations into a single object that can be passed to `provideDynamicForm(...)`.

Converts DynamicText (string | Observable | Signal) to Observable<string> Unifies all three types into a consistent Obse...

Evaluates the disabled state for non-form-bound elements synchronously. This is a pure function (no signal allocation) ...

Evaluates the hidden state for non-form-bound elements synchronously. This is a pure function (no signal allocation) th...

Shorthand alias for createField

Render an `AddonWarning` to a developer-friendly message. Returns the bare message — the `[Dynamic Forms]` prefix is ad...

Type-safe form config builder that ensures schema matches field structure. This helper function provides type safety wh...

Get the length of an array FieldTree.

Maps a group field definition to component inputs. Group components create nested form structures under the group's key...

Type guard to check if a form event has a form value attached. Use this to safely access the `formValue` property on ev...

Injection function for accessing the addon kind registry. Usage parallels {@link injectFieldRegistry}: lookup, lazy loa...

Throwing accessor for {@link FIELD_SIGNAL_CONTEXT}. Use when the consumer requires the context — group/array containers...

Walk `FIELD_REGISTRY` and return every field type that opted into addons (i.e., declared `addons` on its `FieldTypeDefin...

Interpolates {{param}} placeholders in message with error values

Type guard for ArrayField with proper type narrowing. Validates that the field is an array type with a fields property t...

Type guard to check if a field is a container field (page, row, group, or array) Container fields have a 'fields' proper...

Type guard for ContainerField with proper type narrowing. `wrappers` is part of the type but optional in practice — man...

Type guard to check if a field is excluded from form values (display-only field) Currently this includes text fields and...

Performs a deep equality comparison between two values. Handles: - Primitives (including NaN via Object.is) - Dates (by...

Type guard narrowing {@link AddonActionContext} to its field-bound variant.

Type guard to check if a condition is a FormStateCondition.

Type guard for GroupField with proper type narrowing

Type guard to check if a field is a leaf field (value or display field) Leaf fields don't have children and either contr...

Type guard for PageField with proper type narrowing

Type guard for RowField with proper type narrowing

Type guard for SimplifiedArrayField. Checks for `type: 'array'` with a `template` property (discriminant from full Array...

Type guard to check if a field has a value property (value-bearing field) These fields contribute to the form value outp...

Type guard for a `WrappersBundle`.

Type guard for WrapperTypeDefinition. Discriminates via `wrapperName` — field types use `name`, wrapper types use `wrap...

Default warning sink. Pass a `DynamicFormLogger` to route through the form's configured logger (respects `NoopLogger` op...

Creates a new object without the specified keys Native replacement for lodash omit()

Maps a page field definition to component inputs. Page fields are layout containers that don't modify the form context....

Register named action handlers reachable via JSON-driven addon configs. Once registered, a backend can ship `{ kind: 'p...

Provider function to configure the dynamic form system with field types and options. This function creates environment ...

Normalises a {@link DynamicValue} into a `Signal<T>`. Accepts a static value, a `Signal<T>`, or an `Observable<T>`. The...

Resolves the disabled state for a next page button. The disabled state is determined by (in order of precedence): 1. Ex...

Resolves the disabled state for non-form-bound elements as a reactive signal. Wraps {@link evaluateNonFieldDisabled} in...

Resolves the hidden state for non-form-bound elements as a reactive signal. Wraps {@link evaluateNonFieldHidden} in a `...

Resolves the disabled state for a submit button. The disabled state is determined by (in order of precedence): 1. Expli...

Resolves special tokens in event arguments to their actual values Supported tokens: - $key: The current field key - $in...

Maps a row field definition to container component inputs. `row` is a virtual field type: it resolves to `ContainerFiel...

Apply a built-in preset action against the addon's host field. Shared across all adapters — each adapter's `ADDON_PRESET...

Walk a `FormConfig`, validate every field's addons against the active `FIELD_REGISTRY` and `ADDON_KIND_REGISTRY`, and re...

DI-free variant of {@link sanitizeFormConfig} for tooling that lives outside Angular's injector — build-time linters, MC...

Maps a text field definition to component inputs. Text fields are display-only fields that don't participate in the for...

Build a `ReadonlyFieldTree` by extracting the whitelisted read signals from a Signal Forms `FieldTree`. Returns a fresh ...

Walk a field's addons; return the survivors plus a list of warnings for anything dropped. Pure: receives the registries...

Recursively walk a field tree, validating each field's addons. Returns a sanitized copy of the input field array plus ac...

Register a custom addon kind with the form. The provided definition is added to `ADDON_KIND_REGISTRY` at form initialis...

Enables automatic form value attachment to all events dispatched through the EventBus. When this feature is enabled, ev...

Opt into Angular Signal Forms' legacy `.ng-touched` / `.ng-invalid` / `.ng-dirty` / `.ng-pristine` / `.ng-untouched` / `...

Configure logging for dynamic forms. By default, general logging is enabled (ConsoleLogger) and derivation logging is d...

Wraps a `Resource` so that the previous resolved value is preserved while the resource is loading or reloading. This pre...

Configures global validation execution defaults — when validators should run relative to a field's reactive state. By d...

Configures global value exclusion defaults for form submission output. Value exclusion is **enabled by default** — fiel...

Zero-cost type carrier used in wrapper registrations. Returns `undefined` at runtime but is typed as `T`, so TypeScript...

Write a value into a FieldTree's underlying signal. Signal Forms stores `FieldState.value` as a `WritableSignal`; this h...

Multi-provider token populated by `provideAddonActions({...})` calls. `ADDON_ACTION_REGISTRY` aggregates these into a si...

Form-scoped name → handler map. Read by adapter button kinds at click time for `actionRef: 'name'` lookups. Provided at ...

Cache for resolved addon-kind components. Provided per-form by `provideDynamicFormDI()` so two `<df-dynamic-form>` inst...

Multi-provider token used by `withCustomAddon(...)` features to contribute addon kind definitions. `provideDynamicForm` ...

Global registry of addon kinds. Populated by `withCustomAddon(...)` features and adapter feature helpers (e.g., `withPr...

Injection token for providing array context metadata to mappers and components. This token is optionally provided by Ar...

Built-in field types provided by the dynamic form library. Each field type is validated at compile time using satisfies...

Injection token for form-level default props. Default props are form-wide property defaults that are merged with field-...

Injection token for form-level default validation messages. Default validation messages act as fallbacks when fields ha...

Injection token for form-level default wrappers. Provides a Signal of the `defaultWrappers` array from FormConfig. Cons...

Map of named `TemplateRef`s collected by `<df-dynamic-form>` from `<ng-template dfTemplate="...">` children projected in...

Injection token for the dynamic forms logger. Provided by provideDynamicForm() with ConsoleLogger as default. Override ...

Injection token for the global field type registry. Provides access to the map of registered field types throughout the...

Injection token for providing field signal context to mappers and components. The field signal context is the "nervous ...

Injection token for form-level options. Form options control form-wide behavior including button disabled states. Used ...

Injection token for providing group ancestry to mappers and components. Re-provided in two places: 1. `GroupFieldCompon...

Injection token for configuring the initialization timeout in milliseconds. Defaults to 10 seconds. When the timeout is ...

Injection token for the wrapper type registry. Provides access to the map of registered wrapper types. The registry is ...

Renderer for the `mat-button` addon kind. Renders `<button mat-icon-button>` when icon-only (no label), or `<button mat...

Renderer for the `mat-icon` addon kind. Outputs `<mat-icon>{icon}</mat-icon>` using Material Icons ligatures. The host ...

Module-augmentable seam for adding custom addon kinds to `mat-input` at the type level. Pair with `withCustomAddon(...)`...

Configuration options for Material Design form fields. These settings can be applied at two levels: - **Library-level**...

Decorative icon addon for Material fields. Renders `<mat-icon>{icon}</mat-icon>` using Material Icons ligatures — `icon...

Add array item button field - dispatches AppendArrayItemEvent

Insert array item button field - dispatches InsertArrayItemEvent (adds at specific index)

Union of all Material-shipped addon kinds.

Interactive button addon for Material fields. Renders `<button mat-icon-button>` (icon-only) or `<button mat-button>` (...

Material-specific FormConfig with type-safe defaultProps. Use this type alias when defining form configurations with Ma...

Material-specific props that can be set at form level and cascade to all fields. This is the same type as `MaterialConf...

Addon kinds accepted by `mat-input`. Material-specific kinds (`mat-icon`, `mat-button`) plus the universal `text` and `...

Next page button field - with preconfigured NextPageEvent

Previous page button field - with preconfigured PreviousPageEvent

Specific button field types with preconfigured events Submit button field - automatically disabled when form is invalid

Pop array item button field - dispatches PopArrayItemEvent (removes last item)

Prepend array item button field - dispatches PrependArrayItemEvent (adds at beginning)

Remove array item button field - dispatches RemoveAtIndexEvent or PopArrayItemEvent

Shift array item button field - dispatches ShiftArrayItemEvent (removes first item)

Register Material-shipped addon kinds (`mat-icon`, `mat-button`) standalone. **Most users don't need this** — `withMate...

Configure dynamic forms with Material Design field types, with Material-shipped addon kinds (`mat-icon`, `mat-button`) a...

Per-field writable signal that overrides the input's `type` attribute. Provided at the `mat-input` field component leve...

Injection token for Material Design form configuration. Use this to provide global configuration for Material form field...

Material Design field type definitions Follows the FieldTypeDefinition interface for proper registry integration

Material Design field type constants Based on available field components in the /fields folder