Plug in to the grid
This is it, the mythical drag-and-drop multi-column grid has arrived. Gridster is a jQuery plugin that allows building intuitive draggable layouts from elements spanning multiple columns. You can even dynamically add and remove elements from the grid. It is on par with sliced bread, or possibly better. MIT licensed. Suitable for children of all ages. Made by
Ducksboard
.
It's so sweet we like to call it drag-and-drool.
Download now
Multiple gridster instances on the same page
Resizable widgets
Resizable widgets with constraints
Serialize widgets positions
Using drag callbacks
Using resize callbacks
Dynamic grid width
Responsive grid width
Grid with larger widgets swapping spots with smaller ones
Grid that allows widgets to be exactly placed anywhere
Define which elements are the widgets. Can be a CSS Selector string or a jQuery collection of HTMLElements.
Horizontal and vertical margins respectively for widgets.
Base widget dimensions in pixels. The first index is the width, the second is the height.
Add more rows to the grid in addition to those that have been calculated.
Add more rows to the grid in addition to those that have been calculated.
max_cols:
null
The maximum number of columns to create. Set to `null` to disable.
min_cols:
1
The minimum number of columns to create.
min_rows:
15
The minimum number of rows to create.
max_size_x:
false
The maximum number of columns that a widget can span.
autogenerate_stylesheet:
true
If true, all the CSS required to position all widgets in their respective columns and rows will be generated automatically and injected to the
<head>
of the document. You can set this to false and write your own CSS targeting rows and cols via data-attributes like so:
[data-col="1"] { left: 10px; }
.
Don't allow widgets loaded from the DOM to overlap. This is helpful if you're loading widget positions form the database and they might be inconsistent.
serialize_params:
function($w, wgd) { return { col: wgd.col, row: wgd.row, size_x: wgd.size_x, size_y: wgd.size_y } }
A function to return serialized data for each each widget, used when calling the
serialize method
. Two arguments are passed:
$w
: the jQuery wrapped HTMLElement, and
wgd
: the grid coords object with keys
col
,
row
,
size_x
and
size_y
.
draggable.start:
function(event, ui){}
A callback for when dragging starts.
draggable.drag:
function(event, ui){}
A callback for when the mouse is moved during the dragging.
draggable.stop:
function(event, ui){}
A callback for when dragging stops.
resize.enabled:
false
Set to true to enable drag-and-drop widget resizing. This setting doesn't affect to the
resize_widget
method.
resize.axes:
['both']
Axes in which widgets can be resized. Can be
x
,
y
or
both
resize.handle_class:
'gs-resize-handle'
CSS class name used by resize handles.
resize.handle_append_to:
''
Set a valid CSS selector to append resize handles to. If value evaluates to false it's appended to the widget.
resize.max_size:
[Infinity, Infinity]
Limit widget dimensions when resizing. Array values should be integers:
[max_cols_occupied, max_rows_occupied]
resize.start:
function(e, ui, $widget) {}
A callback executed when resizing starts.
resize.resize:
function(e, ui, $widget) {}
A callback executed during the resizing.
resize.stop:
function(e, ui, $widget) {}
A callback executed when resizing stops.
collision.on_overlap_start:
function(collider_data) { }
A callback for the first time when a widget enters a new grid cell.
collision.on_overlap:
function(collider_data) { }
A callback for each time a widget moves inside a grid cell.
collision.on_overlap_stop:
function(collider_data) { }
A callback for the first time when a widget leaves its old grid cell.
html
String|HTMLElement
The string of HTMLElement that represents the widget is going to be added.
size_x
Number
The number of rows that the widget occupies. Defaults to
1
.
size_y
Number
The number of columns that the widget occupies. Defaults to
1
.
col
Number
The column the widget should start in.
row
Number
The row the widget should start in.
Returns
Returns the jQuery wrapped HTMLElement representing the widget that's been created.
$widget
HTMLElement
The jQuery wrapped HTMLElement that represents the widget is going to be resized.
size_x
Number
The number of rows that the widget is going to span. Defaults to current size_x.
size_y
Number
The number of columns that the widget is going to span. Defaults to current size_y.
reposition
Boolean
Set to false to not move the widget to the left if there is insufficient space on the right.
By default
size_x
is limited to the space available from the column where the widget begins, until the last column to the right.
Returns
Returns the jQuery wrapped HTMLElement representing the widget that's been resized.
el
HTMLElement
The jQuery wrapped HTMLElement representing the widget that you want to remove.
callback
Function
A callback for when the widget is removed.
Returns
Returns the instance of the Gridster class.
Creates an array of objects representing the current position of all widgets in the grid.
Parameters
$widgets
HTMLElement
The collection of jQuery wrapped HTMLElements you want to serialize. If no argument is passed all widgets will be serialized.
Returns
Returns an Array of Objects (ready to be encoded as a JSON string) with the data specified by the
serialize_params
option.
Creates an array of objects representing the current position of the widgets who have changed position.
Returns
Returns an Array of Objects (ready to be encoded as a JSON string) with the data specified in the
serialize_params
option.
