tablesorter/README.md
2016-09-01 11:46:28 -05:00

8.5 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

  • Copyright (c) 2007 Christian Bach.
  • Original examples and docs at: http://tablesorter.com.
  • Dual licensed under the MIT or GPL licenses (pick one).

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.27.6 (9/1/2016)

  • Core: textSorter option now accepts class names. See Stackoverflow.
  • Docs:
    • Update emptyTo demo. See issue #1278.
    • Add $.tablesorter.defaults variable.
  • Grouping: Add "group-date-hour" group type; added to demo.
  • Mark:
  • Parser: Header checkbox remains unchecked when table is hidden. Fixes issue #1090.
  • Pager Custom Controls (beta)
    • Prevent out-of-range page numbers. Fixes issue #1276.
    • Allow settings ends and/or aroundCurrent to zero. See issue #1276.
    • Spacer settings now include wrapper element (a <span> by default).
    • Keyboard use changes.
      • A pager element must now be focused before keyboard keys work.
      • Keyboard keys now include left, right, up, down, pageUp, pageDown, home, or end.
      • pageKeyStep option added. Number of pages to skip with pageUp or pageDown.

Version 2.27.5 (8/22/2016)

  • Readme: Update IRC link to a free client.
  • Docs: Correct usage of Sugar v2.0+ sortCollage.
  • Filter: Add any match search by column text - see updated demo.
  • Parser: Fix JSHint issue.

Version 2.27.4 (8/18/2016)

  • Docs & parser: Update Sugar library v2.0+. Fixes issue #1275.
  • Docs: Add sortStable example.