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. This forked version adds lots of new enhancements including: alphanumeric sorting, pager callback functons, multiple widgets providing column styling, ui theme application, sticky headers, column filters and resizer, as well as extended documentation with a lot more demos.

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: zip or tar.gz
• 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.
• UserFrosting (A secure, modern user management system for PHP that uses 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.24.5 (11/10/2015)

• Pager: Fix javascript error in pager addon when using ajax.

Version 2.24.4 (11/10/2015)

• Core
  • sortRestart works again with multi-row headers. Fixes issue #1074.
  • Add sortDisabled language setting; used in aria-labels.
• Docs
  • Update group_formatter docs. See issue #1077.
  • Add clarification & missing possible values. See issue #1070.
  • Fixed mixed content issue, broken links (beta-testing demos) & other stuff.
  • Add filter + jQuery UI Selectmenu demo. See issue #1060
  • Misc updates.
• Filter
  • Convert filters to strings using conventional methods.
  • Prevent "OR" filter type from splitting up regex string. See [issue #1070]https://github.com/Mottie/tablesorter/issues/1070).
  • filter_selectSource option now accepts an array of objects (demo).
• Group
  • Include group & row data parameters in group_formatter. Fixes issue #1077.
• HeaderTitles
  • Update aria-label usage.
• Math
  • Avoid nested table math cells. See Stackoverflow.
• Pager
  • Clear tbody prior to calling ajaxProcessing. This again allows the developer to add the HTML to the table instead of needing to return it.
• Sort2Hash
  • Make widget functions accessible.
  • Add 2 utility functions to simplify hash processing.
• Toggle
  • Add new widget to enable/disable sort & filter. See issue #1075.
• Parser
  • Add "file-extension" parser.
• Misc
  • Grunt: Fix uglify comment removal & update dist folder.

Version 2.24.3 (11/4/2015)

• Core
  • jQuery filter element parameter not defined in v1.2.6.
  • Fix sortRestart preventing sort. Fixes issue #1072.
• Filter
  • Convert filter array to include all strings. Fixes issue #1070.
  • setFilter "apply" parameter now defaults to true. See issue #1071.
• Resizable
  • Fix widget bindings after tablesorter "updateAll" event. See pull #1073; thanks scr34m!
• Misc
  • One more attempt at setting ignore in bower.json. See pull #1063.

Version 2.24.2 (11/2/2015)

• Misc
  • Restory empty bower.json ignore setting... bower is installing an empty dist folder.