tablesorter/README.md
Rob Garrison c77d7b2d6e v2.28.12
2017-05-26 15:11:58 -05:00

9.8 KiB
Raw Blame History

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

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!

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

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!

Recent Changes

View the complete change log here.

Version 2.28.12 (5/26/2017)

  • ColumnSelector:
    • Don't clear container on updateAll. Fixes issue #1406.
  • Filter:
    • Return null from filter_selectSource to prevent select updates; From discussion in IRC with @alexweissman.
    • Select searches now process filter types, then exactly match. Previously only exact matches were performed by default, filter types were ignored. This broke the filter + jQuery UI selectmenu demo.
  • Docs/Meta:

Version 2.28.11 (5/24/2017)

  • Docs:
    • Reword sortReset method description. See issue #1404.
  • Columns:
    • Initialize after pager widget.
  • CssStickyHeaders:
  • Filter:
    • Attempt to fix issue #1152 (liveSearch).
    • Second attempt at issue #1152.
    • Trigger liveSearch on blur & cleanup.
  • Pager (widget only):
    • Allow ajax processing on init.
    • Ensure ajax is called after filter widget initializes.
  • Parsers:
    • Update links to sugarjs/datejs demos.
  • Meta:
    • Update dependencies.

Version 2.28.10 (5/16/2017)

  • Core:
    • Disable updateCell method for child rows (temporary block until code is fixed).
    • Add namespace class name to table.
  • Parsers
    • Input-select:
      • Prevent input select parser from handling events from child rows. See pull #1399; thanks @andysleigh!
      • Remove unused variables & add ignoreChildRow option.
      • Bind & update stickyHeaders checkbox. Fixes issue #261.
  • Meta:
    • Use correct composer.json jQuery version. Fixes issue #1398.
    • Clarify use of GPLv2 license. See issue #1400.
    • Update dependencies.

Version 2.28.9 (5/3/2017)

  • Core:
    • Fix widget option changes across multiple tables; seen in the second table of the math page demo with the math_ignore option.
  • Docs:
    • Add page header section to Math docs. See #1392.
    • Fix misspelling.
    • update jQuery.
  • Math:
    • Include noop math_complete in defaults; prevents option not recognized warning