Difference between revisions of "MediaWiki:Common.js"

From
Jump to: navigation, search
(Copied JS from Wikipedia to make navBars work.)
 
(Compressed to simpler navbar JS from the MediaWiki manual.)
Line 1: Line 1:
 
/**
 
/**
−
  * Keep code in MediaWiki:Common.js to a minimum as it is unconditionally
+
  * Dynamic Navigation Bars. See [[Wikipedia:NavFrame]]
−
  * loaded for all users on every wiki page. If possible create a gadget that is
+
  *  
−
  * enabled by default instead of adding it here (since gadgets are fully
+
  * Based on script from en.wikipedia.org, 2008-09-15.
−
* optimized ResourceLoader modules with possibility to add dependencies etc.)
 
 
  *
 
  *
−
  * Since Common.js isn't a gadget, there is no place to declare its
+
  * @source www.mediawiki.org/wiki/MediaWiki:Gadget-NavFrame.js
−
* dependencies, so we have to lazy load them with mw.loader.using on demand and
+
  * @maintainer Helder.wiki, 2012–2013
−
  * then execute the rest in the callback. In most cases these dependencies will
+
  * @maintainer Krinkle, 2013
−
  * be loaded (or loading) already and the callback will not be delayed. In case a
 
−
* dependency hasn't arrived yet it'll make sure those are loaded before this.
 
 
  */
 
  */
 +
