AdaptableFormFieldRenderParams

Parameters provided to when rendering a custom field type.

TypeScript

export interface

Properties

Property	Type	Description
context	`BaseContext`	Adaptable context (carries `adaptableApi`, etc.). When the form is hosted by a Custom Toolbar this is in fact a `CustomToolbarFormContext`.
disabled	`boolean`	Resolved disabled state of the field (after evaluating `field.disabled` if it's a function).
error	`string`	Current validation error for this field, if any.
field	`AdaptableFormField`	The field definition itself - useful when sharing one render function across several `custom` fields.
formData	`AdaptableFormData`	The current values of all fields in the form, keyed by field `name`.
setValue	`(newValue: any) => void`	Setter to update the field's value. Triggers form-level `onChange`, per-field `onValueChange` and re-validation.
value	`any`	The field's current value

Adaptable context (carries adaptableApi, etc.). When the form is hosted by a Custom Toolbar this is in fact a CustomToolbarFormContext.

TypeScript

context: BaseContext;

Resolved disabled state of the field (after evaluating field.disabled if it's a function).

TypeScript

disabled: boolean;

boolean

Current validation error for this field, if any.

TypeScript

error?: string;

string

The field definition itself - useful when sharing one render function across several custom fields.

TypeScript

field: AdaptableFormField;

The current values of all fields in the form, keyed by field name.

TypeScript

formData: AdaptableFormData;

Setter to update the field's value. Triggers form-level onChange, per-field onValueChange and re-validation.

TypeScript

setValue: (newValue: any) => void;

(newValue: any) => void

The field's current value

TypeScript

value: any;

any