Difference between revisions of "MediaWiki:Common.js"

From TransSOL
Jump to: navigation, search
(Created page with "Any JavaScript here will be loaded for all users on every page load.: /** * Dynamic Navigation Bars. See Wikipedia:NavFrame * * Based on script from en.wikipedia...")
 
Line 2: Line 2:
  
 
/**
 
/**
  * Dynamic Navigation Bars. See [[Wikipedia:NavFrame]]
+
  * Collapsible tables
*
 
* Based on script from en.wikipedia.org, 2008-09-15.
 
 
  *
 
  *
  * @source www.mediawiki.org/wiki/MediaWiki:Gadget-NavFrame.js
+
* Allows tables to be collapsed, showing only the header. See [[Help:Collapsing]].
  * @maintainer Helder.wiki, 2012–2013
+
*
  * @maintainer Krinkle, 2013
+
* @version 2.0.3 (2014-03-14)
 +
  * @source https://www.mediawiki.org/wiki/MediaWiki:Gadget-collapsibleTables.js
 +
  * @author [[User:R. Koot]]
 +
  * @author [[User:Krinkle]]
 +
* @deprecated Since MediaWiki 1.20: Use class="mw-collapsible" instead which
 +
* is supported in MediaWiki core.
 
  */
 
  */
( function () {
 
  
// Set up the words in your language
+
var autoCollapse = 2;
 
var collapseCaption = 'hide';
 
var collapseCaption = 'hide';
 
var expandCaption = 'show';
 
var expandCaption = 'show';
 +
var tableIndex = 0;
  
var navigationBarHide = '[' + collapseCaption + ']';
+
function collapseTable( tableIndex ) {
var navigationBarShow = '[' + expandCaption + ']';
+
var Button = document.getElementById( 'collapseButton' + tableIndex );
 
+
var Table = document.getElementById( 'collapsibleTable' + tableIndex );
/**
 
* 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 "#"
+
if ( !Table || !Button ) {
e.preventDefault();
 
 
 
if ( !navFrame || !navToggle ) {
 
 
return false;
 
return false;
 
}
 
}
  
// If shown now
+
var Rows = Table.rows;
if ( navToggle.firstChild.data === navigationBarHide ) {
+
var i;
for ( navChild = navFrame.firstChild; navChild !== null; navChild = navChild.nextSibling ) {
+
var $row0 = $(Rows[0]);
if ( $( navChild ).hasClass( 'NavContent' ) || $( navChild ).hasClass( 'NavPic' ) ) {
+
 
navChild.style.display = 'none';
+
if ( Button.firstChild.data === collapseCaption ) {
}
+
for ( i = 1; i < Rows.length; i++ ) {
 +
Rows[i].style.display = 'none';
 
}
 
}
navToggle.firstChild.data = navigationBarShow;
+
Button.firstChild.data = expandCaption;
 
+
} else {
// If hidden now
+
for ( i = 1; i < Rows.length; i++ ) {
} else if ( navToggle.firstChild.data === navigationBarShow ) {
+
Rows[i].style.display = $row0.css( 'display' );
for ( navChild = navFrame.firstChild; navChild !== null; navChild = navChild.nextSibling ) {
 
if ( $( navChild ).hasClass( 'NavContent' ) || $( navChild ).hasClass( 'NavPic' ) ) {
 
navChild.style.display = 'block';
 
}
 
 
}
 
}
navToggle.firstChild.data = navigationBarHide;
+
Button.firstChild.data = collapseCaption;
 
}
 
}
 
}
 
}
  
/**
+
function createClickHandler( tableIndex ) {
* Adds show/hide-button to navigation bars.
+
return function ( e ) {
*
+
e.preventDefault();
* @param {jQuery} $content
+
collapseTable( tableIndex );
*/
+
};
function createNavigationBarToggleButton( $content ) {
+
}
var i, j, navChild, navToggle, navToggleText, isCollapsed,
+
 
indexNavigationBar = 0;
+
function createCollapseButtons( $content ) {
// iterate over all < div >-elements
+
var NavigationBoxes = {};
var $divs = $content.find( 'div.NavFrame' );
+
var $Tables = $content.find( 'table' );
$divs.each( function ( i, navFrame ) {
+
var i;
indexNavigationBar++;
+
 
navToggle = document.createElement( 'a' );
+
$Tables.each( function( i, table ) {
navToggle.className = 'NavToggle';
+
if ( $(table).hasClass( 'collapsible' ) ) {
navToggle.setAttribute( 'id', 'NavToggle' + indexNavigationBar );
 
navToggle.setAttribute( 'href', '#' );
 
$( navToggle ).on( 'click', $.proxy( toggleNavigationBar, null, indexNavigationBar ) );
 
  
isCollapsed = $( navFrame ).hasClass( 'collapsed' );
+
/* only add button and increment count if there is a header row to work with */
// backwards compatibility for old technique where the collapsed class was not yet used
+
var HeaderRow = table.getElementsByTagName( 'tr' )[0];
for ( navChild = navFrame.firstChild; navChild !== null && !isCollapsed; navChild = navChild.nextSibling ) {
+
if ( !HeaderRow ) {
if ( $( navChild ).hasClass( 'NavPic' ) || $( navChild ).hasClass( 'NavContent' ) ) {
+
return;
if ( navChild.style.display === 'none' ) {
 
isCollapsed = true;
 
}
 
 
}
 
}
}
+
var Header = table.getElementsByTagName( 'th' )[0];
if ( isCollapsed ) {
+
if ( !Header ) {
for ( navChild = navFrame.firstChild; navChild !== null; navChild = navChild.nextSibling ) {
+
return;
if ( $( navChild ).hasClass( 'NavPic' ) || $( navChild ).hasClass( 'NavContent' ) ) {
 
navChild.style.display = 'none';
 
}
 
 
}
 
}
 +
 +
NavigationBoxes[ tableIndex ] = table;
 +
table.setAttribute( 'id', 'collapsibleTable' + tableIndex );
 +
 +
var Button    = document.createElement( 'span' );
 +
var ButtonLink = document.createElement( 'a' );
 +
var ButtonText = document.createTextNode( collapseCaption );
 +
// Styles are declared in [[MediaWiki:Common.css]]
 +
Button.className = 'collapseButton';
 +
 +
ButtonLink.style.color = Header.style.color;
 +
ButtonLink.setAttribute( 'id', 'collapseButton' + tableIndex );
 +
ButtonLink.setAttribute( 'href', '#' );
 +
$( ButtonLink ).on( 'click', createClickHandler( tableIndex ) );
 +
ButtonLink.appendChild( ButtonText );
 +
 +
Button.appendChild( document.createTextNode( '[' ) );
 +
Button.appendChild( ButtonLink );
 +
Button.appendChild( document.createTextNode( ']' ) );
 +
 +
Header.insertBefore( Button, Header.firstChild );
 +
tableIndex++;
 
}
 
}
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 ( i = 0; i < tableIndex; i++ ) {
for ( j = 0; j < navFrame.childNodes.length; j++ ) {
+
if ( $( NavigationBoxes[i] ).hasClass( 'collapsed' ) ||
if ( $( navFrame.childNodes[j] ).hasClass( 'NavHead' ) ) {
+
( tableIndex >= autoCollapse && $( NavigationBoxes[i] ).hasClass( 'autocollapse' ) )
navToggle.style.color = navFrame.childNodes[j].style.color;
+
) {
navFrame.childNodes[j].appendChild( navToggle );
+
collapseTable( i );
}
 
 
}
 
}
navFrame.setAttribute( 'id', 'NavFrame' + indexNavigationBar );
+
}
} );
 
 
}
 
}
  
mw.hook( 'wikipage.content' ).add( createNavigationBarToggleButton );
+
mw.hook( 'wikipage.content' ).add( createCollapseButtons );
 
 
}());
 

Revision as of 02:42, 23 July 2018

/* Any JavaScript here will be loaded for all users on every page load. */

/**
 * Collapsible tables
 *
 * Allows tables to be collapsed, showing only the header. See [[Help:Collapsing]].
 *
 * @version 2.0.3 (2014-03-14)
 * @source https://www.mediawiki.org/wiki/MediaWiki:Gadget-collapsibleTables.js
 * @author [[User:R. Koot]]
 * @author [[User:Krinkle]]
 * @deprecated Since MediaWiki 1.20: Use class="mw-collapsible" instead which
 * is supported in MediaWiki core.
 */

var autoCollapse = 2;
var collapseCaption = 'hide';
var expandCaption = 'show';
var tableIndex = 0;

function collapseTable( tableIndex ) {
	var Button = document.getElementById( 'collapseButton' + tableIndex );
	var Table = document.getElementById( 'collapsibleTable' + tableIndex );

	if ( !Table || !Button ) {
		return false;
	}

	var Rows = Table.rows;
	var i;
	var $row0 = $(Rows[0]);

	if ( Button.firstChild.data === collapseCaption ) {
		for ( i = 1; i < Rows.length; i++ ) {
			Rows[i].style.display = 'none';
		}
		Button.firstChild.data = expandCaption;
	} else {
		for ( i = 1; i < Rows.length; i++ ) {
			Rows[i].style.display = $row0.css( 'display' );
		}
		Button.firstChild.data = collapseCaption;
	}
}

function createClickHandler( tableIndex ) {
	return function ( e ) {
		e.preventDefault();
		collapseTable( tableIndex );
	};
}

function createCollapseButtons( $content ) {
	var NavigationBoxes = {};
	var $Tables = $content.find( 'table' );
	var i;

	$Tables.each( function( i, table ) {
		if ( $(table).hasClass( 'collapsible' ) ) {

			/* only add button and increment count if there is a header row to work with */
			var HeaderRow = table.getElementsByTagName( 'tr' )[0];
			if ( !HeaderRow ) {
				return;
			}
			var Header = table.getElementsByTagName( 'th' )[0];
			if ( !Header ) {
				return;
			}

			NavigationBoxes[ tableIndex ] = table;
			table.setAttribute( 'id', 'collapsibleTable' + tableIndex );

			var Button     = document.createElement( 'span' );
			var ButtonLink = document.createElement( 'a' );
			var ButtonText = document.createTextNode( collapseCaption );
			// Styles are declared in [[MediaWiki:Common.css]]
			Button.className = 'collapseButton';

			ButtonLink.style.color = Header.style.color;
			ButtonLink.setAttribute( 'id', 'collapseButton' + tableIndex );
			ButtonLink.setAttribute( 'href', '#' );
			$( ButtonLink ).on( 'click', createClickHandler( tableIndex ) );
			ButtonLink.appendChild( ButtonText );

			Button.appendChild( document.createTextNode( '[' ) );
			Button.appendChild( ButtonLink );
			Button.appendChild( document.createTextNode( ']' ) );

			Header.insertBefore( Button, Header.firstChild );
			tableIndex++;
		}
	} );

	for ( i = 0;  i < tableIndex; i++ ) {
		if ( $( NavigationBoxes[i] ).hasClass( 'collapsed' ) ||
			( tableIndex >= autoCollapse && $( NavigationBoxes[i] ).hasClass( 'autocollapse' ) )
		) {
			collapseTable( i );
		}
	}
}

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