resources/src/jquery/jquery.makeCollapsible.js

   1 /**
   2  * jQuery makeCollapsible
   3  *
   4  * Dual licensed:
   5  * - CC BY 3.0 <http://creativecommons.org/licenses/by/3.0>
   6  * - GPL2 <http://www.gnu.org/licenses/old-licenses/gpl-2.0.html>
   7  *
   8  * @class jQuery.plugin.makeCollapsible
   9  */
  10 ( function ( $, mw ) {
  11
  12         /**
  13          * Handler for a click on a collapsible toggler.
  14          *
  15          * @private
  16          * @param {jQuery} $collapsible
  17          * @param {string} action The action this function will take ('expand' or 'collapse').
  18          * @param {jQuery|null} [$defaultToggle]
  19          * @param {Object|undefined} [options]
  20          */
  21         function toggleElement( $collapsible, action, $defaultToggle, options ) {
  22                 var $collapsibleContent, $containers, hookCallback;
  23                 options = options || {};
  24
  25                 // Validate parameters
  26
  27                 // $collapsible must be an instance of jQuery
  28                 if ( !$collapsible.jquery ) {
  29                         return;
  30                 }
  31                 if ( action !== 'expand' && action !== 'collapse' ) {
  32                         // action must be string with 'expand' or 'collapse'
  33                         return;
  34                 }
  35                 if ( $defaultToggle === undefined ) {
  36                         $defaultToggle = null;
  37                 }
  38                 if ( $defaultToggle !== null && !$defaultToggle.jquery ) {
  39                         // is optional (may be undefined), but if defined it must be an instance of jQuery.
  40                         // If it's not, abort right away.
  41                         // After this $defaultToggle is either null or a valid jQuery instance.
  42                         return;
  43                 }
  44
  45                 // Trigger a custom event to allow callers to hook to the collapsing/expanding,
  46                 // allowing the module to be testable, and making it possible to
  47                 // e.g. implement persistence via cookies
  48                 $collapsible.trigger( action === 'expand' ? 'beforeExpand.mw-collapsible' : 'beforeCollapse.mw-collapsible' );
  49                 hookCallback = function () {
  50                         $collapsible.trigger( action === 'expand' ? 'afterExpand.mw-collapsible' : 'afterCollapse.mw-collapsible' );
  51                 };
  52
  53                 // Handle different kinds of elements
  54
  55                 if ( !options.plainMode && $collapsible.is( 'table' ) ) {
  56                         // Tables
  57                         // If there is a caption, hide all rows; otherwise, only hide body rows
  58                         if ( $collapsible.find( '> caption' ).length ) {
  59                                 $containers = $collapsible.find( '> * > tr' );
  60                         } else {
  61                                 $containers = $collapsible.find( '> tbody > tr' );
  62                         }
  63                         if ( $defaultToggle ) {
  64                                 // Exclude table row containing togglelink
  65                                 $containers = $containers.not( $defaultToggle.closest( 'tr' ) );
  66                         }
  67
  68                         if ( action === 'collapse' ) {
  69                                 // Hide all table rows of this table
  70                                 // Slide doesn't work with tables, but fade does as of jQuery 1.1.3
  71                                 // http://stackoverflow.com/questions/467336#920480
  72                                 if ( options.instantHide ) {
  73                                         $containers.hide();
  74                                         hookCallback();
  75                                 } else {
  76                                         $containers.stop( true, true ).fadeOut().promise().done( hookCallback );
  77                                 }
  78                         } else {
  79                                 $containers.stop( true, true ).fadeIn().promise().done( hookCallback );
  80                         }
  81
  82                 } else if ( !options.plainMode && ( $collapsible.is( 'ul' ) || $collapsible.is( 'ol' ) ) ) {
  83                         // Lists
  84                         $containers = $collapsible.find( '> li' );
  85                         if ( $defaultToggle ) {
  86                                 // Exclude list-item containing togglelink
  87                                 $containers = $containers.not( $defaultToggle.parent() );
  88                         }
  89
  90                         if ( action === 'collapse' ) {
  91                                 if ( options.instantHide ) {
  92                                         $containers.hide();
  93                                         hookCallback();
  94                                 } else {
  95                                         $containers.stop( true, true ).slideUp().promise().done( hookCallback );
  96                                 }
  97                         } else {
  98                                 $containers.stop( true, true ).slideDown().promise().done( hookCallback );
  99                         }
 100
 101                 } else {
 102                         // Everything else: <div>, <p> etc.
 103                         $collapsibleContent = $collapsible.find( '> .mw-collapsible-content' );
 104
 105                         // If a collapsible-content is defined, act on it
 106                         if ( !options.plainMode && $collapsibleContent.length ) {
 107                                 if ( action === 'collapse' ) {
 108                                         if ( options.instantHide ) {
 109                                                 $collapsibleContent.hide();
 110                                                 hookCallback();
 111                                         } else {
 112                                                 $collapsibleContent.slideUp().promise().done( hookCallback );
 113                                         }
 114                                 } else {
 115                                         $collapsibleContent.slideDown().promise().done( hookCallback );
 116                                 }
 117
 118                         // Otherwise assume this is a customcollapse with a remote toggle
 119                         // .. and there is no collapsible-content because the entire element should be toggled
 120                         } else {
 121                                 if ( action === 'collapse' ) {
 122                                         if ( options.instantHide ) {
 123                                                 $collapsible.hide();
 124                                                 hookCallback();
 125                                         } else {
 126                                                 if ( $collapsible.is( 'tr' ) || $collapsible.is( 'td' ) || $collapsible.is( 'th' ) ) {
 127                                                         $collapsible.fadeOut().promise().done( hookCallback );
 128                                                 } else {
 129                                                         $collapsible.slideUp().promise().done( hookCallback );
 130                                                 }
 131                                         }
 132                                 } else {
 133                                         if ( $collapsible.is( 'tr' ) || $collapsible.is( 'td' ) || $collapsible.is( 'th' ) ) {
 134                                                 $collapsible.fadeIn().promise().done( hookCallback );
 135                                         } else {
 136                                                 $collapsible.slideDown().promise().done( hookCallback );
 137                                         }
 138                                 }
 139                         }
 140                 }
 141         }
 142
 143         /**
 144          * Handle clicking/keypressing on the collapsible element toggle and other
 145          * situations where a collapsible element is toggled (e.g. the initial
 146          * toggle for collapsed ones).
 147          *
 148          * @private
 149          * @param {jQuery} $toggle the clickable toggle itself
 150          * @param {jQuery} $collapsible the collapsible element
 151          * @param {jQuery.Event|null} e either the event or null if unavailable
 152          * @param {Object|undefined} options
 153          */
 154         function togglingHandler( $toggle, $collapsible, e, options ) {
 155                 var wasCollapsed, $textContainer, collapseText, expandText;
 156                 options = options || {};
 157
 158                 if ( e ) {
 159                         if (
 160                                 e.type === 'click' &&
 161                                 options.linksPassthru &&
 162                                 $.nodeName( e.target, 'a' ) &&
 163                                 $( e.target ).attr( 'href' ) &&
 164                                 $( e.target ).attr( 'href' ) !== '#'
 165                         ) {
 166                                 // Don't fire if a link with href !== '#' was clicked, if requested  (for premade togglers by default)
 167                                 return;
 168                         } else if ( e.type === 'keypress' && e.which !== 13 && e.which !== 32 ) {
 169                                 // Only handle keypresses on the "Enter" or "Space" keys
 170                                 return;
 171                         } else {
 172                                 e.preventDefault();
 173                                 e.stopPropagation();
 174                         }
 175                 }
 176
 177                 // This allows the element to be hidden on initial toggle without fiddling with the class
 178                 if ( options.wasCollapsed !== undefined ) {
 179                         wasCollapsed = options.wasCollapsed;
 180                 } else {
 181                         wasCollapsed = $collapsible.hasClass( 'mw-collapsed' );
 182                 }
 183
 184                 // Toggle the state of the collapsible element (that is, expand or collapse)
 185                 $collapsible.toggleClass( 'mw-collapsed', !wasCollapsed );
 186
 187                 // Toggle the mw-collapsible-toggle classes, if requested (for default and premade togglers by default)
 188                 if ( options.toggleClasses ) {
 189                         $toggle
 190                                 .toggleClass( 'mw-collapsible-toggle-collapsed', !wasCollapsed )
 191                                 .toggleClass( 'mw-collapsible-toggle-expanded', wasCollapsed );
 192                 }
 193
 194                 // Toggle the text ("Show"/"Hide"), if requested (for default togglers by default)
 195                 if ( options.toggleText ) {
 196                         collapseText = options.toggleText.collapseText;
 197                         expandText = options.toggleText.expandText;
 198
 199                         $textContainer = $toggle.find( '> a' );
 200                         if ( !$textContainer.length ) {
 201                                 $textContainer = $toggle;
 202                         }
 203                         $textContainer.text( wasCollapsed ? collapseText : expandText );
 204                 }
 205
 206                 // And finally toggle the element state itself
 207                 toggleElement( $collapsible, wasCollapsed ? 'expand' : 'collapse', $toggle, options );
 208         }
 209
 210         /**
 211          * Enable collapsible-functionality on all elements in the collection.
 212          *
 213          * - Will prevent binding twice to the same element.
 214          * - Initial state is expanded by default, this can be overridden by adding class
 215          *   "mw-collapsed" to the "mw-collapsible" element.
 216          * - Elements made collapsible have jQuery data "mw-made-collapsible" set to true.
 217          * - The inner content is wrapped in a "div.mw-collapsible-content" (except for tables and lists).
 218          *
 219          * @param {Object} [options]
 220          * @param {string} [options.collapseText] Text used for the toggler, when clicking it would
 221          *   collapse the element. Default: the 'data-collapsetext' attribute of the
 222          *   collapsible element or the content of 'collapsible-collapse' message.
 223          * @param {string} [options.expandText] Text used for the toggler, when clicking it would
 224          *   expand the element. Default: the 'data-expandtext' attribute of the
 225          *   collapsible element or the content of 'collapsible-expand' message.
 226          * @param {boolean} [options.collapsed] Whether to collapse immediately. By default
 227          *   collapse only if the elements has the 'mw-collapsible' class.
 228          * @param {jQuery} [options.$customTogglers] Elements to be used as togglers
 229          *   for this collapsible element. By default, if the collapsible element
 230          *   has an id attribute like 'mw-customcollapsible-XXX', elements with a
 231          *   *class* of 'mw-customtoggle-XXX' are made togglers for it.
 232          * @param {boolean} [options.plainMode=false] Whether to use a "plain mode" when making the
 233          *   element collapsible - that is, hide entire tables and lists (instead
 234          *   of hiding only all rows but first of tables, and hiding each list
 235          *   item separately for lists) and don't wrap other elements in
 236          *   div.mw-collapsible-content. May only be used with custom togglers.
 237          * @return {jQuery}
 238          * @chainable
 239          */
 240         $.fn.makeCollapsible = function ( options ) {
 241                 options = options || {};
 242
 243                 this.each( function () {
 244                         var $collapsible, collapseText, expandText, $caption, $toggle, actionHandler, buildDefaultToggleLink,
 245                                 premadeToggleHandler, $toggleLink, $firstItem, collapsibleId, $customTogglers, firstval;
 246
 247                         // Ensure class "mw-collapsible" is present in case .makeCollapsible()
 248                         // is called on element(s) that don't have it yet.
 249                         $collapsible = $( this ).addClass( 'mw-collapsible' );
 250
 251                         // Return if it has been enabled already.
 252                         if ( $collapsible.data( 'mw-made-collapsible' ) ) {
 253                                 return;
 254                         } else {
 255                                 $collapsible.data( 'mw-made-collapsible', true );
 256                         }
 257
 258                         // Use custom text or default?
 259                         collapseText = options.collapseText || $collapsible.attr( 'data-collapsetext' ) || mw.msg( 'collapsible-collapse' );
 260                         expandText = options.expandText || $collapsible.attr( 'data-expandtext' ) || mw.msg( 'collapsible-expand' );
 261
 262                         // Default click/keypress handler and toggle link to use when none is present
 263                         actionHandler = function ( e, opts ) {
 264                                 var defaultOpts = {
 265                                         toggleClasses: true,
 266                                         toggleText: { collapseText: collapseText, expandText: expandText }
 267                                 };
 268                                 opts = $.extend( defaultOpts, options, opts );
 269                                 togglingHandler( $( this ), $collapsible, e, opts );
 270                         };
 271                         // Default toggle link. Only build it when needed to avoid jQuery memory leaks (event data).
 272                         buildDefaultToggleLink = function () {
 273                                 return $( '<a href="#"></a>' )
 274                                         .text( collapseText )
 275                                         .wrap( '<span class="mw-collapsible-toggle"></span>' )
 276                                                 .parent()
 277                                                 .prepend( '<span class="mw-collapsible-bracket">[</span>' )
 278                                                 .append( '<span class="mw-collapsible-bracket">]</span>' )
 279                                                 .on( 'click.mw-collapsible keypress.mw-collapsible', actionHandler );
 280                         };
 281
 282                         // Default handler for clicking on premade toggles
 283                         premadeToggleHandler = function ( e, opts ) {
 284                                 var defaultOpts = { toggleClasses: true, linksPassthru: true };
 285                                 opts = $.extend( defaultOpts, options, opts );
 286                                 togglingHandler( $( this ), $collapsible, e, opts );
 287                         };
 288
 289                         // Check if this element has a custom position for the toggle link
 290                         // (ie. outside the container or deeper inside the tree)
 291                         if ( options.$customTogglers ) {
 292                                 $customTogglers = $( options.$customTogglers );
 293                         } else {
 294                                 collapsibleId = $collapsible.attr( 'id' ) || '';
 295                                 if ( collapsibleId.indexOf( 'mw-customcollapsible-' ) === 0 ) {
 296                                         $customTogglers = $( '.' + collapsibleId.replace( 'mw-customcollapsible', 'mw-customtoggle' ) )
 297                                                 .addClass( 'mw-customtoggle' );
 298                                 }
 299                         }
 300
 301                         // Add event handlers to custom togglers or create our own ones
 302                         if ( $customTogglers && $customTogglers.length ) {
 303                                 actionHandler = function ( e, opts ) {
 304                                         var defaultOpts = {};
 305                                         opts = $.extend( defaultOpts, options, opts );
 306                                         togglingHandler( $( this ), $collapsible, e, opts );
 307                                 };
 308
 309                                 $toggleLink = $customTogglers
 310                                         .on( 'click.mw-collapsible keypress.mw-collapsible', actionHandler )
 311                                         .prop( 'tabIndex', 0 );
 312
 313                         } else {
 314                                 // If this is not a custom case, do the default: wrap the
 315                                 // contents and add the toggle link. Different elements are
 316                                 // treated differently.
 317
 318                                 if ( $collapsible.is( 'table' ) ) {
 319
 320                                         // If the table has a caption, collapse to the caption
 321                                         // as opposed to the first row
 322                                         $caption = $collapsible.find( '> caption' );
 323                                         if ( $caption.length ) {
 324                                                 $toggle = $caption.find( '> .mw-collapsible-toggle' );
 325
 326                                                 // If there is no toggle link, add it to the end of the caption
 327                                                 if ( !$toggle.length ) {
 328                                                         $toggleLink = buildDefaultToggleLink().appendTo( $caption );
 329                                                 } else {
 330                                                         actionHandler = premadeToggleHandler;
 331                                                         $toggleLink = $toggle.on( 'click.mw-collapsible keypress.mw-collapsible', actionHandler )
 332                                                                 .prop( 'tabIndex', 0 );
 333                                                 }
 334                                         } else {
 335                                                 // The toggle-link will be in one of the cells (td or th) of the first row
 336                                                 $firstItem = $collapsible.find( 'tr:first th, tr:first td' );
 337                                                 $toggle = $firstItem.find( '> .mw-collapsible-toggle' );
 338
 339                                                 // If theres no toggle link, add it to the last cell
 340                                                 if ( !$toggle.length ) {
 341                                                         $toggleLink = buildDefaultToggleLink().prependTo( $firstItem.eq( -1 ) );
 342                                                 } else {
 343                                                         actionHandler = premadeToggleHandler;
 344                                                         $toggleLink = $toggle.on( 'click.mw-collapsible keypress.mw-collapsible', actionHandler )
 345                                                                 .prop( 'tabIndex', 0 );
 346                                                 }
 347                                         }
 348
 349                                 } else if ( $collapsible.parent().is( 'li' ) &&
 350                                         $collapsible.parent().children( '.mw-collapsible' ).size() === 1
 351                                 ) {
 352                                         // special case of one collapsible in <li> tag
 353                                         $toggleLink = buildDefaultToggleLink();
 354                                         $collapsible.before( $toggleLink );
 355                                 } else if ( $collapsible.is( 'ul' ) || $collapsible.is( 'ol' ) ) {
 356                                         // The toggle-link will be in the first list-item
 357                                         $firstItem = $collapsible.find( 'li:first' );
 358                                         $toggle = $firstItem.find( '> .mw-collapsible-toggle' );
 359
 360                                         // If theres no toggle link, add it
 361                                         if ( !$toggle.length ) {
 362                                                 // Make sure the numeral order doesn't get messed up, force the first (soon to be second) item
 363                                                 // to be "1". Except if the value-attribute is already used.
 364                                                 // If no value was set WebKit returns "", Mozilla returns '-1', others return 0, null or undefined.
 365                                                 firstval = $firstItem.prop( 'value' );
 366                                                 if ( firstval === undefined || !firstval || firstval === '-1' || firstval === -1 ) {
 367                                                         $firstItem.prop( 'value', '1' );
 368                                                 }
 369                                                 $toggleLink = buildDefaultToggleLink();
 370                                                 $toggleLink.wrap( '<li class="mw-collapsible-toggle-li"></li>' ).parent().prependTo( $collapsible );
 371                                         } else {
 372                                                 actionHandler = premadeToggleHandler;
 373                                                 $toggleLink = $toggle.on( 'click.mw-collapsible keypress.mw-collapsible', actionHandler )
 374                                                         .prop( 'tabIndex', 0 );
 375                                         }
 376
 377                                 } else { // <div>, <p> etc.
 378
 379                                         // The toggle-link will be the first child of the element
 380                                         $toggle = $collapsible.find( '> .mw-collapsible-toggle' );
 381
 382                                         // If a direct child .content-wrapper does not exists, create it
 383                                         if ( !$collapsible.find( '> .mw-collapsible-content' ).length ) {
 384                                                 $collapsible.wrapInner( '<div class="mw-collapsible-content"></div>' );
 385                                         }
 386
 387                                         // If theres no toggle link, add it
 388                                         if ( !$toggle.length ) {
 389                                                 $toggleLink = buildDefaultToggleLink().prependTo( $collapsible );
 390                                         } else {
 391                                                 actionHandler = premadeToggleHandler;
 392                                                 $toggleLink = $toggle.on( 'click.mw-collapsible keypress.mw-collapsible', actionHandler )
 393                                                         .prop( 'tabIndex', 0 );
 394                                         }
 395                                 }
 396                         }
 397
 398                         $( this ).data( 'mw-collapsible', {
 399                                 collapse: function () {
 400                                         actionHandler.call( $toggleLink.get( 0 ), null, { instantHide: true, wasCollapsed: false } );
 401                                 },
 402                                 expand: function () {
 403                                         actionHandler.call( $toggleLink.get( 0 ), null, { instantHide: true, wasCollapsed: true } );
 404                                 },
 405                                 toggle: function () {
 406                                         actionHandler.call( $toggleLink.get( 0 ), null, null );
 407                                 }
 408                         } );
 409
 410                         // Initial state
 411                         if ( options.collapsed || $collapsible.hasClass( 'mw-collapsed' ) ) {
 412                                 // One toggler can hook to multiple elements, and one element can have
 413                                 // multiple togglers. This is the sanest way to handle that.
 414                                 actionHandler.call( $toggleLink.get( 0 ), null, { instantHide: true, wasCollapsed: false } );
 415                         }
 416
 417                 } );
 418
 419                 /**
 420                  * Fired after collapsible content has been initialized
 421                  *
 422                  * This gives an option to modify the collapsible behavior.
 423                  *
 424                  * @event wikipage_collapsibleContent
 425                  * @member mw.hook
 426                  * @param {jQuery} $content All the elements that have been made collapsible
 427                  */
 428                 mw.hook( 'wikipage.collapsibleContent' ).fire( this );
 429
 430                 return this;
 431         };
 432
 433         /**
 434          * @class jQuery
 435          * @mixins jQuery.plugin.makeCollapsible
 436          */
 437
 438 }( jQuery, mediaWiki ) );