mirror of
https://github.com/Mottie/tablesorter.git
synced 2024-10-08 13:44:18 +00:00
132 lines
7.3 KiB
Markdown
132 lines
7.3 KiB
Markdown
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](//mottie.github.io/tablesorter/docs/)
|
|
|
|
* See the [full documentation](//mottie.github.io/tablesorter/docs/).
|
|
* All of the [original document pages](//tablesorter.com/docs/) have been included.
|
|
* Information from my blog post on [undocumented options](//wowmotty.blogspot.com/2011/06/jquery-tablesorter-missing-docs.html) and lots of new demos have also been included.
|
|
* Change log moved from included text file into the [wiki documentation](//github.com/Mottie/tablesorter/wiki/Changes).
|
|
|
|
### Demos
|
|
|
|
* [Basic alpha-numeric sort Demo](//mottie.github.com/tablesorter/).
|
|
* Links to demo pages can be found within the main [documentation](//mottie.github.io/tablesorter/docs/).
|
|
* More demos & playgrounds - updated in the [wiki pages](//github.com/Mottie/tablesorter/wiki).
|
|
|
|
### Features
|
|
|
|
* Multi-column alphanumeric sorting and filtering.
|
|
* Multi-tbody sorting - see the [options](//mottie.github.io/tablesorter/docs/index.html#options) table on the main document page.
|
|
* Supports [Bootstrap v2 and 3](//mottie.github.io/tablesorter/docs/example-widget-bootstrap-theme.html)
|
|
* Parsers for sorting text, alphanumeric text, URIs, integers, currency, floats, IP addresses, dates (ISO, long and short formats) & time. [Add your own easily](//mottie.github.io/tablesorter/docs/example-parsers.html).
|
|
* Inline editing - see [demo](//mottie.github.io/tablesorter/docs/example-widget-editable.html)
|
|
* 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](//mottie.github.io/tablesorter/docs/example-widgets.html).
|
|
* 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](//tablesorter.com).
|
|
* Dual licensed under the [MIT](//www.opensource.org/licenses/mit-license.php) and [GPL](//www.gnu.org/licenses/gpl.html) licenses.
|
|
|
|
### Download
|
|
|
|
* Get [all files](https://github.com/Mottie/tablesorter/archive/master.zip)
|
|
* Use [bower](http://bower.io/): `bower install jquery.tablesorter`
|
|
* Use [node.js](http://nodejs.org/): `npm install tablesorter`
|
|
* CDNJS: [https://cdnjs.com/libraries/jquery.tablesorter](https://cdnjs.com/libraries/jquery.tablesorter)
|
|
|
|
### Related Projects
|
|
|
|
* [Plugin for Rails](//github.com/themilkman/jquery-tablesorter-rails). Maintained by [themilkman](//github.com/themilkman).
|
|
* [Bootsole](//alexweissman.github.io/bootsole/) (OOP templating engine using tablesorter) by [alexweissman](//github.com/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](//github.com/NickCraver) for getting rid of the `eval()` function that was previously needed for multi-column sorting.
|
|
* Big thanks to [thezoggy](//github.com/thezoggy) for helping with code, themes and providing valuable feedback.
|
|
* Big thanks to [ThsSin-](//github.com/TheSin-) for taking over for a while and also providing valuable feedback.
|
|
* Thanks to [prijutme4ty](https://github.com/prijutme4ty) for numerous contributions!
|
|
* Also extra thanks to [christhomas](//github.com/christhomas) and [Lynesth](//github.com/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](//github.com/Mottie/tablesorter/wiki/FAQ) page.
|
|
* Search the [main documentation](//mottie.github.io/tablesorter/docs/) (click the menu button in the upper left corner).
|
|
* Search the [issues](//github.com/Mottie/tablesorter/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](//stackoverflow.com/questions/tagged/tablesorter) using a tablesorter tag.
|
|
* Please don't open a [new issue](//github.com/Mottie/tablesorter/issues) unless it really is an issue with the plugin, or a feature request. Thanks!
|
|
|
|
### Recent Changes
|
|
|
|
View the [complete change log here](//github.com/Mottie/tablesorter/wiki/Changes).
|
|
|
|
#### <a name="v2.23.3">Version 2.23.3</a> (9/1/2015)
|
|
|
|
* Docs:
|
|
* Correction to `dateFormat` demo.
|
|
* Core:
|
|
* Corrected sorting of col/rowspan in `thead`. Fixes [issue #1005](https://github.com/Mottie/tablesorter/issues/1005).
|
|
* Correct header sort indicators in row/colspans. Fixes [issue #1005](https://github.com/Mottie/tablesorter/issues/1005).
|
|
* Filter:
|
|
* Use namespacing when binding reset. Fixes [issue #1001](https://github.com/Mottie/tablesorter/issues/1001).
|
|
* Restore triggered change namespace & prevent search before init. Fixes [issue #1002](https://github.com/Mottie/tablesorter/issues/1002).
|
|
* Group:
|
|
* Remove unused variable.
|
|
* Add `group_forceColumn` & `group_enforceSort` options. Fixes [issue #1000](https://github.com/Mottie/tablesorter/issues/1000).
|
|
|
|
#### <a name="v2.23.2">Version 2.23.2</a> (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).
|
|
* Filter
|
|
* Allow dynamically changing the "any match" filter. Fixes [issue #998](https://github.com/Mottie/tablesorter/issues/998).
|
|
* Cache regular expressions.
|
|
* Add reference to widget code to make the file more compressible.
|
|
|
|
#### <a name="v2.23.1">Version 2.23.1</a> (8/19/2015)
|
|
|
|
* Core
|
|
* Prevent js error when `$.tablesorter.showError` is called without a string. Fixes [issue #997](https://github.com/Mottie/tablesorter/issues/997).
|
|
* Updated `$.tablesorter.showError` function by including a `settings` parameter; a parameter passed by jQuery's `.ajaxError()` method, but was previously omitted.
|
|
|
|
```js
|
|
$.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 the `xhr` and `exception` parameters to match the order of parameters returned by jQuery [`.ajaxError()` method](http://api.jquery.com/ajaxError/).
|
|
|
|
```js
|
|
ajaxError: function( config, xhr, settings, exception ){ return exception; };
|
|
```
|