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.     /** @private {HTMLElement } */
  34.     this.videoContainer_ = this.controls.getVideoContainer();
  36.     this.addButton_(iconText);
  38.     this.addMenu_();
  40.     this.inOverflowMenu_();
  42.     this.eventManager.listen(this.button, 'click', () => {
  43.       if (!this.controls.isOpaque()) {
  44.         return;
  45.       }
  46.       this.onButtonClick_();
  47.     });
  48.   }
  51.   /**
  52.    * @param {string} iconText
  53.    * @private
  54.    */
  55.   addButton_(iconText) {
  56.     /** @protected {!HTMLButtonElement} */
  57.     this.button = shaka.util.Dom.createButton();
  58.     this.button.classList.add('shaka-overflow-button');
  60.     /** @protected {!HTMLElement}*/
  61.     this.icon = shaka.util.Dom.createHTMLElement('i');
  62.     this.icon.classList.add('material-icons-round');
  63.     this.icon.textContent = iconText;
  64.     this.button.appendChild(this.icon);
  66.     const label = shaka.util.Dom.createHTMLElement('label');
  67.     label.classList.add('shaka-overflow-button-label');
  68.     label.classList.add('shaka-overflow-menu-only');
  69.     label.classList.add('shaka-overflow-button-label-inline');
  71.     /** @protected {!HTMLElement}*/
  72.     this.nameSpan = shaka.util.Dom.createHTMLElement('span');
  73.     label.appendChild(this.nameSpan);
  75.     /** @protected {!HTMLElement}*/
  76.     this.currentSelection = shaka.util.Dom.createHTMLElement('span');
  77.     this.currentSelection.classList.add('shaka-current-selection-span');
  78.     label.appendChild(this.currentSelection);
  79.     this.button.appendChild(label);
  81.     this.parent.appendChild(this.button);
  82.   }
  85.   /** @private */
  86.   addMenu_() {
  87.     /** @protected {!HTMLElement}*/
  88.     this.menu = shaka.util.Dom.createHTMLElement('div');
  89.     this.menu.classList.add('shaka-no-propagation');
  90.     this.menu.classList.add('shaka-show-controls-on-mouse-over');
  91.     this.menu.classList.add('shaka-settings-menu');
  92.     this.menu.classList.add('shaka-hidden');
  94.     /** @protected {!HTMLButtonElement}*/
  95.     this.backButton = shaka.util.Dom.createButton();
  96.     this.backButton.classList.add('shaka-back-to-overflow-button');
  97.     this.menu.appendChild(this.backButton);
  98.     this.eventManager.listen(this.backButton, 'click', () => {
  99.       this.controls.hideSettingsMenus();
  100.     });
  102.     const backIcon = shaka.util.Dom.createHTMLElement('i');
  103.     backIcon.classList.add('material-icons-round');
  104.     backIcon.textContent = shaka.ui.Enums.MaterialDesignIcons.CLOSE;
  105.     this.backButton.appendChild(backIcon);
  107.     /** @protected {!HTMLElement}*/
  108.     this.backSpan = shaka.util.Dom.createHTMLElement('span');
  109.     this.backButton.appendChild(this.backSpan);
  111.     const controlsContainer = this.controls.getControlsContainer();
  112.     controlsContainer.appendChild(this.menu);
  113.   }
  115.   /** @private */
  116.   inOverflowMenu_() {
  117.     // Initially, submenus are created with a "Close" option. When present
  118.     // inside of the overflow menu, that option must be replaced with a
  119.     // "Back" arrow that returns the user to the main menu.
  120.     if (this.parent.classList.contains('shaka-overflow-menu')) {
  121.       this.backButton.firstChild.textContent =
  122.             shaka.ui.Enums.MaterialDesignIcons.BACK;
  124.       this.eventManager.listen(this.menu, 'click', () => {
  125.         shaka.ui.Utils.setDisplay(this.menu, false);
  126.         shaka.ui.Utils.setDisplay(this.parent, true);
  128.         const isDisplayed =
  129.         (element) => element.classList.contains('shaka-hidden') == false;
  131.         const Iterables = shaka.util.Iterables;
  132.         if (Iterables.some(this.parent.childNodes, isDisplayed)) {
  133.           // Focus on the first visible child of the overflow menu
  134.           const visibleElements =
  135.             Iterables.filter(this.parent.childNodes, isDisplayed);
  136.           /** @type {!HTMLElement} */ (visibleElements[0]).focus();
  137.         }
  139.         // Make sure controls are displayed
  140.         this.controls.computeOpacity();
  142.         this.computeMaxHeight_();
  143.       });
  144.     }
  145.   }
  148.   /** @private */
  149.   onButtonClick_() {
  150.     if (this.menu.classList.contains('shaka-hidden')) {
  151.       this.controls.dispatchEvent(new shaka.util.FakeEvent('submenuopen'));
  152.       shaka.ui.Utils.setDisplay(this.menu, true);
  153.       shaka.ui.Utils.focusOnTheChosenItem(this.menu);
  154.       this.computeMaxHeight_();
  155.     } else {
  156.       shaka.ui.Utils.setDisplay(this.menu, false);
  157.     }
  158.   }
  161.   /**
  162.    * @private
  163.    */
  164.   computeMaxHeight_() {
  165.     const rectMenu = this.menu.getBoundingClientRect();
  166.     const styleMenu = window.getComputedStyle(this.menu);
  167.     const paddingTop = parseFloat(styleMenu.paddingTop);
  168.     const paddingBottom = parseFloat(styleMenu.paddingBottom);
  169.     const rectContainer = this.videoContainer_.getBoundingClientRect();
  170.     const heightIntersection =
  171.         rectMenu.bottom - rectContainer.top - paddingTop - paddingBottom;
  173.     this.menu.style.maxHeight = heightIntersection + 'px';
  174.   }
  175. };