Roqueform
    Preparing search index...

    Interface FieldEvent<Mixin>

    The event published for subscribers of a field.

    interface FieldEvent<Mixin extends object = {}> {
        payload: any;
        relatedTarget: null | Field<any, Mixin>;
        target: Field<any, Mixin>;
        type: string & {} | FieldEventType;
    }

    Type Parameters

    • Mixin extends object = {}

      The mixin added to the field.

    Index

    Properties

    payload relatedTarget target type

    Properties

    payload: any

    The payload carried by the event.

    relatedTarget: null | Field<any, Mixin>

    The field that caused the event to be published.

    For example, if a parent field value is changed and the child field value is changed as the result. Then the change event published on the child field would have relatedTarget set to the parent field.

    target: Field<any, Mixin>

    The field onto which this event was published.

    type: string & {} | FieldEventType

    The type of the event.

    Settings

    Member Visibility

    On This Page

    Properties