form-schema-runtime - v1.0.0
    Preparing search index...

    Interface FieldRenderContext

    Context passed to custom field renderers.

    interface FieldRenderContext {
        classPrefix: string;
        describedBy: string;
        errorId: string;
        errors: string[];
        events: EventRegistry;
        field: RenderedFieldSchema;
        helpId: string;
        inputId: string;
        schema: FormSchema;
        state: FormStateSnapshot;
        value: FieldValue;
        markTouched(): void;
        setValue(value: FieldValue): void;
    }
    Index

    Properties

    classPrefix describedBy errorId errors events field helpId inputId schema state value

    Methods

    markTouched setValue

    Properties

    classPrefix: string

    Active CSS class prefix.

    describedBy: string

    Space-separated IDs that should be applied to aria-describedby.

    errorId: string

    Stable error element ID generated by the runtime.

    errors: string[]

    Current field errors, if any.

    events: EventRegistry

    Event registry that custom renderers must use for automatic cleanup.

    field: RenderedFieldSchema

    Normalized field definition for the field being rendered.

    helpId: string

    Stable help text element ID generated by the runtime.

    inputId: string

    Stable input ID generated by the runtime.

    schema: FormSchema

    Schema for the owning form.

    state: FormStateSnapshot

    Current immutable form state snapshot.

    value: FieldValue

    Current field value.

    Methods

    Settings

    Member Visibility

    On This Page

    Properties
    Methods