tablesorter/README.md

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.

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

• See the full documentation.
• All of the original document pages have been included.
• Information from my blog post on undocumented options and lots of new demos have also been included.
• Change log moved from included text file into the wiki documentation.

Demos

• Basic alpha-numeric sort Demo.
• Links to demo pages can be found within the main documentation.
• More demos & playgrounds - updated in the wiki pages.

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

• Get all files: zip or tar.gz.
• Use bower: bower install jquery.tablesorter.
• Use node.js: npm install tablesorter.
• CDNJS: https://cdnjs.com/libraries/jquery.tablesorter.

Related Projects

• Plugin for Rails. Maintained by themilkman.
• UserFrosting (A secure, modern user management system for PHP that uses tablesorter) by alexweissman.

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.27.0 (7/31/2016)

• Core:
  • updateCache now ignores "remove-me" rows.
  • Add column count to debug log.
  • Tweak internal sortVars & sortReset. Fixes #1137.
• ColumnSelector:
  • Add max/min visible columns settings.
  • Set state to null for disabled columns - Fixes JSON issues with not storing undefined values.
  • Fix null comparison & incorrect option.
• CurrentSort: Add currentSort widget. Fixes issue #1208.
• Filter:
  • getFilters will now always return an array. Fixes issue #1250. API change
  • Allow ES6 regex flags.
  • Add rowIndex to filter data.
  • Trigger filter formatters after update. See issue #1237.
  • Selected column query works again. Fixes issue #1267; broken since a6b25ae.
• Grouping: Prevent js errors on non-string values.
• Mark: Add mark widget. Fixes issue #1243.
• Math:
  • Add data-math-target attribute.
  • Add math-debug option.
• Output:
  • Automatically ignore widget added rows.
  • Add "url" parameter to output_callback function.
• Scroller: Update when applyWidgets is used. See issue #1261.
• StickyHeaders: Add appendTo option.
• UITheme: jQuery v1.12.0 renamed "carat" to "caret". Fixes issue #1257.
• Parsers: Url parser now ignores "www" & removed parsed flag. The filter widget finds "http" querys.
• Docs:
  • Fix docs javascript; some demos still using jQuery < 1.7.
  • Add scroller widget RTL details. See issue #906.
  • Clarify & expand grouping widget usage.
  • Include ajax type.
  • Add ajax type example to main docs.
  • Update jQuery UI & fix uitheme docs.
  • Remove old syntax highlighter.
  • Update theme switcher.
  • Switch to use jQuery <3.0.0 for Bootstrap demos; later reverted this change after updating to Bootstrap v3.3.7.
  • Add link to cssIgnoreRow example.
  • Clarify column selector initial state.
  • Fix HTML issues.
  • Add filter event function parameter examples.
• Themes:
  • Hide icon when column is disabled.
  • Optimize PNGs in data URLs using ZopfliPNG as well.
  • Compress PNG images further. See pull #1251; thanks @Herst!
  • Add Materialize theme style. Fixes issue #1242.
• Meta:
  • Grunt: Fix IIFE jQuery reference. Fixes issue #1255.
  • Grunt: Update dependencies.
  • Testing: Add filter anyMatch queries; Sadly unrelated to issue #1267.
  • Bower: Oust meta warnings. Fixes issue #1264.
  • Bower: Add recommending settings. Fixes issue #1265.

Version 2.26.6 (7/11/2016)

• Global: Fix "updated" date in various widgets & pager.
• Docs:
  • Cleanup links & license. Fixes issue #1244.
  • Add button type to all buttons.
  • Update to jQuery v3.1.0.
• Core: Prevent undefined error in natural sort. See issue #1151.
• Column Selector: Check visibility of cells after colspan. See issue #1238.
• Filter
  • Filter formatter for Select2 v3.4.6 (v4.0+ still not supported)
    • Now adheres to case sensitivity setting. See issue #1237.
    • Update after filter row rebuilt. See issue #1237.
    • Properly remove case-insensitive flag in regex.
    • Properly escaped characters in regex.
  • Use uncached widgetOptions after inside events.
  • filter_hideFilters option now accepts a function. See issue #477.
• Grouping:
  • Fix js error when storage isn't loaded.
  • Fix group_collapsed behavior. See issue #1247.
• Pager:
  • Prevent ajax call on init. See issue #1196.
  • Prevent setting "all" value before initialization. See issue #1196.
• Scroller: Save scroll position of window. See issue #1240.
• UITheme: Modify filter row after filterInit.
• View:
  • Update to get the raw text value of a column without the span wrap.
  • Trigger "viewComplete" in the view builder, not in init, otherwise you get no trigger when switching views.
  • Replace all instances, not just the first one.
• Bower: Add license identifiers. See pull #1239; thanks @bckfnn!

Version 2.26.5 (6/28/2016)

• Docs:
  • Optimize png images using using zopflipng; see pull #1230 thanks @PeterDaveHello!
  • Add showProcessing toggle button.
  • Add demo link for css3 animated showProcessing icons that actually works!
  • Update to use jQuery v3.0.0.
• Readme: Update for previous version bump.
• Filter: Do not return altered filters variable. Fixes issue #1237.
• Grouping:
  • Use correct pager row indexing. Fixes issue #1232.
  • Prevent JS error with ajax & filtering. Fixes issue #1232.
  • Fix lint issue.
• Resizable: Adjust handles on pager complete.
• Pager:
  • Fix code alignment.
  • Fix filtered regular expression definition.