openmixer — generated API reference
    Preparing search index...

    Interface AdapterSettingsField

    One field in an adapter type's settings form.

    interface AdapterSettingsField {
        default?: unknown;
        hint?: string;
        key: string;
        label: string;
        max?: number;
        min?: number;
        options?: readonly { label: string; value: string }[];
        required?: boolean;
        widget: AdapterFieldWidget;
    }
    Index
    default? hint? key label max? min? options? required? widget
    default?: unknown

    Default applied when the field is omitted.

    hint?: string

    Help text.

    key: string

    Settings key this field writes.

    label: string

    Human label.

    max?: number
    min?: number

    Bounds for a number widget.

    options?: readonly { label: string; value: string }[]

    Choices for a select widget.

    required?: boolean
    widget: AdapterFieldWidget

    Settings
    Member Visibility

    On This Page
    Properties