Documentation - v20.0.0-dev
    Preparing search index...

    Bounds of a NumberController.

    interface NumberControllerOptions {
        description: string;
        hidden?: boolean;
        max: number;
        min: number;
        skipSave?: boolean;
        step: number;
    }

    Hierarchy (View Summary)

    Index

    Properties

    description: string

    What it changes, for the user: an interface shows it (e.g. as the tooltip of its label).

    hidden?: boolean

    Whether an interface leaves it out: a technical setting (sizes, workers, tunings), changed by code only. Default false.

    max: number

    Largest value.

    min: number

    Smallest value.

    skipSave?: boolean

    Whether it is left out of the saved settings (Settings.saveToLocalStorage): a value set again at each visit, or that must not be kept (e.g. a token). Default false.

    step: number

    Step of a control editing it (e.g. a slider). A whole step keeps the value whole (a count, a size); otherwise the value is not rounded to it.