tablesorter/README.md

139 lines
8.6 KiB
Markdown
Raw Normal View History

2015-09-10 03:39:58 +00:00
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.
2015-09-18 17:12:12 +00:00
[![Bower Version][bower-image]][bower-url] [![NPM Version][npm-image]][npm-url] [![devDependency Status][david-dev-image]][david-dev-url] [![zenhub-image]][zenhub-url]
2012-12-19 17:00:47 +00:00
### 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.
2014-09-08 22:03:26 +00:00
### [Documentation](//mottie.github.io/tablesorter/docs/)
2012-12-19 17:00:47 +00:00
2014-09-08 22:03:26 +00:00
* 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).
2012-12-19 17:00:47 +00:00
### Demos
2014-09-08 22:03:26 +00:00
* [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).
2012-12-19 17:00:47 +00:00
### Features
* Multi-column alphanumeric sorting and filtering.
2014-09-08 22:03:26 +00:00
* 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)
2012-12-19 17:00:47 +00:00
* Support for ROWSPAN and COLSPAN on TH elements.
* Support secondary "hidden" sorting (e.g., maintain alphabetical sort when sorting on other criteria).
2014-09-08 22:03:26 +00:00
* 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
2012-12-19 17:00:47 +00:00
* 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).
2012-12-19 17:00:47 +00:00
### Licensing
* Copyright (c) 2007 Christian Bach.
2014-09-08 22:03:26 +00:00
* 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.
2015-02-24 05:58:08 +00:00
### Download
* Get all files: [zip](//github.com/Mottie/tablesorter/archive/master.zip) or [tar.gz](//github.com/Mottie/tablesorter/archive/master.tar.gz)
2015-02-24 05:58:08 +00:00
* 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)
2014-09-08 22:03:26 +00:00
### Related Projects
* [Plugin for Rails](//github.com/themilkman/jquery-tablesorter-rails). Maintained by [themilkman](//github.com/themilkman).
* [UserFrosting](//github.com/alexweissman/UserFrosting) (A secure, modern user management system for PHP that uses tablesorter) by [alexweissman](//github.com/alexweissman).
2012-12-19 17:00:47 +00:00
2015-02-21 03:31:24 +00:00
### 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
2014-09-08 22:03:26 +00:00
* 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.
2015-03-05 16:04:59 +00:00
* Thanks to [prijutme4ty](https://github.com/prijutme4ty) for numerous contributions!
2014-09-08 22:03:26 +00:00
* Also extra thanks to [christhomas](//github.com/christhomas) and [Lynesth](//github.com/Lynesth) for help with code.
2013-10-18 18:38:46 +00:00
* And, of course thanks to everyone else that has contributed, and continues to contribute to this forked project!
### Questions?
2014-09-08 22:03:26 +00:00
* 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.
2014-09-08 22:03:26 +00:00
* 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!
2015-09-10 03:39:58 +00:00
[npm-url]: https://npmjs.org/package/tablesorter
[npm-image]: https://img.shields.io/npm/v/tablesorter.svg
[david-dev-url]: https://david-dm.org/Mottie/tablesorter#info=devDependencies
[david-dev-image]: https://img.shields.io/david/dev/Mottie/tablesorter.svg
[bower-url]: http://bower.io/search/?q=jquery.tablesorter
[bower-image]: https://img.shields.io/bower/v/jquery.tablesorter.svg
[zenhub-url]: https://zenhub.io
[zenhub-image]: https://raw.githubusercontent.com/ZenHubIO/support/master/zenhub-badge.png
2014-12-23 03:12:59 +00:00
### Recent Changes
2012-12-19 17:00:47 +00:00
2014-12-23 03:12:59 +00:00
View the [complete change log here](//github.com/Mottie/tablesorter/wiki/Changes).
2015-10-04 14:26:07 +00:00
#### <a name="v2.23.5">Version 2.23.5</a> (10/4/2015)
* Core:
* Remove `tabindex` when sort is disabled. See
* Docs:
* Add instructions on how to use the new filter option ([`filter_childWithSibs`](http://mottie.github.io/tablesorter/docs/example-widget-filter-childrows.html)).
* Include filter reset in above demo.
* Fixed spelling mistake x2. See pull [#1024](https://github.com/Mottie/tablesorter/pull/1024) & [#1025](https://github.com/Mottie/tablesorter/pull/1025); thanks [OmgImAlexis](https://github.com/OmgImAlexis)!
* Add note data-attribute values added to both parsed & raw data. Closes [issue #983](https://github.com/Mottie/tablesorter/issues/983).
* Move all javascript to page bottom.
* Filter:
* Keep parent match when no child rows match. See [issue #1020](https://github.com/Mottie/tablesorter/issues/1020).
* Ignore `filter_childWithSibs` when `filter_childByColumn` is `false`. See [issue #1020](https://github.com/Mottie/tablesorter/issues/1020).
* Select includes child rows when `filter_childByColumn` is set.
* Pager
* Prevent hiding child rows when disabling or destroying the pager. See [issue #1020](https://github.com/Mottie/tablesorter/issues/1020).
2015-09-23 15:20:58 +00:00
#### <a name="v2.23.4">Version 2.23.4</a> (9/23/2015)
* Core:
* Ensure widgets don't get cached options. Fixes [issue #946](https://github.com/Mottie/tablesorter/issues/946).
* Update natural sort regular expression for chunking data.
* Use `window.console` check to prevent IE9 error. Fixes [issue #1019](https://github.com/Mottie/tablesorter/issues/1019).
* Filter:
* Modified internal variable.
* Add internal processOptions function & code cleanup.
* Fix external filters not allowing columns > 9. See [pull #1021](https://github.com/Mottie/tablesorter/pull/1021); thanks [a-mair](https://github.com/a-mair)!
* Add `filter_childWithSIbs` option. Fixes [issue #1020](https://github.com/Mottie/tablesorter/issues/1020).
* Build
* Update dependencies.
2015-09-01 15:45:24 +00:00
#### <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).