Skip to content

Files

Latest commit

 

History

History
 
 

doc

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
CHANGES.md
CHANGES.md
 
 
README.md
README.md
 
 

README.md

gridstack.js API

Table of Contents generated with DocToc

Options

  • acceptWidgets - if true of jquery selector the grid will accept widgets dragged from other grids or from outside (default: false) See example
  • alwaysShowResizeHandle - if true the resizing handles are shown even if the user is not hovering over the widget (default: false)
  • animate - turns animation on (default: false)
  • auto - if false gridstack will not initialize existing items (default: true)
  • cellHeight - 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.
  • ddPlugin - class that implement drag'n'drop functionallity for gridstack. If false grid will be static. (default: null - first available plugin will be used)
  • disableDrag - disallows dragging of widgets (default: false).
  • disableResize - disallows resizing of widgets (default: false).
  • draggable - allows to override jQuery UI draggable options. (default: {handle: '.grid-stack-item-content', scroll: false, appendTo: 'body'})
  • handle - draggable handle selector (default: '.grid-stack-item-content')
  • handleClass - draggable handle class (e.g. 'grid-stack-item-content'). If set handle is ignored (default: null)
  • height - maximum rows amount. Default is 0 which means no maximum rows
  • float - enable floating widgets (default: false) See example
  • itemClass - widget class (default: 'grid-stack-item')
  • minWidth - minimal width. If window width is less than or equal to, grid will be shown in one-column mode (default: 768)
  • disableOneColumnMode - disables the onColumnMode when the window width is less than minWidth (default: 'false')
  • oneColumnModeClass - class set on grid when in one column mode (default: 'grid-stack-one-column-mode')
  • placeholderClass - class for placeholder (default: 'grid-stack-placeholder')
  • placeholderText - placeholder default content (default: '')
  • resizable - allows to override jQuery UI resizable options. (default: {autoHide: true, handles: 'se'})
  • removable - 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
  • removeTimeout - time in milliseconds before widget is being removed while dragging outside of the grid. (default: 2000)
  • rtl - if true turns grid to RTL. Possible values are true, false, 'auto' (default: 'auto') See example
  • staticGrid - 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.
  • verticalMargin - vertical gap size (default: 20). Can be:
    • an integer (px)
    • a string (ex: '2em', '20px', '2rem')
  • width - amount of columns (default: 12)

Grid attributes

  • data-gs-animate - turns animation on
  • data-gs-width - amount of columns
  • data-gs-height - maximum rows amount. Default is 0 which means no maximum rows.
  • data-gs-current-height - current rows amount. Set by the library only. Can be used by the CSS rules.

Item attributes

  • data-gs-x, data-gs-y - element position
  • data-gs-width, data-gs-height - element size
  • data-gs-id- good for quick identification (for example in change event)
  • data-gs-max-width, data-gs-min-width, data-gs-max-height, data-gs-min-height - element constraints
  • data-gs-no-resize - disable element resizing
  • data-gs-no-move - disable element moving
  • data-gs-auto-position - tells to ignore data-gs-x and data-gs-y attributes and to place element to the first available position
  • data-gs-locked - the widget will be locked. It means another widget wouldn't be able to move it during dragging or resizing. The widget can still be dragged or resized. You need to add data-gs-no-resize and data-gs-no-move attributes to completely lock the widget.
  • data-gs-resize-handles - sets resize handles for a specific widget.

Events

added(event, items)

$('.grid-stack').on('added', function(event, items) {
    for (var i = 0; i < items.length; i++) {
      console.log('item added');
      console.log(items[i]);
    }
});

change(event, items)

Occurs when adding/removing widgets or existing widgets change their position/size

var serializeWidgetMap = function(items) {
    console.log(items);
};

$('.grid-stack').on('change', function(event, items) {
    serializeWidgetMap(items);
});

disable(event)

$('.grid-stack').on('disable', function(event) {
    var grid = event.target;
});

dragstart(event, ui)

$('.grid-stack').on('dragstart', function(event, ui) {
    var grid = this;
    var element = event.target;
});

dragstop(event, ui)

$('.grid-stack').on('dragstop', function(event, ui) {
    var grid = this;
    var element = event.target;
});

dropped(event, previousWidget, newWidget)

$('.grid-stack').on('dropped', function(event, previousWidget, newWidget) {
    console.log('Removed widget that was dragged out of grid:', previousWidget);
    console.log('Added widget in dropped grid:', newWidget);
});

enable(event)

$('.grid-stack').on('enable', function(event) {
    var grid = event.target;
});

removed(event, items)

$('.grid-stack').on('removed', function(event, items) {
    for (var i = 0; i < items.length; i++) {
      console.log('item removed');
      console.log(items[i]);
    }
});

resizestart(event, ui)

$('.grid-stack').on('resizestart', function(event, ui) {
    var grid = this;
    var element = event.target;
});

gsresizestop(event, ui)

$('.grid-stack').on('gsresizestop', function(event, elem) {
    var newHeight = $(elem).attr('data-gs-height');
});

API

addWidget(el[, x, y, width, height, autoPosition, minWidth, maxWidth, minHeight, maxHeight, id])

Creates new widget and returns it.

