OpenFin Workspace API
    Preparing search index...

    Interface BaseField<T, D>

    The base type for form fields.

    interface BaseField<T extends keyof typeof FieldType, D = unknown> {
        helperText?: string;
        key: string;
        label?: string;
        type: T;
        validation?: Record<string, any>;
        value?: D;
    }

    Type Parameters

    • T extends keyof typeof FieldType
    • D = unknown

    Hierarchy (View Summary)

    Index
    helperText? key label? type validation? value?
    helperText?: string

    Helper text.

    key: string

    The property key that this field value will appear in the returned form object.

    label?: string

    Input label.

    type: T

    Field data type.

    validation?: Record<string, any>

    Validation rules used to validate user input.

    value?: D

    Default value for field, and where it will be written to

    Settings

    On This Page
    Properties