Interface ToggleControlOptions

Options for creating a toggle control to layout customization and assigning a callback function

interface ToggleControlOptions {
    addClass?: string;
    addClassOff?: string;
    addClassOn?: string;
    getStatus?: (() => boolean);
    html?: HtmlDef | HtmlToggle;
    onClick?: OnToggleClick;
    status?: boolean;
    title?: string | TitleToggle;
}

Properties

addClass? addClassOff? addClassOn? getStatus? html? onClick? status? title?

Properties

OptionaladdClass

addClass?: string

Additional css class string

OptionaladdClassOff

addClassOff?: string

Additional css class string for off state only.

OptionaladdClassOn

addClassOn?: string

Additional css class string for on state only.

OptionalgetStatus

getStatus?: (() => boolean)

Get current control status.

Optionalhtml

html?: HtmlDef | HtmlToggle

Button content, can be set for each state (on or off).

OptionalonClick

onClick?: OnToggleClick

Set an action to execute when button clicked.

Optionalstatus

status?: boolean

Boolean state of control.

Optionaltitle

title?: string | TitleToggle

Button HTMLElement title, can be set for each state (on or off).

Settings

Member Visibility

On This Page

Properties