dynamic-forms / Function

withValueExclusionDefaults

Configures global value exclusion defaults for form submission output.

Value exclusion is enabled by default — field values are excluded from the (submitted) output based on their reactive state. Use this feature to override those defaults. This does NOT affect two-way binding (value model / entity) — fields retain their values internally.

Notes

Precedence rules:

  1. Per-field excludeValueIf* on FieldDef — wins for that field
  2. Per-form excludeValueIf* on FormOptions — wins for all fields in that form
  3. Global withValueExclusionDefaults() — baseline default
  4. No global feature — uses token default (all enabled)

Presentation

function withValueExclusionDefaults(
  config?: Partial<ValueExclusionConfig> | undefined,
): DynamicFormFeature<"value-exclusion">;

Returns

DynamicFormFeature<"value-exclusion"> -

A DynamicFormFeature that configures value exclusion defaults

Parameters

NameTypeDescription
config
Partial<ValueExclusionConfig> | undefined

Partial override of exclusion rules. Unspecified properties default to true.

Example usage

Default behavior (all exclusions enabled)

Disable specific exclusions

provideDynamicForm(
  ...withMaterialFields(),
  withValueExclusionDefaults({ excludeValueIfReadonly: false })
)

Disable all exclusions (restore pre-v1 behavior)

provideDynamicForm(
  ...withMaterialFields(),
  withValueExclusionDefaults({
    excludeValueIfHidden: false,
    excludeValueIfDisabled: false,
    excludeValueIfReadonly: false,
  })
)