Class SettingsMenuButton

<theoplayer-settings-menu-button> - A menu button that opens a SettingsMenu.

Attribute

menu - The ID of the settings menu.

Hierarchy (View Summary)

MenuButton
- SettingsMenuButton

Index

Constructors

Accessors

disabled menu observedAttributes

Methods

_onKeyDown _onKeyUp _upgradeProperty attributeChangedCallback connectedCallback disconnectedCallback handleClick

Constructors

constructor

new SettingsMenuButton(): SettingsMenuButton
Returns SettingsMenuButton
Overrides MenuButton.constructor
- Defined in components/SettingsMenuButton.ts:16

Accessors

disabled

get disabled(): boolean
Whether the button is disabled.

When disabled, the button cannot be clicked.

Returns boolean
Inherited from MenuButton.disabled
- Defined in components/Button.ts:86
set disabled(disabled: boolean): void
Parameters
- disabled: boolean
Returns void
Inherited from MenuButton.disabled
- Defined in components/Button.ts:90

menu

get menu(): null | string
The ID of the menu to open.

Returns null | string
Inherited from MenuButton.menu
- Defined in components/MenuButton.ts:37
set menu(menuId: null | string): void
Parameters
- menuId: null | string
Returns void
Inherited from MenuButton.menu
- Defined in components/MenuButton.ts:41

`Static`observedAttributes

get observedAttributes(): Attribute[]
Returns Attribute[]
Inherited from MenuButton.observedAttributes
- Defined in components/MenuButton.ts:16

Methods

`Protected` `Readonly`_onKeyDown

_onKeyDown(e: KeyboardEvent): void
Parameters
- e: KeyboardEvent
Returns void
Inherited from MenuButton._onKeyDown
- Defined in components/Button.ts:139

`Protected` `Readonly`_onKeyUp

_onKeyUp(e: KeyboardEvent): void
Parameters
- e: KeyboardEvent
Returns void
Inherited from MenuButton._onKeyUp
- Defined in components/Button.ts:147

`Protected`_upgradeProperty

_upgradeProperty(prop: keyof SettingsMenuButton): void
Parameters
- prop: keyof SettingsMenuButton
Returns void
Inherited from MenuButton._upgradeProperty
- Defined in components/Button.ts:49

attributeChangedCallback

attributeChangedCallback(attrName: string, oldValue: any, newValue: any): void
Parameters
- attrName: string
- oldValue: any
- newValue: any
Returns void
Inherited from MenuButton.attributeChangedCallback
- Defined in components/MenuButton.ts:49

connectedCallback

connectedCallback(): void
Returns void
Overrides MenuButton.connectedCallback
- Defined in components/SettingsMenuButton.ts:20

disconnectedCallback

disconnectedCallback(): void
Returns void
Inherited from MenuButton.disconnectedCallback
- Defined in components/Button.ts:75

`Protected`handleClick

handleClick(): void
Handle a button click.

By default, this does nothing. Subclasses can override this method to add behavior to the button.

Returns void
Inherited from MenuButton.handleClick
- Defined in components/MenuButton.ts:58