datatables.net 2.1.7 → 2.2.0

package/js/dataTables.mjs

@@ -1,4 +1,4 @@
-/*! DataTables 2.1.7
+/*! DataTables 2.2.0
  * © SpryMedia Ltd - datatables.net/license
  */
 
@@ -376,7 +376,6 @@ var DataTable = function ( selector, options )
 			thead = $('<thead/>').appendTo($this);
 		}
 		oSettings.nTHead = thead[0];
-		$('tr', thead).addClass(oClasses.thead.row);
 		
 		var tbody = $this.children('tbody');
 		if ( tbody.length === 0 ) {
@@ -391,7 +390,6 @@ var DataTable = function ( selector, options )
 			tfoot = $('<tfoot/>').appendTo($this);
 		}
 		oSettings.nTFoot = tfoot[0];
-		$('tr', tfoot).addClass(oClasses.tfoot.row);
 		
 		// Copy the data index array
 		oSettings.aiDisplay = oSettings.aiDisplayMaster.slice();
@@ -2108,6 +2106,10 @@ function _fnColumnSizes ( settings )
 		var width = _fnColumnsSumWidth(settings, [i], false, false);
 
 		cols[i].colEl.css('width', width);
+
+		if (settings.oScroll.sX) {
+			cols[i].colEl.css('min-width', width);
+		}
 	}
 }
 
@@ -3175,9 +3177,13 @@ function _fnBuildHead( settings, side )
 
 		// Add the number of cells needed to make up to the number of columns
 		if (row.length === 1) {
-			var cells = $('td, th', row);
+			var cellCount = 0;
+			
+			$('td, th', row).each(function () {
+				cellCount += this.colSpan;
+			});
 
-			for ( i=cells.length, ien=columns.length ; i<ien ; i++ ) {
+			for ( i=cellCount, ien=columns.length ; i<ien ; i++ ) {
 				$('<th/>')
 					.html( columns[i][titleProp] || '' )
 					.appendTo( row );
@@ -3189,14 +3195,13 @@ function _fnBuildHead( settings, side )
 
 	if (side === 'header') {
 		settings.aoHeader = detected;
+		$('tr', target).addClass(classes.thead.row);
 	}
 	else {
 		settings.aoFooter = detected;
+		$('tr', target).addClass(classes.tfoot.row);
 	}
 
-	// ARIA role for the rows
-	$(target).children('tr').attr('role', 'row');
-
 	// Every cell needs to be passed through the renderer
 	$(target).children('tr').children('th, td')
 		.each( function () {
@@ -4457,7 +4462,7 @@ function _fnFilterCustom( settings )
 		// So the array reference doesn't break set the results into the
 		// existing array
 		displayRows.length = 0;
-		displayRows.push.apply(displayRows, rows);
+		_fnArrayApply(displayRows, rows);
 	}
 }
 
@@ -5185,8 +5190,11 @@ function _fnScrollDraw ( settings )
 		// [].find, but it wasn't supported in Chrome until Sept 2015, and DT has 10 year
 		// browser support
 		var firstTr = null;
+		var start = _fnDataSource( settings ) !== 'ssp'
+			? settings._iDisplayStart
+			: 0;
 
-		for (i=0 ; i<settings.aiDisplay.length ; i++) {
+		for (i=start ; i<start + settings.aiDisplay.length ; i++) {
 			var idx = settings.aiDisplay[i];
 			var tr = settings.aoData[idx].nTr;
 
@@ -5201,7 +5209,7 @@ function _fnScrollDraw ( settings )
 				return {
 					idx: _fnVisibleToColumnIndex(settings, vis),
 					width: $(this).outerWidth()
-				}
+				};
 			});
 
 			// Check against what the colgroup > col is set to and correct if needed
@@ -5211,6 +5219,10 @@ function _fnScrollDraw ( settings )
 
 				if (colWidth !== colSizes[i].width) {
 					colEl.style.width = colSizes[i].width + 'px';
+
+					if (scroll.sX) {
+						colEl.style.minWidth = colSizes[i].width + 'px';
+					}
 				}
 			}
 		}
