tablesorter/README.md

tablesorter (FORK) is a jQuery plugin for turning a standard HTML table with THEAD and TBODY tags into a sortable table without page refreshes. tablesorter can successfully parse and sort many types of data including linked data in a cell.

Notice!

• Because of the change to the internal cache, the tablesorter v2.16+ core, filter widget and pager (both plugin & widget) will only work with the same version or newer files.

Documentation

• See the full documentation.
• All of the original document pages have been included.
• Information from my blog post on undocumented options and lots of new demos have also been included.
• Change log moved from included text file into the wiki documentation.

Demos

• Basic alpha-numeric sort Demo.
• Links to demo pages can be found within the main documentation.
• More demos & playgrounds - updated in the wiki pages.

Features

• Multi-column alphanumeric sorting and filtering.
• Multi-tbody sorting - see the options table on the main document page.
• Supports Bootstrap v2 and 3
• Parsers for sorting text, alphanumeric text, URIs, integers, currency, floats, IP addresses, dates (ISO, long and short formats) & time. Add your own easily.
• Inline editing - see demo
• Support for ROWSPAN and COLSPAN on TH elements.
• Support secondary "hidden" sorting (e.g., maintain alphabetical sort when sorting on other criteria).
• Extensibility via widget system.
• Cross-browser: IE 6.0+, FF 2+, Safari 2.0+, Opera 9.0+, Chrome 5.0+.
• Small code size, starting at 25K minified
• Works with jQuery 1.2.6+ (jQuery 1.4.1+ needed with some widgets).
• Works with jQuery 1.9+ ($.browser.msie was removed; needed in the original version).

Licensing

• Copyright (c) 2007 Christian Bach.
• Original examples and docs at: http://tablesorter.com.
• Dual licensed under the MIT and GPL licenses.

Download

• Get all files
• Use bower: bower install jquery.tablesorter
• Use node.js: npm install tablesorter
• CDNJS: https://cdnjs.com/libraries/jquery.tablesorter

Related Projects

• Plugin for Rails. Maintained by themilkman.
• Bootsole (OOP templating engine using tablesorter) by alexweissman.

Contributing

If you would like to contribute, please...

1. Fork.
2. Make changes in a branch & add unit tests.
3. Run grunt test (if qunit fails, run it again - it's fickle).
4. Create a pull request.

Special Thanks

• Big shout-out to Nick Craver for getting rid of the eval() function that was previously needed for multi-column sorting.
• Big thanks to thezoggy for helping with code, themes and providing valuable feedback.
• Big thanks to ThsSin- for taking over for a while and also providing valuable feedback.
• Thanks to prijutme4ty for numerous contributions!
• Also extra thanks to christhomas and Lynesth for help with code.
• And, of course thanks to everyone else that has contributed, and continues to contribute to this forked project!

Questions?

• Check the FAQ page.
• Search the main documentation (click the menu button in the upper left corner).
• Search the issues to see if the question or problem has been brought up before, and hopefully resolved.
• If someone is available, ask your question in the #tablesorter IRC channel at freenode.net.
• Ask your question at Stackoverflow using a tablesorter tag.
• Please don't open a new issue unless it really is an issue with the plugin, or a feature request. Thanks!

Recent Changes

View the complete change log here.

Version 2.21.3 (3/26/2015)

• Core
  • Fix icon targeting for class names
  • Modified sort initiation method. A "click" event can now be triggered on a header to initiate a sort - issue #849. Thanks johnjameswhitman.
  • General code cleanup; mostly changing tagName to nodeName.
  • Modified, then removed all references to config.$extraTables and config.$extraHeaders as it was causing a memory leak.
• Docs
  • Update jQuery to v1.11.2.
  • Update Bootstrap to v3.3.4.
• Grunt Build
  • Add custom build file name. See issue #829.
  • The default custom build file name is now "jquery.tablesorter.custom-widgets.js".
  • See the Customize wiki page for more details.
• Filter
  • Make "disabled" a modifiable class name - modify it in $.tablesorter.css.filterDisabled.
  • Select2 filter formatter now escapes forward slashes.
• Output:
  • Minor code tweak.
• Pager:
  • Make pagerUpdate method page parameter optional. It was previously required or the page would reset to 0.
  • Remove "refreshComplete" bind on destroy. Fixes issue #854.
• Resizable:
  • Major overhaul of this widget to now make it compatible with the stickyHeaders widget.
  • Sadly, it still doesn't work properly with the updated scroller widget; it's on my to-do list!
  • Add a resizable_targetLast option to automatically target the last column for resize; instead of needing to hold shift while dragging.
• Scroller:
  • Added fixed column support! Fixes issues #135, #689, #763 and https://github.com/Mottie/tablesorter/issues/804.
  • Check out the third table in the scroller widget demo - change the slider to adjust the number of fixed columns.
• Storage:
  • Add option (widgetOptions.storage_useSessionStorage) to allow switching from local to session storage. Fixes #851.
  • Add a bunch of other storage widget options including storage_tableId, storage_group, storage_fixedUrl and storage_page. See the documentation on how they might be useful.
  • Deprecated config.fixedUrl in favor of the widgetOptions.storage_fixedUrl option.
• Themes
  • Add "hover" class to all hover definitions (for the scroller widget mostly).
  • Remove filter element offsetting margins.
  • Target background-color instead of background. Fixes issue #853.

Version 2.21.2 (3/13/2015)

• Core: get accurate column count. Fixes issue #840.
• Docs
  • Update to use jQuery UI v1.11.4.
  • Add note about resizable widget needing a non-breaking space in an empty cell. Fixes issue #844.
• Editable: fix editable not updating properly on update/pager complete.
• Filter: prevent error if parseFilter returns NaN - this depends on what custom parsers return.
• Output: change carriage returns & tabs to unicode equivalent so it works in Excel. Fixes issue #845.
• Pager
  • Don't recalculate total rows/pages if using ajax.
  • Remove outdated pager.min file in the addons folder; it is now available in the dist/js/extras folder.
• Uitheme: add icon classes while using stickyHeaders. See issue #842.

Version 2.21.1 (3/10/2015)

• Core:
  • Optimize getColumnData function.
  • Use :last instead of .last() to maintain jQuery v1.2.6 compatibility.
  • Allow multiple icon class names in the cssIcon definition.
• Docs
  • Remove initial sort on first table to avoid confusion.
  • Miscellaneous tweaks.
• Build
  • Add UMD wrapper to built "jquery.tablesorter.widgets.js" file. Thanks to nburlett (pull #837)!
• Scroller
  • Properly adjust column widths; fixes issue #836.