diff --git a/notNeededPackages.json b/notNeededPackages.json index fd6e664435..801e81c359 100644 --- a/notNeededPackages.json +++ b/notNeededPackages.json @@ -1662,6 +1662,12 @@ "sourceRepoURL": "https://github.com/griddlegriddle/griddle", "asOfVersion": "1.3.0" }, + { + "libraryName": "gridstack", + "typingsPackageName": "gridstack", + "sourceRepoURL": "https://github.com/gridstack/gridstack.js", + "asOfVersion": "0.5.2" + }, { "libraryName": "gulp-pug", "typingsPackageName": "gulp-pug", diff --git a/types/gridstack/gridstack-tests.ts b/types/gridstack/gridstack-tests.ts deleted file mode 100644 index 229a835396..0000000000 --- a/types/gridstack/gridstack-tests.ts +++ /dev/null @@ -1,21 +0,0 @@ -/// - -var options: GridstackOptions = { - float: true -}; -var element: JQuery = $(document).gridstack(options); -var gridstack: GridStack = $(document).data("gridstack"); -var gsFromElement: GridStack = element.data("gridstack"); - -if (gridstack !== gsFromElement) throw Error('These should match!'); - -gridstack.addWidget("test", 1, 2, 3, 4, true); -gridstack.addWidget(document.createElement('div'), 1, 2, 3, 4, true); -gridstack.addWidget($(document.createElement('div')), 1, 2, 3, 4, true); -gridstack.makeWidget($(document.createElement('div'))); -gridstack.batchUpdate(); -gridstack.cellHeight();; -gridstack.cellHeight(2); -gridstack.cellWidth(); -gridstack.getCellFromPixel({ left:20, top: 20 }); -gridstack.removeAll(false); diff --git a/types/gridstack/index.d.ts b/types/gridstack/index.d.ts deleted file mode 100644 index ac83ba6c3c..0000000000 --- a/types/gridstack/index.d.ts +++ /dev/null @@ -1,481 +0,0 @@ -// Type definitions for Gridstack 0.5 -// Project: http://gridstack.github.io/gridstack.js/ -// Definitions by: Pascal Senn -// Ricky Blankenaufulland -// Sl1MBoy -// John Archer -// Alain Dumesny -// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped -// TypeScript Version: 2.3 - -interface JQuery { - gridstack(options: GridstackOptions): JQuery; - data(key: 'gridstack'): GridStack; -} - -/* Other items in https://github.com/gridstack/gridstack.js/blob/develop/doc/README.md -* Grid attributes -* Item attributes -* Events -*/ - -type GridStackElement = string | HTMLElement | JQuery; - -interface GridStack { - /** - * Creates new widget and returns it. - * - * Widget will be always placed even if result height is more than actual grid height. - * You need to use willItFit method before calling addWidget for additional check. - * See also makeWidget. - * - * @example - * $('.grid-stack').gridstack(); - * var grid = $('.grid-stack').data('gridstack'); - * grid.addWidget(el, 0, 0, 3, 2, true); - * - * @param {GridStackElement} el widget to add - * @param {number} x widget position x (optional) - * @param {number} y widget position y (optional) - * @param {number} width widget dimension width (optional) - * @param {number} height widget dimension height (optional) - * @param {boolean} autoPosition if true then x, y parameters will be ignored and widget will be places on the first available position (optional) - * @param {number} minWidth minimum width allowed during resize/creation (optional) - * @param {number} maxWidth maximum width allowed during resize/creation (optional) - * @param {number} minHeight minimum height allowed during resize/creation (optional) - * @param {number} maxHeight maximum height allowed during resize/creation (optional) - * @param {number | string} id value for `data-gs-id` (optional) - */ - addWidget(el: GridStackElement, x?: number, y?: number, width?: number, height?: number, autoPosition?: boolean, - minWidth?: number, maxWidth?: number, minHeight?: number, maxHeight?: number, id?: number | string): JQuery; - - /** - * Initializes batch updates. You will see no changes until commit method is called. - */ - batchUpdate(): void; - - /** - * Gets current cell height. - */ - cellHeight(): number; - - /** - * Update current cell height - see `GridstackOptions.cellHeight` for format. - * This method rebuilds an internal CSS style sheet. - * Note: You can expect performance issues if call this method too often. - * - * @param {number | string} val the cell height - * @param {boolean} noUpdate (Optional) if true, styles will not be updated - * - * @example - * grid.cellHeight(grid.cellWidth() * 1.2); - */ - cellHeight(val: number | string, noUpdate?: boolean): void; - - /** - * Gets current cell width. - */ - cellWidth(): number; - - /** - * Finishes batch updates. Updates DOM nodes. You must call it after batchUpdate. - */ - commit(): void; - - /** - * Destroys a grid instance. - * @param {boolean} detachGrid if false nodes and grid will not be removed from the DOM (Optional. Default true). - */ - destroy(detachGrid?: boolean): void; - - /** - * Disables widgets moving/resizing. This is a shortcut for: - * @example - * grid.movable('.grid-stack-item', false); - * grid.resizable('.grid-stack-item', false); - */ - disable(): void; - - /** - * Enables widgets moving/resizing. This is a shortcut for: - * @example - * grid.movable('.grid-stack-item', true); - * grid.resizable('.grid-stack-item', true); - */ - enable(): void; - - /** - * Enables/disables widget moving. - * This is a shortcut for: - * @example - * grid.movable(this.container.children('.' + this.opts.itemClass), doEnable); - * - * @param {boolean} doEnable - * @param {boolean} includeNewWidgets will force new widgets to be draggable as per - * doEnable`s value by changing the disableDrag grid option. - */ - enableMove(doEnable: boolean, includeNewWidgets: boolean): void; - - /** - * Enables/disables widget resizing - * @param {boolean} doEnable - * @param {boolean} includeNewWidgets will force new widgets to be draggable as per - * doEnable`s value by changing the disableResize grid option. - * - * This is a shortcut for: - * @example - * grid.resizable(this.container.children('.' + this.opts.itemClass), doEnable); - */ - enableResize(doEnable: boolean, includeNewWidgets: boolean): void; - - /** - * Get the position of the cell under a pixel on screen. - * @param {MousePosition} position the position of the pixel to resolve in - * absolute coordinates, as an object with top and left properties - * @param {boolean} useOffset if true, value will be based on offset vs position (Optional. Default false). - * Useful when grid is within `position: relative` element - * - * Returns an object with properties `x` and `y` i.e. the column and row in the grid. - */ - getCellFromPixel(position: MousePosition, useOffset?: boolean): CellPosition; - - /** - * Checks if specified area is empty. - * @param {number} x the position x. - * @param {number} y the position y. - * @param {number} width the width of to check - * @param {number} height the height of to check - */ - isAreaEmpty(x: number, y: number, width: number, height: number): void; - - /** - * Locks/unlocks widget. - * @param {GridStackElement} el widget to modify. - * @param {boolean} val if true widget will be locked. - */ - locked(el: GridStackElement, val: boolean): void; - - /** - * If you add elements to your gridstack container by hand, you have to tell gridstack afterwards to make them widgets. - * If you want gridstack to add the elements for you, use addWidget instead. - * Makes the given element a widget and returns it. - * @param {GridStackElement} el widget to convert. - * - * @example - * $('.grid-stack').gridstack(); - * $('.grid-stack').append('
') - * var grid = $('.grid-stack').data('gridstack'); - * grid.makeWidget('gsi-1'); - */ - makeWidget(el: GridStackElement): JQuery; - - /** - * Set the maxWidth for a widget. - * @param {GridStackElement} el widget to modify. - * @param {number} val A numeric value of the number of columns - */ - maxWidth(el: GridStackElement, val: number): void; - - /** - * Set the minWidth for a widget. - * @param {GridStackElement} el widget to modify. - * @param {number} val A numeric value of the number of columns - */ - minWidth(el: GridStackElement, val: number): void; - - /** - * Set the maxHeight for a widget. - * @param {GridStackElement} el widget to modify. - * @param {number} val A numeric value of the number of rows - */ - maxHeight(el: GridStackElement, val: number): void; - - /** - * Set the minHeight for a widget. - * @param {GridStackElement} el widget to modify. - * @param {number} val A numeric value of the number of rows - */ - minHeight(el: GridStackElement, val: number): void; - - /** - * Enables/Disables moving. - * @param {GridStackElement} el widget to modify. - * @param {number} val if true widget will be draggable. - */ - movable(el: GridStackElement, val: boolean): void; - - /** - * Changes widget position - * @param {GridStackElement} el widget to modify - * @param {number} x new position x. If value is null or undefined it will be ignored. - * @param {number} y new position y. If value is null or undefined it will be ignored. - */ - move(el: GridStackElement, x: number, y: number): void; - - /** - * Removes widget from the grid. - * @param {GridStackElement} el widget to modify - * @param {boolean} detachNode if false DOM node won't be removed from the tree (Default? true). - */ - removeWidget(el: GridStackElement, detachNode?: boolean): void; - - /** - * Removes all widgets from the grid. - * @param {boolean} detachNode if false DOM nodes won't be removed from the tree (Default? true). - */ - removeAll(detachNode?: boolean): void; - - /** - * Changes widget size - * @param {GridStackElement} el widget to modify - * @param {number} width new dimensions width. If value is null or undefined it will be ignored. - * @param {number} height new dimensions height. If value is null or undefined it will be ignored. - */ - resize(el: GridStackElement, width: number, height: number): void; - - /** - * Enables/Disables resizing. - * @param {GridStackElement} el widget to modify - * @param {boolean} val if true widget will be resizable. - */ - resizable(el: GridStackElement, val: boolean): void; - - /** - * Toggle the grid animation state. Toggles the `grid-stack-animate` class. - * @param {boolean} doAnimate if true the grid will animate. - */ - setAnimation(doAnimate: boolean): void; - - /** - * (Experimental) Modify number of columns in the grid. Will attempt to update existing widgets - * to conform to new number of columns. Requires `gridstack-extra.css` or `gridstack-extra.min.css`. - * @param {number} gridWidth - Integer between 1 and 12. - * @param {boolean} doNotPropagate if true existing widgets will not be updated. - */ - setGridWidth(gridWidth: number, doNotPropagate: boolean): void; - - /** - * Toggle the grid static state. Also toggle the grid-stack-static class. - * @param {boolean} staticValue if true the grid become static. - */ - setStatic(staticValue: boolean): void; - - /** - * Updates widget position/size. - * @param {GridStackElement} el widget to modify - * @param {number} x new position x. If value is null or undefined it will be ignored. - * @param {number} y new position y. If value is null or undefined it will be ignored. - * @param {number} width new dimensions width. If value is null or undefined it will be ignored. - * @param {number} height new dimensions height. If value is null or undefined it will be ignored. - */ - update(el: GridStackElement, x: number, y: number, width: number, height: number): void; - - /** - * returns current vertical margin value - */ - verticalMargin(): number; - - /** - * Updates the vertical margin - see `GridstackOptions.verticalMargin` for format options. - * - * @param {number | string} value new vertical margin value - * @param {boolean} noUpdate (optional) if true, styles will not be updated - */ - verticalMargin(value: number | string, noUpdate?: boolean): void; - - /** - * Returns true if the height of the grid will be less the vertical - * constraint. Always returns true if grid doesn't have height constraint. - * @param {number} x new position x. If value is null or undefined it will be ignored. - * @param {number} y new position y. If value is null or undefined it will be ignored. - * @param {number} width new dimensions width. If value is null or undefined it will be ignored. - * @param {number} height new dimensions height. If value is null or undefined it will be ignored. - * @param {boolean} autoPosition if true then x, y parameters will be ignored and widget - * will be places on the first available position - * - * @example - * if (grid.willItFit(newNode.x, newNode.y, newNode.width, newNode.height, true)) { - * grid.addWidget(newNode.el, newNode.x, newNode.y, newNode.width, newNode.height, true); - * } else { - * alert('Not enough free space to place the widget'); - * } - */ - willItFit(x: number, y: number, width: number, height: number, autoPosition: boolean): boolean; -} - -/** - * Defines the coordinates of an object - */ -interface MousePosition { - top: number; - left: number; -} - -/** - * Defines the position of a cell inside the grid - */ -interface CellPosition { - x: number; - y: number; -} - -declare namespace GridStackUI { - interface Utils { - /** - * Sorts array of nodes - * @param nodes array to sort - * @param dir 1 for asc, -1 for desc (optional) - * @param width width of the grid. If undefined the width will be calculated automatically (optional). - **/ - sort(nodes: HTMLElement[], dir?: number, width?: number): void; - } -} - -/** - * Gridstack Options - * Defines the options for a Gridstack - */ -interface GridstackOptions { - /** - * if true of jquery selector the grid will accept widgets dragged from other grids or from - * outside (default: false) See [example](http://gridstack.github.io/gridstack.js/demo/two.html) - */ - acceptWidgets?: boolean | string | ((i: number, element: Element) => boolean | string); - - /** - * if true the resizing handles are shown even if the user is not hovering over the widget (default?: false) - */ - alwaysShowResizeHandle?: boolean; - - /** - * turns animation on (default?: true) - */ - animate?: boolean; - - /** - * if false gridstack will not initialize existing items (default?: true) - */ - auto?: boolean; - - /** - * one cell height (default?: 60). Can be: - * an integer (px) - * a string (ex: '10em', '100px', '10rem') - * 0 or null, in which case the library will not generate styles for rows. Everything must be defined in CSS files. - * 'auto' - height will be calculated from cell width. - */ - cellHeight?: number | string; - - /** - * (internal?) unit for cellHeight (default? 'px') - */ - cellHeightUnit?: string; - - /** class that implement drag'n'drop functionality for gridstack. If false grid will be static. - * (default?: null - first available plugin will be used) - */ - ddPlugin?: boolean | null | any; - - /** disallows dragging of widgets (default?: false) */ - disableDrag?: boolean; - - /** disallows resizing of widgets (default?: false). */ - disableResize?: boolean; - - /** - * allows to override jQuery UI draggable options. (default?: { handle?: '.grid-stack-item-content', scroll?: true, appendTo?: 'body' }) - */ - draggable?: {}; - - /** - * draggable handle selector (default?: '.grid-stack-item-content') - */ - handle?: string; - - /** draggable handle class (e.g. 'grid-stack-item-content'). If set 'handle' is ignored (default?: null) */ - handleClass?: string; - - /** - * maximum rows amount. Default? is 0 which means no maximum rows - */ - height?: number; - - /** - * enable floating widgets (default?: false) See example (http://gridstack.github.io/gridstack.js/demo/float.html) - */ - float?: boolean; - - /** - * widget class (default?: 'grid-stack-item') - */ - itemClass?: string; - - /** - * minimal width. If window width is less, grid will be shown in one - column mode (default?: 768) - */ - minWidth?: number; - - /** disables the onColumnMode when the window width is less than minWidth (default?: false) */ - disableOneColumnMode?: boolean; - - /** - * class set on grid when in one column mode (default?: 'grid-stack-one-column-mode') - */ - oneColumnModeClass?: string; - - /** - * class for placeholder (default?: 'grid-stack-placeholder') - */ - placeholderClass?: string; - - /** placeholder default content (default?: '') */ - placeholderText?: string; - - /** - * allows to override jQuery UI resizable options. (default?: { autoHide?: true, handles?: 'se' }) - */ - resizable?: {}; - - /** - * if true widgets could be removed by dragging outside of the grid. It could also be a jQuery selector string, - * in this case widgets will be removed by dropping them there (default?: false) - * See example (http://gridstack.github.io/gridstack.js/demo/two.html) - */ - removable?: boolean | string; - - /** - * time in milliseconds before widget is being removed while dragging outside of the grid. (default?: 2000) - */ - removeTimeout?: number; - - /** - * if true turns grid to RTL. Possible values are true, false, 'auto' (default?: 'auto') - * See [example](http://gridstack.github.io/gridstack.js/demo/rtl.html) - */ - rtl?: boolean | 'auto'; - - /** - * makes grid static (default?: false).If true widgets are not movable/resizable. - * You don't even need jQueryUI draggable/resizable. A CSS class - * 'grid-stack-static' is also added to the container. - */ - staticGrid?: boolean; - - /** - * vertical gap size (default?: 20). Can be: - * an integer (px) - * a string (ex: '2em', '20px', '2rem') - */ - verticalMargin?: number | string; - - /** - * (internal?) unit for verticalMargin (default? 'px') - */ - verticalMarginUnit?: string; - - /** - * number of columns (default?: 12) - */ - width?: number; -} diff --git a/types/gridstack/tsconfig.json b/types/gridstack/tsconfig.json deleted file mode 100644 index 1e4548ab3a..0000000000 --- a/types/gridstack/tsconfig.json +++ /dev/null @@ -1,24 +0,0 @@ -{ - "compilerOptions": { - "module": "commonjs", - "lib": [ - "es6", - "dom" - ], - "noImplicitAny": true, - "noImplicitThis": true, - "strictNullChecks": false, - "strictFunctionTypes": true, - "baseUrl": "../", - "typeRoots": [ - "../" - ], - "types": [], - "noEmit": true, - "forceConsistentCasingInFileNames": true - }, - "files": [ - "index.d.ts", - "gridstack-tests.ts" - ] -} \ No newline at end of file diff --git a/types/gridstack/tslint.json b/types/gridstack/tslint.json deleted file mode 100644 index 9b94e51bd7..0000000000 --- a/types/gridstack/tslint.json +++ /dev/null @@ -1,80 +0,0 @@ -{ - "extends": "dtslint/dt.json", - "rules": { - "adjacent-overload-signatures": false, - "array-type": false, - "arrow-return-shorthand": false, - "ban-types": false, - "callable-types": false, - "comment-format": false, - "npm-naming": false, - "eofline": false, - "export-just-namespace": false, - "import-spacing": false, - "interface-name": false, - "interface-over-type-literal": false, - "jsdoc-format": false, - "max-line-length": false, - "member-access": false, - "new-parens": false, - "no-any-union": false, - "no-boolean-literal-compare": false, - "no-conditional-assignment": false, - "no-consecutive-blank-lines": false, - "no-construct": false, - "no-declare-current-package": false, - "no-duplicate-imports": false, - "no-duplicate-variable": false, - "no-empty-interface": false, - "no-for-in-array": false, - "no-inferrable-types": false, - "no-internal-module": false, - "no-irregular-whitespace": false, - "no-mergeable-namespace": false, - "no-misused-new": false, - "no-namespace": false, - "no-object-literal-type-assertion": false, - "no-padding": false, - "no-redundant-jsdoc": false, - "no-redundant-jsdoc-2": false, - "no-redundant-undefined": false, - "no-reference-import": false, - "no-relative-import-in-test": false, - "no-self-import": false, - "no-single-declare-module": false, - "no-string-throw": false, - "no-unnecessary-callback-wrapper": false, - "no-unnecessary-class": false, - "no-unnecessary-generics": false, - "no-unnecessary-qualifier": false, - "no-unnecessary-type-assertion": false, - "no-useless-files": false, - "no-var-keyword": false, - "no-var-requires": false, - "no-void-expression": false, - "no-trailing-whitespace": false, - "object-literal-key-quotes": false, - "object-literal-shorthand": false, - "one-line": false, - "one-variable-per-declaration": false, - "only-arrow-functions": false, - "prefer-conditional-expression": false, - "prefer-const": false, - "prefer-declare-function": false, - "prefer-for-of": false, - "prefer-method-signature": false, - "prefer-template": false, - "radix": false, - "semicolon": false, - "space-before-function-paren": false, - "space-within-parens": false, - "strict-export-declare-modifiers": false, - "trim-file": false, - "triple-equals": false, - "typedef-whitespace": false, - "unified-signatures": false, - "void-return": false, - "whitespace": false, - "no-angle-bracket-type-assertion": false - } -}