2 * TableSorter for MediaWiki
4 * Written 2011 Leo Koppelkamm
5 * Based on tablesorter.com plugin, written (c) 2007 Christian Bach.
7 * Dual licensed under the MIT and GPL licenses:
8 * http://www.opensource.org/licenses/mit-license.php
9 * http://www.gnu.org/licenses/gpl.html
11 * Depends on mw.config (wgDigitTransformTable, wgDefaultDateFormat, wgPageContentLanguage)
12 * and mw.language.months.
14 * Uses 'tableSorterCollation' in mw.config (if available)
16 * Create a sortable table with multi-column sorting capabilities
18 * // Create a simple tablesorter interface
19 * $( 'table' ).tablesorter();
21 * // Create a tablesorter interface, initially sorting on the first and second column
22 * $( 'table' ).tablesorter( { sortList: [ { 0: 'desc' }, { 1: 'asc' } ] } );
24 * @param {string} [cssHeader="header"] A string of the class name to be appended to sortable
25 * tr elements in the thead of the table.
27 * @param {string} [cssAsc="headerSortUp"] A string of the class name to be appended to
28 * sortable tr elements in the thead on a ascending sort.
30 * @param {string} [cssDesc="headerSortDown"] A string of the class name to be appended to
31 * sortable tr elements in the thead on a descending sort.
33 * @param {string} [sortMultisortKey="shiftKey"] A string of the multi-column sort key.
35 * @param {boolean} [cancelSelection=true] Boolean flag indicating iftablesorter should cancel
36 * selection of the table headers text.
38 * @param {Array} [sortList] An array containing objects specifying sorting. By passing more
39 * than one object, multi-sorting will be applied. Object structure:
40 * { <Integer column index>: <String 'asc' or 'desc'> }
42 * @event sortEnd.tablesorter: Triggered as soon as any sorting has been applied.
44 * @author Christian Bach/christian.bach@polyester.se
50 /* Parser utility functions */
52 function getParserById( name
) {
54 for ( i
= 0; i
< parsers
.length
; i
++ ) {
55 if ( parsers
[ i
].id
.toLowerCase() === name
.toLowerCase() ) {
62 function getElementSortKey( node
) {
63 var $node
= $( node
),
64 // Use data-sort-value attribute.
65 // Use data() instead of attr() so that live value changes
66 // are processed as well (T40152).
67 data
= $node
.data( 'sortValue' );
69 if ( data
!== null && data
!== undefined ) {
70 // Cast any numbers or other stuff to a string, methods
71 // like charAt, toLowerCase and split are expected.
72 return String( data
);
77 if ( node
.tagName
.toLowerCase() === 'img' ) {
78 return $node
.attr( 'alt' ) || ''; // handle undefined alt
80 return $.makeArray( node
.childNodes
).map( function ( elem
) {
81 if ( elem
.nodeType
=== Node
.ELEMENT_NODE
) {
82 if ( $( elem
).hasClass( 'reference' ) ) {
85 return getElementSortKey( elem
);
88 return $.text( elem
);
92 function detectParserForColumn( table
, rows
, column
) {
93 var l
= parsers
.length
,
94 config
= $( table
).data( 'tablesorter' ).config
,
98 // Start with 1 because 0 is the fallback parser
104 needed
= ( rows
.length
> 4 ) ? 5 : rows
.length
;
107 // if this is a child row, continue to the next row (as buildCache())
108 if ( rows
[ rowIndex
] && !$( rows
[ rowIndex
] ).hasClass( config
.cssChildRow
) ) {
109 if ( rowIndex
!== lastRowIndex
) {
110 lastRowIndex
= rowIndex
;
111 cellIndex
= $( rows
[ rowIndex
] ).data( 'columnToCell' )[ column
];
112 nodeValue
= getElementSortKey( rows
[ rowIndex
].cells
[ cellIndex
] ).trim();
118 if ( nodeValue
!== '' ) {
119 if ( parsers
[ i
].is( nodeValue
, table
) ) {
122 if ( concurrent
>= needed
) {
123 // Confirmed the parser for multiple cells, let's return it
126 } else if ( parsers
[ i
].id
.match( /isoDate/ ) && /^\D*(\d{1,4}) ?(\[.+\])?$/.test( nodeValue
) ) {
127 // For 1-4 digits and maybe reference(s) parser "isoDate" or "number" is possible, check next row
131 // Check next parser, reset rows
147 if ( rowIndex
>= rows
.length
) {
148 if ( concurrent
> 0 && concurrent
>= rows
.length
- empty
) {
149 // Confirmed the parser for all filled cells
152 // Check next parser, reset rows
161 // 0 is always the generic parser (text)
165 function buildParserCache( table
, $headers
) {
166 var sortType
, len
, j
, parser
,
167 rows
= table
.tBodies
[ 0 ].rows
,
168 config
= $( table
).data( 'tablesorter' ).config
,
172 len
= config
.columns
;
173 for ( j
= 0; j
< len
; j
++ ) {
175 sortType
= $headers
.eq( config
.columnToHeader
[ j
] ).data( 'sortType' );
176 if ( sortType
!== undefined ) {
177 parser
= getParserById( sortType
);
180 if ( parser
=== false ) {
181 parser
= detectParserForColumn( table
, rows
, j
);
184 parsers
.push( parser
);
190 /* Other utility functions */
192 function buildCache( table
) {
193 var i
, j
, $row
, cols
,
194 totalRows
= ( table
.tBodies
[ 0 ] && table
.tBodies
[ 0 ].rows
.length
) || 0,
195 config
= $( table
).data( 'tablesorter' ).config
,
196 parsers
= config
.parsers
,
197 len
= parsers
.length
,
204 for ( i
= 0; i
< totalRows
; i
++ ) {
206 // Add the table data to main data array
207 $row
= $( table
.tBodies
[ 0 ].rows
[ i
] );
210 // if this is a child row, add it to the last row's children and
211 // continue to the next row
212 if ( $row
.hasClass( config
.cssChildRow
) ) {
213 cache
.row
[ cache
.row
.length
- 1 ] = cache
.row
[ cache
.row
.length
- 1 ].add( $row
);
214 // go to the next for loop
218 cache
.row
.push( $row
);
220 for ( j
= 0; j
< len
; j
++ ) {
221 cellIndex
= $row
.data( 'columnToCell' )[ j
];
222 cols
.push( parsers
[ j
].format( getElementSortKey( $row
[ 0 ].cells
[ cellIndex
] ) ) );
225 cols
.push( cache
.normalized
.length
); // add position for rowCache
226 cache
.normalized
.push( cols
);
233 function appendToTable( table
, cache
) {
236 normalized
= cache
.normalized
,
237 totalRows
= normalized
.length
,
238 checkCell
= ( normalized
[ 0 ].length
- 1 ),
239 fragment
= document
.createDocumentFragment();
241 for ( i
= 0; i
< totalRows
; i
++ ) {
242 pos
= normalized
[ i
][ checkCell
];
244 l
= row
[ pos
].length
;
245 for ( j
= 0; j
< l
; j
++ ) {
246 fragment
.appendChild( row
[ pos
][ j
] );
250 table
.tBodies
[ 0 ].appendChild( fragment
);
252 $( table
).trigger( 'sortEnd.tablesorter' );
256 * Find all header rows in a thead-less table and put them in a <thead> tag.
257 * This only treats a row as a header row if it contains only <th>s (no <td>s)
258 * and if it is preceded entirely by header rows. The algorithm stops when
259 * it encounters the first non-header row.
261 * After this, it will look at all rows at the bottom for footer rows
262 * And place these in a tfoot using similar rules.
264 * @param {jQuery} $table object for a <table>
266 function emulateTHeadAndFoot( $table
) {
267 var $thead
, $tfoot
, i
, len
,
268 $rows
= $table
.find( '> tbody > tr' );
269 if ( !$table
.get( 0 ).tHead
) {
270 $thead
= $( '<thead>' );
271 $rows
.each( function () {
272 if ( $( this ).children( 'td' ).length
) {
273 // This row contains a <td>, so it's not a header row
277 $thead
.append( this );
279 $table
.find( ' > tbody:first' ).before( $thead
);
281 if ( !$table
.get( 0 ).tFoot
) {
282 $tfoot
= $( '<tfoot>' );
284 for ( i
= len
- 1; i
>= 0; i
-- ) {
285 if ( $( $rows
[ i
] ).children( 'td' ).length
) {
288 $tfoot
.prepend( $( $rows
[ i
] ) );
290 $table
.append( $tfoot
);
294 function uniqueElements( array
) {
296 array
.forEach( function ( elem
) {
297 if ( elem
!== undefined && uniques
.indexOf( elem
) === -1 ) {
298 uniques
.push( elem
);
304 function buildHeaders( table
, msg
) {
305 var config
= $( table
).data( 'tablesorter' ).config
,
317 $tableHeaders
= $( [] ),
318 $tableRows
= $( 'thead:eq(0) > tr', table
);
320 if ( $tableRows
.length
<= 1 ) {
321 $tableHeaders
= $tableRows
.children( 'th' );
325 // Loop through all the dom cells of the thead
326 $tableRows
.each( function ( rowIndex
, row
) {
327 // eslint-disable-next-line no-restricted-properties
328 $.each( row
.cells
, function ( columnIndex
, cell
) {
332 rowspan
= Number( cell
.rowSpan
);
333 colspan
= Number( cell
.colSpan
);
335 // Skip the spots in the exploded matrix that are already filled
336 while ( exploded
[ rowIndex
] && exploded
[ rowIndex
][ columnIndex
] !== undefined ) {
340 // Find the actual dimensions of the thead, by placing each cell
341 // in the exploded matrix rowspan times colspan times, with the proper offsets
342 for ( matrixColumnIndex
= columnIndex
; matrixColumnIndex
< columnIndex
+ colspan
; ++matrixColumnIndex
) {
343 for ( matrixRowIndex
= rowIndex
; matrixRowIndex
< rowIndex
+ rowspan
; ++matrixRowIndex
) {
344 if ( !exploded
[ matrixRowIndex
] ) {
345 exploded
[ matrixRowIndex
] = [];
347 exploded
[ matrixRowIndex
][ matrixColumnIndex
] = cell
;
352 // We want to find the row that has the most columns (ignoring colspan)
353 exploded
.forEach( function ( cellArray
, index
) {
354 headerCount
= $( uniqueElements( cellArray
) ).filter( 'th' ).length
;
355 if ( headerCount
>= maxSeen
) {
356 maxSeen
= headerCount
;
360 // We cannot use $.unique() here because it sorts into dom order, which is undesirable
361 $tableHeaders
= $( uniqueElements( exploded
[ longestTR
] ) ).filter( 'th' );
364 // as each header can span over multiple columns (using colspan=N),
365 // we have to bidirectionally map headers to their columns and columns to their headers
366 config
.columnToHeader
= [];
367 config
.headerToColumns
= [];
368 config
.headerList
= [];
370 $tableHeaders
.each( function () {
374 if ( !$cell
.hasClass( config
.unsortableClass
) ) {
376 .addClass( config
.cssHeader
)
377 .prop( 'tabIndex', 0 )
379 role
: 'columnheader button',
383 for ( k
= 0; k
< this.colSpan
; k
++ ) {
384 config
.columnToHeader
[ colspanOffset
+ k
] = headerIndex
;
385 columns
.push( colspanOffset
+ k
);
388 config
.headerToColumns
[ headerIndex
] = columns
;
391 headerIndex
: headerIndex
,
396 // add only sortable cells to headerList
397 config
.headerList
[ headerIndex
] = this;
401 colspanOffset
+= this.colSpan
;
404 // number of columns with extended colspan, inclusive unsortable
405 // parsers[j], cache[][j], columnToHeader[j], columnToCell[j] have so many elements
406 config
.columns
= colspanOffset
;
408 return $tableHeaders
.not( '.' + config
.unsortableClass
);
411 function isValueInArray( v
, a
) {
413 for ( i
= 0; i
< a
.length
; i
++ ) {
414 if ( a
[ i
][ 0 ] === v
) {
422 * Sets the sort count of the columns that are not affected by the sorting to have them sorted
423 * in default (ascending) order when their header cell is clicked the next time.
425 * @param {jQuery} $headers
426 * @param {Array} sortList 2D number array
427 * @param {Array} headerToColumns 2D number array
429 function setHeadersOrder( $headers
, sortList
, headerToColumns
) {
430 // Loop through all headers to retrieve the indices of the columns the header spans across:
431 headerToColumns
.forEach( function ( columns
, headerIndex
) {
433 columns
.forEach( function ( columnIndex
, i
) {
434 var header
= $headers
[ headerIndex
],
435 $header
= $( header
);
437 if ( !isValueInArray( columnIndex
, sortList
) ) {
438 // Column shall not be sorted: Reset header count and order.
444 // Column shall be sorted: Apply designated count and order.
445 sortList
.forEach( function ( sortColumn
) {
446 if ( sortColumn
[ 0 ] === i
) {
448 order
: sortColumn
[ 1 ],
449 count
: sortColumn
[ 1 ] + 1
460 function setHeadersCss( table
, $headers
, list
, css
, msg
, columnToHeader
) {
462 // Remove all header information and reset titles to default message
463 $headers
.removeClass( css
[ 0 ] ).removeClass( css
[ 1 ] ).attr( 'title', msg
[ 1 ] );
465 for ( i
= 0, len
= list
.length
; i
< len
; i
++ ) {
467 .eq( columnToHeader
[ list
[ i
][ 0 ] ] )
468 .addClass( css
[ list
[ i
][ 1 ] ] )
469 .attr( 'title', msg
[ list
[ i
][ 1 ] ] );
473 function sortText( a
, b
) {
474 return ( ( a
< b
) ? -1 : ( ( a
> b
) ? 1 : 0 ) );
477 function sortTextDesc( a
, b
) {
478 return ( ( b
< a
) ? -1 : ( ( b
> a
) ? 1 : 0 ) );
481 function multisort( table
, sortList
, cache
) {
485 for ( i
= 0; i
< sortList
.length
; i
++ ) {
486 sortFn
[ i
] = ( sortList
[ i
][ 1 ] ) ? sortTextDesc
: sortText
;
488 cache
.normalized
.sort( function ( array1
, array2
) {
490 for ( i
= 0; i
< sortList
.length
; i
++ ) {
491 col
= sortList
[ i
][ 0 ];
492 ret
= sortFn
[ i
].call( this, array1
[ col
], array2
[ col
] );
497 // Fall back to index number column to ensure stable sort
498 return sortText
.call( this, array1
[ array1
.length
- 1 ], array2
[ array2
.length
- 1 ] );
503 function buildTransformTable() {
504 var ascii
, localised
, i
, digitClass
,
505 digits
= '0123456789,.'.split( '' ),
506 separatorTransformTable
= mw
.config
.get( 'wgSeparatorTransformTable' ),
507 digitTransformTable
= mw
.config
.get( 'wgDigitTransformTable' );
509 if ( separatorTransformTable
=== null || ( separatorTransformTable
[ 0 ] === '' && digitTransformTable
[ 2 ] === '' ) ) {
510 ts
.transformTable
= false;
512 ts
.transformTable
= {};
514 // Unpack the transform table
515 ascii
= separatorTransformTable
[ 0 ].split( '\t' ).concat( digitTransformTable
[ 0 ].split( '\t' ) );
516 localised
= separatorTransformTable
[ 1 ].split( '\t' ).concat( digitTransformTable
[ 1 ].split( '\t' ) );
518 // Construct regexes for number identification
519 for ( i
= 0; i
< ascii
.length
; i
++ ) {
520 ts
.transformTable
[ localised
[ i
] ] = ascii
[ i
];
521 digits
.push( mw
.RegExp
.escape( localised
[ i
] ) );
524 digitClass
= '[' + digits
.join( '', digits
) + ']';
526 // We allow a trailing percent sign, which we just strip. This works fine
527 // if percents and regular numbers aren't being mixed.
528 ts
.numberRegex
= new RegExp(
530 '[-+\u2212]?[0-9][0-9,]*(\\.[0-9,]*)?(E[-+\u2212]?[0-9][0-9,]*)?' + // Fortran-style scientific
532 '[-+\u2212]?' + digitClass
+ '+[\\s\\xa0]*%?' + // Generic localised
538 function buildDateTable() {
544 for ( i
= 0; i
< 12; i
++ ) {
545 name
= mw
.language
.months
.names
[ i
].toLowerCase();
546 ts
.monthNames
[ name
] = i
+ 1;
547 regex
.push( mw
.RegExp
.escape( name
) );
548 name
= mw
.language
.months
.genitive
[ i
].toLowerCase();
549 ts
.monthNames
[ name
] = i
+ 1;
550 regex
.push( mw
.RegExp
.escape( name
) );
551 name
= mw
.language
.months
.abbrev
[ i
].toLowerCase().replace( '.', '' );
552 ts
.monthNames
[ name
] = i
+ 1;
553 regex
.push( mw
.RegExp
.escape( name
) );
556 // Build piped string
557 regex
= regex
.join( '|' );
560 // Any date formated with . , ' - or /
561 ts
.dateRegex
[ 0 ] = new RegExp( /^\s*(\d{1,2})[,.\-/'\s]{1,2}(\d{1,2})[,.\-/'\s
]{1,2}(\d
{2,4})\s
*?/i
);
563 // Written Month name, dmy
564 ts
.dateRegex
[ 1 ] = new RegExp(
565 '^\\s*(\\d{1,2})[\\,\\.\\-\\/\'\\s]+(' +
568 '[\\,\\.\\-\\/\'\\s]+(\\d{2,4})\\s*$',
572 // Written Month name, mdy
573 ts
.dateRegex
[ 2 ] = new RegExp(
574 '^\\s*(' + regex
+ ')' +
575 '[\\,\\.\\-\\/\'\\s]+(\\d{1,2})[\\,\\.\\-\\/\'\\s]+(\\d{2,4})\\s*$',
582 * Replace all rowspanned cells in the body with clones in each row, so sorting
583 * need not worry about them.
585 * @param {jQuery} $table jQuery object for a <table>
587 function explodeRowspans( $table
) {
588 var spanningRealCellIndex
, rowSpan
, colSpan
,
589 cell
, cellData
, i
, $tds
, $clone
, $nextRows
,
590 rowspanCells
= $table
.find( '> tbody > tr > [rowspan]' ).get();
593 if ( !rowspanCells
.length
) {
597 // First, we need to make a property like cellIndex but taking into
598 // account colspans. We also cache the rowIndex to avoid having to take
599 // cell.parentNode.rowIndex in the sorting function below.
600 $table
.find( '> tbody > tr' ).each( function () {
603 len
= this.cells
.length
;
604 for ( i
= 0; i
< len
; i
++ ) {
605 $( this.cells
[ i
] ).data( 'tablesorter', {
607 realRowIndex
: this.rowIndex
609 col
+= this.cells
[ i
].colSpan
;
613 // Split multi row cells into multiple cells with the same content.
614 // Sort by column then row index to avoid problems with odd table structures.
615 // Re-sort whenever a rowspanned cell's realCellIndex is changed, because it
616 // might change the sort order.
617 function resortCells() {
621 rowspanCells
= rowspanCells
.sort( function ( a
, b
) {
622 cellAData
= $.data( a
, 'tablesorter' );
623 cellBData
= $.data( b
, 'tablesorter' );
624 ret
= cellAData
.realCellIndex
- cellBData
.realCellIndex
;
626 ret
= cellAData
.realRowIndex
- cellBData
.realRowIndex
;
630 rowspanCells
.forEach( function ( cell
) {
631 $.data( cell
, 'tablesorter' ).needResort
= false;
636 function filterfunc() {
637 return $.data( this, 'tablesorter' ).realCellIndex
>= spanningRealCellIndex
;
640 function fixTdCellIndex() {
641 $.data( this, 'tablesorter' ).realCellIndex
+= colSpan
;
642 if ( this.rowSpan
> 1 ) {
643 $.data( this, 'tablesorter' ).needResort
= true;
647 while ( rowspanCells
.length
) {
648 if ( $.data( rowspanCells
[ 0 ], 'tablesorter' ).needResort
) {
652 cell
= rowspanCells
.shift();
653 cellData
= $.data( cell
, 'tablesorter' );
654 rowSpan
= cell
.rowSpan
;
655 colSpan
= cell
.colSpan
;
656 spanningRealCellIndex
= cellData
.realCellIndex
;
658 $nextRows
= $( cell
).parent().nextAll();
659 for ( i
= 0; i
< rowSpan
- 1; i
++ ) {
660 $tds
= $( $nextRows
[ i
].cells
).filter( filterfunc
);
661 $clone
= $( cell
).clone();
662 $clone
.data( 'tablesorter', {
663 realCellIndex
: spanningRealCellIndex
,
664 realRowIndex
: cellData
.realRowIndex
+ i
,
668 $tds
.each( fixTdCellIndex
);
669 $tds
.first().before( $clone
);
671 $nextRows
.eq( i
).append( $clone
);
678 * Build index to handle colspanned cells in the body.
679 * Set the cell index for each column in an array,
680 * so that colspaned cells set multiple in this array.
681 * columnToCell[collumnIndex] point at the real cell in this row.
683 * @param {jQuery} $table object for a <table>
685 function manageColspans( $table
) {
687 $rows
= $table
.find( '> tbody > tr' ),
688 totalRows
= $rows
.length
|| 0,
689 config
= $table
.data( 'tablesorter' ).config
,
690 columns
= config
.columns
,
691 columnToCell
, cellsInRow
, index
;
693 for ( i
= 0; i
< totalRows
; i
++ ) {
695 $row
= $rows
.eq( i
);
696 // if this is a child row, continue to the next row (as buildCache())
697 if ( $row
.hasClass( config
.cssChildRow
) ) {
698 // go to the next for loop
703 cellsInRow
= ( $row
[ 0 ].cells
.length
) || 0; // all cells in this row
704 index
= 0; // real cell index in this row
705 for ( j
= 0; j
< columns
; index
++ ) {
706 if ( index
=== cellsInRow
) {
707 // Row with cells less than columns: add empty cell
708 $row
.append( '<td>' );
711 for ( k
= 0; k
< $row
[ 0 ].cells
[ index
].colSpan
; k
++ ) {
712 columnToCell
[ j
++ ] = index
;
716 $row
.data( 'columnToCell', columnToCell
);
720 function buildCollationTable() {
722 ts
.collationTable
= mw
.config
.get( 'tableSorterCollation' );
723 ts
.collationRegex
= null;
724 if ( ts
.collationTable
) {
725 // Build array of key names
726 for ( key
in ts
.collationTable
) {
727 keys
.push( mw
.RegExp
.escape( key
) );
730 ts
.collationRegex
= new RegExp( keys
.join( '|' ), 'ig' );
735 function cacheRegexs() {
741 new RegExp( /^\d{1,3}[.]\d{1,3}[.]\d{1,3}[.]\d{1,3}$/ )
744 new RegExp( /(^[£$€¥]|[£$€¥]$)/ ),
745 new RegExp( /[£$€¥]/g )
748 new RegExp( /^(https?|ftp|file):\/\/$/ ),
749 new RegExp( /(https?|ftp|file):\/\// )
752 new RegExp( /^[^-\d]*(-?\d{1,4})-(0\d|1[0-2])(-([0-3]\d))?([T\s]([01]\d|2[0-4]):?(([0-5]\d):?(([0-5]\d|60)([.,]\d{1,3})?)?)?([zZ]|([-+])([01]\d|2[0-3]):?([0-5]\d)?)?)?/ ),
753 new RegExp( /^[^-\d]*(-?\d{1,4})-?(\d\d)?(-?(\d\d))?([T\s](\d\d):?((\d\d)?:?((\d\d)?([.,]\d{1,3})?)?)?([zZ]|([-+])(\d\d):?(\d\d)?)?)?/ )
756 new RegExp( /^[A-Za-z]{3,10}\.? [0-9]{1,2}, ([0-9]{4}|'?[0-9]{2}) (([0-2]?[0-9]:[0-5][0-9])|([0-1]?[0-9]:[0-5][0-9]\s(AM|PM)))$/ )
759 new RegExp( /^(([0-2]?[0-9]:[0-5][0-9])|([0-1]?[0-9]:[0-5][0-9]\s(am|pm)))$/ )
765 * Converts sort objects [ { Integer: String }, ... ] to the internally used nested array
766 * structure [ [ Integer, Integer ], ... ]
768 * @param {Array} sortObjects List of sort objects.
769 * @return {Array} List of internal sort definitions.
771 function convertSortList( sortObjects
) {
773 sortObjects
.forEach( function ( sortObject
) {
774 // eslint-disable-next-line no-restricted-properties
775 $.each( sortObject
, function ( columnIndex
, order
) {
776 var orderIndex
= ( order
=== 'desc' ) ? 1 : 0;
777 sortList
.push( [ parseInt( columnIndex
, 10 ), orderIndex
] );
787 cssHeader
: 'headerSort',
788 cssAsc
: 'headerSortUp',
789 cssDesc
: 'headerSortDown',
790 cssChildRow
: 'expand-child',
791 sortMultiSortKey
: 'shiftKey',
792 unsortableClass
: 'unsortable',
794 cancelSelection
: true,
806 * @param {jQuery} $tables
807 * @param {Object} [settings]
810 construct: function ( $tables
, settings
) {
811 return $tables
.each( function ( i
, table
) {
812 // Declare and cache.
813 var $headers
, cache
, config
, sortCSS
, sortMsg
,
818 if ( !table
.tBodies
) {
821 if ( !table
.tHead
) {
822 // No thead found. Look for rows with <th>s and
823 // move them into a <thead> tag or a <tfoot> tag
824 emulateTHeadAndFoot( $table
);
826 // Still no thead? Then quit
827 if ( !table
.tHead
) {
831 // The `sortable` class is used to identify tables which will become sortable
832 // If not used it will create a FOUC but it should be added since the sortable class
833 // is responsible for certain crucial style elements. If the class is already present
834 // this action will be harmless.
835 $table
.addClass( 'jquery-tablesorter sortable' );
838 config
= $.extend( {}, $.tablesorter
.defaultOptions
, settings
);
840 // Save the settings where they read
841 $.data( table
, 'tablesorter', { config
: config
} );
843 // Get the CSS class names, could be done elsewhere
844 sortCSS
= [ config
.cssAsc
, config
.cssDesc
];
845 // Messages tell the user what the *next* state will be
846 // so are in reverse order to the CSS classes.
847 sortMsg
= [ mw
.msg( 'sort-descending' ), mw
.msg( 'sort-ascending' ) ];
850 $headers
= buildHeaders( table
, sortMsg
);
852 // Grab and process locale settings.
853 buildTransformTable();
856 // Precaching regexps can bring 10 fold
857 // performance improvements in some browsers.
860 function setupForFirstSort() {
861 var $tfoot
, $sortbottoms
;
865 // Defer buildCollationTable to first sort. As user and site scripts
866 // may customize tableSorterCollation but load after $.ready(), other
867 // scripts may call .tablesorter() before they have done the
868 // tableSorterCollation customizations.
869 buildCollationTable();
871 // Legacy fix of .sortbottoms
872 // Wrap them inside a tfoot (because that's what they actually want to be)
873 // and put the <tfoot> at the end of the <table>
874 $sortbottoms
= $table
.find( '> tbody > tr.sortbottom' );
875 if ( $sortbottoms
.length
) {
876 $tfoot
= $table
.children( 'tfoot' );
877 if ( $tfoot
.length
) {
878 $tfoot
.eq( 0 ).prepend( $sortbottoms
);
880 $table
.append( $( '<tfoot>' ).append( $sortbottoms
) );
884 explodeRowspans( $table
);
885 manageColspans( $table
);
887 // Try to auto detect column type, and store in tables config
888 config
.parsers
= buildParserCache( table
, $headers
);
891 // Apply event handling to headers
892 // this is too big, perhaps break it out?
893 $headers
.on( 'keypress click', function ( e
) {
894 var cell
, $cell
, columns
, newSortList
, i
,
898 if ( e
.type
=== 'click' && e
.target
.nodeName
.toLowerCase() === 'a' ) {
899 // The user clicked on a link inside a table header.
900 // Do nothing and let the default link click action continue.
904 if ( e
.type
=== 'keypress' && e
.which
!== 13 ) {
905 // Only handle keypresses on the "Enter" key.
913 // Build the cache for the tbody cells
914 // to share between calculations for this sort action.
915 // Re-calculated each time a sort action is performed due to possibility
916 // that sort values change. Shouldn't be too expensive, but if it becomes
917 // too slow an event based system should be implemented somehow where
918 // cells get event .change() and bubbles up to the <table> here
919 cache
= buildCache( table
);
921 totalRows
= ( $table
[ 0 ].tBodies
[ 0 ] && $table
[ 0 ].tBodies
[ 0 ].rows
.length
) || 0;
922 if ( totalRows
> 0 ) {
926 // Get current column sort order
928 order
: $cell
.data( 'count' ) % 2,
929 count
: $cell
.data( 'count' ) + 1
933 // Get current column index
934 columns
= config
.headerToColumns
[ $cell
.data( 'headerIndex' ) ];
935 newSortList
= columns
.map( function ( c
) {
936 return [ c
, $cell
.data( 'order' ) ];
938 // Index of first column belonging to this header
941 if ( !e
[ config
.sortMultiSortKey
] ) {
942 // User only wants to sort on one column set
943 // Flush the sort list and add new columns
944 config
.sortList
= newSortList
;
946 // Multi column sorting
947 // It is not possible for one column to belong to multiple headers,
948 // so this is okay - we don't need to check for every value in the columns array
949 if ( isValueInArray( i
, config
.sortList
) ) {
950 // The user has clicked on an already sorted column.
951 // Reverse the sorting direction for all tables.
952 for ( j
= 0; j
< config
.sortList
.length
; j
++ ) {
953 s
= config
.sortList
[ j
];
954 o
= config
.headerList
[ config
.columnToHeader
[ s
[ 0 ] ] ];
955 if ( isValueInArray( s
[ 0 ], newSortList
) ) {
956 $( o
).data( 'count', s
[ 1 ] + 1 );
957 s
[ 1 ] = $( o
).data( 'count' ) % 2;
961 // Add columns to sort list array
962 config
.sortList
= config
.sortList
.concat( newSortList
);
966 // Reset order/counts of cells not affected by sorting
967 setHeadersOrder( $headers
, config
.sortList
, config
.headerToColumns
);
969 // Set CSS for headers
970 setHeadersCss( $table
[ 0 ], $headers
, config
.sortList
, sortCSS
, sortMsg
, config
.columnToHeader
);
972 $table
[ 0 ], multisort( $table
[ 0 ], config
.sortList
, cache
)
975 // Stop normal event by returning false
980 } ).mousedown( function () {
981 if ( config
.cancelSelection
) {
982 this.onselectstart = function () {
990 * Sorts the table. If no sorting is specified by passing a list of sort
991 * objects, the table is sorted according to the initial sorting order.
992 * Passing an empty array will reset sorting (basically just reset the headers
993 * making the table appear unsorted).
995 * @param {Array} [sortList] List of sort objects.
997 $table
.data( 'tablesorter' ).sort = function ( sortList
) {
1000 setupForFirstSort();
1003 if ( sortList
=== undefined ) {
1004 sortList
= config
.sortList
;
1005 } else if ( sortList
.length
> 0 ) {
1006 sortList
= convertSortList( sortList
);
1009 // Set each column's sort count to be able to determine the correct sort
1010 // order when clicking on a header cell the next time
1011 setHeadersOrder( $headers
, sortList
, config
.headerToColumns
);
1013 // re-build the cache for the tbody cells
1014 cache
= buildCache( table
);
1016 // set css for headers
1017 setHeadersCss( table
, $headers
, sortList
, sortCSS
, sortMsg
, config
.columnToHeader
);
1019 // sort the table and append it to the dom
1020 appendToTable( table
, multisort( table
, sortList
, cache
) );
1024 if ( config
.sortList
.length
> 0 ) {
1025 config
.sortList
= convertSortList( config
.sortList
);
1026 $table
.data( 'tablesorter' ).sort();
1032 addParser: function ( parser
) {
1033 if ( !getParserById( parser
.id
) ) {
1034 parsers
.push( parser
);
1038 formatDigit: function ( s
) {
1040 if ( ts
.transformTable
!== false ) {
1042 for ( p
= 0; p
< s
.length
; p
++ ) {
1044 if ( c
in ts
.transformTable
) {
1045 out
+= ts
.transformTable
[ c
];
1052 i
= parseFloat( s
.replace( /[, ]/g, '' ).replace( '\u2212', '-' ) );
1053 return isNaN( i
) ? -Infinity
: i
;
1056 formatFloat: function ( s
) {
1057 var i
= parseFloat( s
);
1058 return isNaN( i
) ? -Infinity
: i
;
1061 formatInt: function ( s
) {
1062 var i
= parseInt( s
, 10 );
1063 return isNaN( i
) ? -Infinity
: i
;
1066 clearTableBody: function ( table
) {
1067 $( table
.tBodies
[ 0 ] ).empty();
1070 getParser: function ( id
) {
1071 buildTransformTable();
1074 buildCollationTable();
1076 return getParserById( id
);
1079 getParsers: function () { // for table diagnosis
1087 // Register as jQuery prototype method
1088 $.fn
.tablesorter = function ( settings
) {
1089 return ts
.construct( this, settings
);
1092 // Add default parsers
1098 format: function ( s
) {
1100 s
= s
.toLowerCase().trim();
1101 if ( ts
.collationRegex
) {
1102 tsc
= ts
.collationTable
;
1103 s
= s
.replace( ts
.collationRegex
, function ( match
) {
1104 var r
= tsc
[ match
] ? tsc
[ match
] : tsc
[ match
.toUpperCase() ];
1105 return r
.toLowerCase();
1115 is: function ( s
) {
1116 return ts
.rgx
.IPAddress
[ 0 ].test( s
);
1118 format: function ( s
) {
1122 for ( i
= 0; i
< a
.length
; i
++ ) {
1124 if ( item
.length
=== 1 ) {
1126 } else if ( item
.length
=== 2 ) {
1132 return $.tablesorter
.formatFloat( r
);
1139 is: function ( s
) {
1140 return ts
.rgx
.currency
[ 0 ].test( s
);
1142 format: function ( s
) {
1143 return $.tablesorter
.formatDigit( s
.replace( ts
.rgx
.currency
[ 1 ], '' ) );
1150 is: function ( s
) {
1151 return ts
.rgx
.url
[ 0 ].test( s
);
1153 format: function ( s
) {
1154 return s
.replace( ts
.rgx
.url
[ 1 ], '' ).trim();
1161 is: function ( s
) {
1162 return ts
.rgx
.isoDate
[ 0 ].test( s
);
1164 format: function ( s
) {
1165 var match
, i
, isodate
, ms
, hOffset
, mOffset
;
1166 match
= s
.match( ts
.rgx
.isoDate
[ 0 ] );
1167 if ( match
=== null ) {
1168 // Otherwise a signed number with 1-4 digit is parsed as isoDate
1169 match
= s
.match( ts
.rgx
.isoDate
[ 1 ] );
1175 for ( i
= 2; i
<= 4; i
+= 2 ) {
1176 if ( !match
[ i
] || match
[ i
].length
=== 0 ) {
1181 for ( i
= 6; i
<= 15; i
++ ) {
1182 if ( !match
[ i
] || match
[ i
].length
=== 0 ) {
1186 ms
= parseFloat( match
[ 11 ].replace( /,/, '.' ) ) * 1000;
1187 hOffset
= $.tablesorter
.formatInt( match
[ 13 ] + match
[ 14 ] );
1188 mOffset
= $.tablesorter
.formatInt( match
[ 13 ] + match
[ 15 ] );
1190 isodate
= new Date( 0 );
1191 // Because Date constructor changes year 0-99 to 1900-1999, use setUTCFullYear()
1192 isodate
.setUTCFullYear( match
[ 1 ], match
[ 2 ] - 1, match
[ 4 ] );
1193 isodate
.setUTCHours( match
[ 6 ] - hOffset
, match
[ 8 ] - mOffset
, match
[ 10 ], ms
);
1194 return isodate
.getTime();
1201 is: function ( s
) {
1202 return ts
.rgx
.usLongDate
[ 0 ].test( s
);
1204 format: function ( s
) {
1205 return $.tablesorter
.formatFloat( new Date( s
).getTime() );
1212 is: function ( s
) {
1213 return ( ts
.dateRegex
[ 0 ].test( s
) || ts
.dateRegex
[ 1 ].test( s
) || ts
.dateRegex
[ 2 ].test( s
) );
1215 format: function ( s
) {
1217 s
= s
.toLowerCase().trim();
1219 if ( ( match
= s
.match( ts
.dateRegex
[ 0 ] ) ) !== null ) {
1220 if ( mw
.config
.get( 'wgDefaultDateFormat' ) === 'mdy' || mw
.config
.get( 'wgPageContentLanguage' ) === 'en' ) {
1221 s
= [ match
[ 3 ], match
[ 1 ], match
[ 2 ] ];
1222 } else if ( mw
.config
.get( 'wgDefaultDateFormat' ) === 'dmy' ) {
1223 s
= [ match
[ 3 ], match
[ 2 ], match
[ 1 ] ];
1225 // If we get here, we don't know which order the dd-dd-dddd
1226 // date is in. So return something not entirely invalid.
1229 } else if ( ( match
= s
.match( ts
.dateRegex
[ 1 ] ) ) !== null ) {
1230 s
= [ match
[ 3 ], String( ts
.monthNames
[ match
[ 2 ] ] ), match
[ 1 ] ];
1231 } else if ( ( match
= s
.match( ts
.dateRegex
[ 2 ] ) ) !== null ) {
1232 s
= [ match
[ 3 ], String( ts
.monthNames
[ match
[ 1 ] ] ), match
[ 2 ] ];
1234 // Should never get here
1238 // Pad Month and Day
1239 if ( s
[ 1 ].length
=== 1 ) {
1240 s
[ 1 ] = '0' + s
[ 1 ];
1242 if ( s
[ 2 ].length
=== 1 ) {
1243 s
[ 2 ] = '0' + s
[ 2 ];
1246 if ( ( y
= parseInt( s
[ 0 ], 10 ) ) < 100 ) {
1247 // Guestimate years without centuries
1254 while ( s
[ 0 ].length
< 4 ) {
1255 s
[ 0 ] = '0' + s
[ 0 ];
1257 return parseInt( s
.join( '' ), 10 );
1264 is: function ( s
) {
1265 return ts
.rgx
.time
[ 0 ].test( s
);
1267 format: function ( s
) {
1268 return $.tablesorter
.formatFloat( new Date( '2000/01/01 ' + s
).getTime() );
1275 is: function ( s
) {
1276 return $.tablesorter
.numberRegex
.test( s
.trim() );
1278 format: function ( s
) {
1279 return $.tablesorter
.formatDigit( s
);