Class Menu

<theoplayer-menu> - A menu that can be opened on top of the player.

The menu has a heading at the top, with a close button and a heading text.

Attribute

menu-close-on-input - Whether to automatically close the menu whenever one of its controls receives an input (e.g. when a radio button is clicked).

Attribute

menu-opened (readonly) - Whether the menu is currently open.

Slot

heading - A slot for the menu's heading.

Hierarchy (View Summary)

Constructors

constructor

Accessors

closeOnInput observedAttributes

Methods

_upgradeProperty attributeChangedCallback closeMenu connectedCallback disconnectedCallback openMenu

Constructors

constructor

  • new Menu(options?: MenuOptions): Menu

    Creates a menu.

    By default, the button has an unnamed <slot> for its contents, and a named "heading" <slot> for its heading text. Subclasses can override this by passing a different MenuOptions.template in the options, using menuTemplate to correctly style the custom template.

    Parameters

    • Optionaloptions: MenuOptions

      The options for this menu.

    Returns Menu

Accessors

closeOnInput

  • get closeOnInput(): boolean

    Whether to automatically close the menu whenever one of its controls receives an input (e.g. when a radio button is clicked).

    Returns boolean

  • set closeOnInput(value: boolean): void

    Parameters

    • value: boolean

    Returns void

StaticobservedAttributes

Methods

Protected_upgradeProperty

attributeChangedCallback

  • attributeChangedCallback(attrName: string, oldValue: any, newValue: any): void

    Parameters

    • attrName: string
    • oldValue: any
    • newValue: any

    Returns void

closeMenu

connectedCallback

disconnectedCallback

openMenu

Settings

Member Visibility

On This Page

Constructors
Accessors
Methods