Difference between revisions of "MediaWiki:Common.js"

From Wiki Itajaí
Jump to navigation Jump to search
Line 1: Line 1:
 
/**
 
/**
  * Collapsible tables
+
  * Dynamic Navigation Bars. See [[Wikipedia:NavFrame]]
 +
*
 +
* Based on script from en.wikipedia.org, 2008-09-15.
 
  *
 
  *
* Allows tables to be collapsed, showing only the header. See [[Help:Collapsing]].
+
  * @source www.mediawiki.org/wiki/MediaWiki:Gadget-NavFrame.js
*
+
  * @maintainer Helder.wiki, 2012–2013
* @version 2.0.3 (2014-03-14)
+
  * @maintainer Krinkle, 2013
  * @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 () {
  
var autoCollapse = 2;
+
// Set up the words in your language
 
var collapseCaption = 'hide';
 
var collapseCaption = 'hide';
 
var expandCaption = 'show';
 
var expandCaption = 'show';
var tableIndex = 0;
 
  
function collapseTable( tableIndex ) {
+
var navigationBarHide = '[' + collapseCaption + ']';
var Button = document.getElementById( 'collapseButton' + tableIndex );
+
var navigationBarShow = '[' + expandCaption + ']';
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 );
  
if ( !Table || !Button ) {
+
// Prevent browser from jumping to href "#"
 +
e.preventDefault();
 +
 
 +
if ( !navFrame || !navToggle ) {
 
return false;
 
return false;
 
}
 
}
  
var Rows = Table.rows;
+
// If shown now
var i;
+
if ( navToggle.firstChild.data === navigationBarHide ) {
var $row0 = $(Rows[0]);
+
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 ( Button.firstChild.data === collapseCaption ) {
+
// If hidden now
for ( i = 1; i < Rows.length; i++ ) {
+
} else if ( navToggle.firstChild.data === navigationBarShow ) {
Rows[i].style.display = 'none';
+
for ( navChild = navFrame.firstChild; navChild !== null; navChild = navChild.nextSibling ) {
 +
if ( $( navChild ).hasClass( 'NavContent' ) || $( navChild ).hasClass( 'NavPic' ) ) {
 +
navChild.style.display = 'block';
 +
}
 
}
 
}
Button.firstChild.data = expandCaption;
+
navToggle.firstChild.data = navigationBarHide;
} 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 ) {
+
* Adds show/hide-button to navigation bars.
e.preventDefault();
+
*
collapseTable( tableIndex );
+
* @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 ) );
  
function createCollapseButtons( $content ) {
+
isCollapsed = $( navFrame ).hasClass( 'collapsed' );
var NavigationBoxes = {};
+
// backwards compatibility for old technique where the collapsed class was not yet used
var $Tables = $content.find( 'table' );
+
for ( navChild = navFrame.firstChild; navChild !== null && !isCollapsed; navChild = navChild.nextSibling ) {
var i;
+
if ( $( navChild ).hasClass( 'NavPic' ) || $( navChild ).hasClass( 'NavContent' ) ) {
 
+
if ( navChild.style.display === 'none' ) {
$Tables.each( function( i, table ) {
+
isCollapsed = true;
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 ) {
+
if ( isCollapsed ) {
return;
+
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 );
  
NavigationBoxes[ tableIndex ] = table;
+
// Find the NavHead and attach the toggle link (Must be this complicated because Moz's firstChild handling is borked)
table.setAttribute( 'id', 'collapsibleTable' + tableIndex );
+
for ( j = 0; j < navFrame.childNodes.length; j++ ) {
 
+
if ( $( navFrame.childNodes[j] ).hasClass( 'NavHead' ) ) {
var Button    = document.createElement( 'span' );
+
navToggle.style.color = navFrame.childNodes[j].style.color;
var ButtonLink = document.createElement( 'a' );
+
navFrame.childNodes[j].appendChild( navToggle );
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++;
 
 
}
 
}
 +
navFrame.setAttribute( 'id', 'NavFrame' + indexNavigationBar );
 
} );
 
} );
 +
}
  
for ( i = 0;  i < tableIndex; i++ ) {
+
mw.hook( 'wikipage.content' ).add( createNavigationBarToggleButton );
if ( $( NavigationBoxes[i] ).hasClass( 'collapsed' ) ||
 
( tableIndex >= autoCollapse && $( NavigationBoxes[i] ).hasClass( 'autocollapse' ) )
 
) {
 
collapseTable( i );
 
}
 
}
 
}
 
  
mw.hook( 'wikipage.content' ).add( createCollapseButtons );
+
}());

Revision as of 17:33, 28 May 2018

/**
 * 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 );

}());