tablesorter/README.md

8.6 KiB

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.

Bower Version NPM Version devDependency Status zenhub-image

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

Demos

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

Download

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.23.5 (10/4/2015)

  • Core:
    • Remove tabindex when sort is disabled. See
  • Docs:
    • Add instructions on how to use the new filter option (filter_childWithSibs).
    • Include filter reset in above demo.
    • Fixed spelling mistake x2. See pull #1024 & #1025; thanks OmgImAlexis!
    • Add note data-attribute values added to both parsed & raw data. Closes issue #983.
    • Move all javascript to page bottom.
  • Filter:
    • Keep parent match when no child rows match. See issue #1020.
    • Ignore filter_childWithSibs when filter_childByColumn is false. See issue #1020.
    • Select includes child rows when filter_childByColumn is set.
  • Pager
    • Prevent hiding child rows when disabling or destroying the pager. See issue #1020.

Version 2.23.4 (9/23/2015)

  • Core:
    • Ensure widgets don't get cached options. Fixes issue #946.
    • Update natural sort regular expression for chunking data.
    • Use window.console check to prevent IE9 error. Fixes issue #1019.
  • Filter:
    • Modified internal variable.
    • Add internal processOptions function & code cleanup.
    • Fix external filters not allowing columns > 9. See pull #1021; thanks a-mair!
    • Add filter_childWithSIbs option. Fixes issue #1020.
  • Build
    • Update dependencies.

Version 2.23.3 (9/1/2015)

  • Docs:
    • Correction to dateFormat demo.
  • Core:
    • Corrected sorting of col/rowspan in thead. Fixes issue #1005.
    • Correct header sort indicators in row/colspans. Fixes issue #1005.
  • Filter:
    • Use namespacing when binding reset. Fixes issue #1001.
    • Restore triggered change namespace & prevent search before init. Fixes issue #1002.
  • Group:
    • Remove unused variable.
    • Add group_forceColumn & group_enforceSort options. Fixes issue #1000.