tablesorter/README.md
2016-05-28 09:43:14 -05:00

8.3 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?

irc-image gitter-image stackoverflow-image

  • 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.26.2 (5/28/2016)

  • Docs:
    • Add missing "tablesorter-ignoreRow" class. See issue #1218.
    • Update jQuery to 1.12.3 & add migrate for v3.0.
    • Correct grouping & resizable last update.
  • Filter:
    • Remove not any match limitation. See updated demo.
    • Fix select2 v3 filter extension. See issue #1216; this code does not work with select2 v4.
  • Testing: setFilters last parameter now true by default.

Version 2.26.1 (5/16/2016)

  • Docs:
    • Update setFilters method.
    • Update playground links & cleanup.
  • Core: Minor organization of options.
  • Filter:
    • Minor organization of options.
    • Allow any match searches with no input.
  • Group:
    • Escape angled brackets in group names. Fixes issue #1206.
    • Fix HTML escape string & prevent undefined error. See issue #1206.
    • Ensure empty cells get a header. Fixes issue #1209.
  • Math: Add math_completed callback.
  • Resizable: update resizable handle position after init. Fixes issue #1207.

Version 2.26.0 (5/1/2016)

  • Pager:
    • Save pager size as "all" vs number. Fixes issue #1196.
    • CAUTION: This change will pass "all", if set, as a page size to the server for ajax requests. So, this may break current server methods on the number of pages to return.
  • StickyHeaders: Include caption height in calculations. Fixes issue #1205.