gridstack 12.0.0 → 12.1.0

package/dist/es5/types.d.ts

@@ -1,326 +0,0 @@
-/**
- * types.ts 12.0.0
- * Copyright (c) 2021-2024 Alain Dumesny - see GridStack root license
- */
-import { GridStack } from './gridstack';
-import { GridStackEngine } from './gridstack-engine';
-export declare const gridDefaults: GridStackOptions;
-/**
- * different layout options when changing # of columns, including a custom function that takes new/old column count, and array of new/old positions
- * Note: new list may be partially already filled if we have a cache of the layout at that size and new items were added later.
- * Options are:
- * 'list' - treat items as sorted list, keeping items (un-sized unless too big for column count) sequentially reflowing them
- * 'compact' - similar to list, but using compact() method which will possibly re-order items if an empty slots are available due to a larger item needing to be pushed to next row
- * 'moveScale' - will scale and move items by the ratio new newColumnCount / oldColumnCount
- * 'move' | 'scale' - will only size or move items
- * 'none' will leave items unchanged, unless they don't fit in column count
- */
-export type ColumnOptions = 'list' | 'compact' | 'moveScale' | 'move' | 'scale' | 'none' | ((column: number, oldColumn: number, nodes: GridStackNode[], oldNodes: GridStackNode[]) => void);
-export type CompactOptions = 'list' | 'compact';
-export type numberOrString = number | string;
-export interface GridItemHTMLElement extends HTMLElement {
-    /** pointer to grid node instance */
-    gridstackNode?: GridStackNode;
-}
-export type GridStackElement = string | HTMLElement | GridItemHTMLElement;
-/** specific and general event handlers for the .on() method */
-export type GridStackEventHandler = (event: Event) => void;
-export type GridStackElementHandler = (event: Event, el: GridItemHTMLElement) => void;
-export type GridStackNodesHandler = (event: Event, nodes: GridStackNode[]) => void;
-export type GridStackDroppedHandler = (event: Event, previousNode: GridStackNode, newNode: GridStackNode) => void;
-export type GridStackEventHandlerCallback = GridStackEventHandler | GridStackElementHandler | GridStackNodesHandler | GridStackDroppedHandler;
-/** optional function called during load() to callback the user on new added/remove grid items | grids */
-export type AddRemoveFcn = (parent: HTMLElement, w: GridStackWidget, add: boolean, grid: boolean) => HTMLElement | undefined;
-/** optional function called during save() to let the caller add additional custom data to the GridStackWidget structure that will get returned */
-export type SaveFcn = (node: GridStackNode, w: GridStackWidget) => void;
-/** optional function called during load()/addWidget() to let the caller create custom content other than plan text */
-export type RenderFcn = (el: HTMLElement, w: GridStackWidget) => void;
-export type ResizeToContentFcn = (el: GridItemHTMLElement) => void;
-/** describes the responsive nature of the grid. NOTE: make sure to have correct extra CSS to support this. */
-export interface Responsive {
-    /** wanted width to maintain (+-50%) to dynamically pick a column count. NOTE: make sure to have correct extra CSS to support this. */
-    columnWidth?: number;
-    /** maximum number of columns allowed (default: 12). NOTE: make sure to have correct extra CSS to support this. */
-    columnMax?: number;
-    /** explicit width:column breakpoints instead of automatic 'columnWidth'. NOTE: make sure to have correct extra CSS to support this. */
-    breakpoints?: Breakpoint[];
-    /** specify if breakpoints are for window size or grid size (default:false = grid) */
-    breakpointForWindow?: boolean;
-    /** global re-layout mode when changing columns */
-    layout?: ColumnOptions;
-}
-export interface Breakpoint {
-    /** <= width for the breakpoint to trigger */
-    w?: number;
-    /** column count */
-    c: number;
-    /** re-layout mode if different from global one */
-    layout?: ColumnOptions;
-}
-/**
- * Defines the options for a Grid
- */
-export interface GridStackOptions {
-    /**
-     * accept widgets dragged from other grids or from outside (default: `false`). Can be:
-     * `true` (uses `'.grid-stack-item'` class filter) or `false`,
-     * string for explicit class name,
-     * function returning a boolean. See [example](http://gridstack.github.io/gridstack.js/demo/two.html)
-     */
-    acceptWidgets?: boolean | string | ((element: Element) => boolean);
-    /** possible values (default: `mobile`) - does not apply to non-resizable widgets
-      * `false` the resizing handles are only shown while hovering over a widget
-      * `true` the resizing handles are always shown
-      * 'mobile' if running on a mobile device, default to `true` (since there is no hovering per say), else `false`.
-      See [example](http://gridstack.github.io/gridstack.js/demo/mobile.html) */
-    alwaysShowResizeHandle?: true | false | 'mobile';
-    /** turns animation on (default?: true) */
-    animate?: boolean;
-    /** if false gridstack will not initialize existing items (default?: true) */
-    auto?: boolean;
-    /**
-     * one cell height (default?: 'auto'). Can be:
-     *  an integer (px)
-     *  a string (ex: '100px', '10em', '10rem'). Note: % doesn't work right - see demo/cell-height.html
-     *  0, in which case the library will not generate styles for rows. Everything must be defined in your own CSS files.
-     *  'auto' - height will be calculated for square cells (width / column) and updated live as you resize the window - also see `cellHeightThrottle`
-     *  'initial' - similar to 'auto' (start at square cells) but stay that size during window resizing.
-     */
-    cellHeight?: numberOrString;
-    /** throttle time delay (in ms) used when cellHeight='auto' to improve performance vs usability (default?: 100).
-     * A value of 0 will make it instant at a cost of re-creating the CSS file at ever window resize event!
-     * */
-    cellHeightThrottle?: number;
-    /** (internal) unit for cellHeight (default? 'px') which is set when a string cellHeight with a unit is passed (ex: '10rem') */
-    cellHeightUnit?: string;
-    /** list of children item to create when calling load() or addGrid() */
-    children?: GridStackWidget[];
-    /** number of columns (default?: 12). Note: IF you change this, CSS also have to change. See https://github.com/gridstack/gridstack.js#change-grid-columns.
-     * Note: for nested grids, it is recommended to use 'auto' which will always match the container grid-item current width (in column) to keep inside and outside
-     * items always the same. flag is NOT supported for regular non-nested grids.
-     */
-    column?: number | 'auto';
-    /** responsive column layout for width:column behavior */
-    columnOpts?: Responsive;
-    /** additional class on top of '.grid-stack' (which is required for our CSS) to differentiate this instance.
-    Note: only used by addGrid(), else your element should have the needed class */
-    class?: string;
-    /** disallows dragging of widgets (default?: false) */
-    disableDrag?: boolean;
-    /** disallows resizing of widgets (default?: false). */
-    disableResize?: boolean;
-    /** allows to override UI draggable options. (default?: { handle?: '.grid-stack-item-content', appendTo?: 'body' }) */
-    draggable?: DDDragOpt;
-    /** let user drag nested grid items out of a parent or not (default true - not supported yet) */
-    /** the type of engine to create (so you can subclass) default to GridStackEngine */
-    engineClass?: typeof GridStackEngine;
-    /** enable floating widgets (default?: false) See example (http://gridstack.github.io/gridstack.js/demo/float.html) */
-    float?: boolean;
-    /** 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;
-    /** additional widget class (default?: 'grid-stack-item') */
-    itemClass?: string;
-    /** re-layout mode when we're a subgrid and we are being resized. default to 'list' */
-    layout?: ColumnOptions;
-    /** true when widgets are only created when they scroll into view (visible) */
-    lazyLoad?: boolean;
-    /**
-     * gap between grid item and content (default?: 10). This will set all 4 sides and support the CSS formats below
-     *  an integer (px)
-     *  a string with possible units (ex: '2em', '20px', '2rem')
-     *  string with space separated values (ex: '5px 10px 0 20px' for all 4 sides, or '5em 10em' for top/bottom and left/right pairs like CSS).
-     * Note: all sides must have same units (last one wins, default px)
-     */
-    margin?: numberOrString;
-    /** OLD way to optionally set each side - use margin: '5px 10px 0 20px' instead. Used internally to store each side. */
-    marginTop?: numberOrString;
-    marginRight?: numberOrString;
-    marginBottom?: numberOrString;
-    marginLeft?: numberOrString;
-    /** (internal) unit for margin (default? 'px') set when `margin` is set as string with unit (ex: 2rem') */
-    marginUnit?: string;
-    /** maximum rows amount. Default? is 0 which means no maximum rows */
-    maxRow?: number;
-    /** minimum rows amount. Default is `0`. You can also do this with `min-height` CSS attribute
-     * on the grid div in pixels, which will round to the closest row.
-     */
-    minRow?: number;
-    /** If you are using a nonce-based Content Security Policy, pass your nonce here and
-     * GridStack will add it to the <style> elements it creates. */
-    nonce?: string;
-    /** class for placeholder (default?: 'grid-stack-placeholder') */
-    placeholderClass?: string;
-    /** placeholder default content (default?: '') */
-    placeholderText?: string;
-    /** allows to override UI resizable options. (default?: { handles: 'se' }) */
-    resizable?: DDResizeOpt;
-    /**
-     * if true widgets could be removed by dragging outside of the grid. It could also be a selector string (ex: ".trash"),
-     * 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;
-    /** allows to override UI removable options. (default?: { accept: '.grid-stack-item' }) */
-    removableOptions?: DDRemoveOpt;
-    /** fix grid number of rows. This is a shortcut of writing `minRow:N, maxRow:N`. (default `0` no constrain) */
-    row?: number;
-    /**
-     * if true turns grid to RTL. Possible values are true, false, 'auto' (default?: 'auto')
-     * See [example](http://gridstack.github.io/gridstack.js/demo/right-to-left(rtl).html)
-     */
-    rtl?: boolean | 'auto';
-    /** set to true if all grid items (by default, but item can also override) height should be based on content size instead of WidgetItem.h to avoid v-scrollbars.
-     * Note: this is still row based, not pixels, so it will use ceil(getBoundingClientRect().height / getCellHeight())
-     */
-    sizeToContent?: boolean;
-    /**
-     * makes grid static (default?: false). If `true` widgets are not movable/resizable.
-     * You don't even need draggable/resizable. A CSS class
-     * 'grid-stack-static' is also added to the element.
-     */
-    staticGrid?: boolean;
-    /**
-     * @deprecated Not used anymore, styles are now implemented with local CSS variables
-     */
-    styleInHead?: boolean;
-    /** list of differences in options for automatically created sub-grids under us (inside our grid-items) */
-    subGridOpts?: GridStackOptions;
-    /** enable/disable the creation of sub-grids on the fly by dragging items completely
-     * over others (nest) vs partially (push). Forces `DDDragOpt.pause=true` to accomplish that. */
-    subGridDynamic?: boolean;
-}
-/** options used during GridStackEngine.moveNode() */
-export interface GridStackMoveOpts extends GridStackPosition {
-    /** node to skip collision */
-    skip?: GridStackNode;
-    /** do we pack (default true) */
-    pack?: boolean;
-    /** true if we are calling this recursively to prevent simple swap or coverage collision - default false*/
-    nested?: boolean;
-    /** vars to calculate other cells coordinates */
-    cellWidth?: number;
-    cellHeight?: number;
-    marginTop?: number;
-    marginBottom?: number;
-    marginLeft?: number;
-    marginRight?: number;
-    /** position in pixels of the currently dragged items (for overlap check) */
-    rect?: GridStackPosition;
-    /** true if we're live resizing */
-    resizing?: boolean;
-    /** best node (most coverage) we collied with */
-    collide?: GridStackNode;
-    /** for collision check even if we don't move */
-    forceCollide?: boolean;
-}
-export interface GridStackPosition {
-    /** widget position x (default?: 0) */
-    x?: number;
-    /** widget position y (default?: 0) */
-    y?: number;
-    /** widget dimension width (default?: 1) */
-    w?: number;
-    /** widget dimension height (default?: 1) */
-    h?: number;
-}
-/**
- * GridStack Widget creation options
- */
-export interface GridStackWidget extends GridStackPosition {
-    /** if true then x, y parameters will be ignored and widget will be places on the first available position (default?: false) */
-    autoPosition?: boolean;
-    /** minimum width allowed during resize/creation (default?: undefined = un-constrained) */
-    minW?: number;
-    /** maximum width allowed during resize/creation (default?: undefined = un-constrained) */
-    maxW?: number;
-    /** minimum height allowed during resize/creation (default?: undefined = un-constrained) */
-    minH?: number;
-    /** maximum height allowed during resize/creation (default?: undefined = un-constrained) */
-    maxH?: number;
-    /** prevent direct resizing by the user (default?: undefined = un-constrained) */
-    noResize?: boolean;
-    /** prevents direct moving by the user (default?: undefined = un-constrained) */
-    noMove?: boolean;
-    /** prevents being pushed by other widgets or api (default?: undefined = un-constrained), which is different from `noMove` (user action only) */
-    locked?: boolean;
-    /** value for `gs-id` stored on the widget (default?: undefined) */
-    id?: string;
-    /** html to append inside as content */
-    content?: string;
-    /** true when widgets are only created when they scroll into view (visible) */
-    lazyLoad?: boolean;
-    /** local (vs grid) override - see GridStackOptions.
-     * Note: This also allow you to set a maximum h value (but user changeable during normal resizing) to prevent unlimited content from taking too much space (get scrollbar) */
-    sizeToContent?: boolean | number;
-    /** local override of GridStack.resizeToContentParent that specify the class to use for the parent (actual) vs child (wanted) height */
-    resizeToContentParent?: string;
-    /** optional nested grid options and list of children, which then turns into actual instance at runtime to get options from */
-    subGridOpts?: GridStackOptions;
-}
-/** Drag&Drop resize options */
-export interface DDResizeOpt {
-    /** do resize handle hide by default until mouse over ? - default: true on desktop, false on mobile*/
-    autoHide?: boolean;
-    /**
-     * sides where you can resize from (ex: 'e, se, s, sw, w') - default 'se' (south-east)
-     * Note: it is not recommended to resize from the top sides as weird side effect may occur.
-    */
-    handles?: string;
-}
-/** Drag&Drop remove options */
-export interface DDRemoveOpt {
-    /** class that can be removed (default?: opts.itemClass) */
-    accept?: string;
-    /** class that cannot be removed (default: 'grid-stack-non-removable') */
-    decline?: string;
-}
-/** Drag&Drop dragging options */
-export interface DDDragOpt {
-    /** class selector of items that can be dragged. default to '.grid-stack-item-content' */
-    handle?: string;
-    /** default to 'body' */
-    appendTo?: string;
-    /** if set (true | msec), dragging placement (collision) will only happen after a pause by the user. Note: this is Global */
-    pause?: boolean | number;
-    /** default to `true` */
-    scroll?: boolean;
-    /** prevents dragging from starting on specified elements, listed as comma separated selectors (eg: '.no-drag'). default built in is 'input,textarea,button,select,option' */
-    cancel?: string;
-    /** helper function when dropping: 'clone' or your own method */
-    helper?: 'clone' | ((el: HTMLElement) => HTMLElement);
-    /** callbacks */
-    start?: (event: Event, ui: DDUIData) => void;
-    stop?: (event: Event) => void;
-    drag?: (event: Event, ui: DDUIData) => void;
-}
-export interface Size {
-    width: number;
-    height: number;
-}
-export interface Position {
-    top: number;
-    left: number;
-}
-export interface Rect extends Size, Position {
-}
-/** data that is passed during drag and resizing callbacks */
-export interface DDUIData {
-    position?: Position;
-    size?: Size;
-    draggable?: HTMLElement;
-}
-/**
- * internal runtime descriptions describing the widgets in the grid
- */
-export interface GridStackNode extends GridStackWidget {
-    /** pointer back to HTML element */
-    el?: GridItemHTMLElement;
-    /** pointer back to parent Grid instance */
-    grid?: GridStack;
-    /** actual sub-grid instance */
-    subGrid?: GridStack;
-    /** allow delay creation when visible */
-    visibleObservable?: IntersectionObserver;
-}

