dattatable 0.8.8 → 0.9.2

package/README.md

@@ -1,2 +1,36 @@
-# Datta Table
-This is a basic solution displaying data stored in a SharePoint list in a table using the datatables.net library.
+# DattaTable Library
+
+This library will help generate a dashboard or an interactive [datatables.net](https://datatables.net/) table referencing data from a SharePoint list.
+
+## Supported Environments
+
+* SharePoint On-Premise Environments 2013+
+* SharePoint Online (Classic/Modern)
+
+## How to Use
+
+Follow this [code walkthrough](https://github.com/gunjandatta/sp-dashboard/wiki) to build a basic example of this solution.
+
+## [Documentation](https://datta-framework.github.io/dattatable/)
+
+### Common Methods
+
+* [formatDateTimeValue](https://datta-framework.github.io/dattatable/modules.html#formatDateTimeValue)
+* [formatDateValue](https://datta-framework.github.io/dattatable/modules.html#formatDateValue)
+
+### Components
+
+* [Canvas Form](https://datta-framework.github.io/dattatable/classes/CanvasForm.html)
+* [Dashboard](https://datta-framework.github.io/dattatable/classes/Dashboard.html)
+* [Installation Required](https://datta-framework.github.io/dattatable/classes/InstallationRequired.html)
+* [Item Form](https://datta-framework.github.io/dattatable/classes/ItemForm.html)
+* [Loading Dialog](https://datta-framework.github.io/dattatable/classes/LoadingDialog.html)
+* [Modal](https://datta-framework.github.io/dattatable/classes/Modal.html)
+
+### Dashboard Components
+
+* [DataTable](https://datta-framework.github.io/dattatable/classes/DataTable.html)
+* [FilterSlideout](https://datta-framework.github.io/dattatable/classes/FilterSlideout.html)
+* [Footer](https://datta-framework.github.io/dattatable/classes/Footer.html)
+* [Header](https://datta-framework.github.io/dattatable/classes/Header.html)
+* [Navigation](https://datta-framework.github.io/dattatable/classes/Navigation.html)

package/build/common/canvas.d.ts

@@ -1,22 +1,20 @@
 /**
  * Canvas Form
  */
-declare class _CanvasForm {
-    private _canvas;
-    private _elBody;
-    get BodyElement(): HTMLElement;
-    private _elHeader;
-    get HeaderElement(): HTMLElement;
+export declare class CanvasForm {
+    private static _canvas;
+    private static _elBody;
+    static get BodyElement(): HTMLElement;
+    private static _elHeader;
+    static get HeaderElement(): HTMLElement;
     constructor();
-    clear(): void;
-    get el(): HTMLElement;
-    hide(): void;
-    private render;
-    setAutoClose(value: boolean): void;
-    setBody(content: any): void;
-    setHeader(content: any): void;
-    setType(type: any): void;
-    show(): void;
+    static clear(): void;
+    static get el(): HTMLElement;
+    static hide(): void;
+    private static render;
+    static setAutoClose(value: boolean): void;
+    static setBody(content: any): void;
+    static setHeader(content: any): void;
+    static setType(type: any): void;
+    static show(): void;
 }
-export declare const CanvasForm: _CanvasForm;
-export {};

package/build/common/canvas.js

@@ -5,43 +5,38 @@ var gd_sprest_bs_1 = require("gd-sprest-bs");
 /**
  * Canvas Form
  */
-var _CanvasForm = /** @class */ (function () {
+var CanvasForm = /** @class */ (function () {
     // Constructor
-    function _CanvasForm() {
-        this._canvas = null;
-        // Modal Body
-        this._elBody = null;
-        // Modal Header
-        this._elHeader = null;
+    function CanvasForm() {
         // Render the canvas
-        this.render();
+        CanvasForm.render();
     }
-    Object.defineProperty(_CanvasForm.prototype, "BodyElement", {
+    Object.defineProperty(CanvasForm, "BodyElement", {
         get: function () { return this._elBody; },
         enumerable: false,
         configurable: true
     });
-    Object.defineProperty(_CanvasForm.prototype, "HeaderElement", {
+    Object.defineProperty(CanvasForm, "HeaderElement", {
         get: function () { return this._elHeader; },
         enumerable: false,
         configurable: true
     });
     // Clears the canvas form
-    _CanvasForm.prototype.clear = function () {
+    CanvasForm.clear = function () {
         // Clear the header and body
         this.setHeader("");
         this.setBody("");
     };
-    Object.defineProperty(_CanvasForm.prototype, "el", {
+    Object.defineProperty(CanvasForm, "el", {
         // Element
         get: function () { return this._canvas.el; },
         enumerable: false,
         configurable: true
     });
     // Hides the canvas
-    _CanvasForm.prototype.hide = function () { this._canvas.hide(); };
+    CanvasForm.hide = function () { this._canvas.hide(); };
     // Renders the canvas
-    _CanvasForm.prototype.render = function () {
+    CanvasForm.render = function () {
         var _this = this;
         // Create the element
         var el = document.createElement("div");
@@ -73,9 +68,9 @@ var _CanvasForm = /** @class */ (function () {
         });
     };
     // Sets the auto close flag
-    _CanvasForm.prototype.setAutoClose = function (value) { this._canvas.setAutoClose(value); };
+    CanvasForm.setAutoClose = function (value) { this._canvas.setAutoClose(value); };
     // Sets the body
-    _CanvasForm.prototype.setBody = function (content) {
+    CanvasForm.setBody = function (content) {
         // Clear the body
         while (this._elBody.firstChild) {
             this._elBody.removeChild(this._elBody.firstChild);
@@ -94,7 +89,7 @@ var _CanvasForm = /** @class */ (function () {
         }
     };
     // Sets the header
-    _CanvasForm.prototype.setHeader = function (content) {
+    CanvasForm.setHeader = function (content) {
         // Clear the body
         while (this._elHeader.firstChild) {
             this._elHeader.removeChild(this._elHeader.firstChild);
@@ -113,9 +108,16 @@ var _CanvasForm = /** @class */ (function () {
         }
     };
     // Sets the modal type
-    _CanvasForm.prototype.setType = function (type) { this._canvas.setType(type); };
+    CanvasForm.setType = function (type) { this._canvas.setType(type); };
     // Shows the canvas
-    _CanvasForm.prototype.show = function () { this._canvas.show(); };
-    return _CanvasForm;
+    CanvasForm.show = function () { this._canvas.show(); };
+    CanvasForm._canvas = null;
+    // Modal Body
+    CanvasForm._elBody = null;
+    // Modal Header
+    CanvasForm._elHeader = null;
+    return CanvasForm;
 }());
-exports.CanvasForm = new _CanvasForm();
+exports.CanvasForm = CanvasForm;
+// Create an instance of the canvas form
+new CanvasForm();

package/build/common/installRequired.d.ts

@@ -3,12 +3,10 @@ import { Helper } from "gd-sprest-bs";
  * Installation Required
  * Checks the SharePoint configuration file to see if an install is required.
  */
-declare class _InstallationRequired {
-    private _cfg;
-    private _report;
-    private checkLists;
-    requiresInstall(cfg: Helper.ISPConfig): PromiseLike<boolean>;
-    showDialog(): void;
+export declare class InstallationRequired {
+    private static _cfg;
+    private static _report;
+    private static checkLists;
+    static requiresInstall(cfg: Helper.ISPConfig): PromiseLike<boolean>;
+    static showDialog(): void;
 }
-export declare const InstallationRequired: _InstallationRequired;
-export {};

package/build/common/installRequired.js

@@ -8,13 +8,11 @@ var modal_1 = require("./modal");
  * Installation Required
  * Checks the SharePoint configuration file to see if an install is required.
  */
-var _InstallationRequired = /** @class */ (function () {
-    function _InstallationRequired() {
-        this._cfg = null;
-        this._report = null;
+var InstallationRequired = /** @class */ (function () {
+    function InstallationRequired() {
     }
     // Checks the lists
-    _InstallationRequired.prototype.checkLists = function () {
+    InstallationRequired.checkLists = function () {
         var _this = this;
         // Return a promise
         return new Promise(function (resolve) {
@@ -65,7 +63,7 @@ var _InstallationRequired = /** @class */ (function () {
         });
     };
     // Checks the configuration to see if an installation is required
-    _InstallationRequired.prototype.requiresInstall = function (cfg) {
+    InstallationRequired.requiresInstall = function (cfg) {
         var _this = this;
         // Save the configuration
         this._cfg = cfg;
@@ -80,7 +78,7 @@ var _InstallationRequired = /** @class */ (function () {
             });
         });
     };
-    _InstallationRequired.prototype.showDialog = function () {
+    InstallationRequired.showDialog = function () {
         var _this = this;
         // Set the header
         modal_1.Modal.setHeader("Installation Required");
@@ -145,7 +143,7 @@ var _InstallationRequired = /** @class */ (function () {
                             type: gd_sprest_bs_1.Components.ButtonTypes.OutlinePrimary,
                             onClick: function () {
                                 // Refresh the page
-                                window.location.href = window.location.href;
+                                window.location.reload();
                             }
                         }
                     });
@@ -155,6 +153,8 @@ var _InstallationRequired = /** @class */ (function () {
         // Show the modal
         modal_1.Modal.show();
     };
-    return _InstallationRequired;
+    InstallationRequired._cfg = null;
+    InstallationRequired._report = null;
+    return InstallationRequired;
 }());
-exports.InstallationRequired = new _InstallationRequired();
+exports.InstallationRequired = InstallationRequired;

package/build/common/loadingDialog.d.ts

@@ -1,17 +1,16 @@
 /**
  * Loading Dialog
  */
-export declare class LoadingDialogModal {
-    private _el;
-    private _elBody;
-    private _elBackdrop;
-    private _elHeader;
+export declare class LoadingDialog {
+    private static _el;
+    private static _elBody;
+    private static _elBackdrop;
+    private static _elHeader;
     constructor();
-    get el(): HTMLElement;
-    hide(): void;
-    private render;
-    setBody(content: any): void;
-    setHeader(content: any): void;
-    show(): void;
+    static get el(): HTMLElement;
+    static hide(): void;
+    private static render;
+    static setBody(content: any): void;
+    static setHeader(content: any): void;
+    static show(): void;
 }
-export declare const LoadingDialog: LoadingDialogModal;

package/build/common/loadingDialog.js

@@ -1,34 +1,30 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.LoadingDialog = exports.LoadingDialogModal = void 0;
+exports.LoadingDialog = void 0;
 var gd_sprest_bs_1 = require("gd-sprest-bs");
 /**
  * Loading Dialog
  */
-var LoadingDialogModal = /** @class */ (function () {
+var LoadingDialog = /** @class */ (function () {
     // Constructor
-    function LoadingDialogModal() {
-        this._el = null;
-        this._elBody = null;
-        this._elBackdrop = null;
-        this._elHeader = null;
+    function LoadingDialog() {
         // Render the canvas
-        this.render();
+        LoadingDialog.render();
     }
-    Object.defineProperty(LoadingDialogModal.prototype, "el", {
+    Object.defineProperty(LoadingDialog, "el", {
         // Element
         get: function () { return this._el; },
         enumerable: false,
         configurable: true
     });
     // Hides the canvas
-    LoadingDialogModal.prototype.hide = function () {
+    LoadingDialog.hide = function () {
         // Update the display
         this._el.style.display = "none";
         this._elBackdrop.style.display = "none";
     };
     // Renders the canvas
-    LoadingDialogModal.prototype.render = function () {
+    LoadingDialog.render = function () {
         var _this = this;
         // Create the backdrop element
         this._elBackdrop = document.createElement("div");
@@ -75,7 +71,7 @@ var LoadingDialogModal = /** @class */ (function () {
         elMain.appendChild(this._elBody);
     };
     // Sets the body
-    LoadingDialogModal.prototype.setBody = function (content) {
+    LoadingDialog.setBody = function (content) {
         // Clear the body
         while (this._elBody.firstChild) {
             this._elBody.removeChild(this._elBody.firstChild);
@@ -94,7 +90,7 @@ var LoadingDialogModal = /** @class */ (function () {
         }
     };
     // Sets the header
-    LoadingDialogModal.prototype.setHeader = function (content) {
+    LoadingDialog.setHeader = function (content) {
         // Clear the body
         while (this._elHeader.firstChild) {
             this._elHeader.removeChild(this._elHeader.firstChild);
@@ -113,12 +109,17 @@ var LoadingDialogModal = /** @class */ (function () {
         }
     };
     // Shows the canvas
-    LoadingDialogModal.prototype.show = function () {
+    LoadingDialog.show = function () {
         // Update the display
         this._el.style.display = "";
         this._elBackdrop.style.display = "";
     };
-    return LoadingDialogModal;
+    LoadingDialog._el = null;
+    LoadingDialog._elBody = null;
+    LoadingDialog._elBackdrop = null;
+    LoadingDialog._elHeader = null;
+    return LoadingDialog;
 }());
-exports.LoadingDialogModal = LoadingDialogModal;
-exports.LoadingDialog = new LoadingDialogModal();
+exports.LoadingDialog = LoadingDialog;
+// Create an instance of the loading dialog
+new LoadingDialog();

package/build/common/modal.d.ts

@@ -1,26 +1,24 @@
 /**
  * Modal
  */
-declare class _Modal {
-    private _modal;
-    private _onCloseEvent;
-    private _elBody;
-    get BodyElement(): HTMLElement;
-    private _elFooter;
-    get FooterElement(): HTMLElement;
-    private _elHeader;
-    get HeaderElement(): HTMLElement;
+export declare class Modal {
+    private static _modal;
+    private static _onCloseEvent;
+    private static _elBody;
+    static get BodyElement(): HTMLElement;
+    private static _elFooter;
+    static get FooterElement(): HTMLElement;
+    private static _elHeader;
+    static get HeaderElement(): HTMLElement;
     constructor();
-    clear(): void;
-    hide(): void;
-    private render;
-    setAutoClose(value: boolean): void;
-    setBody(content: any): void;
-    setCloseEvent(event: any): void;
-    setFooter(content: any): void;
-    setHeader(content: any): void;
-    setType(type: any): void;
-    show(): void;
+    static clear(): void;
+    static hide(): void;
+    private static render;
+    static setAutoClose(value: boolean): void;
+    static setBody(content: any): void;
+    static setCloseEvent(event: any): void;
+    static setFooter(content: any): void;
+    static setHeader(content: any): void;
+    static setType(type: any): void;
+    static show(): void;
 }
-export declare const Modal: _Modal;
-export {};

package/build/common/modal.js

@@ -5,46 +5,38 @@ var gd_sprest_bs_1 = require("gd-sprest-bs");
 /**
  * Modal
  */
-var _Modal = /** @class */ (function () {
+var Modal = /** @class */ (function () {
     // Constructor
-    function _Modal() {
-        this._modal = null;
-        this._onCloseEvent = null;
-        // Modal Body
-        this._elBody = null;
-        // Modal Footer
-        this._elFooter = null;
-        // Modal Header
-        this._elHeader = null;
+    function Modal() {
         // Render the canvas
-        this.render();
+        Modal.render();
     }
-    Object.defineProperty(_Modal.prototype, "BodyElement", {
+    Object.defineProperty(Modal, "BodyElement", {
         get: function () { return this._elBody; },
         enumerable: false,
         configurable: true
     });
-    Object.defineProperty(_Modal.prototype, "FooterElement", {
+    Object.defineProperty(Modal, "FooterElement", {
         get: function () { return this._elFooter; },
         enumerable: false,
         configurable: true
     });
-    Object.defineProperty(_Modal.prototype, "HeaderElement", {
+    Object.defineProperty(Modal, "HeaderElement", {
         get: function () { return this._elHeader; },
         enumerable: false,
         configurable: true
     });
     // Clears the canvas form
-    _Modal.prototype.clear = function () {
+    Modal.clear = function () {
         // Clear the header, body and footer
         this.setHeader("");
         this.setBody("");
         this.setFooter("");
     };
     // Hides the modal
-    _Modal.prototype.hide = function () { this._modal.hide(); };
+    Modal.hide = function () { this._modal.hide(); };
     // Renders the canvas
-    _Modal.prototype.render = function () {
+    Modal.render = function () {
         var _this = this;
         // Create the element
         var el = document.createElement("div");
@@ -81,9 +73,9 @@ var _Modal = /** @class */ (function () {
         });
     };
     // Sets the auto close flag
-    _Modal.prototype.setAutoClose = function (value) { this._modal.setAutoClose(value); };
+    Modal.setAutoClose = function (value) { this._modal.setAutoClose(value); };
     // Sets the body
-    _Modal.prototype.setBody = function (content) {
+    Modal.setBody = function (content) {
         // Clear the body
         while (this._elBody.firstChild) {
             this._elBody.removeChild(this._elBody.firstChild);
@@ -102,9 +94,9 @@ var _Modal = /** @class */ (function () {
         }
     };
     // Sets the close event
-    _Modal.prototype.setCloseEvent = function (event) { this._onCloseEvent = event; };
+    Modal.setCloseEvent = function (event) { this._onCloseEvent = event; };
     // Sets the footer
-    _Modal.prototype.setFooter = function (content) {
+    Modal.setFooter = function (content) {
         // Clear the body
         while (this._elFooter.firstChild) {
             this._elFooter.removeChild(this._elFooter.firstChild);
@@ -123,7 +115,7 @@ var _Modal = /** @class */ (function () {
         }
     };
     // Sets the header
-    _Modal.prototype.setHeader = function (content) {
+    Modal.setHeader = function (content) {
         // Clear the body
         while (this._elHeader.firstChild) {
             this._elHeader.removeChild(this._elHeader.firstChild);
@@ -142,9 +134,19 @@ var _Modal = /** @class */ (function () {
         }
     };
     // Sets the modal type
-    _Modal.prototype.setType = function (type) { this._modal.setType(type); };
+    Modal.setType = function (type) { this._modal.setType(type); };
     // Shows the modal
-    _Modal.prototype.show = function () { this._modal.show(); };
-    return _Modal;
+    Modal.show = function () { this._modal.show(); };
+    Modal._modal = null;
+    Modal._onCloseEvent = null;
+    // Modal Body
+    Modal._elBody = null;
+    // Modal Footer
+    Modal._elFooter = null;
+    // Modal Header
+    Modal._elHeader = null;
+    return Modal;
 }());
-exports.Modal = new _Modal();
+exports.Modal = Modal;
+// Create an instance of the modal
+new Modal();