Interface SettingsMenuProps

interface SettingsMenuProps {
    children?: ReactNode;
    heading?: ReactNode;
    attributeChangedCallback?(attrName, oldValue, newValue): void;
    closeCurrentMenu?(): boolean;
    closeMenu?(menuId?): boolean;
    connectedCallback?(): void;
    disconnectedCallback?(): void;
    getMenuById?(menuId?): undefined | Menu | MenuGroup;
    hasCurrentMenu?(): boolean;
    isMenuOpen?(menuId?): boolean;
    openMenu?(menuId?, opener?): boolean;
}

Hierarchy (view full)

Properties

children? heading?

Methods

attributeChangedCallback? closeCurrentMenu? closeMenu? connectedCallback? disconnectedCallback? getMenuById? hasCurrentMenu? isMenuOpen? openMenu?

Properties

Optional children

children?: ReactNode

The menu's contents.

Optional heading

heading?: ReactNode

A slot for the menu's heading.

Methods

Optional attributeChangedCallback

  • attributeChangedCallback(attrName, oldValue, newValue): void

  • Parameters

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

    Returns void

Optional closeCurrentMenu

  • closeCurrentMenu(): boolean

  • Close the current menu.

    Returns boolean

Optional 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.

Optional connectedCallback

  • connectedCallback(): void

  • Returns void

Optional disconnectedCallback

  • disconnectedCallback(): void

  • Returns void

Optional getMenuById

  • getMenuById(menuId?): undefined | Menu | MenuGroup

  • Get the menu with the given ID.

    Parameters

    • Optional menuId: string

      The ID of the menu. If unset, returns this menu group.

    Returns undefined | Menu | MenuGroup

Optional hasCurrentMenu

  • hasCurrentMenu(): boolean

  • Whether this menu group has a currently open menu.

    Returns boolean

Optional 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

Optional 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