package/dist/es5/types.js

@@ -1,38 +0,0 @@
-"use strict";
-/**
- * types.ts 12.0.0
- * Copyright (c) 2021-2024 Alain Dumesny - see GridStack root license
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.gridDefaults = void 0;
-// default values for grid options - used during init and when saving out
-exports.gridDefaults = {
-    alwaysShowResizeHandle: 'mobile',
-    animate: true,
-    auto: true,
-    cellHeight: 'auto',
-    cellHeightThrottle: 100,
-    cellHeightUnit: 'px',
-    column: 12,
-    draggable: { handle: '.grid-stack-item-content', appendTo: 'body', scroll: true },
-    handle: '.grid-stack-item-content',
-    itemClass: 'grid-stack-item',
-    margin: 10,
-    marginUnit: 'px',
-    maxRow: 0,
-    minRow: 0,
-    placeholderClass: 'grid-stack-placeholder',
-    placeholderText: '',
-    removableOptions: { accept: 'grid-stack-item', decline: 'grid-stack-non-removable' },
-    resizable: { handles: 'se' },
-    rtl: 'auto',
-    // **** same as not being set ****
-    // disableDrag: false,
-    // disableResize: false,
-    // float: false,
-    // handleClass: null,
-    // removable: false,
-    // staticGrid: false,
-    //removable
-};
-//# sourceMappingURL=types.js.map

package/dist/es5/types.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAKH,yEAAyE;AAC5D,QAAA,YAAY,GAAqB;IAC5C,sBAAsB,EAAE,QAAQ;IAChC,OAAO,EAAE,IAAI;IACb,IAAI,EAAE,IAAI;IACV,UAAU,EAAE,MAAM;IAClB,kBAAkB,EAAE,GAAG;IACvB,cAAc,EAAE,IAAI;IACpB,MAAM,EAAE,EAAE;IACV,SAAS,EAAE,EAAE,MAAM,EAAE,0BAA0B,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE;IACjF,MAAM,EAAE,0BAA0B;IAClC,SAAS,EAAE,iBAAiB;IAC5B,MAAM,EAAE,EAAE;IACV,UAAU,EAAE,IAAI;IAChB,MAAM,EAAE,CAAC;IACT,MAAM,EAAE,CAAC;IACT,gBAAgB,EAAE,wBAAwB;IAC1C,eAAe,EAAE,EAAE;IACnB,gBAAgB,EAAE,EAAE,MAAM,EAAE,iBAAiB,EAAE,OAAO,EAAE,0BAA0B,EAAC;IACnF,SAAS,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE;IAC5B,GAAG,EAAE,MAAM;IAEX,kCAAkC;IAClC,sBAAsB;IACtB,wBAAwB;IACxB,gBAAgB;IAChB,qBAAqB;IACrB,oBAAoB;IACpB,qBAAqB;IACrB,WAAW;CACZ,CAAC","sourcesContent":["/**\r\n * types.ts 12.0.0\r\n * Copyright (c) 2021-2024 Alain Dumesny - see GridStack root license\r\n */\r\n\r\nimport { GridStack } from './gridstack';\r\nimport { GridStackEngine } from './gridstack-engine';\r\n\r\n// default values for grid options - used during init and when saving out\r\nexport const gridDefaults: GridStackOptions = {\r\n  alwaysShowResizeHandle: 'mobile',\r\n  animate: true,\r\n  auto: true,\r\n  cellHeight: 'auto',\r\n  cellHeightThrottle: 100,\r\n  cellHeightUnit: 'px',\r\n  column: 12,\r\n  draggable: { handle: '.grid-stack-item-content', appendTo: 'body', scroll: true },\r\n  handle: '.grid-stack-item-content',\r\n  itemClass: 'grid-stack-item',\r\n  margin: 10,\r\n  marginUnit: 'px',\r\n  maxRow: 0,\r\n  minRow: 0,\r\n  placeholderClass: 'grid-stack-placeholder',\r\n  placeholderText: '',\r\n  removableOptions: { accept: 'grid-stack-item', decline: 'grid-stack-non-removable'},\r\n  resizable: { handles: 'se' },\r\n  rtl: 'auto',\r\n\r\n  // **** same as not being set ****\r\n  // disableDrag: false,\r\n  // disableResize: false,\r\n  // float: false,\r\n  // handleClass: null,\r\n  // removable: false,\r\n  // staticGrid: false,\r\n  //removable\r\n};\r\n\r\n/**\r\n * different layout options when changing # of columns, including a custom function that takes new/old column count, and array of new/old positions\r\n * Note: new list may be partially already filled if we have a cache of the layout at that size and new items were added later.\r\n * Options are:\r\n * 'list' - treat items as sorted list, keeping items (un-sized unless too big for column count) sequentially reflowing them\r\n * 'compact' - similar to list, but using compact() method which will possibly re-order items if an empty slots are available due to a larger item needing to be pushed to next row\r\n * 'moveScale' - will scale and move items by the ratio new newColumnCount / oldColumnCount\r\n * 'move' | 'scale' - will only size or move items\r\n * 'none' will leave items unchanged, unless they don't fit in column count\r\n */\r\nexport type ColumnOptions = 'list' | 'compact' | 'moveScale' | 'move' | 'scale' | 'none' |\r\n  ((column: number, oldColumn: number, nodes: GridStackNode[], oldNodes: GridStackNode[]) => void);\r\nexport type CompactOptions = 'list' | 'compact';\r\nexport type numberOrString = number | string;\r\nexport interface GridItemHTMLElement extends HTMLElement {\r\n  /** pointer to grid node instance */\r\n  gridstackNode?: GridStackNode;\r\n  /** @internal */\r\n  _gridstackNodeOrig?: GridStackNode;\r\n}\r\n\r\nexport type GridStackElement = string | HTMLElement | GridItemHTMLElement;\r\n\r\n/** specific and general event handlers for the .on() method */\r\nexport type GridStackEventHandler = (event: Event) => void;\r\nexport type GridStackElementHandler = (event: Event, el: GridItemHTMLElement) => void;\r\nexport type GridStackNodesHandler = (event: Event, nodes: GridStackNode[]) => void;\r\nexport type GridStackDroppedHandler = (event: Event, previousNode: GridStackNode, newNode: GridStackNode) => void;\r\nexport type GridStackEventHandlerCallback = GridStackEventHandler | GridStackElementHandler | GridStackNodesHandler | GridStackDroppedHandler;\r\n\r\n/** optional function called during load() to callback the user on new added/remove grid items | grids */\r\nexport type AddRemoveFcn = (parent: HTMLElement, w: GridStackWidget, add: boolean, grid: boolean) => HTMLElement | undefined;\r\n\r\n/** optional function called during save() to let the caller add additional custom data to the GridStackWidget structure that will get returned */\r\nexport type SaveFcn = (node: GridStackNode, w: GridStackWidget) => void;\r\n\r\n/** optional function called during load()/addWidget() to let the caller create custom content other than plan text */\r\nexport type RenderFcn = (el: HTMLElement, w: GridStackWidget) => void;\r\n\r\nexport type ResizeToContentFcn = (el: GridItemHTMLElement) => void;\r\n\r\n/** describes the responsive nature of the grid. NOTE: make sure to have correct extra CSS to support this. */\r\nexport interface Responsive {\r\n  /** wanted width to maintain (+-50%) to dynamically pick a column count. NOTE: make sure to have correct extra CSS to support this. */\r\n  columnWidth?: number;\r\n  /** maximum number of columns allowed (default: 12). NOTE: make sure to have correct extra CSS to support this. */\r\n  columnMax?: number;\r\n  /** explicit width:column breakpoints instead of automatic 'columnWidth'. NOTE: make sure to have correct extra CSS to support this. */\r\n  breakpoints?: Breakpoint[];\r\n  /** specify if breakpoints are for window size or grid size (default:false = grid) */\r\n  breakpointForWindow?: boolean;\r\n  /** global re-layout mode when changing columns */\r\n  layout?: ColumnOptions;\r\n}\r\n\r\nexport interface Breakpoint {\r\n  /** <= width for the breakpoint to trigger */\r\n  w?: number;\r\n  /** column count */\r\n  c: number;\r\n  /** re-layout mode if different from global one */\r\n  layout?: ColumnOptions;\r\n  /** TODO: children layout, which spells out exact locations and could omit/add some children */\r\n  // children?: GridStackWidget[];\r\n}\r\n\r\n/**\r\n * Defines the options for a Grid\r\n */\r\nexport interface GridStackOptions {\r\n  /**\r\n   * accept widgets dragged from other grids or from outside (default: `false`). Can be:\r\n   * `true` (uses `'.grid-stack-item'` class filter) or `false`,\r\n   * string for explicit class name,\r\n   * function returning a boolean. See [example](http://gridstack.github.io/gridstack.js/demo/two.html)\r\n   */\r\n  acceptWidgets?: boolean | string | ((element: Element) => boolean);\r\n\r\n  /** possible values (default: `mobile`) - does not apply to non-resizable widgets\r\n    * `false` the resizing handles are only shown while hovering over a widget\r\n    * `true` the resizing handles are always shown\r\n    * 'mobile' if running on a mobile device, default to `true` (since there is no hovering per say), else `false`.\r\n    See [example](http://gridstack.github.io/gridstack.js/demo/mobile.html) */\r\n  alwaysShowResizeHandle?: true | false | 'mobile';\r\n\r\n  /** turns animation on (default?: true) */\r\n  animate?: boolean;\r\n\r\n  /** if false gridstack will not initialize existing items (default?: true) */\r\n  auto?: boolean;\r\n\r\n  /**\r\n   * one cell height (default?: 'auto'). Can be:\r\n   *  an integer (px)\r\n   *  a string (ex: '100px', '10em', '10rem'). Note: % doesn't work right - see demo/cell-height.html\r\n   *  0, in which case the library will not generate styles for rows. Everything must be defined in your own CSS files.\r\n   *  'auto' - height will be calculated for square cells (width / column) and updated live as you resize the window - also see `cellHeightThrottle`\r\n   *  'initial' - similar to 'auto' (start at square cells) but stay that size during window resizing.\r\n   */\r\n  cellHeight?: numberOrString;\r\n\r\n  /** throttle time delay (in ms) used when cellHeight='auto' to improve performance vs usability (default?: 100).\r\n   * A value of 0 will make it instant at a cost of re-creating the CSS file at ever window resize event!\r\n   * */\r\n  cellHeightThrottle?: number;\r\n\r\n  /** (internal) unit for cellHeight (default? 'px') which is set when a string cellHeight with a unit is passed (ex: '10rem') */\r\n  cellHeightUnit?: string;\r\n\r\n  /** list of children item to create when calling load() or addGrid() */\r\n  children?: GridStackWidget[];\r\n\r\n  /** number of columns (default?: 12). Note: IF you change this, CSS also have to change. See https://github.com/gridstack/gridstack.js#change-grid-columns.\r\n   * Note: for nested grids, it is recommended to use 'auto' which will always match the container grid-item current width (in column) to keep inside and outside\r\n   * items always the same. flag is NOT supported for regular non-nested grids.\r\n   */\r\n  column?: number | 'auto';\r\n\r\n  /** responsive column layout for width:column behavior */\r\n  columnOpts?: Responsive;\r\n\r\n  /** additional class on top of '.grid-stack' (which is required for our CSS) to differentiate this instance.\r\n  Note: only used by addGrid(), else your element should have the needed class */\r\n  class?: string;\r\n\r\n  /** disallows dragging of widgets (default?: false) */\r\n  disableDrag?: boolean;\r\n\r\n  /** disallows resizing of widgets (default?: false). */\r\n  disableResize?: boolean;\r\n\r\n  /** allows to override UI draggable options. (default?: { handle?: '.grid-stack-item-content', appendTo?: 'body' }) */\r\n  draggable?: DDDragOpt;\r\n\r\n  /** let user drag nested grid items out of a parent or not (default true - not supported yet) */\r\n  //dragOut?: boolean;\r\n\r\n  /** the type of engine to create (so you can subclass) default to GridStackEngine */\r\n  engineClass?: typeof GridStackEngine;\r\n\r\n  /** enable floating widgets (default?: false) See example (http://gridstack.github.io/gridstack.js/demo/float.html) */\r\n  float?: boolean;\r\n\r\n  /** draggable handle selector (default?: '.grid-stack-item-content') */\r\n  handle?: string;\r\n\r\n  /** draggable handle class (e.g. 'grid-stack-item-content'). If set 'handle' is ignored (default?: null) */\r\n  handleClass?: string;\r\n\r\n  /** additional widget class (default?: 'grid-stack-item') */\r\n  itemClass?: string;\r\n\r\n  /** re-layout mode when we're a subgrid and we are being resized. default to 'list' */\r\n  layout?: ColumnOptions;\r\n\r\n  /** true when widgets are only created when they scroll into view (visible) */\r\n  lazyLoad?: boolean;\r\n\r\n  /**\r\n   * gap between grid item and content (default?: 10). This will set all 4 sides and support the CSS formats below\r\n   *  an integer (px)\r\n   *  a string with possible units (ex: '2em', '20px', '2rem')\r\n   *  string with space separated values (ex: '5px 10px 0 20px' for all 4 sides, or '5em 10em' for top/bottom and left/right pairs like CSS).\r\n   * Note: all sides must have same units (last one wins, default px)\r\n   */\r\n  margin?: numberOrString;\r\n\r\n  /** OLD way to optionally set each side - use margin: '5px 10px 0 20px' instead. Used internally to store each side. */\r\n  marginTop?: numberOrString;\r\n  marginRight?: numberOrString;\r\n  marginBottom?: numberOrString;\r\n  marginLeft?: numberOrString;\r\n\r\n  /** (internal) unit for margin (default? 'px') set when `margin` is set as string with unit (ex: 2rem') */\r\n  marginUnit?: string;\r\n\r\n  /** maximum rows amount. Default? is 0 which means no maximum rows */\r\n  maxRow?: number;\r\n\r\n  /** minimum rows amount. Default is `0`. You can also do this with `min-height` CSS attribute\r\n   * on the grid div in pixels, which will round to the closest row.\r\n   */\r\n  minRow?: number;\r\n\r\n  /** If you are using a nonce-based Content Security Policy, pass your nonce here and\r\n   * GridStack will add it to the <style> elements it creates. */\r\n  nonce?: string;\r\n\r\n  /** class for placeholder (default?: 'grid-stack-placeholder') */\r\n  placeholderClass?: string;\r\n\r\n  /** placeholder default content (default?: '') */\r\n  placeholderText?: string;\r\n\r\n  /** allows to override UI resizable options. (default?: { handles: 'se' }) */\r\n  resizable?: DDResizeOpt;\r\n\r\n  /**\r\n   * if true widgets could be removed by dragging outside of the grid. It could also be a selector string (ex: \".trash\"),\r\n   * in this case widgets will be removed by dropping them there (default?: false)\r\n   * See example (http://gridstack.github.io/gridstack.js/demo/two.html)\r\n   */\r\n  removable?: boolean | string;\r\n\r\n  /** allows to override UI removable options. (default?: { accept: '.grid-stack-item' }) */\r\n  removableOptions?: DDRemoveOpt;\r\n\r\n  /** fix grid number of rows. This is a shortcut of writing `minRow:N, maxRow:N`. (default `0` no constrain) */\r\n  row?: number;\r\n\r\n  /**\r\n   * if true turns grid to RTL. Possible values are true, false, 'auto' (default?: 'auto')\r\n   * See [example](http://gridstack.github.io/gridstack.js/demo/right-to-left(rtl).html)\r\n   */\r\n  rtl?: boolean | 'auto';\r\n\r\n  /** set to true if all grid items (by default, but item can also override) height should be based on content size instead of WidgetItem.h to avoid v-scrollbars.\r\n   * Note: this is still row based, not pixels, so it will use ceil(getBoundingClientRect().height / getCellHeight())\r\n   */\r\n  sizeToContent?: boolean;\r\n\r\n  /**\r\n   * makes grid static (default?: false). If `true` widgets are not movable/resizable.\r\n   * You don't even need draggable/resizable. A CSS class\r\n   * 'grid-stack-static' is also added to the element.\r\n   */\r\n  staticGrid?: boolean;\r\n\r\n  /**\r\n   * @deprecated Not used anymore, styles are now implemented with local CSS variables\r\n   */\r\n  styleInHead?: boolean;\r\n\r\n  /** list of differences in options for automatically created sub-grids under us (inside our grid-items) */\r\n  subGridOpts?: GridStackOptions;\r\n\r\n  /** enable/disable the creation of sub-grids on the fly by dragging items completely\r\n   * over others (nest) vs partially (push). Forces `DDDragOpt.pause=true` to accomplish that. */\r\n  subGridDynamic?: boolean;\r\n}\r\n\r\n/** options used during GridStackEngine.moveNode() */\r\nexport interface GridStackMoveOpts extends GridStackPosition {\r\n  /** node to skip collision */\r\n  skip?: GridStackNode;\r\n  /** do we pack (default true) */\r\n  pack?: boolean;\r\n  /** true if we are calling this recursively to prevent simple swap or coverage collision - default false*/\r\n  nested?: boolean;\r\n  /** vars to calculate other cells coordinates */\r\n  cellWidth?: number;\r\n  cellHeight?: number;\r\n  marginTop?: number;\r\n  marginBottom?: number;\r\n  marginLeft?: number;\r\n  marginRight?: number;\r\n  /** position in pixels of the currently dragged items (for overlap check) */\r\n  rect?: GridStackPosition;\r\n  /** true if we're live resizing */\r\n  resizing?: boolean;\r\n  /** best node (most coverage) we collied with */\r\n  collide?: GridStackNode;\r\n  /** for collision check even if we don't move */\r\n  forceCollide?: boolean;\r\n}\r\n\r\nexport interface GridStackPosition {\r\n  /** widget position x (default?: 0) */\r\n  x?: number;\r\n  /** widget position y (default?: 0) */\r\n  y?: number;\r\n  /** widget dimension width (default?: 1) */\r\n  w?: number;\r\n  /** widget dimension height (default?: 1) */\r\n  h?: number;\r\n}\r\n\r\n/**\r\n * GridStack Widget creation options\r\n */\r\nexport interface GridStackWidget extends GridStackPosition {\r\n  /** if true then x, y parameters will be ignored and widget will be places on the first available position (default?: false) */\r\n  autoPosition?: boolean;\r\n  /** minimum width allowed during resize/creation (default?: undefined = un-constrained) */\r\n  minW?: number;\r\n  /** maximum width allowed during resize/creation (default?: undefined = un-constrained) */\r\n  maxW?: number;\r\n  /** minimum height allowed during resize/creation (default?: undefined = un-constrained) */\r\n  minH?: number;\r\n  /** maximum height allowed during resize/creation (default?: undefined = un-constrained) */\r\n  maxH?: number;\r\n  /** prevent direct resizing by the user (default?: undefined = un-constrained) */\r\n  noResize?: boolean;\r\n  /** prevents direct moving by the user (default?: undefined = un-constrained) */\r\n  noMove?: boolean;\r\n  /** prevents being pushed by other widgets or api (default?: undefined = un-constrained), which is different from `noMove` (user action only) */\r\n  locked?: boolean;\r\n  /** value for `gs-id` stored on the widget (default?: undefined) */\r\n  id?: string;\r\n  /** html to append inside as content */\r\n  content?: string;\r\n  /** true when widgets are only created when they scroll into view (visible) */\r\n  lazyLoad?: boolean;\r\n  /** local (vs grid) override - see GridStackOptions.\r\n   * Note: This also allow you to set a maximum h value (but user changeable during normal resizing) to prevent unlimited content from taking too much space (get scrollbar) */\r\n  sizeToContent?: boolean | number;\r\n  /** local override of GridStack.resizeToContentParent that specify the class to use for the parent (actual) vs child (wanted) height */\r\n  resizeToContentParent?: string;\r\n  /** optional nested grid options and list of children, which then turns into actual instance at runtime to get options from */\r\n  subGridOpts?: GridStackOptions;\r\n}\r\n\r\n/** Drag&Drop resize options */\r\nexport interface DDResizeOpt {\r\n  /** do resize handle hide by default until mouse over ? - default: true on desktop, false on mobile*/\r\n  autoHide?: boolean;\r\n  /**\r\n   * sides where you can resize from (ex: 'e, se, s, sw, w') - default 'se' (south-east)\r\n   * Note: it is not recommended to resize from the top sides as weird side effect may occur.\r\n  */\r\n  handles?: string;\r\n}\r\n\r\n/** Drag&Drop remove options */\r\nexport interface DDRemoveOpt {\r\n  /** class that can be removed (default?: opts.itemClass) */\r\n  accept?: string;\r\n  /** class that cannot be removed (default: 'grid-stack-non-removable') */\r\n  decline?: string;\r\n}\r\n\r\n/** Drag&Drop dragging options */\r\nexport interface DDDragOpt {\r\n  /** class selector of items that can be dragged. default to '.grid-stack-item-content' */\r\n  handle?: string;\r\n  /** default to 'body' */\r\n  appendTo?: string;\r\n  /** if set (true | msec), dragging placement (collision) will only happen after a pause by the user. Note: this is Global */\r\n  pause?: boolean | number;\r\n  /** default to `true` */\r\n  scroll?: boolean;\r\n  /** prevents dragging from starting on specified elements, listed as comma separated selectors (eg: '.no-drag'). default built in is 'input,textarea,button,select,option' */\r\n  cancel?: string;\r\n  /** helper function when dropping: 'clone' or your own method */\r\n  helper?: 'clone' | ((el: HTMLElement) => HTMLElement);\r\n  /** callbacks */\r\n  start?: (event: Event, ui: DDUIData) => void;\r\n  stop?: (event: Event) => void;\r\n  drag?: (event: Event, ui: DDUIData) => void;\r\n}\r\nexport interface Size {\r\n  width: number;\r\n  height: number;\r\n}\r\nexport interface Position {\r\n  top: number;\r\n  left: number;\r\n}\r\nexport interface Rect extends Size, Position {}\r\n\r\n/** data that is passed during drag and resizing callbacks */\r\nexport interface DDUIData {\r\n  position?: Position;\r\n  size?: Size;\r\n  draggable?: HTMLElement;\r\n  /* fields not used by GridStack but sent by jq ? leave in case we go back to them...\r\n  originalPosition? : Position;\r\n  offset?: Position;\r\n  originalSize?: Size;\r\n  element?: HTMLElement[];\r\n  helper?: HTMLElement[];\r\n  originalElement?: HTMLElement[];\r\n  */\r\n}\r\n\r\n/**\r\n * internal runtime descriptions describing the widgets in the grid\r\n */\r\nexport interface GridStackNode extends GridStackWidget {\r\n  /** pointer back to HTML element */\r\n  el?: GridItemHTMLElement;\r\n  /** pointer back to parent Grid instance */\r\n  grid?: GridStack;\r\n  /** actual sub-grid instance */\r\n  subGrid?: GridStack;\r\n  /** allow delay creation when visible */\r\n  visibleObservable?: IntersectionObserver;\r\n  /** @internal internal id used to match when cloning engines or saving column layouts */\r\n  _id?: number;\r\n  /** @internal does the node attr ned to be updated due to changed x,y,w,h values */\r\n  _dirty?: boolean;\r\n  /** @internal */\r\n  _updating?: boolean;\r\n  /** @internal true when over trash/another grid so we don't bother removing drag CSS style that would animate back to old position */\r\n  _isAboutToRemove?: boolean;\r\n  /** @internal true if item came from outside of the grid -> actual item need to be moved over */\r\n  _isExternal?: boolean;\r\n  /** @internal Mouse event that's causing moving|resizing */\r\n  _event?: MouseEvent;\r\n  /** @internal moving vs resizing */\r\n  _moving?: boolean;\r\n  /** @internal is resizing? */\r\n  _resizing?: boolean;\r\n  /** @internal true if we jumped down past item below (one time jump so we don't have to totally pass it) */\r\n  _skipDown?: boolean;\r\n  /** @internal original values before a drag/size */\r\n  _orig?: GridStackPosition;\r\n  /** @internal position in pixels used during collision check  */\r\n  _rect?: GridStackPosition;\r\n  /** @internal top/left pixel location before a drag so we can detect direction of move from last position*/\r\n  _lastUiPosition?: Position;\r\n  /** @internal set on the item being dragged/resized remember the last positions we've tried (but failed) so we don't try again during drag/resize */\r\n  _lastTried?: GridStackPosition;\r\n  /** @internal position willItFit() will use to position the item */\r\n  _willFitPos?: GridStackPosition;\r\n  /** @internal last drag Y pixel position used to incrementally update V scroll bar */\r\n  _prevYPix?: number;\r\n  /** @internal true if we've remove the item from ourself (dragging out) but might revert it back (release on nothing -> goes back) */\r\n  _temporaryRemoved?: boolean;\r\n  /** @internal true if we should remove DOM element on _notify() rather than clearing _id (old way) */\r\n  _removeDOM?: boolean;\r\n  /** @internal original position/size of item if dragged from sidebar */\r\n  _sidebarOrig?: GridStackPosition;\r\n  /** @internal had drag&drop been initialized */\r\n  _initDD?: boolean;\r\n}\r\n"]}