Parameters:

  • el - widget to add
  • x, y, width, height - widget position/dimensions (optional)
  • autoPosition - if true then x, y parameters will be ignored and widget will be places on the first available position (optional)
  • minWidth minimum width allowed during resize/creation (optional)
  • maxWidth maximum width allowed during resize/creation (optional)
  • minHeight minimum height allowed during resize/creation (optional)
  • maxHeight maximum height allowed during resize/creation (optional)
  • id value for data-gs-id (optional)

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.

$('.grid-stack').gridstack();

var grid = $('.grid-stack').data('gridstack');
grid.addWidget(el, 0, 0, 3, 2, true);

batchUpdate()

Initailizes batch updates. You will see no changes until commit method is called.

cellHeight()

Gets current cell height.

cellHeight(val)

Update current cell height. This method rebuilds an internal CSS stylesheet. Note: You can expect performance issues if call this method too often.

grid.cellHeight(grid.cellWidth() * 1.2);

cellWidth()

Gets current cell width.

commit()

Finishes batch updates. Updates DOM nodes. You must call it after batchUpdate.

destroy([detachGrid])

Destroys a grid instance.

Parameters:

  • detachGrid - if false nodes and grid will not be removed from the DOM (Optional. Default true).

disable()

Disables widgets moving/resizing. This is a shortcut for:

grid.movable('.grid-stack-item', false);
grid.resizable('.grid-stack-item', false);

enable()

Enables widgets moving/resizing. This is a shortcut for:

grid.movable('.grid-stack-item', true);
grid.resizable('.grid-stack-item', true);

enableMove(doEnable, includeNewWidgets)

Enables/disables widget moving. includeNewWidgets will force new widgets to be draggable as per doEnable's value by changing the disableDrag grid option. This is a shortcut for:

grid.movable(this.container.children('.' + this.opts.itemClass), doEnable);

enableResize(doEnable, includeNewWidgets)

Enables/disables widget resizing. includeNewWidgets will force new widgets to be resizable as per doEnable's value by changing the disableResize grid option. This is a shortcut for:

grid.resizable(this.container.children('.' + this.opts.itemClass), doEnable);

getCellFromPixel(position[, useOffset])

Get the position of the cell under a pixel on screen.

Parameters :

  • position - the position of the pixel to resolve in absolute coordinates, as an object with top and left properties
  • 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.

isAreaEmpty(x, y, width, height)

Checks if specified area is empty.

locked(el, val)

Locks/unlocks widget.

  • el - widget to modify.
  • val - if true widget will be locked.

makeWidget(el)

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.

Parameters:

  • el - element to convert to a widget
$('.grid-stack').gridstack();

$('.grid-stack').append('<div id="gsi-1" data-gs-x="0" data-gs-y="0" data-gs-width="3" data-gs-height="2" data-gs-auto-position="1"></div>')
var grid = $('.grid-stack').data('gridstack');
grid.makeWidget('gsi-1');

maxHeight(el, val)

Set the maxHeight for a widget.

  • el - widget to modify.
  • val - A numeric value of the number of rows

minHeight(el, val)

Set the minHeight for a widget.

  • el - widget to modify.
  • val - A numeric value of the number of rows

maxWidth(el, val)

Set the maxWidth for a widget.

  • el - widget to modify.
  • val - A numeric value of the number of columns

minWidth(el, val)

Set the minWidth for a widget.

  • el - widget to modify.
  • val - A numeric value of the number of columns

movable(el, val)

Enables/Disables moving.

  • el - widget to modify
  • val - if true widget will be draggable.

move(el, x, y)

Changes widget position

Parameters:

  • el - widget to move
  • x, y - new position. If value is null or undefined it will be ignored.

removeWidget(el[, detachNode])

Removes widget from the grid.

Parameters:

  • el - widget to remove.
  • detachNode - if false node won't be removed from the DOM (Optional. Default true).

removeAll([detachNode])

Removes all widgets from the grid.

Parameters:

  • detachNode - if false nodes won't be removed from the DOM (Optional. Default true).

resize(el, width, height)

Changes widget size

Parameters:

  • el - widget to resize
  • width, height - new dimensions. If value is null or undefined it will be ignored.

resizable(el, val)

Enables/Disables resizing.

  • el - widget to modify
  • val - if true widget will be resizable.

setAnimation(doAnimate)

Toggle the grid animation state. Toggles the grid-stack-animate class.

  • doAnimate - if true the grid will animate.

setGridWidth(gridWidth, doNotPropagate)

(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.

  • gridWidth - Integer between 1 and 12.
  • doNotPropagate - if true existing widgets will not be updated.

setStatic(staticValue)

Toggle the grid static state. Also toggle the grid-stack-static class.

  • staticValue - if true the grid becomes static.

update(el, x, y, width, height)

Parameters:

  • el - widget to move
  • x, y - new position. If value is null or undefined it will be ignored.
  • width, height - new dimensions. If value is null or undefined it will be ignored.

Updates widget position/size.

verticalMargin(value, noUpdate)

Parameters:

  • value - new vertical margin value.
  • noUpdate - if true, styles will not be updated.

willItFit(x, y, width, height, autoPosition)

Returns true if the height of the grid will be less the vertical constraint. Always returns true if grid doesn't have height constraint.

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');
}

Utils

GridStackUI.Utils.sort(nodes[, dir[, width]])

Sorts array of nodes

  • nodes - array to sort
  • dir - 1 for asc, -1 for desc (optional)
  • width - width of the grid. If undefined the width will be calculated automatically (optional).