gridstack.js

gridstack.js is a mobile-friendly Javascript library for dashboard layout and creation. Making a drag-and-drop, multi-column dashboard has never been easier. gridstack.js allows you to build draggable, responsive bootstrap v3-friendly layouts. It also works great with knockout.js, angular.js, ember.

Join gridstack.js on Slack: https://gridstackjs.troolee.com

Table of Contents generated with DocToc

• Demo and examples
• Usage
  • Requirements
    • Using gridstack.js with jQuery UI
  • Install
  • Basic usage
  • Migrating to v0.3.0
  • API Documentation
  • Touch devices support
  • gridstack.js for specific frameworks
  • Change grid columns
  • Custom columns CSS
  • Override resizable/draggable options
  • IE8 support
• Changes
• The Team

Demo and examples

Please visit http://gridstackjs.com for a demo or check out these examples.

Usage

Requirements

• jQuery (>= 3.1.0)
• Array.prototype.find for IE and older browsers (core.js allows to include specific polyfills)

Using gridstack.js with jQuery UI

• jQuery UI (>= 1.12.0). Minimum required components: Core, Widget, Mouse, Draggable, Resizable
• (Optional) jquery-ui-touch-punch for touch-based devices support

Install

• In the browser:

<link rel="stylesheet" href="gridstack.css" />
<script src="gridstack.js"></script>
<script src="gridstack.jQueryUI.js"></script>

• Using CDN:

<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/gridstack@0.5.3/dist/gridstack.min.css" />
<script type="text/javascript" src="https://cdn.jsdelivr.net/npm/gridstack@0.5.3/dist/gridstack.min.js"></script>
<script type="text/javascript" src="https://cdn.jsdelivr.net/npm/gridstack@0.5.3/dist/gridstack.jQueryUI.min.js"></script>

• Using bower:

$ bower install gridstack

• Using npm:

$ npm install gridstack

You can download source and build and use dist directory as well for latest non published code.

Basic usage

<div class="grid-stack">
  <div class="grid-stack-item"
    data-gs-x="0" data-gs-y="0"
    data-gs-width="4" data-gs-height="2">
      <div class="grid-stack-item-content"></div>
  </div>
  <div class="grid-stack-item"
    data-gs-x="4" data-gs-y="0"
    data-gs-width="4" data-gs-height="4">
      <div class="grid-stack-item-content"></div>
  </div>
</div>

<script type="text/javascript">
$(function () {
  $('.grid-stack').gridstack();
});
</script>

Migrating to v0.3.0

As of v0.3.0, gridstack introduces a new plugin system. The drag'n'drop functionality has been modified to take advantage of this system. Because of this, and to avoid dependency on core code from jQuery UI, the plugin was functionality was moved to a separate file.

To ensure gridstack continues to work, either include the additional gridstack.jQueryUI.js file into your HTML or use gridstack.all.js:

<script src="gridstack.js"></script>
<script src="gridstack.jQueryUI.js"></script>

or

<script src="gridstack.all.js"></script>

We're working on implementing support for other drag'n'drop libraries through the new plugin system.

API Documentation

Documentation can be found here.

Touch devices support

Please use jQuery UI Touch Punch to make jQuery UI Draggable/Resizable working on touch-based devices.

<script src="core-js/client/shim.min.js"></script>
<script src="jquery.min.js"></script>
<script src="jquery-ui.min.js"></script>
<script src="jquery.ui.touch-punch.min.js"></script>

<script src="gridstack.js"></script>

Also alwaysShowResizeHandle option may be useful:

$(function () {
  var options = {
    alwaysShowResizeHandle: /Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test(navigator.userAgent)
  };
  $('.grid-stack').gridstack(options);
});

If you're still experiencing issues on touch devices please check #444

gridstack.js for specific frameworks

• AngularJS: gridstack-angular
• Rails: gridstack-js-rails
• ember: gridstack-ember

Change grid columns

GridStack makes it very easy if you need [1-12] columns out of the box (default is 12), but you always need 2 things if you need to customize this:

1. Change the column grid option when creating a grid to your number N

$('.grid-stack').gridstack( {column: N} );

2. and change your HTML accordingly if N < 12 (else custom CSS section next). Without this, things will not render/work correctly.

<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/gridstack@0.5.3/dist/gridstack-extra.css"/>

<div class="grid-stack grid-stack-N">...</div>

Note grid-stack-N class was added.

