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.

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!

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-4.
• 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 or GPL licenses (pick one).

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
• jsDelivr: http://www.jsdelivr.com/?query=tablesorter

Related Projects

• Plugin for Rails. Maintained by themilkman.
• UserFrosting (A secure, modern user management system for PHP that uses tablesorter) by alexweissman.
• Grav CMS: bin/gpm install tablesorter (ref).
• tablesorter-pagercontrols – programmatically adds pager controls below a table and applies the pager add-on for large HTML tables by isg-software.

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!

Recent Changes

View the complete change log here.

Version 2.28.6 (4/2/2017)

• Core:
  • Prevent overwritting default widgetOptions. Fixes issue #1356.
  • Fix method of saving default widgetOptions. See issue #1356.
  • Update column count after reset.
  • Add fix it (in Abelt) note for issue #1362.
  • Update widgets after sortReset. Fixes issue #1361.
  • The applyWidget callback now occurs after "tablesorter-ready" event
• Docs:
  • Update jQuery to v3.2.0.
  • Fix "update" labels from previous version.
  • Add note about Excel & output_encoding. See issue #1353.
  • Clarify parser & sorter class name differences.
  • Add note about event binding after build widget completes. See issue #1370.
  • Fixed linting issues.
  • Add some internal links.
• Build:
  • Stop build widget option warnings.
• Filter:
  • Compare last search array (instead of a combined string). Fixes issue #1363.
• Output:
  • Fixed CSV output when colspan >3. See PR #1373; thanks @ruchir19!
• Pager:
  • Fix "all" option to not set when the option doesn't exist. See PR #1364; thanks @simenflatby!
  • Stop using combined filter values. See issue #1363.
  • Use "all" only when the option exists. Fixes #1364 & #1366.
• Sort2Hash:
  • Stop option warnings. Fixes issue #1369.
• Parsers:
  • Add leading zero parser & demo.
• Theme:
  • Add CSS highlight file; copied from the demo.
• Meta:
  • Add composer.json file. Fixes issue #1355.
  • Readme: Move questions section closer to the top.
  • Update dependencies.
  • Fix indentation & remove extra spaces.
  • Remove cdnjs auto-update config - see CDNJS #9080.
  • Update SPDX license.

Version 2.28.5 (1/28/2017)

• Docs: Fix "update" labels.
• Output:
  • Prevent multiple popups/download with dblClick (i.e. triggering "outputTable" multiple times).
  • Remove extraneous console log.
• Resizable:
  • Add "resizableUpdate" & "resizableReset" methods.
• Scroller:
  • Add scrollerComplete event. Fixes issue #1351.
• Readme: Add related project, tablesorter-pagercontrols

Version 2.28.4 (1/6/2017)

• Docs:
  • Add more notes about moving "ipAddress" parser into an external file. See issue #1344.
  • Load storage widget in grouping widget demo. Fixes issue #1346.
  • Add page header section to grouping child demo. See issue #1346.
  • Include jQuery in page header section in various demos.
  • Add page header to output demo. See issue #1349.
  • Add comma to broken output demo.
  • Add info on output to Excel in output widget demo. See issue #1349.
  • Renamed Bootstrap v2.x demo.
  • Renamed Bootstrap v3.x demo.
  • Created Bootstrap v4.x demo.
  • Update all Bootstrap links to point to Bootstrap v3.x demo.
  • Maintain minimal original Bootstrap demo.
• Output:
  • Prevent error on output to an already open popup.
  • Add output_savePlugin option & update download code.
  • Add output_includeHeader option & docs. Fixes issue #1349.
• Pager:
  • (widget only) make compatible with stickyHeaders. Fixes #1313:
    • Removed all references to stored pager.$goto and pager.$size
    • Removed check if header text matches header length - this breaks when a header row has a "tablesorter-ignoreRow" class name.
    • Add stickyHeader container to pager.$container in case the pager controls are inside the thead.
  • Fix rendering of sticky headers after ajax.
  • Use option to target inner header.
  • Restore check for new headers. Fixes #1343.
  • Add data-attribute override on output. See issue #1348.
• StickHeaders:
  • Reduce widget priority below the pager widget priority.
• Theme:
  • Add group widget css file. See issue #1346.
  • Add column widget support to Bootstrap. See issue #1347.
  • Update high-specificity blue theme - demo; see Stack Overflow.
  • Add theme.bootstrap_4.css file (demo; Bootstrap v4-alpha - do not use in production!).
  • Duplicated theme.bootstrap_3.css from theme.bootstrap.css (maintaining this non-versioned file name until Bootstrap v4-stable has been available for about 6 months).
• Readme:
  • Update log for v2.28.3.