@theoplayer/web-ui
    Preparing search index...

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

    <theoplayer-menu>

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

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

    heading - A slot for the menu's heading.

    Hierarchy (View Summary)

    Index

    Other

    closeOnInput: boolean

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

    lifecycle

    • Invoked when the component is added to the document's DOM.

      In connectedCallback() you should setup tasks that should only occur when the element is connected to the document. The most common of these is adding event listeners to nodes external to the element, like a keydown event handler added to the window.

      connectedCallback() {
      super.connectedCallback();
      addEventListener('keydown', this._handleKeydown);
      }

      Typically, anything done in connectedCallback() should be undone when the element is disconnected, in disconnectedCallback().

      Returns void

    rendering

    shadowRootOptions: ShadowRootInit = ...

    Options used when calling attachShadow. Set this property to customize the options for the shadowRoot; for example, to create a closed shadowRoot: {mode: 'closed'}.

    Note, these options are used in createRenderRoot. If this method is customized, options should be respected if possible.

    • Invoked on each update to perform rendering tasks. This method may return any value renderable by lit-html's ChildPart - typically a TemplateResult. Setting properties inside this method will not trigger the element to update.

      Returns HTMLTemplateResult

    styles

    styles: CSSResult[] = ...

    Array of styles to apply to the element. The styles should be defined using the css tag function, via constructible stylesheets, or imported from native CSS module scripts.

    Note on Content Security Policy:

    Element styles are implemented with <style> tags when the browser doesn't support adopted StyleSheets. To use such <style> tags with the style-src CSP directive, the style-src value must either include 'unsafe-inline' or nonce-<base64-value> with <base64-value> replaced be a server-generated nonce.

    To provide a nonce to use on generated <style> elements, set window.litNonce to a server-generated nonce in your page's HTML, before loading application code:

    <script>
    // Generated and unique per request:
    window.litNonce = 'a1b2c3d4';
    </script>