( function () {
  
−
/* global mw, $ */
+
// Set up the words in your language
−
/* jshint strict:false, browser:true */
+
var collapseCaption = 'hide';
 +
var expandCaption = 'show';
  
−
mw.loader.using( [ 'mediawiki.util' ] ).done( function () {
+
var navigationBarHide = '[' + collapseCaption + ']';
−
/* Begin of mw.loader.using callback */
+
var navigationBarShow = '[' + expandCaption + ']';
  
−
/**
+
/**
−
* Main Page layout fixes
+
* Shows and hides content and picture (if available) of navigation bars.
−
*
+
*
−
* Description: Adds an additional link to the complete list of languages available.
+
* @param {number} indexNavigationBar The index of navigation bar to be toggled
−
* Maintainers: [[User:AzaToth]], [[User:R. Koot]], [[User:Alex Smotrov]]
+
* @param {jQuery.Event} e Event object
−
*/
+
*/
−
if ( mw.config.get( 'wgPageName' ) === 'Main_Page' || mw.config.get( 'wgPageName' ) === 'Talk:Main_Page' ) {
+
function toggleNavigationBar( indexNavigationBar, e ) {
−
$( function () {
+
var navChild,
−
mw.util.addPortletLink( 'p-lang', '//meta.wikimedia.org/wiki/List_of_Wikipedias',
+
navToggle = document.getElementById( 'NavToggle' + indexNavigationBar ),
−
'Complete list', 'interwiki-completelist', 'Complete list of Wikipedias' );
+
navFrame = document.getElementById( 'NavFrame' + indexNavigationBar );
−
} );
 
−
}
 
−
 
 
−
/**
 
−
* Map addPortletLink to mw.util
 
−
* @deprecated: Use mw.util.addPortletLink instead.
 
−
*/
 
−
mw.log.deprecate( window, 'addPortletLink', mw.util.addPortletLink, 'Use mw.util.addPortletLink instead' );
 
  
−
/**
+
// Prevent browser from jumping to href "#"
−
* Extract a URL parameter from the current URL
+
e.preventDefault();
−
* @deprecated: Use mw.util.getParamValue with proper escaping
 
−
*/
 
−
mw.log.deprecate( window, 'getURLParamValue', mw.util.getParamValue, 'Use mw.util.getParamValue instead' );
 
  
−
/**
+
if ( !navFrame || !navToggle ) {
−
* Test if an element has a certain class
+
return false;
−
* @deprecated:  Use $(element).hasClass() instead.
 
−
*/
 
−
mw.log.deprecate( window, 'hasClass', function ( element, className ) {
 
−
return $( element ).hasClass( className );
 
−
}, 'Use jQuery.hasClass() instead' );
 
−
 
 
−
/**
 
−
* @source www.mediawiki.org/wiki/Snippets/Load_JS_and_CSS_by_URL
 
−
* @rev 6
 
−
*/
 
−
var extraCSS = mw.util.getParamValue( 'withCSS' ),
 
−
extraJS = mw.util.getParamValue( 'withJS' );
 
−
 
 
−
if ( extraCSS ) {
 
−
if ( extraCSS.match( /^MediaWiki:[^&<>=%#]*\.css$/ ) ) {
 
−
mw.loader.load( '/w/index.php?title=' + extraCSS + '&action=raw&ctype=text/css', 'text/css' );
 
−
} else {
 
−
mw.notify( 'Only pages from the MediaWiki namespace are allowed.', { title: 'Invalid withCSS value' } );
 
−
}
 
 
}
 
}
  
−
if ( extraJS ) {
+
// If shown now
−
if ( extraJS.match( /^MediaWiki:[^&<>=%#]*\.js$/ ) ) {
+
if ( navToggle.firstChild.data === navigationBarHide ) {
−
mw.loader.load( '/w/index.php?title=' + extraJS + '&action=raw&ctype=text/javascript' );
+
for ( navChild = navFrame.firstChild; navChild !== null; navChild = navChild.nextSibling ) {
−
} else {
+
if ( $( navChild ).hasClass( 'NavContent' ) || $( navChild ).hasClass( 'NavPic' ) ) {
−
mw.notify( 'Only pages from the MediaWiki namespace are allowed.', { title: 'Invalid withJS value' } );
+
navChild.style.display = 'none';
 +
}
 
}
 
}
−
}
+
navToggle.firstChild.data = navigationBarShow;
  
−
/**
+
// If hidden now
−
* Collapsible tables; reimplemented with mw-collapsible
+
} else if ( navToggle.firstChild.data === navigationBarShow ) {
−
* Styling is also in place to avoid FOUC
+
for ( navChild = navFrame.firstChild; navChild !== null; navChild = navChild.nextSibling ) {
−
*
+
if ( $( navChild ).hasClass( 'NavContent' ) || $( navChild ).hasClass( 'NavPic' ) ) {
−
* Allows tables to be collapsed, showing only the header. See [[Help:Collapsing]].
+
navChild.style.display = 'block';
−
* @version 3.0.0 (2018-05-20)
 
−
* @source https://www.mediawiki.org/wiki/MediaWiki:Gadget-collapsibleTables.js
 
−
* @author [[User:R. Koot]]
 
−
* @author [[User:Krinkle]]
 
−
* @author [[User:TheDJ]]
 
−
* @deprecated Since MediaWiki 1.20: Use class="mw-collapsible" instead which
 
−
* is supported in MediaWiki core. Shimmable since MediaWiki 1.32
 
−
*
 
−
* @param {jQuery} $content
 
−
*/
 
−
function makeCollapsibleMwCollapsible( $content ) {
 
−
var $tables = $content
 
−
.find( 'table.collapsible:not(.mw-collapsible)' )
 
−
.addClass( 'mw-collapsible' );
 
−
 
 
−
$.each( $tables, function ( index, table ) {
 
−
// mw.log.warn( 'This page is using the deprecated class collapsible. Please replace it with mw-collapsible.');
 
−
if ( $( table ).hasClass( 'collapsed' ) ) {
 
−
$( table ).addClass( 'mw-collapsed' );
 
−
// mw.log.warn( 'This page is using the deprecated class collapsed. Please replace it with mw-collapsed.');
 
 
}
 
}
−
} );
 
−
if ( $tables.length > 0 ) {
 
−
mw.loader.using( 'jquery.makeCollapsible' ).then( function () {
 
−
$tables.makeCollapsible();
 
−
} );
 
 
}
 
}
 +
navToggle.firstChild.data = navigationBarHide;
 
}
 
}
−
mw.hook( 'wikipage.content' ).add( makeCollapsibleMwCollapsible );
+
}
  
−
/**
+
/**
−
* Add support to mw-collapsible for autocollapse, innercollapse and outercollapse
+
* Adds show/hide-button to navigation bars.
−
*
+
*
−
* Maintainers: TheDJ
+
* @param {jQuery} $content
−
*/
+
*/
−
function mwCollapsibleSetup( $collapsibleContent ) {
+
function createNavigationBarToggleButton( $content ) {
−
var $element,
+
var i, j, navChild, navToggle, navToggleText, isCollapsed,
−
$toggle,
+
indexNavigationBar = 0;
−
autoCollapseThreshold = 2;
+
// iterate over all < div >-elements
−
$.each( $collapsibleContent, function ( index, element ) {
+
var $divs = $content.find( 'div.NavFrame' );
−
$element = $( element );
+
$divs.each( function ( i, navFrame ) {
−
if ( $element.hasClass( 'collapsible' ) ) {
+
indexNavigationBar++;
−
$element.find( 'tr:first > th:first' ).prepend( $element.find( 'tr:first > * > .mw-collapsible-toggle' ) );
+
navToggle = document.createElement( 'a' );
−
}
+
navToggle.className = 'NavToggle';
−
if ( $collapsibleContent.length >= autoCollapseThreshold && $element.hasClass( 'autocollapse' ) ) {
+
navToggle.setAttribute( 'id', 'NavToggle' + indexNavigationBar );
−
$element.data( 'mw-collapsible' ).collapse();
+
navToggle.setAttribute( 'href', '#' );
−
} else if ( $element.hasClass( 'innercollapse' ) ) {
+
$( navToggle ).on( 'click', $.proxy( toggleNavigationBar, null, indexNavigationBar ) );
−
if ( $element.parents( '.outercollapse' ).length > 0 ) {
+
 
−
$element.data( 'mw-collapsible' ).collapse();
+
isCollapsed = $( navFrame ).hasClass( 'collapsed' );
−
}
+
// backwards compatibility for old technique where the collapsed class was not yet used
−
}
+
for ( navChild = navFrame.firstChild; navChild !== null && !isCollapsed; navChild = navChild.nextSibling ) {
−
// because of colored backgrounds, style the link in the text color
+
if ( $( navChild ).hasClass( 'NavPic' ) || $( navChild ).hasClass( 'NavContent' ) ) {
−
// to ensure accessible contrast
+
if ( navChild.style.display === 'none' ) {
−
$toggle = $element.find( '.mw-collapsible-toggle' );
+
isCollapsed = true;
−
if ( $toggle.length ) {
 
−
// Make the toggle inherit text color
 
−
if ( $toggle.parent()[ 0 ].style.color ) {
 
−
$toggle.find( 'a' ).css( 'color', 'inherit' );
 
 
}
 
}
 
}
 
}
−
} );
 
−
}
 
−
 
−
mw.hook( 'wikipage.collapsibleContent' ).add( mwCollapsibleSetup );
 
−
 
−
/**
 
−
* Dynamic Navigation Bars (experimental)
 
−
*
 
−
* Description: See [[Wikipedia:NavFrame]].
 
−
* Maintainers: UNMAINTAINED
 
−
*/
 
−
 
−
var collapseCaption = 'hide';
 
−
var expandCaption = 'show';
 
−
 
−
// Set up the words in your language
 
−
var navigationBarHide = '[' + collapseCaption + ']';
 
−
var navigationBarShow = '[' + expandCaption + ']';
 
−
 
−
/**
 
−
* Shows and hides content and picture (if available) of navigation bars.
 
−
*
 
−
* @param {number} indexNavigationBar The index of navigation bar to be toggled
 
−
* @param {jQuery.Event} event Event object
 
−
* @return {boolean}
 
−
*/
 
−
function toggleNavigationBar( indexNavigationBar, event ) {
 
−
var navToggle = document.getElementById( 'NavToggle' + indexNavigationBar );
 
−
var navFrame = document.getElementById( 'NavFrame' + indexNavigationBar );
 
−
var navChild;
 
−
 
−
if ( !navFrame || !navToggle ) {
 
−
return false;
 
 
}
 
}
−
 
+
if ( isCollapsed ) {
−
// If shown now
 
−
if ( navToggle.firstChild.data === navigationBarHide ) {
 
 
for ( navChild = navFrame.firstChild; navChild !== null; navChild = navChild.nextSibling ) {
 
for ( navChild = navFrame.firstChild; navChild !== null; navChild = navChild.nextSibling ) {
−
if ( $( navChild ).hasClass( 'NavContent' ) ) {
+
if ( $( navChild ).hasClass( 'NavPic' ) || $( navChild ).hasClass( 'NavContent' ) ) {
 
navChild.style.display = 'none';
 
navChild.style.display = 'none';
 
}
 
}
 
}
 
}
−
navToggle.firstChild.data = navigationBarShow;
+
}
 +
navToggleText = document.createTextNode( isCollapsed ? navigationBarShow : navigationBarHide );
 +
navToggle.appendChild( navToggleText );
  
−
// If hidden now
+
// Find the NavHead and attach the toggle link (Must be this complicated because Moz's firstChild handling is borked)
−
} else if ( navToggle.firstChild.data === navigationBarShow ) {
+
for ( j = 0; j < navFrame.childNodes.length; j++ ) {
−
for ( navChild = navFrame.firstChild; navChild !== null; navChild = navChild.nextSibling ) {
+
if ( $( navFrame.childNodes[j] ).hasClass( 'NavHead' ) ) {
−
if ( $( navChild ).hasClass( 'NavContent' ) ) {
+
navToggle.style.color = navFrame.childNodes[j].style.color;
−
navChild.style.display = 'block';
+
navFrame.childNodes[j].appendChild( navToggle );
−
}
 
 
}
 
}
−
navToggle.firstChild.data = navigationBarHide;
 
 
}
 
}
 +
navFrame.setAttribute( 'id', 'NavFrame' + indexNavigationBar );
 +
} );
 +
}
  
−
event.preventDefault();
+
mw.hook( 'wikipage.content' ).add( createNavigationBarToggleButton );
−
}
 
−
 
 
−
/**
 
−
* Adds show/hide-button to navigation bars.
 
−
*
 
−
* @param {jQuery} $content
 
−
*/
 
−
function createNavigationBarToggleButton( $content ) {
 
−
var j, navChild, navToggle, navToggleText, isCollapsed,
 
−
indexNavigationBar = 0;
 
−
// Iterate over all < div >-elements
 
−
var $divs = $content.find( 'div.NavFrame:not(.mw-collapsible)' );
 
−
$divs.each( function ( i, navFrame ) {
 
−
indexNavigationBar++;
 
−
navToggle = document.createElement( 'a' );
 
−
navToggle.className = 'NavToggle';
 
−
navToggle.setAttribute( 'id', 'NavToggle' + indexNavigationBar );
 
−
navToggle.setAttribute( 'href', '#' );
 
−
$( navToggle ).on( 'click', $.proxy( toggleNavigationBar, null, indexNavigationBar ) );
 
−
 
 
−
isCollapsed = $( navFrame ).hasClass( 'collapsed' );
 
−
/**
 
−
* Check if any children are already hidden.  This loop is here for backwards compatibility:
 
−
* the old way of making NavFrames start out collapsed was to manually add style="display:none"
 
−
* to all the NavPic/NavContent elements.  Since this was bad for accessibility (no way to make
 
−
* the content visible without JavaScript support), the new recommended way is to add the class
 
−
* "collapsed" to the NavFrame itself, just like with collapsible tables.
 
−
*/
 
−
for ( navChild = navFrame.firstChild; navChild !== null && !isCollapsed; navChild = navChild.nextSibling ) {
 
−
if ( $( navChild ).hasClass( 'NavPic' ) || $( navChild ).hasClass( 'NavContent' ) ) {
 
−
if ( navChild.style.display === 'none' ) {
 
−
isCollapsed = true;
 
−
}
 
−
}
 
−
}
 
−
if ( isCollapsed ) {
 
−
for ( navChild = navFrame.firstChild; navChild !== null; navChild = navChild.nextSibling ) {
 
−
if ( $( navChild ).hasClass( 'NavPic' ) || $( navChild ).hasClass( 'NavContent' ) ) {
 
−
navChild.style.display = 'none';
 
−
}
 
−
}
 
−
}
 
−
navToggleText = document.createTextNode( isCollapsed ? navigationBarShow : navigationBarHide );
 
−
navToggle.appendChild( navToggleText );
 
−
 
 
−
// Find the NavHead and attach the toggle link (Must be this complicated because Moz's firstChild handling is borked)
 
−
for ( j = 0; j < navFrame.childNodes.length; j++ ) {
 
−
if ( $( navFrame.childNodes[ j ] ).hasClass( 'NavHead' ) ) {
 
−
navToggle.style.color = navFrame.childNodes[ j ].style.color;
 
−
navFrame.childNodes[ j ].appendChild( navToggle );
 
−
}
 
−
}
 
−
navFrame.setAttribute( 'id', 'NavFrame' + indexNavigationBar );
 
−
} );
 
−
}
 
−
 
 
−
mw.hook( 'wikipage.content' ).add( createNavigationBarToggleButton );
 
  
−
/* End of mw.loader.using callback */
+
}());
−
} );
 
−
/* DO NOT ADD CODE BELOW THIS LINE */
 

Revision as of 09:49, 19 August 2020

/**
 * Dynamic Navigation Bars. See [[Wikipedia:NavFrame]]
 * 
 * Based on script from en.wikipedia.org, 2008-09-15.
 *
 * @source www.mediawiki.org/wiki/MediaWiki:Gadget-NavFrame.js
 * @maintainer Helder.wiki, 2012–2013
 * @maintainer Krinkle, 2013
 */
( function () {

// Set up the words in your language
var collapseCaption = 'hide';
var expandCaption = 'show';

var navigationBarHide = '[' + collapseCaption + ']';
var navigationBarShow = '[' + expandCaption + ']';

/**
 * Shows and hides content and picture (if available) of navigation bars.
 *
 * @param {number} indexNavigationBar The index of navigation bar to be toggled
 * @param {jQuery.Event} e Event object
 */
function toggleNavigationBar( indexNavigationBar, e ) {
	var navChild,
		navToggle = document.getElementById( 'NavToggle' + indexNavigationBar ),
		navFrame = document.getElementById( 'NavFrame' + indexNavigationBar );

	// Prevent browser from jumping to href "#"
	e.preventDefault();

	if ( !navFrame || !navToggle ) {
		return false;
	}

	// If shown now
	if ( navToggle.firstChild.data === navigationBarHide ) {
		for ( navChild = navFrame.firstChild; navChild !== null; navChild = navChild.nextSibling ) {
			if ( $( navChild ).hasClass( 'NavContent' ) || $( navChild ).hasClass( 'NavPic' ) ) {
				navChild.style.display = 'none';
			}
		}
		navToggle.firstChild.data = navigationBarShow;

	// If hidden now
	} else if ( navToggle.firstChild.data === navigationBarShow ) {
		for ( navChild = navFrame.firstChild; navChild !== null; navChild = navChild.nextSibling ) {
			if ( $( navChild ).hasClass( 'NavContent' ) || $( navChild ).hasClass( 'NavPic' ) ) {
				navChild.style.display = 'block';
			}
		}
		navToggle.firstChild.data = navigationBarHide;
	}
}

/**
 * Adds show/hide-button to navigation bars.
 *
 * @param {jQuery} $content
 */
function createNavigationBarToggleButton( $content ) {
	var i, j, navChild, navToggle, navToggleText, isCollapsed,
		indexNavigationBar = 0;
	// iterate over all < div >-elements
	var $divs = $content.find( 'div.NavFrame' );
	$divs.each( function ( i, navFrame ) {
		indexNavigationBar++;
		navToggle = document.createElement( 'a' );
		navToggle.className = 'NavToggle';
		navToggle.setAttribute( 'id', 'NavToggle' + indexNavigationBar );
		navToggle.setAttribute( 'href', '#' );
		$( navToggle ).on( 'click', $.proxy( toggleNavigationBar, null, indexNavigationBar ) );

		isCollapsed = $( navFrame ).hasClass( 'collapsed' );
		// backwards compatibility for old technique where the collapsed class was not yet used
		for ( navChild = navFrame.firstChild; navChild !== null && !isCollapsed; navChild = navChild.nextSibling ) {
			if ( $( navChild ).hasClass( 'NavPic' ) || $( navChild ).hasClass( 'NavContent' ) ) {
				if ( navChild.style.display === 'none' ) {
					isCollapsed = true;
				}
			}
		}
		if ( isCollapsed ) {
			for ( navChild = navFrame.firstChild; navChild !== null; navChild = navChild.nextSibling ) {
				if ( $( navChild ).hasClass( 'NavPic' ) || $( navChild ).hasClass( 'NavContent' ) ) {
					navChild.style.display = 'none';
				}
			}
		}
		navToggleText = document.createTextNode( isCollapsed ? navigationBarShow : navigationBarHide );
		navToggle.appendChild( navToggleText );

		// Find the NavHead and attach the toggle link (Must be this complicated because Moz's firstChild handling is borked)
		for ( j = 0; j < navFrame.childNodes.length; j++ ) {
			if ( $( navFrame.childNodes[j] ).hasClass( 'NavHead' ) ) {
				navToggle.style.color = navFrame.childNodes[j].style.color;
				navFrame.childNodes[j].appendChild( navToggle );
			}
		}
		navFrame.setAttribute( 'id', 'NavFrame' + indexNavigationBar );
	} );
}

mw.hook( 'wikipage.content' ).add( createNavigationBarToggleButton );

}());
Retrieved from "http://mediawiki.envri.eu/index.php?title=MediaWiki:Common.js&oldid=1037"