datatables.net-select 2.0.5 → 3.0.0

package/package.json

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

package/types/types.d.ts

@@ -7,7 +7,7 @@
 
 /// <reference types="jquery" />
 
-import DataTables from 'datatables.net';
+import DataTables, {ObjectColumnRender} from 'datatables.net';
 
 export default DataTables;
 
@@ -34,14 +34,24 @@ declare module 'datatables.net' {
 
 	interface ApiRowMethods<T> {
 		/**
-		 * Select a row
+		 * Blur a row
 		 */
-		select(): Api<T>;
+		blur(): Api<T>;
 
 		/**
 		 * Deselect a row
 		 */
 		deselect(): Api<T>;
+
+		/**
+		 * Keyboard focus on a row
+		 */
+		focus(): Api<T>;
+
+		/**
+		 * Select a row
+		 */
+		select(): Api<T>;
 	}
 
 	interface ApiRowsMethods<T> {
@@ -107,6 +117,73 @@ declare module 'datatables.net' {
 			version: string;
 		}
 	}
+
+	interface DataTablesStaticRender {
+		/**
+		 * Display a checkbox in the column's cells to be used for and represent
+		 * row selection.
+		 */
+		select(): ObjectColumnRender;
+
+		/**
+		 * Display a checkbox in the column's cells to be used for and represent
+		 * row selection, with the `value` and `name` attributes for the checkbox
+		 * `input` being set by properties from the row's data object.
+		 *
+		 * @param valueProp Name of the data property where the `value` for the
+		 *   checkbox is.
+		 * @param nameProp Name of the data property where the `name` for the
+		 *   checkbox is.
+		 */
+		select(valueProp: string, nameProp: string): ObjectColumnRender;
+	}
+
+	interface Buttons {
+		/** Select all rows in the table */
+		selectAll: {
+			extend: 'selectAll';
+			selectorModifier?: ApiSelectorModifier;
+		}
+
+		/** Change selection type to cells. Shows as active when cell selection is enabled */
+		selectCells: {
+			extend: 'selectCells';
+		}
+
+		/** Change selection type to columns. Shows as active when cell selection is enabled */
+		selectColumns: {
+			extend: 'selectColumns';
+		}
+
+		/** Button which is enabled only when one or more rows are selected. Provide your own action function. */
+		selected: {
+			extend: 'selected';
+			limitTo?: string[];
+		}
+
+		/** Button which is enabled only when a single row is selected. Provide your own action function. */
+		selectedSingle: {
+			extend: 'selected';
+		}
+
+		/** Deselect all currently selected rows. */
+		selectNone: {
+			extend: 'selectNone';
+		}
+
+		/** Change selection type to rows. Shows as active when cell selection is enabled */
+		selectRows: {
+			extend: 'selectRows';
+		}
+
+		/**
+		 * Toggle a filter that will reduce the rows displayed to just those which are selected. Uses
+		 * its own action function - don't provide your own.
+		 */
+		showSelected: {
+			extend: 'showSelected';
+		}
+	}
 }
 
 interface ConfigSelect {
@@ -130,6 +207,9 @@ interface ConfigSelect {
 	 */
 	items?: string;
 
+	/** Set keyboard accessability (tab and arrow keys) */
+	keys?: boolean;
+
 	/**
 	 * Set the element selector used for mouse event capture to select items
 	 */
@@ -194,6 +274,21 @@ interface ApiSelect<Api> {
 	 */
 	items(set: string): Api;
 
+	/**
+	 * Get Select's keyboard navigation state
+	 * 
+	 * @returns The keyboard navigation state of Select
+	 */
+	keys(): boolean;
+
+	/**
+	 * Set Select's keyboard navigation state
+	 * 
+	 * @param set Enable (true) or disable (false) row keyboard navigation
+	 * @returns DataTables API instance for chaining.
+	 */
+	keys(set: boolean): Api;
+
 	/**
 	 * Get the current item selector string applied to the table.
 	 *