.. | ||
README.md |
gridstack.js API
Table of Contents generated with DocToc
- Options
- Grid attributes
- Item attributes
- Events
- API
- addWidget(el, x, y, width, height, autoPosition)
- batchUpdate()
- cellHeight()
- cellHeight(val)
- cellWidth()
- commit()
- destroy()
- disable()
- enable()
- enableMove(doEnable, includeNewWidgets)
- enableResize(doEnable, includeNewWidgets)
- getCellFromPixel(position)
- isAreaEmpty(x, y, width, height)
- locked(el, val)
- makeWidget(el)
- maxHeight(el, val)
- minHeight(el, val)
- maxWidth(el, val)
- minWidth(el, val)
- movable(el, val)
- move(el, x, y)
- removeWidget(el, detachNode)
- removeAll()
- resize(el, width, height)
- resizable(el, val)
- setStatic(staticValue)
- update(el, x, y, width, height)
- willItFit(x, y, width, height, autoPosition)
- Utils
Options
alwaysShowResizeHandle
- iftrue
the resizing handles are shown even if the user is not hovering over the widget (default:false
)animate
- turns animation on (default:false
)auto
- iffalse
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 will have to be defined in CSS files.
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: true, appendTo: 'body'}
)handle
- draggable handle selector (default:'.grid-stack-item-content'
)handleClass
- draggable handle class (e.g.'grid-stack-item-content'
). If sethandle
is ignored (default:null
)height
- maximum rows amount. Default is0
which means no maximum rowsfloat
- enable floating widgets (default:false
) See exampleitemClass
- widget class (default:'grid-stack-item'
)minWidth
- minimal width. If window width is less, grid will be shown in one-column mode. You need also update your css file (@media (max-width: 768px) {...}
) with corresponding value (default:768
)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'}
)staticGrid
- makes grid static (defaultfalse
). If true widgets are not movable/resizable. You don't even need jQueryUI draggable/resizable. A CSS classgrid-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 ondata-gs-width
- amount of columnsdata-gs-height
- maximum rows amount. Default is0
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 positiondata-gs-width
,data-gs-height
- element sizedata-gs-max-width
,data-gs-min-width
,data-gs-max-height
,data-gs-min-height
- element constraintsdata-gs-no-resize
- disable element resizingdata-gs-no-move
- disable element movingdata-gs-auto-position
- tells to ignoredata-gs-x
anddata-gs-y
attributes and to place element to the first available positiondata-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 adddata-gs-no-resize
anddata-gs-no-move
attributes to completely lock the widget.
Events
onchange(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 (e, items) {
serializeWidgetMap(items);
});
ondragstart(event, ui)
$('.grid-stack').on('dragstart', function (event, ui) {
var grid = this;
var element = event.target;
});
ondragstop(event, ui)
$('.grid-stack').on('dragstop', function (event, ui) {
var grid = this;
var element = event.target;
});
onresizestart(event, ui)
$('.grid-stack').on('resizestart', function (event, ui) {
var grid = this;
var element = event.target;
});
onresizestop(event, ui)
$('.grid-stack').on('resizestop', function (event, ui) {
var grid = this;
var element = event.target;
});
disable(event)
$('.grid-stack').on('disable', function(event) {
var grid = event.target;
});
enable(event)
$('.grid-stack').on('enable', function(event) {
var grid = event.target;
});
API
addWidget(el, x, y, width, height, autoPosition)
Creates new widget and returns it.
Parameters:
el
- widget to addx
,y
,width
,height
- widget position/dimensions (Optional)autoPosition
- iftrue
thenx
,y
parameters will be ignored and widget will be places on the first available position
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()
Destroys a grid instance.
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)
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 withtop
andleft
properties
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
- iftrue
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 modifyval
- iftrue
widget will be draggable.
move(el, x, y)
Changes widget position
Parameters:
el
- widget to movex
,y
- new position. If value isnull
orundefined
it will be ignored.
removeWidget(el, detachNode)
Removes widget from the grid.
Parameters:
el
- widget to remove.detachNode
- iffalse
DOM node won't be removed from the tree (Optional. Defaulttrue
).
removeAll()
Removes all widgets from the grid.
resize(el, width, height)
Changes widget size
Parameters:
el
- widget to resizewidth
,height
- new dimensions. If value isnull
orundefined
it will be ignored.
resizable(el, val)
Enables/Disables resizing.
el
- widget to modifyval
- iftrue
widget will be resizable.
setStatic(staticValue)
Toggle the grid static state. Also toggle the grid-stack-static
class.
staticValue
- iftrue
the grid become static.
update(el, x, y, width, height)
Parameters:
el
- widget to movex
,y
- new position. If value isnull
orundefined
it will be ignored.width
,height
- new dimensions. If value isnull
orundefined
it will be ignored.
Updates widget position/size.
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 sortdir
-1
for asc,-1
for desc (optional)width
- width of the grid. Ifundefined
the width will be calculated automatically (optional).