tablesorter/README.md
2015-12-13 16:24:42 -06:00

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

Bower Version NPM Version devDependency Status zenhub-image

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

Demos

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

Download

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.25.0 (12/13/2015)

  • Global
    • Use triggerHandler instead of trigger to prevent event bubble to any outer table. See issue #1090.
  • Core
    • Add duplicateSpan option (default is true) with unit tests (demo).
    • Add triggered "removeWidget" method & update docs.
    • applyWidgetId now properly initializes a widget, if needed.
    • applyWidgetId now adds widget name to widgets option.
    • Show parsed data in debug log. See issue #1084.
    • Prevent js error - calling "applyWidgetId" on non-existant widget.
    • Prevent js error - trying to apply a non-existent widget.
    • Fix "updateCell" issue. If "updateCell" is triggered on a thead cell, or bubbles to an outer table, tablesorter no longer gets stuck in an "isUpdating" loop.
    • Ensure table has initialized before allowing use of "updateCell". See issue #1099.
    • Fix cache debug log for multiple tbodies.
    • After init, computeColumnIndex now only adds "data-column" attribute to mismatched indexes - lessens DOM interaction on tbody (e.g. math widget).
    • Add "sortBeforeEnd" event for internal widget binding.
    • Renamed $.tablesorter.formatSortingOrder to $.tablesorter.getOrder.
    • Include table in console.error if an issue is encountered during initialization.
    • Clean up warning when no parser is found for given data.
    • Fix config.sortVars js error for non-existent header cells (makes second column of this demo sortable using "sorton").
  • Docs
    • Add reference to datejs parser. See issue #1084.
    • Add note that reflow widget only works with HTML5.
    • Add note in filter localization about escaping special characters in regular expressions. See issue #1101.
    • Update & add all options in math widget demo.
    • Fix search tooltip not hiding on side menu close.
    • Update to Bootstrap v3.3.6.
  • Editable
    • Ensure table has initialized before allowing use of "updateCell". See issue #1099.
  • Filter
    • Prevent js error when columnFilters are false. Fixes issue #1091.
    • Restore column specific default filters. Fixes issue #1088.
    • Prevent insideRange filter type (widget-filter-type-insideRange.js) searches on "all" columns.
    • Prevent edge case js error.
    • Add "filterBeforeEnd" event for internal widget binding.
    • Filters that span multiple columns now have the correct "data-column" value set.
    • Consolidated code that parsed "data-column" ranges into a findRange function (e.g. external filters with data-column="1-3,4-6,8").
  • Math
    • Add "data-math-filter" cell override of math_rowFilter option. See issue #1083.
    • Limit tbody cell processing & use cellIndex whenever possible. See issue #1048.
    • Use core textExtraction on cells. See issue #1098.
    • Initial calculation performed once - changed binding to either "filterEnd" or "pagerComplete", not both.
    • Added change flag so a cache update is only performed when cell content inside of a sortable tbody was modified.
    • Fix "data-math-filter" on "all" cell calculation with fixes to getRow & getColumn functions so that filters get priority over the "filtered" row check. See issue #1083.
    • Another "data-math-filter" fix and change flag fix. See issue #1083; thanks to @lindonb for all the feedback!
    • math_none can now be set to an empty string.
  • Print
  • Parsers
    • Checkbox row class & header now work with sorter-false set. See issue #1090.
    • Return true for header checkbox to work in IE8. See issue #1090.
  • Misc
    • gitignore file - ignore "idea" demos used for testing.

Version 2.24.6 (11/22/2015)

  • Core
    • Prevent "tablesorter-ready" event from firing multiple times in a row.
    • While detecting parsers, use cssIgnoreRow & stop after 50 rows.
  • Docs
    • Update utility options section.
  • Math
    • Add math_rowFilter option. See issue #1083.
    • Spelling corrections to math_rowFilter option.
    • Ensure internal updating flag gets cleared. Fixes issue #1083.
  • Pager
    • Initial page no longer ignored (no filter widget). Fixes issue #1085.
    • Fix other page set issues (no filter widget). Fixes issue #1085.
    • Fix page set issues (with filter widget). Fixes issue #1085.
    • Clean up pager widget code.
  • Print
    • Add print_now option. See issue #1081.
    • Fix print & close button actions.
  • SortTbodies
    • Use config parameter for numeric sorting. See issue #1082.
  • Parsers:
    • Update parser-input-select.js. See issue #971.
    • parser-date-month.js no longer removes other language data.
    • Add alternate date range parser & update filter insideRange filter type.
    • Don't use $.extend for simple additions.
  • Misc
    • Update grunt dependencies.

Version 2.24.5 (11/10/2015)

  • Pager: Fix javascript error in pager addon when using ajax.