MediaWiki:Common.js: Difference between revisions
Jump to navigation
Jump to search
(Disable "force preview" to fix live preview bug) |
Red Leader (talk | contribs) (Updates from https://en.wikipedia.org/wiki/MediaWiki:Common.js. Should we use mw.loader.using? I'm going to test and see if it all works) |
||
Line 6: | Line 6: | ||
*/ | */ | ||
/** | |||
* Test if an element has a certain class | |||
* @deprecated: Use $(element).hasClass() instead. | |||
*/ | |||
mw.log.deprecate( window, 'hasClass', function ( element, className ) { | |||
}) | return $( element ).hasClass( className ); | ||
}, 'Use jQuery.hasClass() instead' ); | |||
/** | /** | ||
Line 22: | Line 23: | ||
var collapseCaption = 'hide'; | var collapseCaption = 'hide'; | ||
var expandCaption = 'show'; | var expandCaption = 'show'; | ||
var tableIndex = 0; | |||
function collapseTable( tableIndex ) { | |||
var Button = document.getElementById( 'collapseButton' + tableIndex ); | var Button = document.getElementById( 'collapseButton' + tableIndex ); | ||
var Table = document.getElementById( 'collapsibleTable' + tableIndex ); | var Table = document.getElementById( 'collapsibleTable' + tableIndex ); | ||
if ( !Table || !Button ) { | if ( !Table || !Button ) { | ||
return false; | return false; | ||
} | } | ||
var Rows = Table.rows; | var Rows = Table.rows; | ||
var i; | var i; | ||
if ( Button.firstChild.data === collapseCaption ) { | if ( Button.firstChild.data === collapseCaption ) { | ||
for ( i = 1; i < Rows.length; i++ ) { | for ( i = 1; i < Rows.length; i++ ) { | ||
Line 45: | Line 47: | ||
Button.firstChild.data = collapseCaption; | Button.firstChild.data = collapseCaption; | ||
} | } | ||
} | } | ||
function | function createClickHandler( tableIndex ) { | ||
return function ( e ) { | |||
e.preventDefault(); | |||
collapseTable( tableIndex ); | |||
}; | |||
} | |||
function createCollapseButtons( $content ) { | |||
var NavigationBoxes = {}; | var NavigationBoxes = {}; | ||
var Tables = | var $Tables = $content.find( 'table' ); | ||
var i; | var i; | ||
$Tables.each( function( i, table ) { | |||
if ( $(table).hasClass( 'collapsible' ) ) { | |||
if ( $( | |||
/* only add button and increment count if there is a header row to work with */ | /* only add button and increment count if there is a header row to work with */ | ||
var HeaderRow = | var HeaderRow = table.getElementsByTagName( 'tr' )[0]; | ||
if ( !HeaderRow ) | if ( !HeaderRow ) { | ||
var Header = | return; | ||
if ( !Header ) | } | ||
var Header = table.getElementsByTagName( 'th' )[0]; | |||
NavigationBoxes[ tableIndex ] = | if ( !Header ) { | ||
return; | |||
} | |||
NavigationBoxes[ tableIndex ] = table; | |||
table.setAttribute( 'id', 'collapsibleTable' + tableIndex ); | |||
var Button = document.createElement( 'span' ); | var Button = document.createElement( 'span' ); | ||
var ButtonLink = document.createElement( 'a' ); | var ButtonLink = document.createElement( 'a' ); | ||
var ButtonText = document.createTextNode( collapseCaption ); | var ButtonText = document.createTextNode( collapseCaption ); | ||
// Styles are declared in [[MediaWiki:Common.css]] | |||
Button.className = 'collapseButton'; | Button.className = 'collapseButton'; | ||
ButtonLink.style.color = Header.style.color; | ButtonLink.style.color = Header.style.color; | ||
ButtonLink.setAttribute( 'id', 'collapseButton' + tableIndex ); | ButtonLink.setAttribute( 'id', 'collapseButton' + tableIndex ); | ||
ButtonLink.setAttribute( 'href', '#' ); | ButtonLink.setAttribute( 'href', '#' ); | ||
$( ButtonLink ).on( 'click', | $( ButtonLink ).on( 'click', createClickHandler( tableIndex ) ); | ||
ButtonLink.appendChild( ButtonText ); | ButtonLink.appendChild( ButtonText ); | ||
Button.appendChild( document.createTextNode( '[' ) ); | Button.appendChild( document.createTextNode( '[' ) ); | ||
Button.appendChild( ButtonLink ); | Button.appendChild( ButtonLink ); | ||
Button.appendChild( document.createTextNode( ']' ) ); | Button.appendChild( document.createTextNode( ']' ) ); | ||
Header.insertBefore( Button, Header.firstChild ); | Header.insertBefore( Button, Header.firstChild ); | ||
tableIndex++; | tableIndex++; | ||
} | } | ||
} | } ); | ||
for ( i = 0; i < tableIndex; i++ ) { | for ( i = 0; i < tableIndex; i++ ) { | ||
if ( $( NavigationBoxes[i] ).hasClass( 'collapsed' ) || ( tableIndex >= autoCollapse && $( NavigationBoxes[i] ).hasClass( 'autocollapse' ) ) ) { | if ( $( NavigationBoxes[i] ).hasClass( 'collapsed' ) || | ||
( tableIndex >= autoCollapse && $( NavigationBoxes[i] ).hasClass( 'autocollapse' ) ) | |||
} | ) { | ||
collapseTable( i ); | |||
} | |||
else if ( $( NavigationBoxes[i] ).hasClass ( 'innercollapse' ) ) { | else if ( $( NavigationBoxes[i] ).hasClass ( 'innercollapse' ) ) { | ||
var element = NavigationBoxes[i]; | var element = NavigationBoxes[i]; | ||
while ((element = element.parentNode)) { | while ((element = element.parentNode)) { | ||
if ( $( element ).hasClass( 'outercollapse' ) ) { | if ( $( element ).hasClass( 'outercollapse' ) ) { | ||
collapseTable ( i ); | |||
break; | break; | ||
} | } | ||
Line 106: | Line 115: | ||
} | } | ||
} | } | ||
mw.hook( 'wikipage.content' ).add( createCollapseButtons ); | mw.hook( 'wikipage.content' ).add( createCollapseButtons ); | ||
Line 115: | Line 124: | ||
*/ | */ | ||
/ | /* set up the words in your language */ | ||
var NavigationBarHide = '[' + collapseCaption + ']'; | var NavigationBarHide = '[' + collapseCaption + ']'; | ||
var NavigationBarShow = '[' + expandCaption + ']'; | var NavigationBarShow = '[' + expandCaption + ']'; | ||
var indexNavigationBar = 0; | |||
/ | |||
/** | |||
* Shows and hides content and picture (if available) of navigation bars | |||
window.toggleNavigationBar = function(indexNavigationBar){ | * Parameters: | ||
var NavToggle = document.getElementById( | * indexNavigationBar: the index of navigation bar to be toggled | ||
var NavFrame = document.getElementById( | **/ | ||
window.toggleNavigationBar = function ( indexNavigationBar, event ) { | |||
if (!NavFrame || !NavToggle) { | var NavToggle = document.getElementById( 'NavToggle' + indexNavigationBar ); | ||
var NavFrame = document.getElementById( 'NavFrame' + indexNavigationBar ); | |||
var NavChild; | |||
if ( !NavFrame || !NavToggle ) { | |||
return false; | return false; | ||
} | } | ||
/ | /* if shown now */ | ||
if (NavToggle.firstChild.data == NavigationBarHide) { | if ( NavToggle.firstChild.data === NavigationBarHide ) { | ||
for ( | for ( NavChild = NavFrame.firstChild; NavChild != null; NavChild = NavChild.nextSibling ) { | ||
if (hasClass( | 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 */ | ||
} else if (NavToggle.firstChild.data == NavigationBarShow) { | } else if ( NavToggle.firstChild.data === NavigationBarShow ) { | ||
for ( | for ( NavChild = NavFrame.firstChild; NavChild != null; NavChild = NavChild.nextSibling ) { | ||
if (hasClass( | if ( $( NavChild ).hasClass( 'NavContent' ) || $( NavChild ).hasClass( 'NavPic' ) ) { | ||
NavChild.style.display = 'block'; | NavChild.style.display = 'block'; | ||
} | } | ||
Line 148: | Line 161: | ||
NavToggle.firstChild.data = NavigationBarHide; | NavToggle.firstChild.data = NavigationBarHide; | ||
} | } | ||
} | |||
event.preventDefault(); | |||
/ | }; | ||
function createNavigationBarToggleButton(){ | |||
var | /* adds show/hide-button to navigation bars */ | ||
/ | function createNavigationBarToggleButton( $content ) { | ||
var divs = | var NavChild; | ||
/* iterate over all < div >-elements */ | |||
/ | var $divs = $content.find( 'div' ); | ||
if (hasClass(NavFrame | $divs.each( function ( i, NavFrame ) { | ||
/* if found a navigation bar */ | |||
if ( $( NavFrame ).hasClass( 'NavFrame' ) ) { | |||
indexNavigationBar++; | indexNavigationBar++; | ||
var NavToggle = document.createElement( | var NavToggle = document.createElement( 'a' ); | ||
NavToggle.className = 'NavToggle'; | NavToggle.className = 'NavToggle'; | ||
NavToggle.setAttribute('id', 'NavToggle' + indexNavigationBar); | NavToggle.setAttribute( 'id', 'NavToggle' + indexNavigationBar ); | ||
NavToggle.setAttribute('href', ' | NavToggle.setAttribute( 'href', '#' ); | ||
$( NavToggle ).on( 'click', $.proxy( window.toggleNavigationBar, window, indexNavigationBar ) ); | |||
var isCollapsed = hasClass( | |||
/* | var isCollapsed = $( NavFrame ).hasClass( 'collapsed' ); | ||
/** | |||
* Check if any children are already hidden. This loop is here for backwards compatibility: | * 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" | * the old way of making NavFrames start out collapsed was to manually add style="display:none" | ||
Line 173: | Line 189: | ||
* "collapsed" to the NavFrame itself, just like with collapsible tables. | * "collapsed" to the NavFrame itself, just like with collapsible tables. | ||
*/ | */ | ||
for ( | for ( NavChild = NavFrame.firstChild; NavChild != null && !isCollapsed; NavChild = NavChild.nextSibling ) { | ||
if ( hasClass( | if ( $( NavChild ).hasClass( 'NavPic' ) || $( NavChild ).hasClass( 'NavContent' ) ) { | ||
if ( NavChild.style.display == 'none' ) { | if ( NavChild.style.display === 'none' ) { | ||
isCollapsed = true; | isCollapsed = true; | ||
} | } | ||
} | } | ||
} | } | ||
if (isCollapsed) { | if ( isCollapsed ) { | ||
for ( | for ( NavChild = NavFrame.firstChild; NavChild != null; NavChild = NavChild.nextSibling ) { | ||
if ( hasClass( | if ( $( NavChild ).hasClass( 'NavPic' ) || $( NavChild ).hasClass( 'NavContent' ) ) { | ||
NavChild.style.display = 'none'; | NavChild.style.display = 'none'; | ||
} | } | ||
} | } | ||
} | } | ||
var NavToggleText = document.createTextNode(isCollapsed ? NavigationBarShow : NavigationBarHide); | var NavToggleText = document.createTextNode( isCollapsed ? NavigationBarShow : NavigationBarHide ); | ||
NavToggle.appendChild(NavToggleText); | NavToggle.appendChild( NavToggleText ); | ||
/ | /* Find the NavHead and attach the toggle link (Must be this complicated because Moz's firstChild handling is borked) */ | ||
for(var j=0; j < NavFrame.childNodes.length; j++) { | for( var j = 0; j < NavFrame.childNodes.length; j++ ) { | ||
if ( | if ( $( NavFrame.childNodes[j] ).hasClass( 'NavHead' ) ) { | ||
NavToggle.style.color = NavFrame.childNodes[j].style.color; | NavToggle.style.color = NavFrame.childNodes[j].style.color; | ||
NavFrame.childNodes[j].appendChild(NavToggle); | NavFrame.childNodes[j].appendChild( NavToggle ); | ||
} | } | ||
} | } | ||
NavFrame.setAttribute('id', 'NavFrame' + indexNavigationBar); | NavFrame.setAttribute( 'id', 'NavFrame' + indexNavigationBar ); | ||
} | } | ||
} | } ); | ||
} | } | ||
mw.hook( 'wikipage.content' ).add( createNavigationBarToggleButton ); |
Revision as of 14:27, 11 December 2015
/* Any JavaScript here will be loaded for all users on every page load. */
/* Test if an element has a certain class
*
* @deprecated: Use $(element).hasClass() instead.
*/
/**
* Test if an element has a certain class
* @deprecated: Use $(element).hasClass() instead.
*/
mw.log.deprecate( window, 'hasClass', function ( element, className ) {
return $( element ).hasClass( className );
}, 'Use jQuery.hasClass() instead' );
/**
* Collapsible tables *********************************************************
*
* Description: Allows tables to be collapsed, showing only the header.
*/
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;
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 = Rows[0].style.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 );
}
else if ( $( NavigationBoxes[i] ).hasClass ( 'innercollapse' ) ) {
var element = NavigationBoxes[i];
while ((element = element.parentNode)) {
if ( $( element ).hasClass( 'outercollapse' ) ) {
collapseTable ( i );
break;
}
}
}
}
}
mw.hook( 'wikipage.content' ).add( createCollapseButtons );
/** Dynamic Navigation Bars (experimental) *************************************
*
* Description: See [[Wikipedia:NavFrame]].
* Maintainers: UNMAINTAINED
*/
/* set up the words in your language */
var NavigationBarHide = '[' + collapseCaption + ']';
var NavigationBarShow = '[' + expandCaption + ']';
var indexNavigationBar = 0;
/**
* Shows and hides content and picture (if available) of navigation bars
* Parameters:
* indexNavigationBar: the index of navigation bar to be toggled
**/
window.toggleNavigationBar = function ( indexNavigationBar, event ) {
var NavToggle = document.getElementById( 'NavToggle' + indexNavigationBar );
var NavFrame = document.getElementById( 'NavFrame' + indexNavigationBar );
var NavChild;
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;
}
event.preventDefault();
};
/* adds show/hide-button to navigation bars */
function createNavigationBarToggleButton( $content ) {
var NavChild;
/* iterate over all < div >-elements */
var $divs = $content.find( 'div' );
$divs.each( function ( i, NavFrame ) {
/* if found a navigation bar */
if ( $( NavFrame ).hasClass( 'NavFrame' ) ) {
indexNavigationBar++;
var NavToggle = document.createElement( 'a' );
NavToggle.className = 'NavToggle';
NavToggle.setAttribute( 'id', 'NavToggle' + indexNavigationBar );
NavToggle.setAttribute( 'href', '#' );
$( NavToggle ).on( 'click', $.proxy( window.toggleNavigationBar, window, indexNavigationBar ) );
var 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';
}
}
}
var 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( var 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 );