OpenFin Workspace API
    Preparing search index...

    Interface NumberField<W>

    Number field within a form.

    interface NumberField<W extends NumberWidget = NumberWidget> {
        helperText?: string;
        key: string;
        label?: string;
        type: "number";
        validation?: Partial<
            {
                lessThan: ValidationEntry<number>;
                max: ValidationEntry<number>;
                min: ValidationEntry<number>;
                moreThan: ValidationEntry<number>;
                negative: ValidationEntry;
                positive: ValidationEntry;
                required: ValidationEntry;
            },
        >;
        value?: number;
        widget: W;
    }

    Type Parameters

    Hierarchy (View Summary)

    Index
    helperText? key label? type validation? value? widget
    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: "number"

    Field data type.

    validation?: Partial<
        {
            lessThan: ValidationEntry<number>;
            max: ValidationEntry<number>;
            min: ValidationEntry<number>;
            moreThan: ValidationEntry<number>;
            negative: ValidationEntry;
            positive: ValidationEntry;
            required: ValidationEntry;
        },
    >

    Validation rules used to validate user input.

    value?: number

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

    widget: W

    Settings

    On This Page
    Properties