Type Alias ComponentFieldInstance<Data, Payload>

ComponentFieldInstance: Data & {
    _fieldData: Data;
    _fieldParams: IField;
    context: Record<string, any>;
    disabled: boolean;
    features: string[];
    incorrect: IManaged<Data, Payload>["incorrect"];
    invalid: IManaged<Data, Payload>["invalid"];
    onChange: (data: Partial<Data>) => void;
    onClick: (e: React.MouseEvent<any>) => void | Promise<void>;
    onValueChange: IManaged<Data, Payload>["onChange"];
    outlinePaper: boolean;
    payload: Payload;
    readonly: boolean;
    transparentPaper: boolean;
    value: IManaged<Data, Payload>["value"];
}

Represents parameters for a component field element callback.

Type Parameters

  • Data = any

    The data type of the field.

  • Payload = any

    The payload type of the field.

Type declaration

  • _fieldData: Data

    Represents the field data.

  • _fieldParams: IField

    Represents a field parameter for a particular field.

  • context: Record<string, any>

    Represents the context variable.

  • disabled: boolean

    Represents the state of disablement.

  • features: string[]
  • incorrect: IManaged<Data, Payload>["incorrect"]

    The 'incorrect' property of IManaged<Data, Payload> interface represents the incorrect value of a managed data object.

    Template: Data

    The type of the managed data object.

    Template: Payload

    The type of data payload that represents the incorrect value.

  • invalid: IManaged<Data, Payload>["invalid"]

    Represents the invalid property of the IManaged interface.

    This property stores the invalid state of a managed object in relation to its data and payload types.

    Template: Data

    The data type of the managed object.

    Template: Payload

    The payload type of the managed object.

  • onChange: (data: Partial<Data>) => void

    A callback function type that is called when a change event occurs.

  • onClick: (e: React.MouseEvent<any>) => void | Promise<void>
  • onValueChange: IManaged<Data, Payload>["onChange"]

    Callback function to handle the change event of a managed data object.

    Memberof

    IManaged

    Template: Data

    The type of data managed by the object.

    Template: Payload

    The type of payload passed to the change event handler.

    Param: data

    The updated data after the change.

    Param: payload

    The payload passed to the change event handler.

    Returns

  • outlinePaper: boolean

    Represents whether an outline paper is present.

  • payload: Payload

    Represents a payload object.

    Classdesc

    This class represents a payload object that can be used to send data between systems.

  • readonly: boolean

    Indicates whether a variable is read-only or not.

  • transparentPaper: boolean

    Represents whether the paper is transparent.

  • value: IManaged<Data, Payload>["value"]

Settings

Member Visibility