gridstack-extra.css (and gridstack-extra.min.css) defines CSS for grids with custom [1-12] columns. Anything more and you'll need to generate the SASS/CSS yourself (see next).

See example: 2 grids demo with 6 columns

Custom columns CSS

If you need > 12 columns or want to generate the CSS manually (else see above) you will need to generate CSS rules for .grid-stack-item[data-gs-width="X"] and .grid-stack-item[data-gs-x="X"].

For instance for 3-column grid you need to rewrite CSS to be:

.grid-stack-item[data-gs-width="3"]  { width: 100% }
.grid-stack-item[data-gs-width="2"]  { width: 66.66666667% }
.grid-stack-item[data-gs-width="1"]  { width: 33.33333333% }

.grid-stack-item[data-gs-x="2"]  { left: 66.66666667% }
.grid-stack-item[data-gs-x="1"]  { left: 33.33333333% }

For 4-column grid it should be:

.grid-stack-item[data-gs-width="4"]  { width: 100% }
.grid-stack-item[data-gs-width="3"]  { width: 75% }
.grid-stack-item[data-gs-width="2"]  { width: 50% }
.grid-stack-item[data-gs-width="1"]  { width: 25% }

.grid-stack-item[data-gs-x="3"]  { left: 75% }
.grid-stack-item[data-gs-x="2"]  { left: 50% }
.grid-stack-item[data-gs-x="1"]  { left: 25% }

and so on.

Better yet, here is a SASS code snippet which can make life much easier (Thanks to @ascendantofrain, #81 and @StefanM98, #868) and you can use sites like sassmeister.com to generate the CSS for you instead:

.grid-stack > .grid-stack-item {

  $gridstack-columns: 12;

  min-width: (100% / $gridstack-columns);

  @for $i from 1 through $gridstack-columns {
    &[data-gs-width='#{$i}'] { width: (100% / $gridstack-columns) * $i; }
    &[data-gs-x='#{$i}'] { left: (100% / $gridstack-columns) * $i; }
    &[data-gs-min-width='#{$i}'] { min-width: (100% / $gridstack-columns) * $i; }
    &[data-gs-max-width='#{$i}'] { max-width: (100% / $gridstack-columns) * $i; }
  }
}

Override resizable/draggable options

You can override default resizable/draggable options. For instance to enable other then bottom right resizing handle you can init gridstack like:

$('.grid-stack').gridstack({
  resizable: {
    handles: 'e, se, s, sw, w'
  }
});

Note: It's not recommended to enable nw, n, ne resizing handles. Their behaviour may be unexpected.

IE8 support

Support of IE8 is quite limited and is not a goal at this time. As far as IE8 doesn't support DOM Level 2 I cannot manipulate with CSS stylesheet dynamically. As a workaround you can do the following:

• Create gridstack-ie8.css for your configuration (sample for grid with cell height of 60px can be found here).
• Include this CSS:

<!--[if lt IE 9]>
<link rel="stylesheet" href="gridstack-ie8.css"/>
<![endif]-->

• You can use this python script to generate such kind of CSS:

#!/usr/bin/env python

height = 60
margin = 20
N = 100

print '.grid-stack > .grid-stack-item { min-height: %(height)spx }' % {'height': height}

for i in range(N):
    h = height * (i + 1) + margin * i
    print '.grid-stack > .grid-stack-item[data-gs-height="%(index)s"] { height: %(height)spx }' % {'index': i + 1, 'height': h}

for i in range(N):
    h = height * (i + 1) + margin * i
    print '.grid-stack > .grid-stack-item[data-gs-min-height="%(index)s"] { min-height: %(height)spx }' % {'index': i + 1, 'height': h}

for i in range(N):
    h = height * (i + 1) + margin * i
    print '.grid-stack > .grid-stack-item[data-gs-max-height="%(index)s"] { max-height: %(height)spx }' % {'index': i + 1, 'height': h}

for i in range(N):
    h = height * i + margin * i
    print '.grid-stack > .grid-stack-item[data-gs-y="%(index)s"] { top: %(height)spx }' % {'index': i , 'height': h}

There are at least two more issues with gridstack in IE8 with jQueryUI resizable (it seems it doesn't work) and droppable. If you have any suggestions about support of IE8 you are welcome here: https://github.com/gridstack/gridstack.js/issues/76

Changes

View our change log here.

The Team

gridstack.js is currently maintained by Dylan Weiss and Alain Dumesny, originally created by Pavel Reznikov. We appreciate all contributors for help.