MediaWiki:Common.js: Difference between revisions
Jump to navigation
Jump to search
(Created page with " * Keep code in MediaWiki:Common.js to a minimum as it is unconditionally * loaded for all users on every wiki page. If possible create a gadget that is * enabled by default...") |
(Common.js source from https://www.mediawiki.org/wiki/Manual:Collapsible_elements) |
||
(One intermediate revision by the same user not shown) | |||
Line 1: | Line 1: | ||
/** | /** | ||
* | * 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 | |||
* @source | |||
* @ | |||
* @ | |||
*/ | */ | ||
( function () { | ( function () { | ||
// Set up the words in your language | |||
var collapseCaption = 'hide'; | var collapseCaption = 'hide'; | ||
var expandCaption = 'show'; | var expandCaption = 'show'; | ||
var navigationBarHide = '[' + collapseCaption + ']'; | var navigationBarHide = '[' + collapseCaption + ']'; | ||
var navigationBarShow = '[' + expandCaption + ']'; | var navigationBarShow = '[' + expandCaption + ']'; | ||
Line 208: | Line 21: | ||
* | * | ||
* @param {number} indexNavigationBar The index of navigation bar to be toggled | * @param {number} indexNavigationBar The index of navigation bar to be toggled | ||
* @param {jQuery.Event} | * @param {jQuery.Event} e Event object | ||
*/ | */ | ||
function toggleNavigationBar( indexNavigationBar, | function toggleNavigationBar( indexNavigationBar, e ) { | ||
var navToggle = document.getElementById( 'NavToggle' + indexNavigationBar ) | var navChild, | ||
navToggle = document.getElementById( 'NavToggle' + indexNavigationBar ), | |||
navFrame = document.getElementById( 'NavFrame' + indexNavigationBar ); | |||
// Prevent browser from jumping to href "#" | |||
e.preventDefault(); | |||
if ( !navFrame || !navToggle ) { | if ( !navFrame || !navToggle ) { | ||
Line 222: | Line 38: | ||
if ( navToggle.firstChild.data === navigationBarHide ) { | 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( 'NavContent' ) || $( navChild ).hasClass( 'NavPic' ) ) { | ||
navChild.style.display = 'none'; | navChild.style.display = 'none'; | ||
} | } | ||
} | } | ||
navToggle.firstChild.data = navigationBarShow; | navToggle.firstChild.data = navigationBarShow; | ||
// If hidden now | // If hidden now | ||
} else if ( navToggle.firstChild.data === navigationBarShow ) { | } else if ( navToggle.firstChild.data === navigationBarShow ) { | ||
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( 'NavContent' ) || $( navChild ).hasClass( 'NavPic' ) ) { | ||
navChild.style.display = 'block'; | navChild.style.display = 'block'; | ||
} | } | ||
Line 237: | Line 53: | ||
navToggle.firstChild.data = navigationBarHide; | navToggle.firstChild.data = navigationBarHide; | ||
} | } | ||
} | } | ||
Line 249: | Line 63: | ||
var i, j, navChild, navToggle, navToggleText, isCollapsed, | var i, j, navChild, navToggle, navToggleText, isCollapsed, | ||
indexNavigationBar = 0; | indexNavigationBar = 0; | ||
// | // iterate over all < div >-elements | ||
var $divs = $content.find( 'div.NavFrame | var $divs = $content.find( 'div.NavFrame' ); | ||
$divs.each( function ( i, navFrame ) { | $divs.each( function ( i, navFrame ) { | ||
indexNavigationBar++; | indexNavigationBar++; | ||
Line 260: | Line 74: | ||
isCollapsed = $( navFrame ).hasClass( 'collapsed' ); | 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 ) { | for ( navChild = navFrame.firstChild; navChild !== null && !isCollapsed; navChild = navChild.nextSibling ) { | ||
if ( $( navChild ).hasClass( 'NavPic' ) || $( navChild ).hasClass( 'NavContent' ) ) { | if ( $( navChild ).hasClass( 'NavPic' ) || $( navChild ).hasClass( 'NavContent' ) ) { | ||
Line 297: | Line 105: | ||
mw.hook( 'wikipage.content' ).add( createNavigationBarToggleButton ); | mw.hook( 'wikipage.content' ).add( createNavigationBarToggleButton ); | ||
}()); | |||
} | |||
Latest revision as of 18:02, 6 April 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 );
}());