dynamic-forms / Function

isContainerField

Type guard to check if a field is a container field (page, row, group, or array) Container fields have a 'fields' property and don't contribute values directly. This overload works with RegisteredFieldTypes for full type narrowing.

Presentation

function isContainerField(field: RegisteredFieldTypes): boolean;

Returns

boolean

Parameters

NameTypeDescription
field
RegisteredFieldTypes

Overloads

Overload #1

Type guard to check if a field is a container field (page, row, group, or array) Container fields have a 'fields' property and don't contribute values directly. This overload works with RegisteredFieldTypes for full type narrowing.

Presentation
Parameters
NameTypeDescription
field
RegisteredFieldTypes
Returns
boolean
Overload #2

Type guard to check if a field is a container field (page, row, group, or array). This overload works with any FieldDef for looser type checking.

Presentation
isContainerField(field: FieldDef<unknown>): boolean;
Parameters
NameTypeDescription
field
FieldDef<unknown>
Returns
boolean