@@ -5360,6 +5372,8 @@ function _fnCalculateColumnWidths ( settings )
 			// browser will collapse it. If this width is smaller than the
 			// width the column requires, then it will have no effect
 			if ( scrollX ) {
+				this.style.minWidth = width;
+
 				$( this ).append( $('<div/>').css( {
 					width: width,
 					margin: 0,
@@ -5469,15 +5483,52 @@ function _fnCalculateColumnWidths ( settings )
 	}
 
 	if ( (tableWidthAttr || scrollX) && ! settings._reszEvt ) {
-		var bindResize = function () {
-			$(window).on('resize.DT-'+settings.sInstance, DataTable.util.throttle( function () {
-				if (! settings.bDestroying) {
-					_fnAdjustColumnSizing( settings );
+		var wrapperWidth = function () {
+			return $(settings.nTableWrapper).is(':visible')
+				? $(settings.nTableWrapper).width()
+				: 0;
+		}
+
+		settings.containerWidth = wrapperWidth();
+
+		var resize = DataTable.util.throttle( function () {
+			var newWidth = wrapperWidth();
+
+			// Don't do it if destroying, is the same size as last time, or the container
+			// width is 0
+			if (
+				! settings.bDestroying &&
+				settings.containerWidth !== newWidth &&
+				newWidth !== 0
+			) {
+				// Do a resize
+				_fnAdjustColumnSizing( settings );
+				settings.containerWidth = newWidth;
+			}
+		} );
+
+		// For browsers that support it (~2020 onwards for wide support) we can watch for the
+		// container changing width.
+		if (window.ResizeObserver) {
+			settings.resizeObserver = new ResizeObserver(function (e) {
+				var box = e[0].contentBoxSize;
+				var size = Array.isArray(box)
+					? box[0].inlineSize // Spec
+					: box.inlineSize; // Old Firefox
+
+				// Under this condition a resize will trigger its own resize, causing an error.
+				if (size < settings.containerWidth) {
+					return;
 				}
-			} ) );
-		};
 
-		bindResize();
+				resize();
+			});
+			settings.resizeObserver.observe(settings.nTableWrapper);
+		}
+		else {
+			// For old browsers, the best we can do is listen for a window resize
+			$(window).on('resize.DT-'+settings.sInstance, resize);
+		}
 
 		settings._reszEvt = true;
 	}
@@ -6091,15 +6142,26 @@ function _fnSaveState ( settings )
 		return;
 	}
 
+	// Sort state saving uses [[idx, order]] structure.
+	var sorting = [];
+	_fnSortResolve(settings, sorting, settings.aaSorting );
+
 	/* Store the interesting variables */
+	var columns = settings.aoColumns;
 	var state = {
 		time:    +new Date(),
 		start:   settings._iDisplayStart,
 		length:  settings._iDisplayLength,
-		order:   $.extend( true, [], settings.aaSorting ),
+		order:   sorting.map(function (sort) {
+			// If a column name is available, use it
+			return columns[sort[0]] && columns[sort[0]].sName
+				? [ columns[sort[0]].sName, sort[1] ]
+				: sort.slice();
+		} ),
 		search:  $.extend({}, settings.oPreviousSearch),
 		columns: settings.aoColumns.map( function ( col, i ) {
 			return {
+				name: col.sName,
 				visible: col.bVisible,
 				search: $.extend({}, settings.aoPreSearchCols[i])
 			};
@@ -6147,6 +6209,8 @@ function _fnLoadState ( settings, init, callback )
 function _fnImplementState ( settings, s, callback) {
 	var i, ien;
 	var columns = settings.aoColumns;
+	var currentNames = _pluck(settings.aoColumns, 'sName');
+
 	settings._bLoadingState = true;
 
 	// When StateRestore was introduced the state could now be implemented at any time
@@ -6176,13 +6240,6 @@ function _fnImplementState ( settings, s, callback) {
 		return;
 	}
 
-	// Number of columns have changed - all bets are off, no restore of settings
-	if ( s.columns && columns.length !== s.columns.length ) {
-		settings._bLoadingState = false;
-		callback();
-		return;
-	}
-
 	// Store the saved state so it might be accessed at any time
 	settings.oLoadedState = $.extend( true, {}, s );
 
@@ -6216,10 +6273,23 @@ function _fnImplementState ( settings, s, callback) {
 	if ( s.order !== undefined ) {
 		settings.aaSorting = [];
 		$.each( s.order, function ( i, col ) {
-			settings.aaSorting.push( col[0] >= columns.length ?
-				[ 0, col[1] ] :
-				col
-			);
+			var set = [ col[0], col[1] ];
+
+			// A column name was stored and should be used for restore
+			if (typeof col[0] === 'string') {
+				var idx = currentNames.indexOf(col[0]);
+
+				// Find the name from the current list of column names, or fallback to index 0
+				set[0] = idx >= 0
+					? idx
+					: 0;
+			}
+			else if (set[0] >= columns.length) {
+				// If a column name, but it is out of bounds, set to 0
+				set[0] = 0;
+			}
+
+			settings.aaSorting.push(set);
 		} );
 	}
 
@@ -6230,30 +6300,64 @@ function _fnImplementState ( settings, s, callback) {
 
 	// Columns
 	if ( s.columns ) {
-		for ( i=0, ien=s.columns.length ; i<ien ; i++ ) {
-			var col = s.columns[i];
-
-			// Visibility
-			if ( col.visible !== undefined ) {
-				// If the api is defined, the table has been initialised so we need to use it rather than internal settings
-				if (api) {
-					// Don't redraw the columns on every iteration of this loop, we will do this at the end instead
-					api.column(i).visible(col.visible, false);
+		var set = s.columns;
+		var incoming = _pluck(s.columns, 'name');
+
+		// Check if it is a 2.2 style state object with a `name` property for the columns, and if
+		// the name was defined. If so, then create a new array that will map the state object
+		// given, to the current columns (don't bother if they are already matching tho).
+		if (incoming.join('').length && incoming.join('') !== currentNames.join('')) {
+			set = [];
+
+			// For each column, try to find the name in the incoming array
+			for (i=0 ; i<currentNames.length ; i++) {
+				if (currentNames[i] != '') {
+					var idx = incoming.indexOf(currentNames[i]);
+
+					if (idx >= 0) {
+						set.push(s.columns[idx]);
+					}
+					else {
+						// No matching column name in the state's columns, so this might be a new
+						// column and thus can't have a state already.
+						set.push({});
+					}
 				}
 				else {
-					columns[i].bVisible = col.visible;
+					// If no name, but other columns did have a name, then there is no knowing
+					// where this one came from originally so it can't be restored.
+					set.push({});
 				}
 			}
+		}
+
+		// If the number of columns to restore is different from current, then all bets are off.
+		if (set.length === columns.length) {
+			for ( i=0, ien=set.length ; i<ien ; i++ ) {
+				var col = set[i];
 
-			// Search
-			if ( col.search !== undefined ) {
-				$.extend( settings.aoPreSearchCols[i], col.search );
+				// Visibility
+				if ( col.visible !== undefined ) {
+					// If the api is defined, the table has been initialised so we need to use it rather than internal settings
+					if (api) {
+						// Don't redraw the columns on every iteration of this loop, we will do this at the end instead
+						api.column(i).visible(col.visible, false);
+					}
+					else {
+						columns[i].bVisible = col.visible;
+					}
+				}
+
+				// Search
+				if ( col.search !== undefined ) {
+					$.extend( settings.aoPreSearchCols[i], col.search );
+				}
+			}
+
+			// If the api is defined then we need to adjust the columns once the visibility has been changed
+			if (api) {
+				api.columns.adjust();
 			}
-		}
-		
-		// If the api is defined then we need to adjust the columns once the visibility has been changed
-		if (api) {
-			api.columns.adjust();
 		}
 	}
 
@@ -6571,6 +6675,30 @@ function _fnMacros ( settings, str, entries )
 		replace(/_ENTRIES-TOTAL_/g, settings.api.i18n('entries', '', vis) );
 }
 
+/**
+ * Add elements to an array as quickly as possible, but stack stafe.
+ *
+ * @param {*} arr Array to add the data to
+ * @param {*} data Data array that is to be added
+ * @returns 
+ */
+function _fnArrayApply(arr, data) {
+	if (! data) {
+		return;
+	}
+
+	// Chrome can throw a max stack error if apply is called with
+	// too large an array, but apply is faster.
+	if (data.length < 10000) {
+		arr.push.apply(arr, data);
+	}
+	else {
+		for (i=0 ; i<data.length ; i++) {
+			arr.push(data[i]);
+		}
+	}
+}
+
 
 
 /**
@@ -6763,18 +6891,7 @@ _Api = function ( context, data )
 		: settings;
 
 	// Initial data
-	if ( data ) {
-		// Chrome can throw a max stack error if apply is called with
-		// too large an array, but apply is faster.
-		if (data.length < 10000) {
-			this.push.apply(this, data);
-		}
-		else {
-			for (i=0 ; i<data.length ; i++) {
-				this.push(data[i]);
-			}
-		}
-	}
+	_fnArrayApply(this, data);
 
 	// selector
 	this.selector = {
@@ -7155,7 +7272,7 @@ var __table_selector = function ( selector, a )
 		selector.forEach(function (sel) {
 			var inner = __table_selector(sel, a);
 
-			result.push.apply(result, inner);
+			_fnArrayApply(result, inner);
 		});
 
 		return result.filter( function (item) {
@@ -8009,7 +8126,7 @@ _api_register( 'rows.add()', function ( rows ) {
 	// Return an Api.rows() extended instance, so rows().nodes() etc can be used
 	var modRows = this.rows( -1 );
 	modRows.pop();
-	modRows.push.apply(modRows, newRows);
+	_fnArrayApply(modRows, newRows);
 
 	return modRows;
 } );
@@ -8522,7 +8639,10 @@ var __column_selector = function ( settings, selector, opts )
 			.map( function () {
 				return _fnColumnsFromHeader( this ); // `nodes` is column index complete and in order
 			} )
-			.toArray();
+			.toArray()
+			.sort(function (a, b) {
+				return a - b;
+			});
 
 		if ( jqResult.length || ! s.nodeName ) {
 			return jqResult;
@@ -9341,6 +9461,10 @@ _api_register( 'state.save()', function () {
 	} );
 } );
 
+// Can be assigned in DateTable.use() - note luxon and moment vars are in helpers.js
+var __bootstrap;
+var __foundation;
+
 /**
  * Set the libraries that DataTables uses, or the global objects.
  * Note that the arguments can be either way around (legacy support)
@@ -9374,6 +9498,14 @@ DataTable.use = function (arg1, arg2) {
 			case 'moment':
 				return __moment;
 
+			case 'bootstrap':
+				// Use local if set, otherwise try window, which could be undefined
+				return __bootstrap || window.bootstrap;
+
+			case 'foundation':
+				// Ditto
+				return __foundation || window.Foundation;
+
 			default:
 				return null;
 		}
@@ -9383,7 +9515,7 @@ DataTable.use = function (arg1, arg2) {
 	if (type === 'lib' || type === 'jq' || (module && module.fn && module.fn.jquery)) {
 		$ = module;
 	}
-	else if (type == 'win' || (module && module.document)) {
+	else if (type === 'win' || (module && module.document)) {
 		window = module;
 		document = module.document;
 	}
@@ -9396,6 +9528,14 @@ DataTable.use = function (arg1, arg2) {
 	else if (type === 'moment' || (module && module.isMoment)) {
 		__moment = module;
 	}
+	else if (type === 'bootstrap' || (module && module.Modal && module.Modal.NAME === 'modal'))
+	{
+		// This is currently for BS5 only. BS3/4 attach to jQuery, so no need to use `.use()`
+		__bootstrap = module;
+	}
+	else if (type === 'foundation' || (module && module.Reveal)) {
+		__foundation = module;
+	}
 }
 
 /**
@@ -9686,6 +9826,11 @@ _api_register( 'destroy()', function ( remove ) {
 			new _Api( settings ).columns().visible( true );
 		}
 
+		// Container width change listener
+		if (settings.resizeObserver) {
+			settings.resizeObserver.disconnect();
+		}
+
 		// Blitz all `DT` namespaced events (these are internal events, the
 		// lowercase, `dt` events are user subscribed and they are responsible
 		// for removing them
@@ -9804,7 +9949,7 @@ _api_register( 'i18n()', function ( token, def, plural ) {
  *  @type string
  *  @default Version number
  */
-DataTable.version = "2.1.7";
+DataTable.version = "2.2.0";
 
 /**
  * Private data store, containing all of the settings objects that are
@@ -11907,7 +12052,13 @@ DataTable.models.oSettings = {
 	deferLoading: null,
 
 	/** Allow auto type detection */
-	typeDetect: true
+	typeDetect: true,
+
+	/** ResizeObserver for the container div */
+	resizeObserver: null,
+
+	/** Keep a record of the last size of the container, so we can skip duplicates */
+	containerWidth: 0
 };
 
 /**
@@ -12049,8 +12200,8 @@ function __mld( dtLib, momentFn, luxonFn, dateFn, arg1 ) {
 
 
 var __mlWarning = false;
-var __luxon; // Can be assigned in DateTeble.use()
-var __moment; // Can be assigned in DateTeble.use()
+var __luxon; // Can be assigned in DateTable.use()
+var __moment; // Can be assigned in DateTable.use()
 
 /**
  * 
@@ -12086,7 +12237,7 @@ function __mldObj (d, format, locale) {
 			return null;
 		}
 
-		dt.setLocale(locale);
+		dt = dt.setLocale(locale);
 	}
 	else if (! format) {
 		// No format given, must be ISO
@@ -12129,7 +12280,7 @@ function __mlHelper (localeString) {
 
 		// Add type detection and sorting specific to this date format - we need to be able to identify
 		// date type columns as such, rather than as numbers in extensions. Hence the need for this.
-		if (! DataTable.ext.type.order[typeName]) {
+		if (! DataTable.ext.type.order[typeName + '-pre']) {
 			DataTable.type(typeName, {
 				detect: function (d) {
 					// The renderer will give the value to type detect as the type!
@@ -12469,6 +12620,13 @@ var __diacriticSort = function (a, b) {
 	});
 }
 
+var __diacriticHtmlSort = function (a, b) {
+	a = _stripHtml(a);
+	b = _stripHtml(b);
+
+	return __diacriticSort(a, b);
+}
+
 //
 // Built in data types
 //
@@ -12539,6 +12697,31 @@ DataTable.type('html', {
 });
 
 
+DataTable.type('html-utf8', {
+	detect: {
+		allOf: function ( d ) {
+			return _empty( d ) || (typeof d === 'string' && d.indexOf('<') !== -1);
+		},
+		oneOf: function ( d ) {
+			// At least one data point must contain a `<` and a non-ASCII character
+			// eslint-disable-next-line compat/compat
+			return navigator.languages &&
+				! _empty( d ) &&
+				typeof d === 'string' &&
+				d.indexOf('<') !== -1 &&
+				typeof d === 'string' && d.match(/[^\x00-\x7F]/);
+		}
+	},
+	order: {
+		asc: __diacriticHtmlSort,
+		desc: function (a, b) {
+			return __diacriticHtmlSort(a, b) * -1;
+		}
+	},
+	search: _filterString(true, true)
+});
+
+
 DataTable.type('date', {
 	className: 'dt-type-date',
 	detect: {
@@ -12749,6 +12932,7 @@ $.extend( true, DataTable.ext.renderer, {
 				var indexes = columns.indexes();
 				var sortDirs = columns.orderable(true).flatten();
 				var orderedColumns = _pluck(sorting, 'col');
+				var tabIndex = settings.iTabIndex;
 
 				cell
 					.removeClass(
@@ -12813,8 +12997,13 @@ $.extend( true, DataTable.ext.renderer, {
 
 				// Make the headers tab-able for keyboard navigation
 				if (orderable) {
-					cell.find('.dt-column-title').attr('role', 'button');
-					cell.attr('tabindex', 0)
+					var orderSpan = cell.find('.dt-column-order');
+					
+					orderSpan.attr('role', 'button');
+
+					if (tabIndex !== -1) {
+						orderSpan.attr('tabindex', tabIndex);
+					}
 				}
 			} );
 		}
@@ -12828,7 +13017,7 @@ $.extend( true, DataTable.ext.renderer, {
 				.addClass(items.className || classes.row)
 				.appendTo( container );
 
-			$.each( items, function (key, val) {
+			DataTable.ext.renderer.layout._forLayoutRow(items, function (key, val) {
 				if (key === 'id' || key === 'className') {
 					return;
 				}
@@ -12859,7 +13048,31 @@ $.extend( true, DataTable.ext.renderer, {
 					})
 					.append( val.contents )
 					.appendTo( row );
-			} );
+			});
+		},
+
+		// Shared for use by the styling frameworks
+		_forLayoutRow: function (items, fn) {
+			// As we are inserting dom elements, we need start / end in a
+			// specific order, this function is used for sorting the layout
+			// keys.
+			var layoutEnum = function (x) {
+				switch (x) {
+					case '': return 0;
+					case 'start': return 1;
+					case 'end': return 2;
+					default: return 3;
+				}
+			};
+
+			Object
+				.keys(items)
+				.sort(function (a, b) {
+					return layoutEnum(a) - layoutEnum(b);
+				})
+				.forEach(function (key) {
+					fn(key, items[key]);
+				});
 		}
 	}
 } );
@@ -13211,7 +13424,7 @@ function _pagingDraw(settings, host, opts) {
 			'data-dt-idx': button,
 			'tabIndex': btnInfo.disabled
 				? -1
-				: settings.iTabIndex
+				: settings.iTabIndex && btn.clicker[0].nodeName.toLowerCase() !== 'span'
 					? settings.iTabIndex
 					: null, // `0` doesn't need a tabIndex since it is the default
 		});
@@ -13245,12 +13458,16 @@ function _pagingDraw(settings, host, opts) {
 
 	// Responsive - check if the buttons are over two lines based on the
 	// height of the buttons and the container.
-	if (
-		buttonEls.length && // any buttons
-		opts.buttons > 1 && // prevent infinite
-		$(host).height() >= ($(buttonEls[0]).outerHeight() * 2) - 10
-	) {
-		_pagingDraw(settings, host, $.extend({}, opts, { buttons: opts.buttons - 2 }));
+	if (buttonEls.length) {
+		var outerHeight = $(buttonEls[0]).outerHeight();
+	
+		if (
+			opts.buttons > 1 && // prevent infinite
+			outerHeight > 0 && // will be 0 if hidden
+			$(host).height() >= (outerHeight * 2) - 10
+		) {
+			_pagingDraw(settings, host, $.extend({}, opts, { buttons: opts.buttons - 2 }));
+		}
 	}
 }
 
@@ -13274,7 +13491,6 @@ function _pagingButtonInfo(settings, button, page, pages) {
 	switch ( button ) {
 		case 'ellipsis':
 			o.display = '&#x2026;';
-			o.disabled = true;
 			break;
 
 		case 'first':
@@ -13461,7 +13677,7 @@ DataTable.feature.register( 'pageLength', function ( settings, opts ) {
 
 	// Save text node content for macro updating
 	var textNodes = [];
-	Array.from(div.find('label')[0].childNodes).forEach(function (el) {
+	Array.prototype.slice.call(div.find('label')[0].childNodes).forEach(function (el) {
 		if (el.nodeType === Node.TEXT_NODE) {
 			textNodes.push({
 				el: el,
@@ -13479,7 +13695,6 @@ DataTable.feature.register( 'pageLength', function ( settings, opts ) {
 
 	// Next, the select itself, along with the options
 	var select = $('<select/>', {
-		'name':          tableId+'_length',
 		'aria-controls': tableId,
 		'class':         classes.select
 	} );

package/package.json

@@ -4,7 +4,7 @@
     "main": "js/dataTables.js",
     "module": "js/dataTables.mjs",
     "types": "./types/types.d.ts",
-    "version": "2.1.7",
+    "version": "2.2.0",
     "files": [
         "js/**/*.js",
         "js/**/*.mjs",