OpenFin Workspace API
    Preparing search index...

    Interface CheckboxGroupField<W>

    The base type for form fields.

    interface CheckboxGroupField<
        W extends CheckboxGroupWidget = CheckboxGroupWidget,
    > {
        helperText?: string;
        key: string;
        label?: string;
        type: "checkboxGroup";
        validation?: Record<string, any>;
        value?: string[];
        widget: W;
    }

    Type Parameters

    Hierarchy (View Summary)

    • BaseField<"checkboxGroup", string[]>
      • CheckboxGroupField
    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: "checkboxGroup"

    Field data type.

    validation?: Record<string, any>

    Validation rules used to validate user input.

    value?: string[]

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

    widget: W

    Settings

    On This Page
    Properties