10 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.
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.
Download
- Get all files
- 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.
- Bootsole (OOP templating engine using tablesorter) by alexweissman.
Contributing
If you would like to contribute, please...
- Fork.
- Make changes in a branch & add unit tests.
- Run
grunt test
(if qunit fails, run it again - it's fickle). - 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.23.2 (8/23/2015)
- Readme
- Corrections for last update
- Docs
- Add parsed values function no longer wraps empty content.
- Core
- Cache regular expressions.
- ColumnSelector
- Add
columnSelector_updated
option (triggered event name).
- Add
- Filter
- Allow dynamically changing the "any match" filter. Fixes issue #998.
- Cache regular expressions.
- Add reference to widget code to make the file more compressible.
Version 2.23.1 (8/19/2015)
-
Core
-
Prevent js error when
$.tablesorter.showError
is called without a string. Fixes issue #997. -
Updated
$.tablesorter.showError
function by including asettings
parameter; a parameter passed by jQuery's.ajaxError()
method, but was previously omitted.$.tablesorter.showError( table, xhr, settings, exception );
I didn't bump the minor version as this is somewhat on the edge of calling this a breaking change.
-
-
Pager
-
Include
settings
parameter from ajaxError method, between thexhr
andexception
parameters to match the order of parameters returned by jQuery.ajaxError()
method.ajaxError: function( config, xhr, settings, exception ){ return exception; };
-
Version 2.23.0 (8/17/2015)
- Core:
- Prevent
addRows
error. See issue #979. - Make all updating methods public
- Call a function instead of triggering an event on the table. Changes include:
$.tablesorter.addRows
- called byaddRows
method.$.tablesorter.appendCache
- renamed fromappendToTable
; appends cache to DOM, called byappendCache
method.$.tablesorter.isEmptyObject
- clone of$.isEmptyObject
(jQuery v1.4).$.tablesorter.sortOn
- called bysortOn
method.$.tablesorter.sortReset
- called bysortReset
method.$.tablesorter.updateAll
- called byupdateAll
method.$.tablesorter.updateCache
- called byupdateCache
method.$.tablesorter.updateCell
- called byupdateCell
method.$.tablesorter.update
- called byupdate
andupdateRows
method.
- Call a function instead of triggering an event on the table. Changes include:
addRows
now accepts a row string if only one tbody exists in the table.- The one tbody does not include information only tbodies (which have a class name from
cssInfoBlock
). - Previously, you had to make a jQuery object, append it to the table, then pass a reference containing the new rows.
- This method doesn't work if a table has multiple tbodies, because the plugin doesn't know where you want to add the rows.
- Also, updated the debug message for this method.
- The one tbody does not include information only tbodies (which have a class name from
- Use header cells instead of references to prevent IE8 error. Fixes issue #987.
- Fix above header cell targetting causing a javascript error in jQuery v1.2.6. Fixes issue #995.
- Add
updateHeaders
method- Triggered event & public api function.
$.tablesorter.updateHeaders
- called byupdateHeaders
method.- Fixes issue #989.
- Prevent
- Docs:
- Update jQuery UI theme switcher URLs.
- ColumnSelector:
- Modify
refreshColumnSelector
method so it also updates the contents of the container in case of changes to the header text, column priorities, etc. - See examples of these changes in the column selector methods section.
- Fixes issue #985.
- Modify
- Editable:
- Filter:
- Fix js error caused when limiting search columns - external "any" filter targeting specific columns; see Stackoverflow.
- Pager:
- Widget only: No more javascript error in widget ajax error message.
- Addon only: replace use of
$.isEmptyObject
which was not available in jQuery v1.2.6. - Change enable, disable & destroy trigger methods.
- Previously, these methods had to include a
.pager
namespace:enable.pager
,disable.pager
&destroy.pager
. - These methods stopped working when unique pager namespaces were added.
- New trigger methods are named as follows:
enablePager
,disablePager
&destroyPager
. - Fixes issue #980.
- Previously, these methods had to include a
- Unbind pager controls on destroy. Fixes issue #981.
- Add
ajaxError
callback function. Fixes issue #992.
- Parsers:
- parser-input-select: fix javascript error when no rows returned.
- Misc & Testing
- Miscellaneous cleanup of testing code.
- Add empty
ignore
entry to bower.json. Fixes issue #991. - Fix license in package.json to match the new spdx license expression syntax.