README.md 7.87 KB
Newer Older
Pavel Reznikov's avatar
Pavel Reznikov committed
1
2
3
gridstack.js
============

Pavel Reznikov's avatar
Pavel Reznikov committed
4
5
gridstack.js is a jQuery plugin for widget layout. This is drag-and-drop multi-column grid. It allows you to build 
draggable responsive bootstrap v3 friendly layouts. It also works great with [knockout.js](http://knockoutjs.com)
Pavel Reznikov's avatar
Pavel Reznikov committed
6

Pavel Reznikov's avatar
readme    
Pavel Reznikov committed
7
Inspired by [gridster.js](http://gridster.net). Built with love.
Pavel Reznikov's avatar
Pavel Reznikov committed
8
9
10
11

Demo
====

Pavel Reznikov's avatar
Pavel Reznikov committed
12
Please visit http://troolee.github.io/gridstack.js/ for demo.
Pavel Reznikov's avatar
Pavel Reznikov committed
13
14
15
16


Usage
=====
Pavel Reznikov's avatar
readme    
Pavel Reznikov committed
17

Pavel Reznikov's avatar
Pavel Reznikov committed
18
19
## Requirements

Pavel Reznikov's avatar
Pavel Reznikov committed
20
21
22
23
* http://underscorejs.org (>= 1.7.0)
* http://jquery.com (>= 1.11.0)
* http://jqueryui.com (>= 1.11.0)
* (Optional) http://knockoutjs.com (>= 3.2.0)
Pavel Reznikov's avatar
license    
Pavel Reznikov committed
24

Pavel Reznikov's avatar
Pavel Reznikov committed
25
26
27
## Basic usage

```html
28
29
30
31
32
<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>
Pavel Reznikov's avatar
Pavel Reznikov committed
33
    </div>
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
    <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 () {
    var options = {
        cell_height: 80,
        vertical_margin: 10
    };
    $('.grid-stack').gridstack(options);
});
</script>
Pavel Reznikov's avatar
Pavel Reznikov committed
50
51
```

Pavel Reznikov's avatar
Pavel Reznikov committed
52
53
## Options

Pavel Reznikov's avatar
Pavel Reznikov committed
54
55
56
- `auto` - if `false` it tells to do not initialize existing items (default: true)
- `cell_height` - one cell height (default: 60)
- `handle` - draggable handle selector (default: '.grid-stack-item-content')
Pavel Reznikov's avatar
Pavel Reznikov committed
57
- `height` - maximum rows amount. Default is `0` which means no maximum rows
Pavel Reznikov's avatar
Pavel Reznikov committed
58
- `float` - enable floating widgets (default: false)
Pavel Reznikov's avatar
Pavel Reznikov committed
59
- `item_class` - widget class (default: 'grid-stack-item')
Pavel Reznikov's avatar
Pavel Reznikov committed
60
- `min_width` - minimal width. If window width is less grid will be shown in one-column mode (default: 768)
Pavel Reznikov's avatar
Pavel Reznikov committed
61
62
- `placeholder_class` - class for placeholder (default: 'grid-stack-placeholder')
- `vertical_margin` - vertical gap size (default: 20)
Pavel Reznikov's avatar
Pavel Reznikov committed
63
- `width` - amount of columns (default: 12)
Pavel Reznikov's avatar
Pavel Reznikov committed
64

Pavel Reznikov's avatar
Pavel Reznikov committed
65
66
## Grid attributes

67
 - `data-gs-width` - amount of columns
Pavel Reznikov's avatar
Pavel Reznikov committed
68
 - `data-gs-height` - maximum rows amount. Default is `0` which means no maximum rows.
Pavel Reznikov's avatar
Pavel Reznikov committed
69

Pavel Reznikov's avatar
Pavel Reznikov committed
70
71
72
73
74
75
## Item attributes

- `data-gs-x`, `data-gs-y` - element position
- `data-gs-width`, `data-gs-height` - element size
- `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
Pavel Reznikov's avatar
Pavel Reznikov committed
76
- `data-gs-no-move` - disable element moving 
Pavel Reznikov's avatar
Pavel Reznikov committed
77
78
- `data-gs-auto-position` - tells to ignore `data-gs-x` and `data-gs-y` attributes and to place element to the first 
    available position
Pavel Reznikov's avatar
Pavel Reznikov committed
79
80
81
    
## Events

Pavel Reznikov's avatar
Pavel Reznikov committed
82
### onchange(items)
Pavel Reznikov's avatar
Pavel Reznikov committed
83
84
85
86

Occurs when widgets change their position/size

```javascript
87
88
89
var serialize_widget_map = function (items) {
    console.log(items);
};
Pavel Reznikov's avatar
samples    
Pavel Reznikov committed
90

91
92
93
$('.grid-stack').on('change', function (e, items) {
    serialize_widget_map(items);
});
Pavel Reznikov's avatar
Pavel Reznikov committed
94
95
```

Pavel Reznikov's avatar
Pavel Reznikov committed
96
97
98
### ondragstart(event, ui)

```javascript
99
100
101
102
$('.grid-stack').on('dragstart', function (event, ui) {
    var grid = this;
    var element = event.target;
});
Pavel Reznikov's avatar
Pavel Reznikov committed
103
104
105
106
107
```

### ondragstop(event, ui)

```javascript
108
109
110
111
$('.grid-stack').on('dragstop', function (event, ui) {
    var grid = this;
    var element = event.target;
});
Pavel Reznikov's avatar
Pavel Reznikov committed
112
113
114
115
116
```

### onresizestart(event, ui)

```javascript
117
118
119
120
$('.grid-stack').on('resizestart', function (event, ui) {
    var grid = this;
    var element = event.target;
});
Pavel Reznikov's avatar
Pavel Reznikov committed
121
122
123
124
125
```

### onresizestop(event, ui)

```javascript
126
127
128
129
$('.grid-stack').on('resizestop', function (event, ui) {
    var grid = this;
    var element = event.target;
});
Pavel Reznikov's avatar
Pavel Reznikov committed
130
131
132
```


Pavel Reznikov's avatar
Pavel Reznikov committed
133
134
135
136
137
138
139
140
141
142
143
144
145
## API

### add_widget(el, x, y, width, height, auto_position)

Creates new widget.

Parameters:

- `el` - widget to add
- `x`, `y`, `width`, `height` - widget position/dimensions (Optional)
- `auto_position` - if `true` then `x`, `y` parameters will be ignored and widget will be places on the first available
position

Pavel Reznikov's avatar
Pavel Reznikov committed
146
```javascript
Pavel Reznikov's avatar
Pavel Reznikov committed
147
$('.grid-stack').gridstack();
Pavel Reznikov's avatar
Pavel Reznikov committed
148

Pavel Reznikov's avatar
Pavel Reznikov committed
149
var grid = $('.grid-stack').data('gridstack');
Pavel Reznikov's avatar
Pavel Reznikov committed
150
151
152
grid.add_widget(el, 0, 0, 3, 2, true);
```

Pavel Reznikov's avatar
Pavel Reznikov committed
153
154
155
156
157
158
### remove_widget(el)

Removes widget from the grid.

Parameters:

Pavel Reznikov's avatar
samples    
Pavel Reznikov committed
159
- `el` - widget to remove
Pavel Reznikov's avatar
Pavel Reznikov committed
160

161
162
163
164
### remove_all()

Removes all widgets from the grid.

165
166
167
168
169
170
171
### resize(el, width, \[height\])

Changes widget size

Parameters:

- `el` - widget to resize
Pavel Reznikov's avatar
Pavel Reznikov committed
172
- `width`, `height` - new dimensions. If value is `null` or `undefined` it will be ignored.
173
174
175
176
177
178
179
180

### move(el, x, \[y\])

Changes widget position

Parameters:

- `el` - widget to move
Pavel Reznikov's avatar
Pavel Reznikov committed
181
- `x`, `y` - new position. If value is `null` or `undefined` it will be ignored.
182

183
184
185
186
187
188
189
190
191
192
193
194
### resizable(el, val)

Enables/Disables resizing.

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

### movable(el, val)

Enables/Disables moving.

- `el` - widget to modify
195
196
197
198
199
200
201
202
203
204
- `val` - if `true` widget will be draggable.
 
## Utils

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

Sorts array of nodes

- `nodes` - array to sort
- `dir` - `1` for asc, `-1` for desc
Pavel Reznikov's avatar
Pavel Reznikov committed
205
- `width` - width of the grid. If `undefined` the width will be calculated automatically.
206

Pavel Reznikov's avatar
Pavel Reznikov committed
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
## Use with knockout.js

```javascript
ko.components.register('dashboard-grid', {
    viewModel: {
        createViewModel: function (params, componentInfo) {
            var ViewModel = function (params, componentInfo) {
                var grid = null;

                this.widgets = params.widgets;

                this.afterAddWidget = function (items) {
                    _.each(items, function (item) {
                        item = $(item);

                        if (grid == null) {
                            grid = $(componentInfo.element).find('.grid-stack').gridstack({
                                auto: false
                            }).data('gridstack');
                        }

                        grid.add_widget(item);
229
230
231
                        ko.utils.domNodeDisposal.addDisposeCallback(item[0], function () {
                            grid.remove_widget(item);
                        });
Pavel Reznikov's avatar
Pavel Reznikov committed
232
233
234
235
236
237
238
239
240
241
242
                    }, this);
                };

            };

            return new ViewModel(params, componentInfo);
        }
    },
    template: [
        '<div class="grid-stack">',
        '   <!-- ko foreach: widgets, afterRender: afterAddWidget -->',
Pavel Reznikov's avatar
Pavel Reznikov committed
243
244
245
246
247
        '       <div class="grid-stack-item" data-bind="attr: {',
        '               \'data-gs-x\': x, \'data-gs-y\': y,',
        '               \'data-gs-width\': width, \'data-gs-height\': height}">',
        '           <span data-bind="text: $index"></span>',
        '       </div>',
Pavel Reznikov's avatar
Pavel Reznikov committed
248
249
250
251
252
253
254
255
256
257
258
259
260
        '   <!-- /ko -->',
        '</div>'
    ].join('\n')
});
```

and HTML:

```html
<div data-bind="component: {name: 'dashboard-grid', params: $data}"></div>
```


261
262
263
Changes
=======

Pavel Reznikov's avatar
Pavel Reznikov committed
264
#### v0.2.0 (2014-11-30)
Pavel Reznikov's avatar
Pavel Reznikov committed
265

Pavel Reznikov's avatar
Pavel Reznikov committed
266
- add `height` option
Pavel Reznikov's avatar
Pavel Reznikov committed
267
- auto-generate css rules (widgets `height` and `top`)
Pavel Reznikov's avatar
Pavel Reznikov committed
268
269
- add `GridStackUI.Utils.sort` utility function
- add `remove_all` API method
270
- add `resize` and `move` API methods 
271
272
- add `resizable` and `movable` API methods
- add `data-gs-no-move` attribute
Pavel Reznikov's avatar
Pavel Reznikov committed
273
274
- add `float` option
- fix default css rule for inner content
Pavel Reznikov's avatar
Pavel Reznikov committed
275
- minor fixes
Pavel Reznikov's avatar
Pavel Reznikov committed
276

277
278
#### v0.1.0 (2014-11-18)

Pavel Reznikov's avatar
Pavel Reznikov committed
279
280
Very first version.

281

Pavel Reznikov's avatar
license    
Pavel Reznikov committed
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
License
=======

The MIT License (MIT)

Copyright (c) 2014 Pavel Reznikov

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.