package/dist/es5/utils.d.ts

@@ -1,104 +0,0 @@
-/**
- * utils.ts 12.0.0
- * Copyright (c) 2021-2024 Alain Dumesny - see GridStack root license
- */
-import { GridStackElement, GridStackNode, GridStackOptions, numberOrString, GridStackPosition, GridStackWidget } from './types';
-export interface HeightData {
-    h: number;
-    unit: string;
-}
-export interface DragTransform {
-    xScale: number;
-    yScale: number;
-    xOffset: number;
-    yOffset: number;
-}
-/** checks for obsolete method names */
-export declare function obsolete(self: any, f: any, oldName: string, newName: string, rev: string): (...args: any[]) => any;
-/** checks for obsolete grid options (can be used for any fields, but msg is about options) */
-export declare function obsoleteOpts(opts: GridStackOptions, oldName: string, newName: string, rev: string): void;
-/** checks for obsolete grid options which are gone */
-export declare function obsoleteOptsDel(opts: GridStackOptions, oldName: string, rev: string, info: string): void;
-/** checks for obsolete Jquery element attributes */
-export declare function obsoleteAttr(el: HTMLElement, oldName: string, newName: string, rev: string): void;
-/**
- * Utility methods
- */
-export declare class Utils {
-    /** convert a potential selector into actual list of html elements. optional root which defaults to document (for shadow dom) */
-    static getElements(els: GridStackElement, root?: HTMLElement | Document): HTMLElement[];
-    /** convert a potential selector into actual single element. optional root which defaults to document (for shadow dom) */
-    static getElement(els: GridStackElement, root?: HTMLElement | Document): HTMLElement;
-    /** true if widget (or grid) makes this item lazyLoad */
-    static lazyLoad(n: GridStackNode): boolean;
-    /** create a div with the given classes */
-    static createDiv(classes: string[], parent?: HTMLElement): HTMLElement;
-    /** true if we should resize to content. strict=true when only 'sizeToContent:true' and not a number which lets user adjust */
-    static shouldSizeToContent(n: GridStackNode | undefined, strict?: boolean): boolean;
-    /** returns true if a and b overlap */
-    static isIntercepted(a: GridStackPosition, b: GridStackPosition): boolean;
-    /** returns true if a and b touch edges or corners */
-    static isTouching(a: GridStackPosition, b: GridStackPosition): boolean;
-    /** returns the area a and b overlap */
-    static areaIntercept(a: GridStackPosition, b: GridStackPosition): number;
-    /** returns the area */
-    static area(a: GridStackPosition): number;
-    /**
-     * Sorts array of nodes
-     * @param nodes array to sort
-     * @param dir 1 for ascending, -1 for descending (optional)
-     **/
-    static sort(nodes: GridStackNode[], dir?: 1 | -1): GridStackNode[];
-    /** find an item by id */
-    static find(nodes: GridStackNode[], id: string): GridStackNode | undefined;
-    static toBool(v: unknown): boolean;
-    static toNumber(value: null | string): number;
-    static parseHeight(val: numberOrString): HeightData;
-    /** copies unset fields in target to use the given default sources values */
-    static defaults(target: any, ...sources: any[]): {};
-    /** given 2 objects return true if they have the same values. Checks for Object {} having same fields and values (just 1 level down) */
-    static same(a: unknown, b: unknown): boolean;
-    /** copies over b size & position (GridStackPosition), and optionally min/max as well */
-    static copyPos(a: GridStackWidget, b: GridStackWidget, doMinMax?: boolean): GridStackWidget;
-    /** true if a and b has same size & position */
-    static samePos(a: GridStackPosition, b: GridStackPosition): boolean;
-    /** given a node, makes sure it's min/max are valid */
-    static sanitizeMinMax(node: GridStackNode): void;
-    /** removes field from the first object if same as the second objects (like diffing) and internal '_' for saving */
-    static removeInternalAndSame(a: unknown, b: unknown): void;
-    /** removes internal fields '_' and default values for saving */
-    static removeInternalForSave(n: GridStackNode, removeEl?: boolean): void;
-    /** return the closest parent (or itself) matching the given class */
-    /** delay calling the given function for given delay, preventing new calls from happening while waiting */
-    static throttle(func: () => void, delay: number): () => void;
-    static removePositioningStyles(el: HTMLElement): void;
-    /** single level clone, returning a new object with same top fields. This will share sub objects and arrays */
-    static clone<T>(obj: T): T;
-    /**
-     * Recursive clone version that returns a full copy, checking for nested objects and arrays ONLY.
-     * Note: this will use as-is any key starting with double __ (and not copy inside) some lib have circular dependencies.
-     */
-    static cloneDeep<T>(obj: T): T;
-    /** deep clone the given HTML node, removing teh unique id field */
-    static cloneNode(el: HTMLElement): HTMLElement;
-    static appendTo(el: HTMLElement, parent: string | HTMLElement): void;
-    static addElStyles(el: HTMLElement, styles: {
-        [prop: string]: string | string[];
-    }): void;
-    static initEvent<T>(e: DragEvent | MouseEvent, info: {
-        type: string;
-        target?: EventTarget;
-    }): T;
-    /** copies the MouseEvent (or convert Touch) properties and sends it as another event to the given target */
-    static simulateMouseEvent(e: MouseEvent | Touch, simulatedType: string, target?: EventTarget): void;
-    /**
-     * defines an element that is used to get the offset and scale from grid transforms
-     * returns the scale and offsets from said element
-    */
-    static getValuesFromTransformedElement(parent: HTMLElement): DragTransform;
-    /** swap the given object 2 field values */
-    static swap(o: unknown, a: string, b: string): void;
-    /** returns true if event is inside the given element rectangle */
-    /** true if the item can be rotated (checking for prop, not space available) */
-    static canBeRotated(n: GridStackNode): boolean;
-}