Difference between revisions of "MediaWiki:Common.js"

From King Arthur's Gold Wiki
Jump to: navigation, search
m (test2)
m (test3)
Line 1: Line 1:
/* Any JavaScript here will be loaded for all users on every page load. */
 
 
 
/**
 
* Collapsible tables *********************************************************
 
*
 
* Description: Allows tables to be collapsed, showing only the header. See
 
*              [https://en.wikipedia.org/wiki/Wikipedia:NavFrame Wikipedia:NavFrame].
 
*/
 
 
 
/** Collapsible tables *********************************************************
 
/** Collapsible tables *********************************************************
 
  *
 
  *
 
  *  Description: Allows tables to be collapsed, showing only the header. See
 
  *  Description: Allows tables to be collapsed, showing only the header. See
 
  *                        http://www.mediawiki.org/wiki/Manual:Collapsible_tables.
 
  *                        http://www.mediawiki.org/wiki/Manual:Collapsible_tables.
*  Maintainers: [[en:User:R. Koot]]
 
 
  */
 
  */
 
   
 
   
Line 98: Line 87:
 
         }
 
         }
 
}
 
}
 
+
 
addOnloadHook( createCollapseButtons );
 
addOnloadHook( createCollapseButtons );
 
   
 
   
Line 113: Line 102:
 
         };
 
         };
 
})();
 
})();
 
 
 
/**
 
* Dynamic Navigation Bars (experimental)
 
*
 
* Description: See [https://en.wikipedia.org/wiki/Wikipedia:NavFrame Wikipedia:NavFrame].
 
*/
 
 
/* set up the words in your language */
 
var NavigationBarHide = '[' + collapseCaption + ']';
 
var NavigationBarShow = '[' + expandCaption + ']';
 
 
/**
 
* 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() {
 
    var indexNavigationBar = 0;
 
    var NavFrame;
 
    var NavChild;
 
    /* iterate over all < div >-elements */
 
    var divs = document.getElementsByTagName( 'div' );
 
    for ( var i = 0; (NavFrame = divs[i]); i++ ) {
 
        /* 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 );
 
        }
 
    }
 
}
 
 
$( createNavigationBarToggleButton );
 

Revision as of 22:33, 5 August 2013

/** Collapsible tables *********************************************************
 *
 *  Description: Allows tables to be collapsed, showing only the header. See
 *                         http://www.mediawiki.org/wiki/Manual:Collapsible_tables.
 */
 
var autoCollapse = 2;
var collapseCaption = 'hide';
var expandCaption = 'show';
 
function collapseTable( tableIndex ) {
        var Button = document.getElementById( 'collapseButton' + tableIndex );
        var Table = document.getElementById( 'collapsibleTable' + tableIndex );
 
        if ( !Table || !Button ) {
                return false;
        }
 
        var Rows = Table.rows;
 
        if ( Button.firstChild.data == collapseCaption ) {
                for ( var i = 1; i < Rows.length; i++ ) {
                        Rows[i].style.display = 'none';
                }
                Button.firstChild.data = expandCaption;
        } else {
                for ( var i = 1; i < Rows.length; i++ ) {
                        Rows[i].style.display = Rows[0].style.display;
                }
                Button.firstChild.data = collapseCaption;
        }
}
 
function createCollapseButtons() {
        var tableIndex = 0;
        var NavigationBoxes = new Object();
        var Tables = document.getElementsByTagName( 'table' );
 
        for ( var i = 0; i < Tables.length; i++ ) {
                if ( hasClass( Tables[i], 'collapsible' ) ) {
 
                        /* only add button and increment count if there is a header row to work with */
                        var HeaderRow = Tables[i].getElementsByTagName( 'tr' )[0];
                        if ( !HeaderRow ) {
                                continue;
                        }
                        var Header = HeaderRow.getElementsByTagName( 'th' )[0];
                        if ( !Header ) {
                                continue;
                        }
 
                        NavigationBoxes[tableIndex] = Tables[i];
                        Tables[i].setAttribute( 'id', 'collapsibleTable' + tableIndex );
 
                        var Button = document.createElement( 'span' );
                        var ButtonLink = document.createElement( 'a' );
                        var ButtonText = document.createTextNode( collapseCaption );
 
                        Button.className = 'collapseButton'; // Styles are declared in [[MediaWiki:Common.css]]
 
                        ButtonLink.style.color = Header.style.color;
                        ButtonLink.setAttribute( 'id', 'collapseButton' + tableIndex );
                        ButtonLink.setAttribute( 'href', "javascript:collapseTable(" + tableIndex + ");" );
                        ButtonLink.appendChild( ButtonText );
 
                        Button.appendChild( document.createTextNode( '[' ) );
                        Button.appendChild( ButtonLink );
                        Button.appendChild( document.createTextNode( ']' ) );
 
                        Header.insertBefore( Button, Header.childNodes[0] );
                        tableIndex++;
                }
        }
 
        for ( var i = 0;  i < tableIndex; i++ ) {
                if ( hasClass( NavigationBoxes[i], 'collapsed' ) || ( tableIndex >= autoCollapse && hasClass( NavigationBoxes[i], 'autocollapse' ) ) ) {
                        collapseTable( i );
                } else if ( hasClass( NavigationBoxes[i], 'innercollapse' ) ) {
                        var element = NavigationBoxes[i];
                        while ( element = element.parentNode ) {
                                if ( hasClass( element, 'outercollapse' ) ) {
                                        collapseTable( i );
                                        break;
                                }
                        }
                }
        }
}
 
addOnloadHook( createCollapseButtons );
 
/** Test if an element has a certain class **************************************
 *
 * Description: Uses regular expressions and caching for better performance.
 * Maintainers: [[User:Mike Dillon]], [[User:R. Koot]], [[User:SG]]
 */
 
var hasClass = ( function() {
        var reCache = {};
        return function( element, className ) {
                return ( reCache[className] ? reCache[className] : ( reCache[className] = new RegExp( "(?:\\s|^)" + className + "(?:\\s|$)" ) ) ).test( element.className );
        };
})();