theme/boost/amd/src/drawers.js

  1. // This file is part of Moodle - http://moodle.org/
  2. //
  3. // Moodle is free software: you can redistribute it and/or modify
  4. // it under the terms of the GNU General Public License as published by
  5. // the Free Software Foundation, either version 3 of the License, or
  6. // (at your option) any later version.
  7. //
  8. // Moodle is distributed in the hope that it will be useful,
  9. // but WITHOUT ANY WARRANTY; without even the implied warranty of
  10. // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  11. // GNU General Public License for more details.
  12. //
  13. // You should have received a copy of the GNU General Public License
  14. // along with Moodle. If not, see <http://www.gnu.org/licenses/>.
  15. /**
  16. * Toggling the visibility of the secondary navigation on mobile.
  17. *
  18. * @module theme_boost/drawers
  19. * @copyright 2021 Bas Brands
  20. * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  21. */
  22. import ModalBackdrop from 'core/modal_backdrop';
  23. import Templates from 'core/templates';
  24. import * as Aria from 'core/aria';
  25. import {dispatchEvent} from 'core/event_dispatcher';
  26. import {debounce} from 'core/utils';
  27. import {isSmall, isLarge} from 'core/pagehelpers';
  28. import Pending from 'core/pending';
  29. import {setUserPreference} from 'core_user/repository';
  30. // The jQuery module is only used for interacting with Boostrap 4. It can we removed when MDL-71979 is integrated.
  31. import jQuery from 'jquery';
  32. let backdropPromise = null;
  33. const drawerMap = new Map();
  34. const SELECTORS = {
  35. BUTTONS: '[data-toggler="drawers"]',
  36. CLOSEBTN: '[data-toggler="drawers"][data-action="closedrawer"]',
  37. OPENBTN: '[data-toggler="drawers"][data-action="opendrawer"]',
  38. TOGGLEBTN: '[data-toggler="drawers"][data-action="toggle"]',
  39. DRAWERS: '[data-region="fixed-drawer"]',
  40. DRAWERCONTENT: '.drawercontent',
  41. PAGECONTENT: '#page-content',
  42. HEADERCONTENT: '.drawerheadercontent',
  43. };
  44. const CLASSES = {
  45. SCROLLED: 'scrolled',
  46. SHOW: 'show',
  47. NOTINITIALISED: 'not-initialized',
  48. };
  49. /**
  50. * Pixel thresshold to auto-hide drawers.
  51. *
  52. * @type {Number}
  53. */
  54. const THRESHOLD = 20;
  55. /**
  56. * Try to get the drawer z-index from the page content.
  57. *
  58. * @returns {Number|null} the z-index of the drawer.
  59. * @private
  60. */
  61. const getDrawerZIndex = () => {
  62. const drawer = document.querySelector(SELECTORS.DRAWERS);
  63. if (!drawer) {
  64. return null;
  65. }
  66. return parseInt(window.getComputedStyle(drawer).zIndex, 10);
  67. };
  68. /**
  69. * Add a backdrop to the page.
  70. *
  71. * @returns {Promise} rendering of modal backdrop.
  72. * @private
  73. */
  74. const getBackdrop = () => {
  75. if (!backdropPromise) {
  76. backdropPromise = Templates.render('core/modal_backdrop', {})
  77. .then(html => new ModalBackdrop(html))
  78. .then(modalBackdrop => {
  79. const drawerZindex = getDrawerZIndex();
  80. if (drawerZindex) {
  81. modalBackdrop.setZIndex(getDrawerZIndex() - 1);
  82. }
  83. modalBackdrop.getAttachmentPoint().get(0).addEventListener('click', e => {
  84. e.preventDefault();
  85. Drawers.closeAllDrawers();
  86. });
  87. return modalBackdrop;
  88. })
  89. .catch();
  90. }
  91. return backdropPromise;
  92. };
  93. /**
  94. * Get the button element to open a specific drawer.
  95. *
  96. * @param {String} drawerId the drawer element Id
  97. * @return {HTMLElement|undefined} the open button element
  98. * @private
  99. */
  100. const getDrawerOpenButton = (drawerId) => {
  101. let openButton = document.querySelector(`${SELECTORS.OPENBTN}[data-target="${drawerId}"]`);
  102. if (!openButton) {
  103. openButton = document.querySelector(`${SELECTORS.TOGGLEBTN}[data-target="${drawerId}"]`);
  104. }
  105. return openButton;
  106. };
  107. /**
  108. * Disable drawer tooltips.
  109. *
  110. * @param {HTMLElement} drawerNode the drawer main node
  111. * @private
  112. */
  113. const disableDrawerTooltips = (drawerNode) => {
  114. const buttons = [
  115. drawerNode.querySelector(SELECTORS.CLOSEBTN),
  116. getDrawerOpenButton(drawerNode.id),
  117. ];
  118. buttons.forEach(button => {
  119. if (!button) {
  120. return;
  121. }
  122. disableButtonTooltip(button);
  123. });
  124. };
  125. /**
  126. * Disable the button tooltips.
  127. *
  128. * @param {HTMLElement} button the button element
  129. * @param {boolean} enableOnBlur if the tooltip must be re-enabled on blur.
  130. * @private
  131. */
  132. const disableButtonTooltip = (button, enableOnBlur) => {
  133. if (button.hasAttribute('data-original-title')) {
  134. // The jQuery is still used in Boostrap 4. It can we removed when MDL-71979 is integrated.
  135. jQuery(button).tooltip('disable');
  136. button.setAttribute('title', button.dataset.originalTitle);
  137. } else {
  138. button.dataset.disabledToggle = button.dataset.toggle;
  139. button.removeAttribute('data-toggle');
  140. }
  141. if (enableOnBlur) {
  142. button.dataset.restoreTooltipOnBlur = true;
  143. }
  144. };
  145. /**
  146. * Enable drawer tooltips.
  147. *
  148. * @param {HTMLElement} drawerNode the drawer main node
  149. * @private
  150. */
  151. const enableDrawerTooltips = (drawerNode) => {
  152. const buttons = [
  153. drawerNode.querySelector(SELECTORS.CLOSEBTN),
  154. getDrawerOpenButton(drawerNode.id),
  155. ];
  156. buttons.forEach(button => {
  157. if (!button) {
  158. return;
  159. }
  160. enableButtonTooltip(button);
  161. });
  162. };
  163. /**
  164. * Enable the button tooltips.
  165. *
  166. * @param {HTMLElement} button the button element
  167. * @private
  168. */
  169. const enableButtonTooltip = (button) => {
  170. // The jQuery is still used in Boostrap 4. It can we removed when MDL-71979 is integrated.
  171. if (button.hasAttribute('data-original-title')) {
  172. jQuery(button).tooltip('enable');
  173. button.removeAttribute('title');
  174. } else if (button.dataset.disabledToggle) {
  175. button.dataset.toggle = button.dataset.disabledToggle;
  176. jQuery(button).tooltip();
  177. }
  178. delete button.dataset.restoreTooltipOnBlur;
  179. };
  180. /**
  181. * Add scroll listeners to a drawer element.
  182. *
  183. * @param {HTMLElement} drawerNode the drawer main node
  184. * @private
  185. */
  186. const addInnerScrollListener = (drawerNode) => {
  187. const content = drawerNode.querySelector(SELECTORS.DRAWERCONTENT);
  188. if (!content) {
  189. return;
  190. }
  191. content.addEventListener("scroll", () => {
  192. drawerNode.classList.toggle(
  193. CLASSES.SCROLLED,
  194. content.scrollTop != 0
  195. );
  196. });
  197. };
  198. /**
  199. * The Drawers class is used to control on-screen drawer elements.
  200. *
  201. * It handles opening, and closing of drawer elements, as well as more detailed behaviours such as closing a drawer when
  202. * another drawer is opened, and supports closing a drawer when the screen is resized.
  203. *
  204. * Drawers are instantiated on page load, and can also be toggled lazily when toggling any drawer toggle, open button,
  205. * or close button.
  206. *
  207. * A range of show and hide events are also dispatched as detailed in the class
  208. * {@link module:theme_boost/drawers#eventTypes eventTypes} object.
  209. *
  210. * @example <caption>Standard usage</caption>
  211. *
  212. * // The module just needs to be included to add drawer support.
  213. * import 'theme_boost/drawers';
  214. *
  215. * @example <caption>Manually open or close any drawer</caption>
  216. *
  217. * import Drawers from 'theme_boost/drawers';
  218. *
  219. * const myDrawer = Drawers.getDrawerInstanceForNode(document.querySelector('.myDrawerNode');
  220. * myDrawer.closeDrawer();
  221. *
  222. * @example <caption>Listen to the before show event and cancel it</caption>
  223. *
  224. * import Drawers from 'theme_boost/drawers';
  225. *
  226. * document.addEventListener(Drawers.eventTypes.drawerShow, e => {
  227. * // The drawer which will be shown.
  228. * window.console.log(e.target);
  229. *
  230. * // The instance of the Drawers class for this drawer.
  231. * window.console.log(e.detail.drawerInstance);
  232. *
  233. * // Prevent this drawer from being shown.
  234. * e.preventDefault();
  235. * });
  236. *
  237. * @example <caption>Listen to the shown event</caption>
  238. *
  239. * document.addEventListener(Drawers.eventTypes.drawerShown, e => {
  240. * // The drawer which was shown.
  241. * window.console.log(e.target);
  242. *
  243. * // The instance of the Drawers class for this drawer.
  244. * window.console.log(e.detail.drawerInstance);
  245. * });
  246. */
  247. export default class Drawers {
  248. /**
  249. * The underlying HTMLElement which is controlled.
  250. */
  251. drawerNode = null;
  252. /**
  253. * The drawer page bounding box dimensions.
  254. * @var {DOMRect} boundingRect
  255. */
  256. boundingRect = null;
  257. constructor(drawerNode) {
  258. // Some behat tests may use fake drawer divs to test components in drawers.
  259. if (drawerNode.dataset.behatFakeDrawer !== undefined) {
  260. return;
  261. }
  262. this.drawerNode = drawerNode;
  263. if (isSmall()) {
  264. this.closeDrawer({focusOnOpenButton: false, updatePreferences: false});
  265. }
  266. if (this.drawerNode.classList.contains(CLASSES.SHOW)) {
  267. this.openDrawer({focusOnCloseButton: false, setUserPref: false});
  268. } else if (this.drawerNode.dataset.forceopen == 1) {
  269. if (!isSmall()) {
  270. this.openDrawer({focusOnCloseButton: false, setUserPref: false});
  271. }
  272. } else {
  273. Aria.hide(this.drawerNode);
  274. }
  275. // Disable tooltips in small screens.
  276. if (isSmall()) {
  277. disableDrawerTooltips(this.drawerNode);
  278. }
  279. addInnerScrollListener(this.drawerNode);
  280. drawerMap.set(drawerNode, this);
  281. drawerNode.classList.remove(CLASSES.NOTINITIALISED);
  282. }
  283. /**
  284. * Whether the drawer is open.
  285. *
  286. * @returns {boolean}
  287. */
  288. get isOpen() {
  289. return this.drawerNode.classList.contains(CLASSES.SHOW);
  290. }
  291. /**
  292. * Whether the drawer should close when the window is resized
  293. *
  294. * @returns {boolean}
  295. */
  296. get closeOnResize() {
  297. return !!parseInt(this.drawerNode.dataset.closeOnResize);
  298. }
  299. /**
  300. * The list of event types.
  301. *
  302. * @static
  303. * @property {String} drawerShow See {@link event:theme_boost/drawers:show}
  304. * @property {String} drawerShown See {@link event:theme_boost/drawers:shown}
  305. * @property {String} drawerHide See {@link event:theme_boost/drawers:hide}
  306. * @property {String} drawerHidden See {@link event:theme_boost/drawers:hidden}
  307. */
  308. static eventTypes = {
  309. /**
  310. * An event triggered before a drawer is shown.
  311. *
  312. * @event theme_boost/drawers:show
  313. * @type {CustomEvent}
  314. * @property {HTMLElement} target The drawer that will be opened.
  315. */
  316. drawerShow: 'theme_boost/drawers:show',
  317. /**
  318. * An event triggered after a drawer is shown.
  319. *
  320. * @event theme_boost/drawers:shown
  321. * @type {CustomEvent}
  322. * @property {HTMLElement} target The drawer that was be opened.
  323. */
  324. drawerShown: 'theme_boost/drawers:shown',
  325. /**
  326. * An event triggered before a drawer is hidden.
  327. *
  328. * @event theme_boost/drawers:hide
  329. * @type {CustomEvent}
  330. * @property {HTMLElement} target The drawer that will be hidden.
  331. */
  332. drawerHide: 'theme_boost/drawers:hide',
  333. /**
  334. * An event triggered after a drawer is hidden.
  335. *
  336. * @event theme_boost/drawers:hidden
  337. * @type {CustomEvent}
  338. * @property {HTMLElement} target The drawer that was be hidden.
  339. */
  340. drawerHidden: 'theme_boost/drawers:hidden',
  341. };
  342. /**
  343. * Get the drawer instance for the specified node
  344. *
  345. * @param {HTMLElement} drawerNode
  346. * @returns {module:theme_boost/drawers}
  347. */
  348. static getDrawerInstanceForNode(drawerNode) {
  349. if (!drawerMap.has(drawerNode)) {
  350. new Drawers(drawerNode);
  351. }
  352. return drawerMap.get(drawerNode);
  353. }
  354. /**
  355. * Dispatch a drawer event.
  356. *
  357. * @param {string} eventname the event name
  358. * @param {boolean} cancelable if the event is cancelable
  359. * @returns {CustomEvent} the resulting custom event
  360. */
  361. dispatchEvent(eventname, cancelable = false) {
  362. return dispatchEvent(
  363. eventname,
  364. {
  365. drawerInstance: this,
  366. },
  367. this.drawerNode,
  368. {
  369. cancelable,
  370. }
  371. );
  372. }
  373. /**
  374. * Open the drawer.
  375. *
  376. * By default, openDrawer sets the page focus to the close drawer button. However, when a drawer is open at page
  377. * load, this represents an accessibility problem as the initial focus changes without any user interaction. The
  378. * focusOnCloseButton parameter can be set to false to prevent this behaviour.
  379. *
  380. * @param {object} args
  381. * @param {boolean} [args.focusOnCloseButton=true] Whether to alter page focus when opening the drawer
  382. * @param {boolean} [args.setUserPref=true] Whether to store the opened drawer state as a user preference
  383. */
  384. openDrawer({focusOnCloseButton = true, setUserPref = true} = {}) {
  385. const pendingPromise = new Pending('theme_boost/drawers:open');
  386. const showEvent = this.dispatchEvent(Drawers.eventTypes.drawerShow, true);
  387. if (showEvent.defaultPrevented) {
  388. return;
  389. }
  390. // Hide close button and header content while the drawer is showing to prevent glitchy effects.
  391. this.drawerNode.querySelector(SELECTORS.CLOSEBTN)?.classList.toggle('hidden', true);
  392. this.drawerNode.querySelector(SELECTORS.HEADERCONTENT)?.classList.toggle('hidden', true);
  393. // Remove open tooltip if still visible.
  394. let openButton = getDrawerOpenButton(this.drawerNode.id);
  395. if (openButton && openButton.hasAttribute('data-original-title')) {
  396. // The jQuery is still used in Boostrap 4. It can we removed when MDL-71979 is integrated.
  397. jQuery(openButton)?.tooltip('hide');
  398. }
  399. Aria.unhide(this.drawerNode);
  400. this.drawerNode.classList.add(CLASSES.SHOW);
  401. const preference = this.drawerNode.dataset.preference;
  402. if (preference && !isSmall() && (this.drawerNode.dataset.forceopen != 1) && setUserPref) {
  403. setUserPreference(preference, true);
  404. }
  405. const state = this.drawerNode.dataset.state;
  406. if (state) {
  407. const page = document.getElementById('page');
  408. page.classList.add(state);
  409. }
  410. this.boundingRect = this.drawerNode.getBoundingClientRect();
  411. if (isSmall()) {
  412. getBackdrop().then(backdrop => {
  413. backdrop.show();
  414. const pageWrapper = document.getElementById('page');
  415. pageWrapper.style.overflow = 'hidden';
  416. return backdrop;
  417. })
  418. .catch();
  419. }
  420. // Show close button and header content once the drawer is fully opened.
  421. const closeButton = this.drawerNode.querySelector(SELECTORS.CLOSEBTN);
  422. const headerContent = this.drawerNode.querySelector(SELECTORS.HEADERCONTENT);
  423. if (focusOnCloseButton && closeButton) {
  424. disableButtonTooltip(closeButton, true);
  425. }
  426. setTimeout(() => {
  427. closeButton.classList.toggle('hidden', false);
  428. headerContent.classList.toggle('hidden', false);
  429. if (focusOnCloseButton) {
  430. closeButton.focus();
  431. }
  432. pendingPromise.resolve();
  433. }, 300);
  434. this.dispatchEvent(Drawers.eventTypes.drawerShown);
  435. }
  436. /**
  437. * Close the drawer.
  438. *
  439. * @param {object} args
  440. * @param {boolean} [args.focusOnOpenButton=true] Whether to alter page focus when opening the drawer
  441. * @param {boolean} [args.updatePreferences=true] Whether to update the user prewference
  442. */
  443. closeDrawer({focusOnOpenButton = true, updatePreferences = true} = {}) {
  444. const pendingPromise = new Pending('theme_boost/drawers:close');
  445. const hideEvent = this.dispatchEvent(Drawers.eventTypes.drawerHide, true);
  446. if (hideEvent.defaultPrevented) {
  447. return;
  448. }
  449. // Hide close button and header content while the drawer is hiding to prevent glitchy effects.
  450. const closeButton = this.drawerNode.querySelector(SELECTORS.CLOSEBTN);
  451. closeButton?.classList.toggle('hidden', true);
  452. const headerContent = this.drawerNode.querySelector(SELECTORS.HEADERCONTENT);
  453. headerContent?.classList.toggle('hidden', true);
  454. // Remove the close button tooltip if visible.
  455. if (closeButton.hasAttribute('data-original-title')) {
  456. // The jQuery is still used in Boostrap 4. It can we removed when MDL-71979 is integrated.
  457. jQuery(closeButton)?.tooltip('hide');
  458. }
  459. const preference = this.drawerNode.dataset.preference;
  460. if (preference && updatePreferences && !isSmall()) {
  461. setUserPreference(preference, false);
  462. }
  463. const state = this.drawerNode.dataset.state;
  464. if (state) {
  465. const page = document.getElementById('page');
  466. page.classList.remove(state);
  467. }
  468. Aria.hide(this.drawerNode);
  469. this.drawerNode.classList.remove(CLASSES.SHOW);
  470. getBackdrop().then(backdrop => {
  471. backdrop.hide();
  472. if (isSmall()) {
  473. const pageWrapper = document.getElementById('page');
  474. pageWrapper.style.overflow = 'visible';
  475. }
  476. return backdrop;
  477. })
  478. .catch();
  479. // Move focus to the open drawer (or toggler) button once the drawer is hidden.
  480. let openButton = getDrawerOpenButton(this.drawerNode.id);
  481. if (openButton) {
  482. disableButtonTooltip(openButton, true);
  483. }
  484. setTimeout(() => {
  485. if (openButton && focusOnOpenButton) {
  486. openButton.focus();
  487. }
  488. pendingPromise.resolve();
  489. }, 300);
  490. this.dispatchEvent(Drawers.eventTypes.drawerHidden);
  491. }
  492. /**
  493. * Toggle visibility of the drawer.
  494. */
  495. toggleVisibility() {
  496. if (this.drawerNode.classList.contains(CLASSES.SHOW)) {
  497. this.closeDrawer();
  498. } else {
  499. this.openDrawer();
  500. }
  501. }
  502. /**
  503. * Displaces the drawer outsite the page.
  504. *
  505. * @param {Number} scrollPosition the page current scroll position
  506. */
  507. displace(scrollPosition) {
  508. let displace = scrollPosition;
  509. let openButton = getDrawerOpenButton(this.drawerNode.id);
  510. if (scrollPosition === 0) {
  511. this.drawerNode.style.transform = '';
  512. if (openButton) {
  513. openButton.style.transform = '';
  514. }
  515. return;
  516. }
  517. const state = this.drawerNode.dataset?.state;
  518. const drawrWidth = this.drawerNode.offsetWidth;
  519. let scrollThreshold = drawrWidth;
  520. let direction = -1;
  521. if (state === 'show-drawer-right') {
  522. direction = 1;
  523. scrollThreshold = THRESHOLD;
  524. }
  525. // LTR scroll is positive while RTL scroll is negative.
  526. if (Math.abs(scrollPosition) > scrollThreshold) {
  527. displace = Math.sign(scrollPosition) * (drawrWidth + THRESHOLD);
  528. }
  529. displace *= direction;
  530. const transform = `translateX(${displace}px)`;
  531. if (openButton) {
  532. openButton.style.transform = transform;
  533. }
  534. this.drawerNode.style.transform = transform;
  535. }
  536. /**
  537. * Prevent drawer from overlapping an element.
  538. *
  539. * @param {HTMLElement} currentFocus
  540. */
  541. preventOverlap(currentFocus) {
  542. // Start position drawer (aka. left drawer) will never overlap with the page content.
  543. if (!this.isOpen || this.drawerNode.dataset?.state === 'show-drawer-left') {
  544. return;
  545. }
  546. const drawrWidth = this.drawerNode.offsetWidth;
  547. const element = currentFocus.getBoundingClientRect();
  548. // The this.boundingRect is calculated only once and it is reliable
  549. // for horizontal overlapping (which is the most common). However,
  550. // it is not reliable for vertical overlapping because the drawer
  551. // height can be changed by other elements like sticky footer.
  552. // To prevent recalculating the boundingRect on every
  553. // focusin event, we use horizontal overlapping as first fast check.
  554. let overlapping = (
  555. (element.right + THRESHOLD) > this.boundingRect.left &&
  556. (element.left - THRESHOLD) < this.boundingRect.right
  557. );
  558. if (overlapping) {
  559. const currentBoundingRect = this.drawerNode.getBoundingClientRect();
  560. overlapping = (
  561. (element.bottom) > currentBoundingRect.top &&
  562. (element.top) < currentBoundingRect.bottom
  563. );
  564. }
  565. if (overlapping) {
  566. // Force drawer to displace out of the page.
  567. let displaceOut = drawrWidth + 1;
  568. if (window.right_to_left()) {
  569. displaceOut *= -1;
  570. }
  571. this.displace(displaceOut);
  572. } else {
  573. // Reset drawer displacement.
  574. this.displace(window.scrollX);
  575. }
  576. }
  577. /**
  578. * Close all drawers.
  579. */
  580. static closeAllDrawers() {
  581. drawerMap.forEach(drawerInstance => {
  582. drawerInstance.closeDrawer();
  583. });
  584. }
  585. /**
  586. * Close all drawers except for the specified drawer.
  587. *
  588. * @param {module:theme_boost/drawers} comparisonInstance
  589. */
  590. static closeOtherDrawers(comparisonInstance) {
  591. drawerMap.forEach(drawerInstance => {
  592. if (drawerInstance === comparisonInstance) {
  593. return;
  594. }
  595. drawerInstance.closeDrawer();
  596. });
  597. }
  598. /**
  599. * Prevent drawers from covering the focused element.
  600. */
  601. static preventCoveringFocusedElement() {
  602. const currentFocus = document.activeElement;
  603. // Focus on page layout elements should be ignored.
  604. const pagecontent = document.querySelector(SELECTORS.PAGECONTENT);
  605. if (!currentFocus || !pagecontent?.contains(currentFocus)) {
  606. Drawers.displaceDrawers(window.scrollX);
  607. return;
  608. }
  609. drawerMap.forEach(drawerInstance => {
  610. drawerInstance.preventOverlap(currentFocus);
  611. });
  612. }
  613. /**
  614. * Prevent drawer from covering the content when the page content covers the full page.
  615. *
  616. * @param {Number} displace
  617. */
  618. static displaceDrawers(displace) {
  619. drawerMap.forEach(drawerInstance => {
  620. drawerInstance.displace(displace);
  621. });
  622. }
  623. }
  624. /**
  625. * Set the last used attribute for the last used toggle button for a drawer.
  626. *
  627. * @param {object} toggleButton The clicked button.
  628. */
  629. const setLastUsedToggle = (toggleButton) => {
  630. if (toggleButton.dataset.target) {
  631. document.querySelectorAll(`${SELECTORS.BUTTONS}[data-target="${toggleButton.dataset.target}"]`)
  632. .forEach(btn => {
  633. btn.dataset.lastused = false;
  634. });
  635. toggleButton.dataset.lastused = true;
  636. }
  637. };
  638. /**
  639. * Set the focus to the last used button to open this drawer.
  640. * @param {string} target The drawer target.
  641. */
  642. const focusLastUsedToggle = (target) => {
  643. const lastUsedButton = document.querySelector(`${SELECTORS.BUTTONS}[data-target="${target}"][data-lastused="true"`);
  644. if (lastUsedButton) {
  645. lastUsedButton.focus();
  646. }
  647. };
  648. /**
  649. * Register the event listeners for the drawer.
  650. *
  651. * @private
  652. */
  653. const registerListeners = () => {
  654. // Listen for show/hide events.
  655. document.addEventListener('click', e => {
  656. const toggleButton = e.target.closest(SELECTORS.TOGGLEBTN);
  657. if (toggleButton && toggleButton.dataset.target) {
  658. e.preventDefault();
  659. const targetDrawer = document.getElementById(toggleButton.dataset.target);
  660. const drawerInstance = Drawers.getDrawerInstanceForNode(targetDrawer);
  661. setLastUsedToggle(toggleButton);
  662. drawerInstance.toggleVisibility();
  663. }
  664. const openDrawerButton = e.target.closest(SELECTORS.OPENBTN);
  665. if (openDrawerButton && openDrawerButton.dataset.target) {
  666. e.preventDefault();
  667. const targetDrawer = document.getElementById(openDrawerButton.dataset.target);
  668. const drawerInstance = Drawers.getDrawerInstanceForNode(targetDrawer);
  669. setLastUsedToggle(toggleButton);
  670. drawerInstance.openDrawer();
  671. }
  672. const closeDrawerButton = e.target.closest(SELECTORS.CLOSEBTN);
  673. if (closeDrawerButton && closeDrawerButton.dataset.target) {
  674. e.preventDefault();
  675. const targetDrawer = document.getElementById(closeDrawerButton.dataset.target);
  676. const drawerInstance = Drawers.getDrawerInstanceForNode(targetDrawer);
  677. drawerInstance.closeDrawer();
  678. focusLastUsedToggle(closeDrawerButton.dataset.target);
  679. }
  680. });
  681. // Close drawer when another drawer opens.
  682. document.addEventListener(Drawers.eventTypes.drawerShow, e => {
  683. if (isLarge()) {
  684. return;
  685. }
  686. Drawers.closeOtherDrawers(e.detail.drawerInstance);
  687. });
  688. // Tooglers and openers blur listeners.
  689. const btnSelector = `${SELECTORS.TOGGLEBTN}, ${SELECTORS.OPENBTN}, ${SELECTORS.CLOSEBTN}`;
  690. document.addEventListener('focusout', (e) => {
  691. const button = e.target.closest(btnSelector);
  692. if (button?.dataset.restoreTooltipOnBlur !== undefined) {
  693. enableButtonTooltip(button);
  694. }
  695. });
  696. const closeOnResizeListener = () => {
  697. if (isSmall()) {
  698. let anyOpen = false;
  699. drawerMap.forEach(drawerInstance => {
  700. disableDrawerTooltips(drawerInstance.drawerNode);
  701. if (drawerInstance.isOpen) {
  702. const currentFocus = document.activeElement;
  703. const drawerContent = drawerInstance.drawerNode.querySelector(SELECTORS.DRAWERCONTENT);
  704. const shouldClose = drawerInstance.closeOnResize && (!drawerContent || !drawerContent.contains(currentFocus));
  705. if (shouldClose) {
  706. drawerInstance.closeDrawer();
  707. } else {
  708. anyOpen = true;
  709. }
  710. }
  711. });
  712. if (anyOpen) {
  713. getBackdrop().then(backdrop => backdrop.show()).catch();
  714. }
  715. } else {
  716. drawerMap.forEach(drawerInstance => {
  717. enableDrawerTooltips(drawerInstance.drawerNode);
  718. });
  719. getBackdrop().then(backdrop => backdrop.hide()).catch();
  720. }
  721. };
  722. document.addEventListener('scroll', () => {
  723. const currentFocus = document.activeElement;
  724. const drawerContentElements = document.querySelectorAll(SELECTORS.DRAWERCONTENT);
  725. // Check if the current focus is within any drawer content.
  726. if (Array.from(drawerContentElements).some(drawer => drawer.contains(currentFocus))) {
  727. return;
  728. }
  729. const body = document.querySelector('body');
  730. if (window.scrollY >= window.innerHeight) {
  731. body.classList.add(CLASSES.SCROLLED);
  732. } else {
  733. body.classList.remove(CLASSES.SCROLLED);
  734. }
  735. // Horizontal scroll listener to displace the drawers to prevent covering
  736. // any possible sticky content.
  737. Drawers.displaceDrawers(window.scrollX);
  738. });
  739. const preventOverlap = debounce(Drawers.preventCoveringFocusedElement, 100);
  740. document.addEventListener('focusin', preventOverlap);
  741. document.addEventListener('focusout', preventOverlap);
  742. window.addEventListener('resize', debounce(closeOnResizeListener, 400, {pending: true}));
  743. };
  744. registerListeners();
  745. const drawers = document.querySelectorAll(SELECTORS.DRAWERS);
  746. drawers.forEach(drawerNode => Drawers.getDrawerInstanceForNode(drawerNode));