@resistdesign/voltra
    Preparing search index...

    Type Alias FieldRenderContext

    Context passed to field renderers.

    type FieldRenderContext = {
        allowCustomSelection?: boolean;
        constraints?: FieldConstraints;
        customType?: string;
        disabled: boolean;
        error?: string;
        field: TypeInfoField;
        fieldKey: string;
        format?: string;
        label: string;
        onChange: (value: FieldValue) => void;
        onCustomTypeAction?: (payload: CustomTypeActionPayload) => void;
        onRelationAction?: (payload: RelationActionPayload) => void;
        possibleValues?: LiteralValue[];
        required: boolean;
        value: FieldValue | undefined;
    }
    Index

    Properties

    allowCustomSelection? constraints? customType? disabled error? field fieldKey format? label onChange onCustomTypeAction? onRelationAction? possibleValues? required value

    Properties

    allowCustomSelection?: boolean

    Whether custom entries are allowed for selectable values.

    constraints?: FieldConstraints

    Optional validation and UI constraints.

    customType?: string

    Optional custom type identifier.

    disabled: boolean

    True when the field UI should be disabled.

    error?: string

    Optional error message to display under the field.

    field: TypeInfoField

    Type info describing the field to render.

    fieldKey: string

    Key that identifies the field in the form values.

    format?: string

    Optional format hint for the field.

    label: string

    Display label for the field.

    onChange: (value: FieldValue) => void

    Change handler for the field value.

    onCustomTypeAction?: (payload: CustomTypeActionPayload) => void

    Optional callback for custom type actions.

    onRelationAction?: (payload: RelationActionPayload) => void

    Optional callback for relation actions.

    possibleValues?: LiteralValue[]

    Allowed literal values for the field.

    required: boolean

    True when the field must be provided.

    value: FieldValue | undefined

    Current value for the field.

    Settings

    Member Visibility

    On This Page

    Properties