tablesorter/README.md

tablesorter 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.

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 and GPL licenses.

Related Projects

• Plugin for Rails. Maintained by themilkman.
• Bootsole (OOP templating engine using tablesorter) by alexweissman.

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.
• 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.18.4 (12/22/2014)

• Docs
  • Add link to demo showing how to apply jQuery selectmenu widget to a filter
  • Update theme switcher linked styles
  • Add clarification on using jQuery selectors that target the header cell. Fixes issue #766.
  • Fix various typos. Thanks seanhussey!
  • Add cssIgnoreRow docs.
• Core
  • Add cssIgnoreRow option. Added to a header row that is to be ignored & not added to the config.$headers variable.
  • Allow passing alternate headers to getColumnData function.
• ColumnSelector widget
  • Add columnUpdate event when columnSelector is updated.
  • Add columnSelector_cssChecked option - css class name added to checkboxes.
• Pager (addon & widget)
  • Ensure filteredRows variable gets updated before the move to page function is called. Fixes issue #778.
• StickyHeaders widget
  • Make includeCaption option dynamic; add note of new jQuery requirement.
  • Add popup window demo to sticky headers example.
• Themes
  • Style filter input & selects only.
  • Only style <i> tags from tablesorter on theme Bootstrap v2 & less file. Thanks frodrigo!
  • Modify theme Dropbox & grey to also only target icon class name for css styling.

Version 2.18.3 (11/7/2014)

• Core
  • Add class names to the header icons: cssIconNone, cssIconAsc & cssIconDesc to indicate the sort status.
  • The widthFixed option will no longer target nested table colgroup elements to determine if it needs to add a new colgroup.
• Docs
  • Updated Bootstrap theme example.
  • Pager widget option comment corrections.
• Themes: update all themes to hide all elements in the filter row when the filter_hideFilters option is true
• CssStickyHeaders widget: tables with a caption now work properly in Firefox.

Version 2.18.2 (11/3/2014)

• Filter widget

  • Fixed initialization intermittently stalling.

• Pager addon & widget

  • Fixed pager addon javascript error.
  • Fixed pager widget not firing off "pagerComplete" in non-ajax tables.
  • Fixed savePages being overwritten on initialization.
  • Fixed pager widget updating the table content in non-ajax tables.