datatables.net 2.2.2 → 2.3.0

package/package.json

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

package/types/types.d.ts

@@ -109,7 +109,7 @@ export interface OrderName {
 	dir: 'asc' | 'desc';
 }
 
-export type OrderArray = [number, 'asc' | 'desc'];
+export type OrderArray = [number, 'asc' | 'desc' | ''];
 
 export type OrderCombined = OrderIdx | OrderName | OrderArray;
 
@@ -231,7 +231,14 @@ type LayoutElement = {
     features: LayoutFeatures;
 }
 
-type Layout = Partial<Record<LayoutKeys, LayoutElement | LayoutFeatures | null>>;
+type Layout = Partial<Record<LayoutKeys,
+    LayoutElement |
+    LayoutFeatures |
+    (() => HTMLElement) |
+    HTMLElement |
+    JQuery<HTMLElement> |
+    null
+>>;
 
 
 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
@@ -388,6 +395,13 @@ export interface Config {
      */
     lengthMenu?: Array<(number | string)> | Array<Array<(number | string)>>;
 
+    /**
+     * Add event listeners during the DataTables startup
+     */
+    on?: {
+        [name: string]: ((this: HTMLElement, e: Event, ...args: any[]) => void);
+    };
+
     /**
      * Control which cell the order event handler will be applied to in a column.
      */
@@ -419,7 +433,18 @@ export interface Config {
     /**
      * Feature control ordering (sorting) abilities in DataTables.
      */
-    ordering?: boolean;
+    ordering?: boolean | {
+        /**
+         * Control the showing of the ordering icons in the table header.
+         */
+        indicators?: boolean;
+
+        /**
+         * Control the addition of a click event handler on the table headers to activate
+         * ordering.
+         */
+        handler?: boolean;
+    };
 
     /**
      * Multiple column ordering ability control.
@@ -602,6 +627,9 @@ export interface ConfigLanguage {
     infoPostFix?: string;
     decimal?: string;
     thousands?: string;
+
+    /** Labels for page length entries */
+    lengthLabels?: { [key: string | number]: string};
     lengthMenu?: string;
     loadingRecords?: string;
     processing?: string;
@@ -1148,7 +1176,9 @@ export interface Api<T=any> {
      * @param initialValue Value to use as the first argument of the first call to the fn callback.
      * @returns Result from the final call to the fn callback function.
      */
-    reduce(fn: ((current: number, value: any, index: number, dt: Api<any>) => number), initialValue?: any): any;
+    reduce(fn: (current: T, value: T, index: number, dt: Api<any>) => T): T;
+    reduce(fn: (current: T, value: T, index: number, dt: Api<any>) => T, initialValue: T): T;
+    reduce<U>(fn: (current: U, value: T, index: number, dt: Api<any>) => U, initialValue: U): U;
 
     /**
      * Apply a callback function against and accumulator and each element in the Api's result set (right-to-left).
@@ -1157,7 +1187,9 @@ export interface Api<T=any> {
      * @param initialValue Value to use as the first argument of the first call to the fn callback.
      * @returns Result from the final call to the fn callback function.
      */
-    reduceRight(fn: ((current: number, value: any, index: number, dt: Api<any>) => number), initialValue?: any): any;
+    reduceRight(fn: (current: T, value: T, index: number, dt: Api<any>) => T): T;
+    reduceRight(fn: (current: T, value: T, index: number, dt: Api<any>) => T, initialValue: T): T;
+    reduceRight<U>(fn: (current: U, value: T, index: number, dt: Api<any>) => U, initialValue: U): U;
 
     /**
      * Reverse the result set of the API instance and return the original array.
@@ -1272,7 +1304,7 @@ export interface Api<T=any> {
      *   impact for bubbling events.
      * @returns Api instance for chaining
      */
-    trigger( name: string, args: any[], bubbles?: boolean): Api<T>;
+    trigger(name: string, args?: any[], bubbles?: boolean): Api<T>;
 
     /**
      * Create a new API instance containing only the unique items from the elements in an instance's result set.
@@ -1292,18 +1324,25 @@ export interface Api<T=any> {
 
 
 export interface ApiSelectorModifier {
+    /**
+     * The order in which the resolved columns should be returned in.
+     * 
+     * * `implied` - the order given in the selector (default)
+     * * `index` - column index order
+     */
+    columnOrder?: 'index' | 'implied';
     /**
      * The order modifier provides the ability to control which order the rows are
      * processed in. Can be one of 'current', 'applied', 'index', 'original', or
      * the column index that you want the order to be applied from.
      */
-    order?: string | number;
+    order?: 'current' | 'applied' | 'index' | 'original' | number;
 
     /**
      * The search modifier provides the ability to govern which rows are used by the selector using the search options that are applied to the table.
      * Values: 'none', 'applied', 'removed'
      */
-    search?: string;
+    search?: 'none' | 'applied' | 'removed';
 
     /**
      * The searchPlaceholder modifier provides the ability to provide informational text for an input control when it has no value.
@@ -1314,7 +1353,7 @@ export interface ApiSelectorModifier {
      * The page modifier allows you to control if the selector should consider all data in the table, regardless of paging, or if only the rows in the currently disabled page should be used.
      * Values: 'all', 'current'
      */
-    page?: string;
+    page?: 'all' | 'current';
 }
 
 export interface AjaxMethods extends Api<any> {
@@ -1896,6 +1935,13 @@ export interface ApiColumnMethods<T> extends Omit<Api<T>, 'init' | 'data' | 'ord
      */
     init(): ConfigColumns;
 
+    /**
+     * Get the name for the selected column (set by `columns.name`).
+     * 
+     * @returns Column name or null if not set.
+     */
+    name(): string | null;
+
     /**
      * Obtain the th / td nodes for the selected column
      * 
@@ -2129,6 +2175,13 @@ export interface ApiColumnsMethods<T> extends Omit<Api<T>, 'init' | 'data' | 'or
      */
     init(): Api<ConfigColumns>;
 
+    /**
+     * Get the names for the selected columns (set by `columns.name`).
+     * 
+     * @returns Column names (each entry can be null if not set).
+     */
+    names(): string | null;
+
     /**
      * Obtain the th / td nodes for the selected columns
      * 
@@ -2790,7 +2843,8 @@ export interface DataTablesStatic {
      * Usage:
      * $.fn.dataTable.versionCheck("1.10.0");
      * @param version Version string
-     * @returns true if this version of DataTables is greater or equal to the required version, or false if this version of DataTales is not suitable
+     * @returns true if this version of DataTables is greater or equal to the required version, or
+     *   false if this version of DataTables is not suitable
      */
     versionCheck(version: string): boolean;
 }
@@ -3060,6 +3114,9 @@ export interface AjaxSettings extends JQueryAjaxSettings {
         /** Mapping for `recordsFiltered` property */
         recordsFiltered: AjaxDataSrc;
     };
+
+    /** Format to submit the data parameters as in the Ajax request */
+    submitAs?: 'http' | 'json';
 }
 
 interface FunctionColumnData {
@@ -3092,6 +3149,7 @@ export interface CellMetaSettings {
 export interface DataTablesStaticExt {
     builder: string;
     buttons: DataTablesStaticExtButtons;
+    ccContent: IColumnControlContent;
     classes: ExtClassesSettings;
     errMode: string;
     feature: any[];
@@ -3115,6 +3173,10 @@ export interface DataTablesStaticExtButtons {
     // Intentionally empty, completed in Buttons extension
 }
 
+export interface IColumnControlContent {
+    [name: string]: any;
+}
+
 /**
  * Classes used by DataTables. Used for styling integration. Note
  * that these all use legacy Hungarian notation.
@@ -3317,38 +3379,38 @@ export type ExtTypeSettingsDetect = ((data: any, settings: InternalSettings) =>
     init?: (settings: InternalSettings, column: any, index: number) => boolean
 };
 
-type FunctionAjax = (data: object, callback: ((data: any) => void), settings: InternalSettings) => void;
+type FunctionAjax = (this: JQueryDataTables, data: object, callback: ((data: any) => void), settings: InternalSettings) => void;
 
-type FunctionAjaxData = (data: AjaxData, settings: InternalSettings) => string | object;
+type FunctionAjaxData = (this: JQueryDataTables, data: AjaxData, settings: InternalSettings) => string | object;
 
-type FunctionColumnRender = (data: any, type: any, row: any, meta: CellMetaSettings) => any;
+type FunctionColumnRender = (this: JQueryDataTables, data: any, type: any, row: any, meta: CellMetaSettings) => any;
 
-type FunctionColumnCreatedCell = (cell: HTMLTableCellElement, cellData: any, rowData: any, row: number, col: number) => void;
+type FunctionColumnCreatedCell = (this: JQueryDataTables, cell: HTMLTableCellElement, cellData: any, rowData: any, row: number, col: number) => void;
 
-type FunctionCreateRow = (row: HTMLTableRowElement, data: any[] | object, dataIndex: number, cells: HTMLTableCellElement[]) => void;
+type FunctionCreateRow = (this: JQueryDataTables, row: HTMLTableRowElement, data: any[] | object, dataIndex: number, cells: HTMLTableCellElement[]) => void;
 
-type FunctionDrawCallback = (settings: InternalSettings) => void;
+type FunctionDrawCallback = (this: JQueryDataTables, settings: InternalSettings) => void;
 
-type FunctionFooterCallback = (tr: HTMLTableRowElement, data: any[], start: number, end: number, display: any[]) => void;
+type FunctionFooterCallback = (this: JQueryDataTables, tr: HTMLTableRowElement, data: any[], start: number, end: number, display: any[]) => void;
 
-type FunctionFormatNumber = (formatNumber: number) => void;
+type FunctionFormatNumber = (this: JQueryDataTables, formatNumber: number) => void;
 
-type FunctionHeaderCallback = (tr: HTMLTableRowElement, data: any[], start: number, end: number, display: any[]) => void;
+type FunctionHeaderCallback = (this: JQueryDataTables, tr: HTMLTableRowElement, data: any[], start: number, end: number, display: any[]) => void;
 
-type FunctionInfoCallback = (settings: InternalSettings, start: number, end: number, mnax: number, total: number, pre: string) => void;
+type FunctionInfoCallback = (this: JQueryDataTables, settings: InternalSettings, start: number, end: number, mnax: number, total: number, pre: string) => void;
 
-type FunctionInitComplete = (settings: InternalSettings, json: object) => void;
+type FunctionInitComplete = (this: JQueryDataTables, settings: InternalSettings, json: object) => void;
 
-type FunctionPreDrawCallback = (settings: InternalSettings) => void;
+type FunctionPreDrawCallback = (this: JQueryDataTables, settings: InternalSettings) => void;
 
-type FunctionRowCallback = (row: HTMLTableRowElement, data: any[] | object, index: number) => void;
+type FunctionRowCallback = (this: JQueryDataTables, row: HTMLTableRowElement, data: any[] | object, index: number) => void;
 
-type FunctionStateLoadCallback = (settings: InternalSettings) => void;
+type FunctionStateLoadCallback = (this: JQueryDataTables, settings: InternalSettings, callback: ((state) => void)) => void | object;
 
-type FunctionStateLoaded = (settings: InternalSettings, data: object) => void;
+type FunctionStateLoaded = (this: JQueryDataTables, settings: InternalSettings, data: object) => void;
 
-type FunctionStateLoadParams = (settings: InternalSettings, data: object) => void;
+type FunctionStateLoadParams = (this: JQueryDataTables, settings: InternalSettings, data: object) => void;
 
-type FunctionStateSaveCallback = (settings: InternalSettings, data: object) => void;
+type FunctionStateSaveCallback = (this: JQueryDataTables, settings: InternalSettings, data: object) => void;
 
-type FunctionStateSaveParams = (settings: InternalSettings, data: object) => void;
+type FunctionStateSaveParams = (this: JQueryDataTables, settings: InternalSettings, data: object) => void;