Interface ToggleControlOptions

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

Hierarchy

  • ToggleControlOptions

Properties

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

Properties

Optional addClass

addClass?: string

Additional css class string

Optional addClassOff

addClassOff?: string

Additional css class string for off state only.

Optional addClassOn

addClassOn?: string

Additional css class string for on state only.

Optional getStatus

getStatus?: (() => boolean)

Type declaration

    • (): boolean

    • Get current control status.

      Returns boolean

Optional html

html?: HtmlToggle | HtmlDef

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

Optional onClick

onClick?: OnToggleClick

Set an action to execute when button clicked.

Optional status

status?: boolean

Boolean state of control.

Optional title

title?: string | TitleToggle

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

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc