Skip to content

Commit 1cf3b10

Browse files
author
Alain Dumesny
authored
Merge pull request #1048 from adumesny/feature/TS
Feature/ts
2 parents 1c3f50b + 9dd08e5 commit 1cf3b10

File tree

1 file changed

+14
-14
lines changed

1 file changed

+14
-14
lines changed

src/gridstack.d.ts

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
1-
// Type definitions for Gridstack 0.5
2-
// Project: http://gridstack.github.io/gridstack.js/
1+
// Type definitions for Gridstack 0.5.2
2+
// Project: https://gridstackjs.com/
33
// Definitions by: Pascal Senn <https://github.com/PascalSenn>
44
// Ricky Blankenaufulland <https://github.com/ZoolWay>
55
// Sl1MBoy <https://github.com/Sl1MBoy>
66
// John Archer <https://github.com/JohnArcher>
77
// Alain Dumesny <https://github.com/adumesny>
8-
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
9-
// TypeScript Version: 2.3
8+
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped initially, but now part of gridstack.js
9+
// TypeScript Version: 2.8
1010

1111
interface JQuery {
1212
gridstack(options: GridstackOptions): JQuery;
@@ -336,27 +336,27 @@ interface CellPosition {
336336

337337
/**
338338
* Gridstack Widget creation options
339+
* @param {number} x widget position x (default?: 0)
340+
* @param {number} y widget position y (default?: 0)
341+
* @param {number} width widget dimension width (default?: 1)
342+
* @param {number} height widget dimension height (default?: 1)
343+
* @param {boolean} autoPosition if true then x, y parameters will be ignored and widget will be places on the first available position (default?: false)
344+
* @param {number} minWidth minimum width allowed during resize/creation (default?: undefined = un-constrained)
345+
* @param {number} maxWidth maximum width allowed during resize/creation (default?: undefined = un-constrained)
346+
* @param {number} minHeight minimum height allowed during resize/creation (default?: undefined = un-constrained)
347+
* @param {number} maxHeight maximum height allowed during resize/creation (default?: undefined = un-constrained)
348+
* @param {number | string} id value for `data-gs-id` stored on the widget (default?: undefined)
339349
*/
340350
interface GridstackWidget {
341-
/** x position (default?: 0) */
342351
x?: number;
343-
/** y position (default?: 0) */
344352
y?: number;
345-
/** width (default?: 1) */
346353
width?: number;
347-
/** height (default?: 1) */
348354
height?: number;
349-
/** autoPosition if true then x, y parameters will be ignored and widget will be places on the first available position (default?: false) */
350355
autoPosition?: boolean;
351-
/** minimum width allowed during resize/creation (default?: undefined = un-constrained) */
352356
minWidth?: number;
353-
/** maximum width allowed during resize/creation (default?: undefined = un-constrained) */
354357
maxWidth?: number;
355-
/** minimum height allowed during resize/creation (default?: undefined = un-constrained) */
356358
minHeight?: number;
357-
/** maximum height allowed during resize/creation (default?: undefined = un-constrained) */
358359
maxHeight?: number;
359-
/** id value for `data-gs-id` stored on the widget (default?: undefined)*/
360360
id?: number | string;
361361
}
362362

0 commit comments

Comments
 (0)