mediawiki-skins-MinervaNeue/resources/skins.minerva.scripts/drawers.js
Ed Sanders 2be7b9f919 build: Update jsdoc-wmf-theme to 1.1.0
Additional changes:
* Update Minerva so that it doesn't output any APIs
to the documentation - this is intentional as Minerva does
not have any public facing APIs.

Bug: T368081
Change-Id: Ie1a3ea30cbf35663c7fdd2494c1698044882969e
2024-06-28 12:38:54 -07:00

52 lines
1.4 KiB
JavaScript

const $drawerContainer = $( document.body );
const BODY_CLASS_SCROLL_LOCKED = 'has-drawer--with-scroll-locked';
/**
* Discard a drawer from display on the page.
*
* @private
* @param {Drawer} drawer
*/
function discardDrawer( drawer ) {
// remove the class
$drawerContainer.removeClass( BODY_CLASS_SCROLL_LOCKED );
// FIXME: queue removal from DOM (using setTimeout so that any animations have time to run)
// This works around an issue in MobileFrontend that the Drawer onBeforeHide method is
// called /before/ the animation for closing has completed. This needs to be accounted
// for in Drawer so this function can be synchronous.
setTimeout( () => {
// detach the node from the DOM. Use detach rather than remove to allow reuse without
// losing any existing events.
drawer.$el.detach();
}, 100 );
}
/**
* Lock scroll of viewport.
* @ignore
*/
function lockScroll() {
$drawerContainer.addClass( BODY_CLASS_SCROLL_LOCKED );
}
/**
* @param {Drawer} drawer to display
* @param {Object} options for display
* @param {boolean} options.hideOnScroll whether a scroll closes the drawer
* @ignore
*/
function displayDrawer( drawer, options ) {
$drawerContainer.append( drawer.$el );
drawer.show();
if ( options.hideOnScroll ) {
$( window ).one( 'scroll.drawer', () => {
drawer.hide();
} );
}
}
module.exports = {
displayDrawer,
lockScroll,
discardDrawer
};