Interface FieldRendererProps<F>

Properties of the FieldRenderer component.

Template: Field

The rendered field.

interface FieldRendererProps<F> {
    children: ((field) => ReactNode);
    eagerlyUpdated?: boolean;
    field: F;
    onChange?: ((value) => void);
}

Type Parameters

Properties

children: ((field) => ReactNode)

The render function that receive a rendered field as an argument.

Type declaration

    • (field): ReactNode
    • The render function that receive a rendered field as an argument.

      Parameters

      • field: F

      Returns ReactNode

eagerlyUpdated?: boolean

If set to true then FieldRenderer is re-rendered whenever the field itself, its parent fields or descendant fields are updated. If set to false then FieldRenderer re-rendered only if the field was directly changed (updates from parent and descendants are ignored, even if they affect the value of the field).

Default

false
field: F

The field that triggers re-renders.

onChange?: ((value) => void)

Triggered when the field value received a non-transient update.

Type declaration

    • (value): void
    • Triggered when the field value received a non-transient update.

      Parameters

      Returns void

Param: value

The new field value.