Roqueform
    Preparing search index...

    Interface FieldRendererProps<F>

    Properties of the FieldRenderer component.

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

    Type Parameters

    • F extends Field

      The rendered field.

    Hierarchy (View Summary)

    Index

    Properties

    children field isEagerlyUpdated? onChange?

    Properties

    children: (field: F) => ReactNode

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

    field: F

    The field that triggers re-renders.

    isEagerlyUpdated?: boolean

    If set to true then the component is re-rendered whenever the field itself, its parent fields or descendant fields are updated. If set to false then the component 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).

    false
    onChange?: (value: InferValue<F>) => void

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

    Type declaration

      • (value: InferValue<F>): void

      • Parameters

        • value: InferValue<F>

          The new field value.

        Returns void

    Settings

    Member Visibility

    On This Page

    Properties