Function

withValueExclusionDefaults

@ng-forge/dynamic-forms

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.

Remarks

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)

Signature

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

Parameters

Name	Type	Description
`config`?	`Partial<ValueExclusionConfig>`	- Partial override of exclusion rules. Unspecified properties default to `true`.

Returns

DynamicFormFeature<"value-exclusion">

Examples

provideDynamicForm(
...withMaterialFields(),
withValueExclusionDefaults()
)

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

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

packages/dynamic-forms/src/lib/providers/features/value-exclusion/with-value-exclusion-defaults.ts:53