Documentation - v19.16.0-dev
    Preparing search index...

    A setting on or off: a value that is not a boolean (e.g. read from a storage) throws a TypeError.

    Hierarchy (View Summary)

    Index

    Constructors

    Properties

    Accessors

    Methods

    Constructors

    Properties

    defaultValue: boolean

    The value at first and after reset.

    description: string

    What it changes, for the user (see ValueControllerOptions.description).

    hidden: boolean

    Whether an interface leaves it out (see ValueControllerOptions.hidden).

    onChange: Signal<(value: boolean) => void> = ...

    Emitted with the new value when it changes; not when the value set is the current one.

    Accessors

    • get value(): T

      The current value.

      Returns T

    • set value(value: T): void

      Sets the value, validated first (see validate).

      Parameters

      • value: T

      Returns void

    Methods

    • Sets the value back to defaultValue.

      Returns void

    • The value kept for value: value itself by default; a subclass corrects it or throws a RangeError.

      Parameters

      • value: boolean

      Returns boolean