+ This callback allows you to customize the error message displayed in the thead (v2.22.6).
+
+
+ When there is an ajax error, the $.tablesorter.showError function is called. In v2.22.6, that function now checks this callback to allow adding a custom error message.
+
+ Use it as follows:
+
$(function(){
+ $("table")
+ .tablesorter()
+ .tablesorterPager({
+ ajaxError: function( config, xhr, exception ) {
+ // returning false will abort the error message
+ // the code below is the default behavior when this callback is set to `null`
+ return
+ xhr.status === 0 ? 'Not connected, verify Network' :
+ xhr.status === 404 ? 'Requested page not found [404]' :
+ xhr.status === 500 ? 'Internal Server Error [500]' :
+ exception === 'parsererror' ? 'Requested JSON parse failed' :
+ exception === 'timeout' ? 'Time out error' :
+ exception === 'abort' ? 'Ajax Request aborted' :
+ 'Uncaught error: ' + xhr.statusText + ' [' + xhr.status + ']' );
+ }
+ });
+});
This function allows adding/removing a row to the thead, to display any errors (v2.15).
-
- This function is ONLY included within the widget-pager.js and jquery.tablesorter.pager.js files; in version 3+, I plan to add it as a selectable option in a build.
-
+
This function allows adding/removing a row to the thead, to display any errors (v2.15; v2.22.6).
+
+
This function is ONLY included within the widget-pager.js and jquery.tablesorter.pager.js files; in version 3+, I plan to add it as a selectable option in a build.
+
In v2.22.6, this function will accept xhr and exception parameters provided by ajax error messages. To maintain backward compatibility, if xhr is a string, it will be treated as previous message parameter and displayed in the error row without modification.
Use it as follows:
-
$.tablesorter.showError( table, message );
+
$.tablesorter.showError( table, xhr, exception );
-
table - table DOM element (or jQuery object) of table (or tables).
-
message - a plain string, or string of an HTML row.
+
table - table DOM element (or jQuery object) of the table.
+
xhr - a plain string, string of an HTML row, or the XMLHttpRequest (XHR) object from ajax error message.
+
exception - exception string passed from the ajax error message.
- This function will add a table row to the thead, with a class name from either the pager plugin cssErrorRow option setting, or the pager widget pager_css.errorRow option (the default class name is "tablesorter-errorRow"; and styled within each theme css file).
-
- When passing this function a message, there are three possibilities:
+ This function will add a table row to the thead, with a class name from either the pager plugin cssErrorRow option setting, or the pager widget pager_css.errorRow option (the default class name is "tablesorter-errorRow"; and styled within each theme css file).
+
When passing this function a message string (in the xhr parameter), there are three possibilities:
-
Plain string - "table refuses to cooperate"
+
Plain string (with inline HTML is okay) - "<strong>table refuses to cooperate</strong>"
HTML row string - '<tr><td colspan="' + table.config.columns + '">yeah, instead of showing your data... I am taking a nap</td></tr>' (the table.config.columns variable contains the number of table columns; use as needed)
undefined - completely leave out a message parameter $.tablesorter.showError( table ); to remove all error rows from the table thead.
+ As of v2.22.6,
+
+
*WARNING* the table parameter no longer accepts multiple tables.
+
If the xhr parameter is not a string, then the pager ajaxError callback is called to allow modification of the displayed message.
+
diff --git a/js/widgets/widget-pager.js b/js/widgets/widget-pager.js
index cc9719aa..b18049f0 100644
--- a/js/widgets/widget-pager.js
+++ b/js/widgets/widget-pager.js
@@ -62,6 +62,11 @@
// modify the url after all processing has been applied
pager_customAjaxUrl: function(table, url) { return url; },
+ // ajax error callback from $.tablesorter.showError function
+ // pager_ajaxError: function( config, xhr, exception ){ return exception; };
+ // returning false will abort the error message
+ pager_ajaxError: null,
+
// modify the $.ajax object to allow complete control over your ajax requests
pager_ajaxObject: {
dataType: 'json'
@@ -653,20 +658,13 @@
hl = $table.find('thead th').length;
// Clean up any previous error.
- ts.showError(table);
+ ts.showError( table );
if ( exception ) {
if (c.debug) {
console.error('Pager: >> Ajax Error', xhr, exception);
}
- ts.showError(table,
- xhr.status === 0 ? 'Not connected, verify Network' :
- xhr.status === 404 ? 'Requested page not found [404]' :
- xhr.status === 500 ? 'Internal Server Error [500]' :
- exception === 'parsererror' ? 'Requested JSON parse failed' :
- exception === 'timeout' ? 'Time out error' :
- exception === 'abort' ? 'Ajax Request aborted' :
- 'Uncaught error: ' + xhr.statusText + ' [' + xhr.status + ']' );
+ ts.showError( table, xhr, exception );
c.$tbodies.eq(0).children('tr').detach();
p.totalRows = 0;
} else {
@@ -1144,32 +1142,73 @@
};
// see #486
- ts.showError = function( table, message ) {
- var index, $row, c, wo, errorRow,
+ ts.showError = function( table, xhr, exception ) {
+ var $row,
$table = $( table ),
- len = $table.length;
- for ( index = 0; index < len; index++ ) {
- c = $table[ index ].config;
- if ( c ) {
- wo = c.widgetOptions;
- errorRow = c.pager && c.pager.cssErrorRow || wo.pager_css && wo.pager_css.errorRow || 'tablesorter-errorRow';
- if ( typeof message === 'undefined' ) {
- c.$table.find('thead').find(c.selectorRemove).remove();
- } else {
- $row = ( /tr\>/.test(message) ? $(message) : $('
' + message + '
') )
- .click(function(){
- $(this).remove();
- })
- // add error row to thead instead of tbody, or clicking on the header will result in a parser error
- .appendTo( c.$table.find('thead:first') )
- .addClass( errorRow + ' ' + c.selectorRemove.slice(1) )
- .attr({
- role : 'alert',
- 'aria-live' : 'assertive'
- });
- }
- }
+ c = $table[0].config,
+ wo = c && c.widgetOptions,
+ errorRow = c.pager && c.pager.cssErrorRow || wo.pager_css && wo.pager_css.errorRow || 'tablesorter-errorRow',
+ typ = typeof xhr,
+ valid = true,
+ message = '',
+ removeRow = function(){
+ c.$table.find( 'thead' ).find( '.' + errorRow ).remove();
+ };
+
+ if ( !$table.length ) {
+ console.error('tablesorter showError: no table parameter passed');
+ return;
}
+
+ if ( typ !== 'string' ) {
+ // ajaxError callback for plugin or widget - see #992
+ if ( typeof c.pager.ajaxError === 'function' ) {
+ valid = c.pager.ajaxError( c, xhr, exception );
+ if ( valid === false ) {
+ return removeRow();
+ } else {
+ message = valid;
+ }
+ } else if ( typeof wo.pager_ajaxError === 'function' ) {
+ valid = wo.pager_ajaxError( c, xhr, exception );
+ if ( valid === false ) {
+ return removeRow();
+ } else {
+ message = valid;
+ }
+ } else {
+ message =
+ xhr.status === 0 ? 'Not connected, verify Network' :
+ xhr.status === 404 ? 'Requested page not found [404]' :
+ xhr.status === 500 ? 'Internal Server Error [500]' :
+ exception === 'parsererror' ? 'Requested JSON parse failed' :
+ exception === 'timeout' ? 'Time out error' :
+ exception === 'abort' ? 'Ajax Request aborted' :
+ 'Uncaught error: ' + xhr.statusText + ' [' + xhr.status + ']';
+ }
+ } else if ( typ !== 'undefined' ) {
+ // keep backward compatibility (external usage just passes a message string)
+ message = xhr;
+ }
+
+ if ( message === '' ) {
+ // remove all error rows
+ return removeRow();
+ }
+
+ // allow message to include HTML (must include entire row!)
+ $row = ( /tr\>/.test(message) ? $(message) : $('
' + message + '
') )
+ .click( function() {
+ $( this ).remove();
+ })
+ // add error row to thead instead of tbody, or clicking on the header will result in a parser error
+ .appendTo( c.$table.find( 'thead:first' ) )
+ .addClass( errorRow + ' ' + c.selectorRemove.slice(1) )
+ .attr({
+ role : 'alert',
+ 'aria-live' : 'assertive'
+ });
+
};
})(jQuery);