From 1f37cbae336e7f105227e786852b85ede04f062d Mon Sep 17 00:00:00 2001
From: Rob Garrison <wowmotty@gmail.com>
Date: Tue, 19 Jun 2018 07:47:57 -0500
Subject: [PATCH] Core: Add data-sortedBy to headers. See #1558

---
 docs/example-option-sort-append.html |  2 +-
 docs/index.html                      | 16 +++++++++++--
 js/jquery.tablesorter.js             | 34 +++++++++++++++++++++++-----
 3 files changed, 43 insertions(+), 9 deletions(-)

diff --git a/docs/example-option-sort-append.html b/docs/example-option-sort-append.html
index 79fd0340..0a87881b 100644
--- a/docs/example-option-sort-append.html
+++ b/docs/example-option-sort-append.html
@@ -19,7 +19,7 @@
 	th { width: 16.7%; }
 	#result1, #result2 { color: red; font-size: .8em; font-weight: normal; vertical-align: text-top; }
 	</style>
-	<script src="../dist/js/jquery.tablesorter.js"></script>
+	<script src="../js/jquery.tablesorter.js"></script>
 
 <script id="js">$(function() {
 	$('#table1').tablesorter({
diff --git a/docs/index.html b/docs/index.html
index c33f69a3..c5a43f72 100644
--- a/docs/index.html
+++ b/docs/index.html
@@ -6744,14 +6744,16 @@ $headers.each(function() {
   // column 0
   count: 0, // click count; used as index for order value
   order: [ 0, 1, 2 ], // default sort (sortReset: true)
-  lockedOrder: false  // true if column order is locked (read only)
+  lockedOrder: false, // true if column order is locked (read only)
+  sortedBy: 'user'
 },{
   // ...
 },{
   // column n
   count: 0, // click count; used as index for order value
   order: [ 0, 1, 2 ], // default sort (sortReset: true)
-  lockedOrder: false  // true if column order is locked (read only)
+  lockedOrder: false, // true if column order is locked (read only)
+  sortedBy: 'sorton'
 }]</pre>
 						<ul>
 							<li><code>count</code>
@@ -6777,6 +6779,16 @@ $headers.each(function() {
 									<li>It's readonly because it is set during initialization and not used again (future use by a widget?)</li>
 								</ul>
 							</li>
+							<li><code>sortedBy</code>
+								These values are added to the header cell in a <code>data-sortedBy</code> attribute and may contain:
+								<ul>
+									<li><code>'user'</code> (renamed from <code>'mouseup'</code> event) when a column is sorted by a user.</li>
+									<li><code>'sort'</code> when a column is sorted by triggering a <a href="#sort">sort</a> event on the header.</li>
+									<li><code>'sorton'</code> when a column is sorted using the <a href="#sorton">sorton</a> method.</li>
+									<li><code>'sortAppend'</code> when a sorted column is added by the <a href="#sortappend">sortAppend</a> option.</li>
+									<li><code>'sortForce'</code> when a sorted column is added by the <a href="#sortforce">sortForce</a> option.</li>
+								</ul>
+							</li>
 						</ul>
 					</div>
 					</td>
diff --git a/js/jquery.tablesorter.js b/js/jquery.tablesorter.js
index d943b6a7..37906614 100644
--- a/js/jquery.tablesorter.js
+++ b/js/jquery.tablesorter.js
@@ -593,10 +593,11 @@
 				// this may get updated numerous times if there are multiple rows
 				c.sortVars[ column ] = {
 					count : -1, // set to -1 because clicking on the header automatically adds one
-					order:  tmp ?
+					order :  tmp ?
 						( c.sortReset ? [ 1, 0, 2 ] : [ 1, 0 ] ) : // desc, asc, unsorted
 						( c.sortReset ? [ 0, 1, 2 ] : [ 0, 1 ] ),  // asc, desc, unsorted
-					lockedOrder : false
+					lockedOrder : false,
+					sortedBy : ''
 				};
 				tmp = ts.getData( $elem, configHeaders, 'lockedOrder' ) || false;
 				if ( typeof tmp !== 'undefined' && tmp !== false ) {
@@ -1196,6 +1197,11 @@
 					txt += ts.language[ nextSort === 0 ? 'nextAsc' : nextSort === 1 ? 'nextDesc' : 'nextNone' ];
 				}
 				$header.attr( 'aria-label', txt );
+				if (vars.sortedBy) {
+					$header.attr( 'data-sortedBy', vars.sortedBy );
+				} else {
+					$header.removeAttr('data-sortedBy');
+				}
 			}
 		},
 
@@ -1550,6 +1556,7 @@
 				len = c.$headers.length,
 				th = ts.getClosest( $( cell ), 'th, td' ),
 				col = parseInt( th.attr( 'data-column' ), 10 ),
+				sortedBy = event.type === 'mouseup' ? 'user' : event.type,
 				order = c.sortVars[ col ].order;
 			th = th[0];
 			// Only call sortStart if sorting is enabled
@@ -1570,6 +1577,9 @@
 			}
 			// user only wants to sort on one column
 			if ( notMultiSort ) {
+				$.each( c.sortVars, function( i ) {
+					c.sortVars[ i ].sortedBy = '';
+				});
 				// flush the sort list
 				c.sortList = [];
 				c.last.sortList = [];
@@ -1578,6 +1588,7 @@
 					for ( indx = 0; indx < arry.length; indx++ ) {
 						if ( arry[ indx ][ 0 ] !== col ) {
 							c.sortList[ c.sortList.length ] = arry[ indx ];
+							c.sortVars[ arry[ indx ][ 0 ] ].sortedBy = 'sortForce';
 						}
 					}
 				}
@@ -1585,12 +1596,14 @@
 				dir = order[ c.sortVars[ col ].count ];
 				if ( dir < 2 ) {
 					c.sortList[ c.sortList.length ] = [ col, dir ];
+					c.sortVars[ col ].sortedBy = sortedBy;
 					// add other columns if header spans across multiple
 					if ( th.colSpan > 1 ) {
 						for ( indx = 1; indx < th.colSpan; indx++ ) {
 							c.sortList[ c.sortList.length ] = [ col + indx, dir ];
 							// update count on columns in colSpan
 							c.sortVars[ col + indx ].count = $.inArray( dir, order );
+							c.sortVars[ col + indx ].sortedBy = sortedBy;
 						}
 					}
 				}
@@ -1602,6 +1615,7 @@
 				// the user has clicked on an already sorted column
 				if ( ts.isValueInArray( col, c.sortList ) >= 0 ) {
 					// reverse the sorting direction
+					c.sortVars[ col ].sortedBy = sortedBy;
 					for ( indx = 0; indx < c.sortList.length; indx++ ) {
 						tmp = c.sortList[ indx ];
 						if ( tmp[ 0 ] === col ) {
@@ -1616,6 +1630,7 @@
 				} else {
 					// add column to sort list array
 					dir = order[ c.sortVars[ col ].count ];
+					c.sortVars[ col ].sortedBy = sortedBy;
 					if ( dir < 2 ) {
 						c.sortList[ c.sortList.length ] = [ col, dir ];
 						// add other columns if header spans across multiple
@@ -1624,6 +1639,7 @@
 								c.sortList[ c.sortList.length ] = [ col + indx, dir ];
 								// update count on columns in colSpan
 								c.sortVars[ col + indx ].count = $.inArray( dir, order );
+								c.sortVars[ col + indx ].sortedBy = sortedBy;
 							}
 						}
 					}
@@ -1659,6 +1675,7 @@
 								}
 							}
 							c.sortList[ c.sortList.length ] = [ arry[ indx ][ 0 ], dir ];
+							c.sortVars[ arry[ indx ][ 0 ] ].sortedBy = 'sortAppend';
 						}
 					}
 				}
@@ -1790,8 +1807,12 @@
 		},
 
 		sortOn : function( c, list, callback, init ) {
-			var table = c.table;
+			var indx,
+				table = c.table;
 			c.$table.triggerHandler( 'sortStart', table );
+			for (indx = 0; indx < c.columns; indx++) {
+				c.sortVars[ indx ].sortedBy = ts.isValueInArray( indx, list ) > -1 ? 'sorton' : '';
+			}
 			// update header count index
 			ts.updateHeaderSortCount( c, list );
 			// set css for headers
@@ -1814,13 +1835,14 @@
 
 		sortReset : function( c, callback ) {
 			c.sortList = [];
-			ts.setHeadersCss( c );
-			ts.multisort( c );
-			ts.appendCache( c );
 			var indx;
 			for (indx = 0; indx < c.columns; indx++) {
 				c.sortVars[ indx ].count = -1;
+				c.sortVars[ indx ].sortedBy = '';
 			}
+			ts.setHeadersCss( c );
+			ts.multisort( c );
+			ts.appendCache( c );
 			if ( $.isFunction( callback ) ) {
 				callback( c.table );
 			}