Class MenuGroup

<theoplayer-menu-group> - A group of Menus.

This can contain multiple other menus, which can be opened with MenuGroup.openMenu. When a MenuButton in one menu opens another menu in this group, it is opened as a "submenu". When a submenu is closed, the menu that originally opened it is shown again.

Attribute

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

Hierarchy (view full)

Constructors

constructor

Accessors

observedAttributes

Methods

_upgradeProperty attributeChangedCallback closeCurrentMenu closeMenu connectedCallback disconnectedCallback getMenuById hasCurrentMenu isMenuOpen openMenu

Constructors

constructor

Accessors

Static observedAttributes

Methods

Protected _upgradeProperty

attributeChangedCallback

  • attributeChangedCallback(attrName, oldValue, newValue): void

  • Parameters

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

    Returns void

closeCurrentMenu

closeMenu

  • closeMenu(menuId?): boolean

  • Closes the menu with the given ID.

    If no ID is given, then the entire menu group is closed.

    If the given menu has opened one or more submenus, then those are also closed. If the last open menu is closed, then the menu group also becomes closed.

    Parameters

    • Optional menuId: string

      The ID of the menu to close.

    Returns boolean

    True if the given menu was found and closed.

connectedCallback

disconnectedCallback

getMenuById

hasCurrentMenu

isMenuOpen

  • isMenuOpen(menuId?): boolean

  • Whether the menu with the given ID is currently open.

    Parameters

    • Optional menuId: string

      The ID of the menu.

    Returns boolean

openMenu

  • openMenu(menuId?, opener?): boolean

  • Open the menu with the given ID.

    If no ID is given, the first menu in the group is opened.

    If there's already an open menu, then the new menu is opened as a "submenu". When it closed, the previous menu is opened.

    Parameters

    • Optional menuId: string

      The ID of the menu to open.

    • Optional opener: HTMLElement

      The control that opened the menu. When the menu is closed, focus is moved back to this control.

    Returns boolean

    True if the given menu was found.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc