- NOTE! Click on any column header to sort that column. The alphanumeric sort working in the first column was added in version 2.0.6 (not part of the original plugin).
+ NOTE!
+
+
Click on any column header to sort that column.
+
The alphanumeric sort working in the first column was added in version 2.0.6 (not part of the original plugin).
+
The above sort was replaced with a natural sort in version 2.2.
+
Demo
diff --git a/docs/index.html b/docs/index.html
index c09df5ca..ee351a2e 100644
--- a/docs/index.html
+++ b/docs/index.html
@@ -43,30 +43,6 @@
or GPL licenses.
-
- Note! Version 2.0.3 of the tablesorter docs are available in russian, head over to tablesorter.ru
-
-
-
- Helping out! If you like tablesorter and you're feeling generous, take a look at my Amazon Wish List or make a donation.
-
-
-
-
-
Comments and love letters can be sent to: christian at tablesorter dot com.
tablesorter has many options you can pass in at initialization to achieve different effects
- TIP! Click on the link in the property column to reveal full details (or toggle|show|hide all)
+ TIP! Click on the link in the property column to reveal full details (or toggle|show|hide all) or double click to update the browser location.
@@ -400,7 +374,7 @@
-
cancelSelection
+
cancelSelection
Boolean
true
Indicates if tablesorter should disable selection of text in the table header (TH). Makes header behave more like a button.
All tbodies with this class name will not have its contents sorted. New! v2.2
+
All tbodies with this class name will not have its contents sorted. New! v2.2.
With the addition of multiple tbody sorting in v2.2, you can now insert a non-sorting tbody within the table by adding this class to the tbody.
@@ -540,7 +514,7 @@
This CSS class name can be applied to all rows that are to be removed prior to triggering a table update. New! v2.1
+
This CSS class name can be applied to all rows that are to be removed prior to triggering a table update. (New v2.1).
It was necessary to add this option because some widgets add table rows for styling (see the writing custom widgets demo) and if a table update is triggered ($('table').trigger('update');) those added rows will automatically become incorporated into the table.
@@ -553,7 +527,7 @@
Set the date format. Here are the available options. Modified in version 2.0.23.
+
Set the date format. Here are the available options. (Modified v2.0.23).
"mmddyyyy" (default)
@@ -585,7 +559,7 @@
-
debug
+
debug
Boolean
false
@@ -599,7 +573,7 @@
String
"bottom"
- Boolean flag indicating how tablesorter should deal with empty table cells. Modified! v2.1.16.
+ Boolean flag indicating how tablesorter should deal with empty table cells. (Modified v2.1.16).
bottom - sort empty table cells to the bottom.
@@ -621,7 +595,7 @@
-
headerList
+
headerList
Array
[ ] (empty array)
Internal list of each header element as selected using jQuery selectors in the selectorHeaders option. Not really useful for normal usage.
@@ -679,10 +653,10 @@
-
ignoreCase
+
ignoreCase
Boolean
true
-
When true, text sorting will ignore the character case. If false, upper case characters will sort before lower case.
+
When true, text sorting will ignore the character case. If false, upper case characters will sort before lower case. New! v2.2.
@@ -728,7 +702,7 @@
sorter: "isoDate"
Sort by ISO date (YYYY-MM-DD or YYYY/MM/DD).
sorter: "percent"
Sort by percent.
sorter: "usLongDate"
Sort by date (U.S. Standard, e.g. Jan 18, 2001 9:12 AM).
jQuery selectors used to find the header cells. You can change this, but the table will still need the required thead and tbody before this plugin will work properly.
+
"> thead th"
+
jQuery selectors used to find the header cells.
+
+ You can change this, but the table will still need the required thead and tbody before this plugin will work properly.
+ Added > to the selector in version 2.3 to prevent targetting nested table headers. Modified! v2.3
+
Use to add an additional forced sort that is prepended to sortList.
+
Use to add an additional forced sort that is prepended to sortList.
For example, sortForce: [[0,0]] will sort the first column in ascending order. After the forced sort, the user selected column(s), or during initialzation, the sorting order defined in the sortList will follow. And lastly, the sort defined in the sortAppend option will be applied. More explicitly:
@@ -806,7 +785,7 @@
-
sortInitialOrder
+
sortInitialOrder
String
"asc"
@@ -839,7 +818,7 @@
Please see the example page for instrcutions on how to modify the above equivalency table.
-
If you would like to continuing using the String.localeCompare method, then set the sortLocaleCompare option to false and use the new textSorter option as follows:
+
If you would like to continuing using the String.localeCompare method, then set the sortLocaleCompare option to false and use the new textSorter option as follows:
- Setting this option to true will allow you to click on the table header a third time to reset the sort direction. New in v2.0.27.
+ Setting this option to true will allow you to click on the table header a third time to reset the sort direction. (New v2.0.27).
- Setting this option to true will start the sort with the sortInitialOrder when clicking on a previously unsorted column. New in v2.0.31.
+ Setting this option to true will start the sort with the sortInitialOrder when clicking on a previously unsorted column. (New v2.0.31).
The key used to select more than one column for multi-column sorting. Defaults to the shift key. The other options are "ctrlKey" or "altKey". Reference: https://developer.mozilla.org/en/DOM/MouseEvent
- Boolean flag indicating how tablesorter should deal with text inside of numerically sorted columns. New! v2.1.16.
+ Boolean flag indicating how tablesorter should deal with text inside of numerically sorted columns. (New v2.1.16).
String options was initially set in the header options only. Overall option added and values changed in version 2.1.16; setting the value to:
This class was required in the default markup in version 2.0.5. But in version 2.0.6, it was added as an option.
@@ -989,7 +968,7 @@ $(function(){
Boolean
true
- Indicates how tablesorter should deal with a numerical format: New! in v2.1.3.
+ Indicates how tablesorter should deal with a numerical format: (New v2.1.3).
@@ -1009,7 +988,7 @@ $(function(){
-
widgets
+
widgets
Array
[ ] (empty array)
@@ -1019,7 +998,7 @@ $(function(){
-
widthFixed
+
widthFixed
Boolean
false
@@ -1034,7 +1013,7 @@ $(function(){
Object
{ }
- As of version 2.1, all widget options have been moved into this option. This is a move to store all widget specific options in one place so as not to polute the main table options. All current widgets have been modified to use this new option. New! in v2.1.
+ As of version 2.1, all widget options have been moved into this option. This is a move to store all widget specific options in one place so as not to polute the main table options. All current widgets have been modified to use this new option. (New v2.1).
Previously documented widget options widgetZebra, widgetColumns and widgetUitheme will be retained for backwards compatibility.
@@ -1093,8 +1072,8 @@ $(function(){
@@ -1102,7 +1081,7 @@ $(function(){
It has been replaced by widgetOptions.columns; but is still available for backwards compatibility.
- When the column styling widget is initialized, it automatically applied the default class names of "primary" for the primary sort, "secondary" for the next sort, "tertiary" for the next sort, and so on (add more as needed)... New in v2.0.17.
+ When the column styling widget is initialized, it automatically applied the default class names of "primary" for the primary sort, "secondary" for the next sort, "tertiary" for the next sort, and so on (add more as needed)... (New v2.0.17).
Use the widgetColumns option to change the css class name as follows:
@@ -1123,7 +1102,7 @@ $(function(){
It has been replaced by widgetOptions.uitheme; but is still available for backwards compatibility.
- Used when the ui theme styling widget is initialized. It automatically applies the default class names of "ui-icon-arrowthick-2-n-s" for the unsorted column, "ui-icon-arrowthick-1-s" for the descending sort and "ui-icon-arrowthick-1-n" for the ascending sort. New in v2.0.9.
+ Used when the ui theme styling widget is initialized. It automatically applies the default class names of "ui-icon-arrowthick-2-n-s" for the unsorted column, "ui-icon-arrowthick-1-s" for the descending sort and "ui-icon-arrowthick-1-n" for the ascending sort. (New v2.0.9).
Find more jQuery UI class names by hovering over the Framework icons on this page: http://jqueryui.com/themeroller/
Use the widgetUitheme option to change the css class name as follows:
@@ -1144,7 +1123,7 @@ $(function(){
tablesorter widgets have many options, and to better organize them, they now are grouped together inside of the widgetOptions
- TIP! Click on the link in the property column to reveal full details (or toggle|show|hide all)
+ TIP! Click on the link in the property column to reveal full details (or toggle|show|hide all) or double click to update the browser location.
@@ -1201,7 +1180,7 @@ $(function(){
Array
[ "primary", "secondary", "tertiary" ]
- columns widget: When the column styling widget is initialized, it automatically applied the default class names of "primary" for the primary sort, "secondary" for the next sort, "tertiary" for the next sort, and so on (add more as needed)... Modified! in v2.1.
+ columns widget: When the column styling widget is initialized, it automatically applied the default class names of "primary" for the primary sort, "secondary" for the next sort, "tertiary" for the next sort, and so on (add more as needed)... (Modified v2.1).
Use the "columns" option to change the css class name as follows:
@@ -1223,7 +1202,7 @@ $(function(){
false
Filter widget: If there are child rows in the table (rows with class name from "cssChildRow" option) and this option is true and a match is found anywhere in the child row, then it will make that row visible.
- Modified! in v2.1.
+ (Modified v2.1).
Use the filter_childRows option include child row text as follows:
@@ -1245,7 +1224,7 @@ $(function(){
'tablesorter-filter'
Filter widget: This is the class name applied to the filter header row (tr) and each input within that row. If you change it from the default class name of "tablesorter-filter" make sure you also update the css!
- New! in v2.1.
+ (New v2.1).
Use the "tablesorter-filter" option to change the css class name as follows:
@@ -1267,8 +1246,7 @@ $(function(){
Boolean
false
- Filter widget: Set this option to true to use the filter to find text from the start of the column, so typing in "a" will find "albert" but not "frank", both have a's.
- New! in v2.1.
+ Filter widget: Set this option to true to use the filter to find text from the start of the column, so typing in "a" will find "albert" but not "frank", both have a's. (New v2.1).
Use the filter_startsWith option as follows:
@@ -1289,8 +1267,7 @@ $(function(){
String
'tablesorter-stickyHeader'
- stickyHeaders widget: This is the class name applied to the sticky header row (tr). If you change it from the default class name of "tablesorter-stickyHeader" make sure you also update the css!
- New! in v2.1.
+ stickyHeaders widget: This is the class name applied to the sticky header row (tr). If you change it from the default class name of "tablesorter-stickyHeader" make sure you also update the css! (New v2.1).
Use the "stickyHeaders" option to change the css class name as follows:
@@ -1312,7 +1289,7 @@ $(function(){
- uitheme widget: This widget option replaces the previous widgetUitheme. It is used when the ui theme styling widget is initialized. It automatically applies the default class names of "ui-icon-arrowthick-2-n-s" for the unsorted column, "ui-icon-arrowthick-1-s" for the descending sort and "ui-icon-arrowthick-1-n" for the ascending sort. Modified! in v2.1.
+ uitheme widget: This widget option replaces the previous widgetUitheme. It is used when the ui theme styling widget is initialized. It automatically applies the default class names of "ui-icon-arrowthick-2-n-s" for the unsorted column, "ui-icon-arrowthick-1-s" for the descending sort and "ui-icon-arrowthick-1-n" for the ascending sort. (Modified v2.1).
Find more jQuery UI class names by hovering over the Framework icons on this page: http://jqueryui.com/themeroller/
@@ -1339,7 +1316,7 @@ $(function(){
Array
[ "even", "odd" ]
- zebra widget: When the zebra striping widget is initialized, it automatically applied the default class names of "even" and "odd". Modified! in v2.1.
+ zebra widget: When the zebra striping widget is initialized, it automatically applied the default class names of "even" and "odd". (Modified v2.1).
Use the "zebra" option to change the css class name as follows:
@@ -1364,7 +1341,7 @@ $(function(){
tablesorter has some methods available to allow updating, resorting or applying widgets to a table after it has been initialized.
- TIP! Click on the link in the method column to reveal full details (or toggle|show|hide all):
+ TIP! Click on the link in the method column to reveal full details (or toggle|show|hide all) or double click to update the browser location.
Use this method to add table rows. New in v2.0.16
+
Use this method to add table rows. (New v2.0.16).
It does not work the same as "update" in that it only adds rows, it does not remove them.
Also, use this method to add table rows while using the pager plugin. If the "update" method is used, only the visible table rows continue to exist.
@@ -1521,7 +1498,7 @@ $("table")
tablesorter has some methods available to allow updating, resorting or applying widgets to a table after it has been initialized.
- TIP! Click on the link in the event column to reveal full details (or toggle|show|hide all):
+ TIP! Click on the link in the event column to reveal full details (or toggle|show|hide all) or double click to update the browser location.
jquery.tablesorter.widgets.js (16kb/8kb min, includes the jQuery UI theme, columns styling, resizable columns, filter, sticky header and save sort widgets. Updated! in v2.1.)
+
jquery.tablesorter.widgets.js (16kb/8kb min, includes the jQuery UI theme, columns styling, resizable columns, filter, sticky header and save sort widgets. (Updated v2.1)
Themes:
Green Skin - Images and CSS styles for green themed headers
Blue Skin - Images and CSS styles for blue themed headers (as seen in the examples)
-
jQuery UI Theme - Apply any jQuery UI theme to the table using the "uitheme" widget code. New in v2.0.9!
+
jQuery UI Theme - Apply any jQuery UI theme to the table using the "uitheme" widget code. (New v2.0.9).