@types/datatables.net-buttons - npm Package Compare versions

Comparing version 1.1.4 to 1.4.0

datatables.net-buttons/index.d.ts

@@ -1,6 +0,6 @@
-// Type definitions for JQuery DataTables Buttons extension 1.1.0
+// Type definitions for JQuery DataTables Buttons extension 1.4
 // Project: http://datatables.net/extensions/buttons/
-// Definitions by: Sam Germano <https://github.com/SammyG4Free>, Jim Hartford <https://github.com/jimhartford>
+// Definitions by: Kiarash Ghiaseddin <https://github.com/Silver-Connection>, Sam Germano <https://github.com/SammyG4Free>, Jim Hartford <https://github.com/jimhartford>
 // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
-// TypeScript Version: 2.3
+// TypeScript Version: 2.4
 
@@ -11,120 +11,440 @@ /// <reference types="jquery" />
 declare namespace DataTables {
-    export interface Settings {
+    interface Settings {
         /**
          * Buttons extension options
          */
-        buttons?: boolean | string[] | ButtonSettings[];
+        buttons?: boolean | string[] | ButtonsSettings | ButtonSettings[];
     }
 
-    //#region "button-settings"
+    interface StaticFunctions {
+        Buttons: ButtonStaticFunctions;
+    }
 
-    /**
-    * Buttons extension options
-    */
-    export interface ButtonSettings {
+    interface ButtonStaticFunctions {
+        new (dt: Api, settings: boolean | string[] | ButtonsSettings | ButtonSettings[]): undefined;
+        version: string;
+        defaults: ButtonsSettings;
+    }
+
+    interface ExtSettings {
+        buttons: ExtButtonsSettings;
+    }
+
+    interface Api {
+        button(groupSelector?: any, buttonSelector?: any): ButtonApi;
+        buttons: ButtonsGlobalApi;
+    }
+
+    interface ButtonsGlobalApi {
+        (groupSelector?: any, buttonSelector?: any): ButtonsApi;
+
         /**
-        * Action to take when the button is activated
-        */
+         * Resize the Flash movie clips to take account of the current button dimensions.
+         */
+        resize(): Api;
+
+        /**
+         * Display / hide an information message to the end user to indicate that something has happened.
+         */
+        info(title: string, message?: string, time?: number): Api;
+
+        /**
+         * Get meta information that is common to many different button types.
+         */
+        exportInfo(options?: ButtonsApiExportInfoParameter): ButtonsApiExportInfoReturn;
+
+        /**
+         * Obtain data from a DataTable that is suitable for exporting by saving into a file or copying to clipboard.
+         */
+        exportData(options?: ButtonsApiExportDataParameter): ButtonsApiExportDataReturn;
+    }
+
+    interface ButtonApi {
+        /**
+         * Get the action function for the selected button.
+         */
+        action(): FunctionButtonAction;
+
+        /**
+         * Set the action function for the selected button.
+         */
+        action(set: FunctionButtonAction): Api;
+
+        /**
+         * Get the active state for the selected button.
+         */
+        active(): boolean;
+
+        /**
+         * Set the active state for the selected button.
+         */
+        active(state: boolean): Api;
+
+        /**
+         * Create a new button, adding it to the selected button instance and inserting immediately into the document.
+         */
+        add(index: number | string, config: string|FunctionButtom|ButtonSettings): Api;
+
+        /**
+         * Disable the selected buttons.
+         */
+        disable(): Api;
+
+        /**
+         * Set the enabled state for the selected button.
+         */
+        enable(state?: boolean): Api;
+
+        /**
+         * Get a jQuery object that contains a reference to the node for the selected button.
+         */
+        node(): JQuery;
+        nodes(): JQuery;
+
+        /**
+         * Determine if a button is currently in the processing state or not.
+         */
+        processing(): boolean;
+
+        /**
+         * Set the processing state for the selected button.
+         */
+        processing(set: boolean): Api;
+
+        /**
+         * Set the processing state for the selected button.
+         */
+        processing(set: boolean): Api;
+
+        /**
+         * Remove the selected button from the display. The button is destroyed and can no longer be used once removed.
+         */
+        remove(): Api;
+
+        /**
+         * Get / Set the display text for the selected button
+         */
+        text(title?: string | FunctionButtonText): Api;
+
+        /**
+         * Programmatically trigger the action of the selected button.
+         */
+        trigger(): Api;
+    }
+
+    interface ButtonsApi extends ButtonApi {
+        /**
+         * Get a jQuery instance that contains a reference to the button container instance.
+         */
+        container(): JQuery;
+        containers(): JQuery;
+
+        /**
+         * Destroy the selected button instances, removing the container and all button elements from the document.
+         */
+        destroy(): Api;
+    }
+
+    interface ButtonsApiExportInfoParameter {
+        extension?: string | (() => string);
+        filename?: string | (() => string);
+        messageBottom?: null | string | (() => string);
+        messageTop?: null | string | (() => string);
+        title?: null | string | (() => string);
+    }
+
+    interface ButtonsApiExportInfoReturn {
+        filename: string;
+        messageTop: string;
+        messageBottom: string;
+        title: string;
+    }
+
+    interface ButtonsApiExportDataParameter {
+        rows?: any;
+        columns?: any;
+        modifier?: any;
+        orthogonal?: string;
+        stripHtml?: boolean;
+        stripNewlines?: boolean;
+        decodeEntities?: boolean;
+        trim?: boolean;
+        format?: any;
+    }
+
+    interface ButtonsApiExportDataReturn {
+        header: string[];
+        footer: string[];
+        body: string[];
+    }
+
+    //#region "Button Settings"
+
+    interface ButtonsSettings {
+        name?: string;
+        tabIndex?: number;
+        buttons: Array<string|FunctionButtom|ButtonSettings>;
+        dom?: ButtonDomSettings;
+    }
+
+    interface ButtonDomSettings {
+        button?: ButtonDomButtomButton;
+        buttonContainer?: ButtonDomButtomCommon;
+        buttonLiner?: ButtonDomButtomCommon;
+        collection?: ButtonDomButtomCommon;
+        container?: ButtonDomButtomCommon;
+    }
+
+    interface ButtonDomButtomCommon {
+        className?: string;
+        tag?: string;
+    }
+
+    interface ButtonDomButtomButton extends ButtonDomButtomCommon {
+        active?: string;
+        disabled?: string;
+    }
+
+    interface ButtomSettingsCommon {
+        /**
+         * Action to take when the button is activated
+         */
         action?: FunctionButtonAction;
 
         /**
-        * Ensure that any requirements have been satisfied before initialising a button
-        */
+         * Ensure that any requirements have been satisfied before initialising a button
+         */
         available?: FunctionButtonAvailable;
 
         /**
-        * Set the class name for the button
-        */
+         * Set the class name for the button
+         */
         className?: string;
 
         /**
-        * Function that is called when the button is destroyed
-        */
+         * Function that is called when the button is destroyed
+         */
         destroy?: FunctionButtonInit;
 
         /**
-        * Set a button's initial enabled state
-        */
+         * Set a button's initial enabled state
+         */
         enabled?: boolean;
 
         /**
-        * Define which button type the button should be based on
-        */
+         * Define which button type the button should be based on
+         */
         extend?: string;
 
         /**
-        * Initialisation function that can be used to add events specific to this button
-        */
+         * Initialisation function that can be used to add events specific to this button
+         */
         init?: FunctionButtonInit;
 
         /**
-        * Define an activation key for a button
-        */
+         * Define an activation key for a button
+         */
         key?: string | ButtonKey;
 
         /**
-        * Set a name for each selection
-        */
+         * Set a name for each selection
+         */
         name?: string;
 
         /**
-        * Unique namespace for every button
-        */
+         * Unique namespace for every button
+         */
         namespace?: string;
 
         /**
-        * The text to show in the button
-        */
-        text?: string | ButtonText;
+         * The text to show in the button
+         */
+        text?: string | FunctionButtonText;
 
         /**
-        * Button 'title' attribute text
-        */
+         * Button 'title' attribute text
+         */
         titleAttr?: string;
+    }
 
+    interface ButtonKey {
+        key?: string;
+        shiftKey?: boolean;
+        altKey?: boolean;
+        ctrlKey?: boolean;
+        metaKey?: boolean;
+    }
+
+    /**
+     * A function that will be executed upon creation of the buttons.
+     */
+    type FunctionButtom = (dt: Api) => ButtomSettingsCommon;
+
+    type FunctionButtonText = (dt: Api, node: JQuery, config: any) => string;
+
+    type FunctionButtonAvailable = (dt: Api, config: any) => boolean;
+
+    type FunctionButtonInit = (dt: Api, node: JQuery, config: any) => void;
+
+    type FunctionButtonAction = (e: any, dt: Api, node: JQuery, config: ButtonSettings) => void;
+
+    type FunctionButtonCustomize = (win: Window|string) => void;
+
+    type FunctionExtButtonsCollectionText = (a: any) => string;
+
+    interface ExtButtonsSettings {
+        collection: ExtButtonsCollectionSettings;
+    }
+
+    interface ExtButtonsCollectionSettings {
+        action: FunctionButtonAction;
+        autoClose: boolean;
+        background: boolean;
+        backgroundClassName: string;
+        className: string;
+        collectionLayout: string;
+        fade: number;
+        text: FunctionExtButtonsCollectionText;
+    }
+
+    //#endregion "Button Defaults"
+
+    //#region "Add-Ons"
+
+    /**
+     * Buttons extension options
+     */
+    interface ButtonSettings extends ButtomSettingsCommon {
+        //#region (HTML-)File-Export
+
         /**
-         * Button 'title' text
+         * CSV / EXCEL: Define what the exported filename should be
          */
+        filename?: string;
+
+        /**
+         * COPY / CSV: field separator
+         */
+        fieldSeparator?: string;
+
+        /**
+         * COPY / CSV: field boundary
+         */
+        fieldBoundary?: string;
+
+        /**
+         * COPY / CSV: field separator
+         */
+        newLine?: string;
+
+        /**
+         * CSV / EXCEL / PDF: file extension
+         */
+        extension?: string;
+
+        /**
+         * CSV: UTF-8 boom
+         */
+        bom?: boolean;
+
+        /**
+         * CSV: charset
+         */
+        charset?: string|boolean;
+
+        /**
+         * CSV: escape char
+         */
+        escapeChar?: string;
+
+        /**
+         * EXCEL
+         */
+        customizeData?: FunctionButtonCustomizeData;
+
+        /**
+         * PDF: portrait / landscape
+         */
+        orientation?: string;
+
+        /**
+         * PDF: A3 / A4 / A5 / LEGAL / LETTER / TABLOID
+         */
+        pageSize?: string;
+
+        //#endregion (HTML-)File-Export
+
+        //#region Export and Print
+
+        /**
+         * COPY / CSV / EXCEL / PDF / PRINT: show header
+         */
+        exportOptions?: ButtonExportOptions | object;
+
+        /**
+         * COPY / CSV / EXCEL / PDF / PRINT: show header
+         */
+        customize?: FunctionButtonCustomize;
+
+        /**
+         * COPY / CSV / EXCEL / PDF / PRINT: show header
+         */
+        header?: boolean;
+
+        /**
+         * COPY / CSV / EXCEL / PDF / PRINT: show footer
+         */
+        footer?: boolean;
+
+        /**
+         * COPY / PRINT: title
+         */
         title?: string;
 
         /**
-         * Define what the exported filename should be
+         * COPY / EXCEL / PDF / PRINT: field separator
          */
-        filename?: string;
+        messageTop?: string;
 
-        exportOptions?: ButtonExportOptions;
+        /**
+         * COPY / EXCEL / PDF / PRINT: field separator
+         */
+        messageBottom?: string;
+
+        /**
+         * PDF / PRINT: Extra message
+         */
+        message?: string|Api|JQuery|object;
+
+        /**
+         * PRINT: Show print dialoge on click
+         */
         autoPrint?: boolean;
-        customize?: FunctionButtonCustomize;
+
+        //#endregion Export and Print
+
+        //#region ColVis
+
+        /**
+         * COLVIS: Column selector
+         */
+        columns?: any;
+
+        /**
+         * COLVIS:
+         */
+        columnText?: FunctionButtonColvisColumnText;
+
+        //#endregion ColVis
     }
 
-    export interface FunctionButtonAvailable {
-        (dt: DataTables.Api, config: any): boolean
-    }
-    export interface ButtonExportOptions {
+    interface ButtonExportOptions {
         columns?: string | number | string[] | number[];
     }
 
-    export interface ButtonKey {
-        key?: string;
-        shiftKey?: boolean;
-        altKey?: boolean;
-        ctrlKey?: boolean;
-        metaKey?: boolean;
-    }
+    type FunctionButtonCustomizeData = (content: any) => void;
 
-    export interface ButtonText {
-        (dt: DataTables.Api, node: JQuery, config: any): string
-    }
-    export interface FunctionButtonInit {
-        (dt: DataTables.Api, node: JQuery, config: any): void
-    }
-    // api object?
-    export interface FunctionButtonAction {
-        (e: any, dt: DataTables.Api, node: JQuery, config: any): void
-    }
+    type FunctionButtonColvisColumnText = (dt: Api, i: number, title: string) => string;
 
-    export interface FunctionButtonCustomize {
-        (win: Window): void
-    }
     //#endregion "button-settings
 }

datatables.net-buttons/package.json

 {
     "name": "@types/datatables.net-buttons",
-    "version": "1.1.4",
+    "version": "1.4.0",
     "description": "TypeScript definitions for JQuery DataTables Buttons extension",
@@ -8,2 +8,7 @@ "license": "MIT",
         {
+            "name": "Kiarash Ghiaseddin",
+            "url": "https://github.com/Silver-Connection",
+            "githubUsername": "Silver-Connection"
+        },
+        {
             "name": "Sam Germano",
@@ -29,4 +34,4 @@ "url": "https://github.com/SammyG4Free",
     },
-    "typesPublisherContentHash": "8a42aa8a7c149297f955a061829252084d5279b4b7b01829bf9ad27073db812f",
-    "typeScriptVersion": "2.3"
+    "typesPublisherContentHash": "5daddc8fc7bf453f9984caa6b8a980bd0c60a6a1f8e766c4ed3219ab3bd7c1f7",
+    "typeScriptVersion": "2.4"
 }

datatables.net-buttons/README.md

@@ -11,3 +11,3 @@ # Installation
 Additional Details
- * Last updated: Thu, 07 Sep 2017 22:03:13 GMT
+ * Last updated: Wed, 25 Oct 2017 00:19:45 GMT
  * Dependencies: jquery, datatables.net
@@ -17,2 +17,2 @@ * Global values: none
 # Credits
-These definitions were written by Sam Germano <https://github.com/SammyG4Free>, Jim Hartford <https://github.com/jimhartford>.
+These definitions were written by Kiarash Ghiaseddin <https://github.com/Silver-Connection>, Sam Germano <https://github.com/SammyG4Free>, Jim Hartford <https://github.com/jimhartford>.

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

14301

increased by142.72%

Lines of code

357

increased by233.64%

Worsened metrics

Number of medium supply chain risk alerts

1

increased byInfinity%

No dependency changes