Source: ui/settings_menu.js

  1. /*! @license
  2.  * Shaka Player
  3.  * Copyright 2016 Google LLC
  4.  * SPDX-License-Identifier: Apache-2.0
  5.  */
  8. goog.provide('shaka.ui.SettingsMenu');
  10. goog.require('shaka.ui.Element');
  11. goog.require('shaka.ui.Enums');
  12. goog.require('shaka.ui.Utils');
  13. goog.require('shaka.util.Dom');
  14. goog.require('shaka.util.FakeEvent');
  15. goog.require('shaka.util.Iterables');
  16. goog.requireType('shaka.ui.Controls');
  19. /**
  20.  * @extends {shaka.ui.Element}
  21.  * @implements {shaka.extern.IUISettingsMenu}
  22.  * @export
  23.  */
  24. shaka.ui.SettingsMenu = class extends shaka.ui.Element {
  25.   /**
  26.    * @param {!HTMLElement} parent
  27.    * @param {!shaka.ui.Controls} controls
  28.    * @param {string} iconText
  29.    */
  30.   constructor(parent, controls, iconText) {
  31.     super(parent, controls);
  33.     this.addButton_(iconText);
  35.     this.addMenu_();
  37.     this.inOverflowMenu_();
  39.     this.eventManager.listen(this.button, 'click', () => {
  40.       if (!this.controls.isOpaque()) {
  41.         return;
  42.       }
  43.       this.onButtonClick_();
  44.     });
  45.   }
  48.   /**
  49.    * @param {string} iconText
  50.    * @private
  51.    */
  52.   addButton_(iconText) {
  53.     /** @protected {!HTMLButtonElement} */
  54.     this.button = shaka.util.Dom.createButton();
  55.     this.button.classList.add('shaka-overflow-button');
  57.     /** @protected {!HTMLElement}*/
  58.     this.icon = shaka.util.Dom.createHTMLElement('i');
  59.     this.icon.classList.add('material-icons-round');
  60.     this.icon.textContent = iconText;
  61.     this.button.appendChild(this.icon);
  63.     const label = shaka.util.Dom.createHTMLElement('label');
  64.     label.classList.add('shaka-overflow-button-label');
  65.     label.classList.add('shaka-overflow-menu-only');
  67.     /** @protected {!HTMLElement}*/
  68.     this.nameSpan = shaka.util.Dom.createHTMLElement('span');
  69.     label.appendChild(this.nameSpan);
  71.     /** @protected {!HTMLElement}*/
  72.     this.currentSelection = shaka.util.Dom.createHTMLElement('span');
  73.     this.currentSelection.classList.add('shaka-current-selection-span');
  74.     label.appendChild(this.currentSelection);
  75.     this.button.appendChild(label);
  77.     this.parent.appendChild(this.button);
  78.   }
  81.   /** @private */
  82.   addMenu_() {
  83.     /** @protected {!HTMLElement}*/
  84.     this.menu = shaka.util.Dom.createHTMLElement('div');
  85.     this.menu.classList.add('shaka-no-propagation');
  86.     this.menu.classList.add('shaka-show-controls-on-mouse-over');
  87.     this.menu.classList.add('shaka-settings-menu');
  88.     this.menu.classList.add('shaka-hidden');
  90.     /** @protected {!HTMLButtonElement}*/
  91.     this.backButton = shaka.util.Dom.createButton();
  92.     this.backButton.classList.add('shaka-back-to-overflow-button');
  93.     this.menu.appendChild(this.backButton);
  94.     this.eventManager.listen(this.backButton, 'click', () => {
  95.       this.controls.hideSettingsMenus();
  96.     });
  98.     const backIcon = shaka.util.Dom.createHTMLElement('i');
  99.     backIcon.classList.add('material-icons-round');
  100.     backIcon.textContent = shaka.ui.Enums.MaterialDesignIcons.CLOSE;
  101.     this.backButton.appendChild(backIcon);
  103.     /** @protected {!HTMLElement}*/
  104.     this.backSpan = shaka.util.Dom.createHTMLElement('span');
  105.     this.backButton.appendChild(this.backSpan);
  107.     const controlsContainer = this.controls.getControlsContainer();
  108.     controlsContainer.appendChild(this.menu);
  109.   }
  111.   /** @private */
  112.   inOverflowMenu_() {
  113.     // Initially, submenus are created with a "Close" option. When present
  114.     // inside of the overflow menu, that option must be replaced with a
  115.     // "Back" arrow that returns the user to the main menu.
  116.     if (this.parent.classList.contains('shaka-overflow-menu')) {
  117.       this.backButton.firstChild.textContent =
  118.             shaka.ui.Enums.MaterialDesignIcons.BACK;
  120.       this.eventManager.listen(this.menu, 'click', () => {
  121.         shaka.ui.Utils.setDisplay(this.menu, false);
  122.         shaka.ui.Utils.setDisplay(this.parent, true);
  124.         const isDisplayed =
  125.         (element) => element.classList.contains('shaka-hidden') == false;
  127.         const Iterables = shaka.util.Iterables;
  128.         if (Iterables.some(this.parent.childNodes, isDisplayed)) {
  129.           // Focus on the first visible child of the overflow menu
  130.           const visibleElements =
  131.             Iterables.filter(this.parent.childNodes, isDisplayed);
  132.           /** @type {!HTMLElement} */ (visibleElements[0]).focus();
  133.         }
  135.         // Make sure controls are displayed
  136.         this.controls.computeOpacity();
  137.       });
  138.     }
  139.   }
  142.   /** @private */
  143.   onButtonClick_() {
  144.     if (this.menu.classList.contains('shaka-hidden')) {
  145.       this.controls.dispatchEvent(new shaka.util.FakeEvent('submenuopen'));
  146.       shaka.ui.Utils.setDisplay(this.menu, true);
  147.       shaka.ui.Utils.focusOnTheChosenItem(this.menu);
  148.     } else {
  149.       shaka.ui.Utils.setDisplay(this.menu, false);
  150.     }
  151.   }
  152. };