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

    Class TextTrackStyleMenu

    A menu to change the text track style of the player.

    <theoplayer-text-track-style-menu>

    heading - A slot for the menu's heading.

    Hierarchy (View Summary)

    Index

    Other

    • 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

      • OptionalmenuId: string

        The ID of the menu to close.

      Returns boolean

      True if the given menu was found and closed.

    • 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

      • OptionalmenuId: string

        The ID of the menu to open.

      • Optionalopener: 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.

    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 TemplateResult

    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>

    updates

    • Invoked when the element is first updated. Implement to perform one time work on the element after update.

      firstUpdated() {
      this.renderRoot.getElementById('my-text-area').focus();
      }

      Setting properties inside this method will trigger the element to update again after this update cycle completes.

      Returns void