AdaptableFormFieldGroup

Logical grouping of related fields, with an optional title and description. Use to break long forms into visually distinct sections.

Groups behave like fields when it comes to hidden: a hidden group is not rendered and its child fields are excluded from validation. They are otherwise transparent - each child field continues to drive its own value, validation, and onValueChange lifecycle.

In the inline layout the group's title/description are not rendered (the layout is too compact for sectioning). The child fields are laid out inline alongside the rest.

export interface

Properties

Property Details

description

Optional description rendered immediately below the title.

description?: string;

Property Value

string

fields

Fields contained in the group. Inner items may be a single field or an array of fields (rendered side-by-side on the same row, exactly like the top-level shorthand).

fields: (AdaptableFormField | AdaptableFormField[])[];

Property Value

(AdaptableFormField|AdaptableFormField[])[]

hidden

Hide the entire group. Either a boolean or a function evaluated against the current form data. Hidden groups skip rendering and exclude their children from validation.

hidden?: boolean | ((formData: AdaptableFormData, context: BaseContext) => boolean);

Property Value

boolean | ((formData:AdaptableFormData, context:BaseContext) => boolean)

kind

Discriminator - identifies the item as a group rather than a field.

kind: 'group';

Property Value

'group'

title

Optional title rendered as the section header.

title?: string;

Property Value

string