tablesorter/README.md
Rob Garrison 97784fac29 v2.28.4
2017-01-06 20:56:05 -06:00

11 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-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

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.28.4 (1/6/2017)

  • Docs:
  • 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.

Version 2.28.3 (12/16/2016)

  • Core: Fix internal version numbering.
  • Grunt: add version check.

Version 2.28.2 (12/15/2016)

  • ColumnSelector:
  • Reorder:
    • Add style to <HEAD>.
  • Resizable:
  • Scroller:
  • Theme:
  • Meta:
    • Add jsDelivr CDN link to readme.
    • Add scss to dist folder.