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.
• The original version can be found at http://tablesorter.com, or on GitHub.
• Dual licensed under the MIT or GPLv2 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 through pull requests and open issues to this forked project!

Recent Changes

View the complete change log here.

Version 2.29.0 (9/27/2017)

• Core:
  • Include callback method for "applyWidgets".
  • Add "widgetRemoveEnd" event. Fixes issue #1430.
  • Clarify warning message (widget enabled but code not loaded).
  • Target header cells for data-column. Fixes issue #1459.
• ColumnSelector:
  • Add classHasSpan option.
  • Fix compatibility with grouping widget.
• Grouping:
  • Fix compatibility with columnSelector widget.
• Output:
  • Modify internal process function to allow outputting of data without adding it to the table.
• Resizable:
  • Add resizableComplete event. Fixes issue #1444.
• Scroller:
  • Save position to fix scroller_upAfterSort: false; See PR #1441. This should fix issue #1297 - The current position is now saved on scroll so it can be restored after sorting; thanks @lbodtke!
  • Update scroll position after fixing columns.
• Sort2Hash:
  • Prevent sort2Hash from adding extraneous entries to browser history. Use window.location.replace to update the browser URL only, rather than window.location.hash, which modifies the browser history. See PR #1447; thanks @alexweissman!
• StickyHeaders:
  • Only update class as needed. See issue #1018.
  • Check horizontal scrolling. Fixes issue #1455.
• UITheme:
  • Remove bootstrap v2 refs & fix docs. See issue #1432.
• Docs:
  • Miscellaneous fixes and updates.
  • Add more info about zebra widget when the table is not visible. See PR #1438; thanks @Federico-G!
  • Fix alignCharacter widget reference to css4.
  • Update userfrosting link in the readme.
  • Update to Bootstrap v4.0.0-beta.
  • Fix colspan demo.
• Themes:
  • Rename icon-white to bootstrap-icon-white. Fixes issue #1432.
• Meta:
  • Update dependencies.
  • Build: maintain ie8 support to fix issue #1431.

Version 2.28.15 (7/4/2017)

• Core:
  • Use calculated index instead of DOM index. See pull #1424; thanks @ced-b!
  • Fix check count cell indexing.
• ColumnSelector:
  • Remove colspan adjustments when widget removed.
  • Include tbody colspan updates on removal.
• Filter:
  • Add namespacing to filter-formatter listeners. Needed to prevent JS error when a "resetToLoadState" is triggered and the "filterFomatterUpdate" bindings are still firing.
  • Fix namespacing of events.
• Sort2Hash:
  • Prevent filter update if unchanged & compare (with) hash filter.
  • Fix p's (reference to pager object).
• Docs
  • CSS fixed to comply with editable_wrapContent : <div>. See pull #1420; thanks @LaurentBarbareau!
  • Remove note on contenteditable wrapping. See pull #1420.
  • Update pager widget options in demo code.
  • Use src files in filter formatter demo for testing.
• Meta:
  • Include js & css folders with bower installs.

Version 2.28.14 (6/8/2017)

• Core:
  • Show console error for mismatched column count. See issue #1415.
• Pager:
  • (addon) Ensure ajax is called after filter widget init. Fixes issue #1389.
  • (addon) Fix height issues for certain browsers (border-spacing). See pull #1418; thanks @DoctorWhite
  • (widget) Apply height adjustment code to pager widget.
  • Use selectorRemove to remove error rows. Removes error rows with dynamically changed class names.
• Meta:
  • Added AUTHORS file.