mirror of
https://gerrit.wikimedia.org/r/mediawiki/skins/Vector.git
synced 2024-11-29 01:45:00 +00:00
d4a7fb6479
Update setupIntersectionObservers so it only contains code that uses observers. Other code is moved to the skin.js entry point along with other features. Change-Id: Ia11b4e07f899426687c616ce2054e0df9d36ab7c
133 lines
4.9 KiB
JavaScript
133 lines
4.9 KiB
JavaScript
const languageButton = require( './languageButton.js' ),
|
|
limitedWidthToggle = require( './limitedWidthToggle.js' ),
|
|
pinnableElement = require( './pinnableElement.js' ),
|
|
searchToggle = require( './searchToggle.js' ),
|
|
echo = require( './echo.js' ),
|
|
initSearchLoader = require( './searchLoader.js' ).initSearchLoader,
|
|
dropdownMenus = require( './dropdownMenus.js' ).dropdownMenus,
|
|
watchstar = require( './watchstar.js' ),
|
|
setupIntersectionObservers = require( './setupIntersectionObservers.js' ),
|
|
menuTabs = require( './menuTabs.js' );
|
|
|
|
/**
|
|
* Wait for first paint before calling this function. That's its whole purpose.
|
|
*
|
|
* Some CSS animations and transitions are "disabled" by default as a workaround to this old Chrome
|
|
* bug, https://bugs.chromium.org/p/chromium/issues/detail?id=332189, which otherwise causes them to
|
|
* render in their terminal state on page load. By adding the `vector-animations-ready` class to the
|
|
* `html` root element **after** first paint, the animation selectors suddenly match causing the
|
|
* animations to become "enabled" when they will work properly. A similar pattern is used in Minerva
|
|
* (see T234570#5779890, T246419).
|
|
*
|
|
* Example usage in Less:
|
|
*
|
|
* ```less
|
|
* .foo {
|
|
* color: #f00;
|
|
* transform: translateX( -100% );
|
|
* }
|
|
*
|
|
* // This transition will be disabled initially for JavaScript users. It will never be enabled for
|
|
* // non-JavaScript users.
|
|
* .vector-animations-ready .foo {
|
|
* transition: transform 100ms ease-out;
|
|
* }
|
|
* ```
|
|
*
|
|
* @param {Document} document
|
|
* @return {void}
|
|
*/
|
|
function enableCssAnimations( document ) {
|
|
document.documentElement.classList.add( 'vector-animations-ready' );
|
|
}
|
|
|
|
/**
|
|
* In https://phabricator.wikimedia.org/T313409 #p-namespaces was renamed to #p-associatedPages
|
|
* This code maps items added by gadgets to the new menu.
|
|
* This code can be removed in MediaWiki 1.40.
|
|
*/
|
|
function addNamespacesGadgetSupport() {
|
|
// Set up hidden dummy portlet.
|
|
const dummyPortlet = document.createElement( 'div' );
|
|
dummyPortlet.setAttribute( 'id', 'p-namespaces' );
|
|
dummyPortlet.setAttribute( 'style', 'display: none;' );
|
|
dummyPortlet.appendChild( document.createElement( 'ul' ) );
|
|
document.body.appendChild( dummyPortlet );
|
|
mw.hook( 'util.addPortletLink' ).add( function ( /** @type {Element} */ node ) {
|
|
// If it was added to p-namespaces, show warning and move.
|
|
// eslint-disable-next-line no-jquery/no-global-selector
|
|
if ( $( '#p-namespaces' ).find( node ).length ) {
|
|
// eslint-disable-next-line no-jquery/no-global-selector
|
|
$( '#p-associated-pages ul' ).append( node );
|
|
mw.log.warn( 'Please update call to mw.util.addPortletLink with ID p-namespaces. Use p-associatedPages instead.' );
|
|
// in case it was empty before:
|
|
mw.util.showPortlet( 'p-associated-pages' );
|
|
}
|
|
} );
|
|
}
|
|
|
|
/**
|
|
* @param {Window} window
|
|
* @return {void}
|
|
*/
|
|
function main( window ) {
|
|
enableCssAnimations( window.document );
|
|
initSearchLoader( document );
|
|
languageButton();
|
|
echo();
|
|
dropdownMenus();
|
|
// menuTabs should follow `dropdownMenus` as that can move menu items from a
|
|
// tab menu to a dropdown.
|
|
menuTabs();
|
|
addNamespacesGadgetSupport();
|
|
watchstar();
|
|
limitedWidthToggle();
|
|
// Initialize the search toggle for the main header only. The sticky header
|
|
// toggle is initialized after Codex search loads.
|
|
const searchToggleElement = document.querySelector( '.mw-header .search-toggle' );
|
|
if ( searchToggleElement ) {
|
|
searchToggle( searchToggleElement );
|
|
}
|
|
pinnableElement.initPinnableElement();
|
|
// Initializes the TOC and sticky header, behaviour of which depend on scroll behaviour.
|
|
setupIntersectionObservers.main();
|
|
}
|
|
|
|
/**
|
|
* @param {Window} window
|
|
* @return {void}
|
|
*/
|
|
function init( window ) {
|
|
const now = mw.now();
|
|
// This is the earliest time we can run JS for users (and bucket anonymous
|
|
// users for A/B tests).
|
|
// Where the browser supports it, for a 10% sample of users
|
|
// we record a value to give us a sense of the expected delay in running A/B tests or
|
|
// disabling JS features. This will inform us on various things including what to expect
|
|
// with regards to delay while running A/B tests to anonymous users.
|
|
// When EventLogging is not available this will reject.
|
|
// This code can be removed by the end of the Desktop improvements project.
|
|
// https://www.mediawiki.org/wiki/Desktop_improvements
|
|
mw.loader.using( 'ext.eventLogging' ).then( function () {
|
|
if (
|
|
mw.eventLog &&
|
|
mw.eventLog.eventInSample( 100 /* 1 in 100 */ ) &&
|
|
window.performance &&
|
|
window.performance.timing &&
|
|
window.performance.timing.navigationStart
|
|
) {
|
|
mw.track( 'timing.Vector.ready', now - window.performance.timing.navigationStart ); // milliseconds
|
|
}
|
|
} );
|
|
}
|
|
|
|
init( window );
|
|
if ( document.readyState === 'interactive' || document.readyState === 'complete' ) {
|
|
main( window );
|
|
} else {
|
|
// This is needed when document.readyState === 'loading'.
|
|
document.addEventListener( 'DOMContentLoaded', function () {
|
|
main( window );
|
|
} );
|
|
}
|