* Toggle entire element if no .mw-collapsible-content is found
[lhc/web/wiklou.git] / resources / jquery / jquery.makeCollapsible.js
index 363f307..127cc8e 100644 (file)
 /**
- * make lists, divs, tables etc. toggleable
+ * jQuery makeCollapsible
  *
  * This will enable collapsible-functionality on all passed elements.
  * Will prevent binding twice to the same element.
  * Initial state is expanded by default, this can be overriden by adding class
- * "kr-collapsed" to the "kr-collapsible" element.
- * Elements made collapsible have class "kr-made-collapsible".
- * Except for tables and lists, the inner content is wrapped in "kr-collapsible-content".
+ * "mw-collapsed" to the "mw-collapsible" element.
+ * Elements made collapsible have class "mw-made-collapsible".
+ * Except for tables and lists, the inner content is wrapped in "mw-collapsible-content".
  *
- * Copyright 2008-2009 Krinkle <krinklemail@gmail.com>
+ * @author Krinkle <krinklemail@gmail.com>
  *
- * @license CC-BY 2.0 NL <http://creativecommons.org/licenses/by/2.0/nl/deed.en>
+ * Dual license:
+ * @license CC-BY 3.0 <http://creativecommons.org/licenses/by/3.0>
+ * @license GPL2 <http://www.gnu.org/licenses/old-licenses/gpl-2.0.html>
  */
 
 $.fn.makeCollapsible = function() {
 
        return this.each(function() {
-               var     $that = $(this).addClass('kr-collapsible'), // in case $('#myAJAXelement').makeCollapsible() was called
+               mw.config.set( 'mw.log.prefix', 'jquery.makeCollapsible' );
+
+               // Define reused variables and functions
+               var     $that = $(this).addClass( 'mw-collapsible' ), // case: $( '#myAJAXelement' ).makeCollapsible()
                        that = this,
-                       collapsetext = $(this).attr('data-collapsetext'),
-                       expandtext = $(this).attr('data-expandtext');
+                       collapsetext = $(this).attr( 'data-collapsetext' ),
+                       expandtext = $(this).attr( 'data-expandtext' ),
+                       toggleElement = function( $collapsible, action, $defaultToggle ) {
+                               // Validate parameters
+                               if ( !$collapsible.jquery ) { // $collapsible must be an instance of jQuery
+                                       return;
+                               }
+                               if ( action != 'expand' && action != 'collapse' ) {
+                                       // action must be string with 'expand' or 'collapse'
+                                       return;
+                               }
+                               if ( typeof $defaultToggle !== 'undefined' && !$defaultToggle.jquery ) {
+                                       // is optional, but if passed must be an instance of jQuery
+                                       return;
+                               }
+
+                               if ( action == 'collapse' ) {
+
+                                       // Collapse the element
+                                       if ( $collapsible.is( 'table' ) ) {
+                                               // Hide all table rows of this table
+                                               // Slide doens't work with tables, but fade does as of jQuery 1.1.3
+                                               // http://stackoverflow.com/questions/467336#920480
+
+                                               if ( $defaultToggle.jquery ) {
+                                                       // Exclude tablerow containing togglelink
+                                                       $collapsible.find( '>tbody>tr' ).not( $defaultToggle.parent().parent() ).stop(true, true).fadeOut();
+                                               } else {
+                                                       $collapsible.find( '>tbody>tr' ).stop( true, true ).fadeOut();
+                                               }
+       
+                                       } else if ( $collapsible.is( 'ul' ) || $collapsible.is( 'ol' ) ) {
+                                               if ( $defaultToggle.jquery ) {
+                                                       // Exclude list-item containing togglelink
+                                                       $collapsible.find( '> li' ).not( $defaultToggle.parent() ).stop( true, true ).slideUp();
+                                               } else {
+                                                       $collapsible.find( '> li' ).stop( true, true ).slideUp();
+                                               }
+       
+                                       } else { // <div>, <p> etc.
+                                               var $collapsibleContent = $collapsible.find( '> .mw-collapsible-content' );
+                                               
+                                               // If a collapsible-content is defined, collapse it
+                                               if ( $collapsibleContent.size() ) {
+                                                       $collapsibleContent.slideUp();
+
+                                               // Otherwise assume this is a customcollapse with a remote toggle
+                                               // .. and there is no collapsible-content because the entire element should be toggled
+                                               } else {
+                                                       if ( $collapsible.is( 'tr' ) || $collapsible.is( 'td' ) || $collapsible.is( 'th' ) ) {
+                                                               $collapsible.fadeOut();
+                                                       } else {
+                                                               $collapsible.slideUp();
+                                                       }
+                                               }
+                                       }
+
+                               } else {
+                               
+                                       // Expand the element
+                                       if ( $collapsible.is( 'table' ) ) {
+                                               if ( $defaultToggle.jquery ) {
+                                                       // Exclude tablerow containing togglelink
+                                                       $collapsible.find( '>tbody>tr' ).not( $defaultToggle.parent().parent() ).stop(true, true).fadeIn();
+                                               } else {
+                                                       $collapsible.find( '>tbody>tr' ).stop(true, true).fadeIn();
+                                               }
+       
+                                       } else if ( $collapsible.is( 'ul' ) || $collapsible.is( 'ol' ) ) {
+                                               if ( $defaultToggle.jquery ) {
+                                                       // Exclude list-item containing togglelink
+                                                       $collapsible.find( '> li' ).not( $defaultToggle.parent() ).stop( true, true ).slideDown();
+                                               } else {
+                                                       $collapsible.find( '> li' ).stop( true, true ).slideDown();
+                                               }
+       
+                                       } else { // <div>, <p> etc.
+                                               var $collapsibleContent = $collapsible.find( '> .mw-collapsible-content' );
+                                               
+                                               // If a collapsible-content is defined, collapse it
+                                               if ( $collapsibleContent.size() ) {
+                                                       $collapsibleContent.slideDown();
+
+                                               // Otherwise assume this is a customcollapse with a remote toggle
+                                               // .. and there is no collapsible-content because the entire element should be toggled
+                                               } else {
+                                                       if ( $collapsible.is( 'tr' ) || $collapsible.is( 'td' ) || $collapsible.is( 'th' ) ) {
+                                                               $collapsible.fadeIn();
+                                                       } else {
+                                                               $collapsible.slideDown();
+                                                       }
+                                               }
+                                       }
+                               }
+                       },
+                       // Toggles collapsible and togglelink class and updates text label
+                       toggleLinkDefault = function( that, e ) {
+                               var     $that = $(that),
+                                       $collapsible = $that.closest( '.mw-collapsible.mw-made-collapsible' ).toggleClass( 'mw-collapsed' );
+                               e.preventDefault();
+                               
+                               // It's expanded right now
+                               if ( !$that.hasClass( 'mw-collapsible-toggle-collapsed' ) ) {
+                                       // Change link to "Show"
+                                       $that.removeClass( 'mw-collapsible-toggle-expanded' ).addClass( 'mw-collapsible-toggle-collapsed' );
+                                       if ( $that.find( '> a' ).size() ) {
+                                               $that.find( '> a' ).text( expandtext );
+                                       } else {
+                                               $that.text( expandtext );
+                                       }
+                                       // Collapse element
+                                       toggleElement( $collapsible, 'collapse', $that );
+
+                               // It's collapsed right now
+                               } else {
+                                       // Change link to "Hide"
+                                       $that.removeClass( 'mw-collapsible-toggle-collapsed' ).addClass( 'mw-collapsible-toggle-expanded' );
+                                       if ( $that.find( '> a' ).size() ) {
+                                               $that.find( '> a' ).text( collapsetext );
+                                       } else {
+                                               $that.text( collapsetext );
+                                       }
+                                       // Expand element
+                                       toggleElement( $collapsible, 'expand', $that );
+                               }
+                               return;
+                       },
+                       // Toggles collapsible and togglelink class
+                       toggleLinkPremade = function( that, e ) {
+                               var     $that = $(that),
+                                       $collapsible = $that.closest( '.mw-collapsible.mw-made-collapsible' ).toggleClass( 'mw-collapsed' );
+                               e.preventDefault();
+                               
+                               // It's expanded right now
+                               if ( !$that.hasClass( 'mw-collapsible-toggle-collapsed' ) ) {
+                                       // Change toggle to collapsed
+                                       $that.removeClass( 'mw-collapsible-toggle-expanded' ).addClass( 'mw-collapsible-toggle-collapsed' );
+                                       // Collapse element
+                                       toggleElement( $collapsible, 'collapse', $that );
+
+                               // It's collapsed right now
+                               } else {
+                                       // Change toggle to expanded
+                                       $that.removeClass( 'mw-collapsible-toggle-collapsed' ).addClass( 'mw-collapsible-toggle-expanded' );
+                                       // Expand element
+                                       toggleElement( $collapsible, 'expand', $that );
+                               }
+                               return;
+                       },
+                       // Toggles customcollapsible
+                       toggleLinkCustom = function( $that, e, $collapsible ) {
+                               // For the initial state call of customtogglers there is no event passed
+                               if (e) {
+                                       e.preventDefault();
+                               }
+                               // Get current state and toggle to the opposite
+                               var action = $collapsible.hasClass( 'mw-collapsed' ) ? 'expand' : 'collapse';
+                               $collapsible.toggleClass( 'mw-collapsed' );
+                               toggleElement( $collapsible, action, $that )
+                               
+                       };
+
                // Use custom text or default ?
-               if( !collapsetext || collapsetext == ''){
-                       collapsetext = 'Collapse';
+               if( !collapsetext || collapsetext === '' ){
+                       collapsetext = mw.msg( 'collapsible-collapse', 'Collapse' );
                }
-               if ( !expandtext || expandtext == ''){
-                       expandtext = 'Expand';
+               if ( !expandtext || expandtext === '' ){
+                       expandtext = mw.msg( 'collapsible-expand', 'Expand' );
                }
-               // Create toggle link with a space around the brackets (&nbsp)
-               $toggleLink = $('<span class="kr-collapsible-toggle kr-collapsible-toggle-hide">&nbsp;[<a href="#">' + collapsetext + '</a>]&nbsp;</span>').click(function(){
-                       var     $that = $(this),
-                               $collapsible = $that.closest('.kr-collapsible.kr-made-collapsible').toggleClass('kr-collapsed');
-                       if ($that.hasClass('kr-collapsible-toggle-hide')) {
-                               // Change link to "Show"
-                               $that
-                                       .removeClass('kr-collapsible-toggle-hide').addClass('kr-collapsible-toggle-show')
-                                       .find('> a').html(expandtext);
-                               // Hide the collapsible element
-                               if ($collapsible.is('table')) {
-                                       // Hide all direct childing table rows of this table, except the row containing the link
-                                       // Slide doens't work, but fade works fine as of jQuery 1.1.3
-                                       // http://stackoverflow.com/questions/467336/jquery-how-to-use-slidedown-or-show-function-on-a-table-row#920480
-                                       // Stop to prevent animaties from stacking up 
-                                       $collapsible.find('> tbody > tr').not($that.parent().parent()).stop(true, true).fadeOut();
-                               } else if ($collapsible.is('ul') || $collapsible.is('ol')) {
-                                       $collapsible.find('> li').not($that.parent()).stop(true, true).slideUp();
-                               } else { // <div>, <p> etc.
-                                       $collapsible.find('> .kr-collapsible-content').slideUp();
-                               }
-                       } else {
-                               // Change link to "Hide"
-                               $that
-                                       .removeClass('kr-collapsible-toggle-show').addClass('kr-collapsible-toggle-hide')
-                                       .find('> a').html(collapsetext);
-                               // Show the collapsible element
-                               if ($collapsible.is('table')) {
-                                       $collapsible.find('> tbody > tr').not($that.parent().parent()).stop(true, true).fadeIn();
-                               } else if ($collapsible.is('ul') || $collapsible.is('ol')) {
-                                       $collapsible.find('> li').not($that.parent()).stop(true, true).slideDown();
-                               } else { // <div>, <p> etc.
-                                       $collapsible.find('> .kr-collapsible-content').slideDown();
-                               }
-                       }
-                       return false;
-               });
-               // Skip if it has been enabled already.
-               if ($that.hasClass('kr-made-collapsible')) {
+
+               // Create toggle link with a space around the brackets (&nbsp;[text]&nbsp;)
+               var $toggleLink = $( '<a href="#">' ).text( collapsetext ).wrap( '<span class="mw-collapsible-toggle">' ).parent().prepend( '&nbsp;[' ).append( ']&nbsp;' ).bind( 'click.mw-collapse', function(e){
+                       toggleLinkDefault( this, e );
+               } );
+
+               // Return if it has been enabled already.
+               if ( $that.hasClass( 'mw-made-collapsible' ) ) {
                        return;
                } else {
-                       $that.addClass('kr-made-collapsible');
+                       $that.addClass( 'mw-made-collapsible' );
                }
-               // Elements are treated differently
-               if ($that.is('table')) {
-                       // The toggle-link will be in the last cell (td or th) of the first row
-                       var $lastCell = $('tr:first th, tr:first td', that).eq(-1);
-                       if (!$lastCell.find('> .kr-collapsible-toggle').size()) {
-                               $lastCell.prepend($toggleLink);
+               
+               // Check if this element has a custom position for the toggle link
+               // (ie. outside the container or deeper inside the tree)
+               // Then: Locate the custom toggle link(s) and bind them
+               if ( $that.attr( 'id' ).indexOf( 'mw-customcollapsible-' ) === 0 ) {
+
+                       var thatId = $that.attr( 'id' ),
+                               $customTogglers = $( '.' + thatId.replace( 'mw-customcollapsible', 'mw-customtoggle' ) );
+                       mw.log( 'Found custom collapsible: #' + thatId );
+                                               
+                       // Double check that there is actually a customtoggle link
+                       if ( $customTogglers.size() ) {
+                               $customTogglers.bind( 'click.mw-collapse', function( e ) {
+                                       toggleLinkCustom( $(this), e, $that );
+                               } );
+                       } else {
+                               mw.log( '#' + thatId + ': Missing toggler!' );
                        }
                        
-               } else if ($that.is('ul') || $that.is('ol')) {
-                       if (!$('li:first', $that).find('> .kr-collapsible-toggle').size()) {
-                               // Make sure the numeral count doesn't get messed up, reset to 1 unless value-attribute is already used
-                               if ( $('li:first', $that).attr('value') == '' ) {
-                                       $('li:first', $that).attr('value', '1');
-                               }
-                               $that.prepend($toggleLink.wrap('<li class="kr-collapsibile-toggle-li">').parent());
-                       }               
-               } else { // <div>, <p> etc.
-                       // Is there an content-wrapper already made ?
-                       // If a direct child with the class does not exists, create the wrap.
-                       if (!$that.find('g> .kr-collapsible-content').size()) {
-                               $that.wrapInner('<div class="kr-collapsible-content">');
+                       // Initial state
+                       if ( $that.hasClass( 'mw-collapsed' ) ) {
+                               $that.removeClass( 'mw-collapsed' );
+                               toggleLinkCustom( $customTogglers, null, $that )
                        }
 
-                       // Add toggle-link if not present
-                       if (!$that.find('> .kr-collapsible-toggle').size()) {
-                               $that.prepend($toggleLink);
+               // If this is not a custom case, do the default:
+               // Wrap the contents add the toggle link 
+               } else {
+
+                       // Elements are treated differently
+                       if ( $that.is( 'table' ) ) {
+                               // The toggle-link will be in one the the cells (td or th) of the first row
+                               var     $firstRowCells = $( 'tr:first th, tr:first td', that ),
+                                       $toggle = $firstRowCells.find( '> .mw-collapsible-toggle' );
+       
+                               // If theres no toggle link, add it to the last cell
+                               if ( !$toggle.size() ) {
+                                       $firstRowCells.eq(-1).prepend( $toggleLink );
+                               } else {
+                                       $toggleLink = $toggle.unbind( 'click.mw-collapse' ).bind( 'click.mw-collapse', function( e ){
+                                               toggleLinkPremade( this, e );
+                                       } );
+                               }
+                               
+                       } else if ( $that.is( 'ul' ) || $that.is( 'ol' ) ) {
+                               // The toggle-link will be in the first list-item
+                               var     $firstItem = $( 'li:first', $that),
+                                       $toggle = $firstItem.find( '> .mw-collapsible-toggle' );
+       
+                               // If theres no toggle link, add it
+                               if ( !$toggle.size() ) {
+                                       // Make sure the numeral order doesn't get messed up, reset to 1 unless value-attribute is already used
+                                       // WebKit return '' if no value, Mozilla returns '-1' is no value
+                                       if ( $firstItem.attr( 'value' ) == '' || $firstItem.attr( 'value' ) == '-1' ) { // Will fail with ===
+                                               $firstItem.attr( 'value', '1' );
+                                       }
+                                       $that.prepend( $toggleLink.wrap( '<li class="mw-collapsible-toggle-li">' ).parent() );
+                               } else {
+                                       $toggleLink = $toggle.unbind( 'click.mw-collapse' ).bind( 'click.mw-collapse', function( e ){
+                                               toggleLinkPremade( this, e );
+                                       } );
+                               }
+       
+                       } else { // <div>, <p> etc.
+                               // If a direct child .content-wrapper does not exists, create it
+                               if ( !$that.find( '> .mw-collapsible-content' ).size() ) {
+                                       $that.wrapInner( '<div class="mw-collapsible-content">' );
+                               }
+       
+                               // The toggle-link will be the first child of the element
+                               var $toggle = $that.find( '> .mw-collapsible-toggle' );
+       
+                               // If theres no toggle link, add it
+                               if ( !$toggle.size() ) {
+                                       $that.prepend( $toggleLink );
+                               } else {
+                                       $toggleLink = $toggle.unbind( 'click.mw-collapse' ).bind( 'click.mw-collapse', function( e ){
+                                               toggleLinkPremade( this, e );
+                                       } );
+                               }
                        }
                }
-               // Initial state
-               if ($that.hasClass('kr-collapsed')) {
+
+               // Initial state (only for those that are not custom)
+               if ( $that.hasClass( 'mw-collapsed' ) && $that.attr( 'id' ).indexOf( 'mw-customcollapsible-' ) !== 0 ) {
+                       $that.removeClass( 'mw-collapsed' );
                        $toggleLink.click();
                }
-       });
-};
-$(function(){
-       $('.kr-collapsible').makeCollapsible();
-});
\ No newline at end of file
+       } );
+};
\ No newline at end of file