@@ -9,7 +9,7 @@ vue-grid-layout是一个类似于[Gridster](http://dsmorse.github.io/gridster.js
9
9
### ** 当前版本:** 2.3.8 (支持 Vue 2.2+)
10
10
11
11
### ** Vue 2.1.10 及以下请使用 [ 2.1.3] ( https://github.com/jbaysolutions/vue-grid-layout/tree/2.1.3 ) **
12
- ### ** Vue 1 请使用 [ 1.0.3] ( https://github.com/jbaysolutions/vue-grid-layout/tree/1.0.3 ) **
12
+ ### ** Vue 1 请使用 [ 1.0.3] ( https://github.com/jbaysolutions/vue-grid-layout/tree/1.0.3 ) **
13
13
14
14
<br />
15
15
@@ -64,10 +64,10 @@ Also check https://cli.vuejs.org/guide/build-targets.html#library
64
64
65
65
#### npm
66
66
67
- # 使用 npm
67
+ # 使用 npm
68
68
npm install vue-grid-layout --save
69
-
70
- # 使用 yarn
69
+
70
+ # 使用 yarn
71
71
yarn add vue-grid-layout
72
72
73
73
@@ -77,7 +77,7 @@ Also check https://cli.vuejs.org/guide/build-targets.html#library
77
77
import VueGridLayout from ' vue-grid-layout' ;
78
78
```
79
79
80
- 加入到 Vue 组件
80
+ 加入到 Vue 组件
81
81
82
82
``` javascript
83
83
export default {
@@ -87,8 +87,8 @@ Also check https://cli.vuejs.org/guide/build-targets.html#library
87
87
},
88
88
// ... data, methods, mounted (), etc.
89
89
}
90
-
91
- ```
90
+
91
+ ```
92
92
93
93
#### 浏览器
94
94
@@ -123,14 +123,14 @@ Also check https://cli.vuejs.org/guide/build-targets.html#library
123
123
{" x" : 0 ," y" : 9 ," w" : 2 ," h" : 3 ," i" : " 18" },
124
124
{" x" : 2 ," y" : 6 ," w" : 2 ," h" : 2 ," i" : " 19" }
125
125
];
126
-
126
+
127
127
new Vue ({
128
128
el: ' #app' ,
129
129
data: {
130
130
layout: testLayout,
131
131
},
132
132
});
133
- ```
133
+ ```
134
134
135
135
136
136
``` html
@@ -167,38 +167,46 @@ Also check https://cli.vuejs.org/guide/build-targets.html#library
167
167
##### GridLayout
168
168
169
169
* ** layout**
170
-
170
+
171
171
* type: ` Array `
172
172
* required: ` true `
173
173
174
174
数据源。值必须为 ` Array ` ,其数据项为 ` Object ` 。 每条数据项必须有 ` i ` , ` x ` , ` y ` , ` w ` 和 ` h ` 属性。 请参考下面的 ` GridItem ` 。
175
175
176
+ * ** responsiveLayouts**
177
+
178
+ * type: ` Object `
179
+ * required: ` false `
180
+ * default: ` {} `
181
+
182
+ 如果 ` responsive ` 设置为 ` true ` ,该配置将作为栅格中每个断点的初始布局。键值是断点名称,每项的值都是类似 ` layout ` 属性定义的数据结构,值必须为 ` Array ` ,其数据项为 ` Object ` 。例如: ` {lg: [layout items], md: [layout items]} ` 。需要注意的是,在创建栅格布局后设置该属性无效。
183
+
176
184
* ** colNum**
177
-
185
+
178
186
* type: ` Number `
179
187
* required: ` false `
180
188
* default: ` 12 `
181
189
182
190
定义栅格系统的列数,其值需为自然数。
183
191
184
192
* ** rowHeight**
185
-
193
+
186
194
* type: ` Number `
187
195
* required: ` false `
188
196
* default: ` 150 `
189
197
190
198
每行的高度,单位像素。
191
199
192
200
* ** maxRows**
193
-
201
+
194
202
* type: ` Number `
195
203
* required: ` false `
196
204
* default: ` Infinity `
197
205
198
206
定义最大行数。
199
207
200
208
* ** margin**
201
-
209
+
202
210
* type: ` Array `
203
211
* required: ` false `
204
212
* default: ` [10, 10] `
@@ -208,55 +216,55 @@ Also check https://cli.vuejs.org/guide/build-targets.html#library
208
216
值必须是包含两个 ` Number ` 的数组,数组中第一个元素表示水平边距,第二个表示垂直边距,单位为像素。
209
217
210
218
* ** isDraggable**
211
-
219
+
212
220
* type: ` Boolean `
213
221
* required: ` false `
214
222
* default: ` true `
215
223
216
224
标识栅格中的元素是否可拖拽。
217
225
218
226
* ** isResizable**
219
-
227
+
220
228
* type: ` Boolean `
221
229
* required: ` false `
222
230
* default: ` true `
223
231
224
232
标识栅格中的元素是否可调整大小。
225
233
226
234
* ** isMirrored**
227
-
235
+
228
236
* type: ` Boolean `
229
237
* required: ` false `
230
238
* default: ` false `
231
239
232
240
标识栅格中的元素是否可镜像反转。
233
241
234
242
* ** autoSize**
235
-
243
+
236
244
* type: ` Boolean `
237
245
* required: ` false `
238
246
* default: ` true `
239
247
240
248
标识容器是否自动调整大小。
241
249
242
250
* ** verticalCompact**
243
-
251
+
244
252
* type: ` Boolean `
245
253
* required: ` false `
246
254
* default: ` true `
247
255
248
256
标识布局是否垂直压缩。
249
257
250
258
* ** useCssTransforms**
251
-
259
+
252
260
* type: ` Boolean `
253
261
* required: ` false `
254
262
* default: ` true `
255
263
256
264
标识是否使用CSS属性 ` transition-property: transform; ` 。
257
265
258
266
* ** responsive**
259
-
267
+
260
268
* type: ` Boolean `
261
269
* required: ` false `
262
270
* default: ` false `
@@ -283,106 +291,106 @@ Also check https://cli.vuejs.org/guide/build-targets.html#library
283
291
##### GridItem
284
292
285
293
* ** i**
286
-
294
+
287
295
* type: ` String `
288
296
* required: ` true `
289
297
290
298
栅格中元素的ID。
291
299
292
300
* ** x**
293
-
301
+
294
302
* type: ` Number `
295
303
* required: ` true `
296
304
297
305
标识栅格元素位于第几列,需为自然数。
298
306
299
307
* ** y**
300
-
308
+
301
309
* type: ` Number `
302
310
* required: ` true `
303
311
304
312
标识栅格元素位于第几行,需为自然数。
305
313
306
314
* ** w**
307
-
315
+
308
316
* type: ` Number `
309
317
* required: ` true `
310
318
311
319
标识栅格元素的初始宽度,值为` colWidth ` 的倍数。
312
320
313
321
* ** h**
314
-
322
+
315
323
* type: ` Number `
316
324
* required: ` true `
317
325
318
326
标识栅格元素的初始高度,值为` rowHeight ` 的倍数。
319
327
320
328
* ** minW**
321
-
329
+
322
330
* type: ` Number `
323
331
* required: ` false `
324
332
* default: ` 1 `
325
333
326
334
栅格元素的最小宽度,值为` colWidth ` 的倍数。
327
-
335
+
328
336
如果` w ` 小于` minW ` ,则` minW ` 的值会被` w ` 覆盖。
329
337
330
338
* ** minH**
331
-
339
+
332
340
* type: ` Number `
333
341
* required: ` false `
334
342
* default: ` 1 `
335
343
336
344
栅格元素的最小高度,值为` rowHeight ` 的倍数。
337
-
345
+
338
346
如果` h ` 小于` minH ` ,则` minH ` 的值会被` h ` 覆盖。
339
347
340
348
* ** maxW**
341
-
349
+
342
350
* type: ` Number `
343
351
* required: ` false `
344
352
* default: ` Infinity `
345
353
346
354
栅格元素的最大宽度,值为` colWidth ` 的倍数。
347
-
355
+
348
356
如果` w ` 大于` maxW ` ,则` maxW ` 的值会被` w ` 覆盖。
349
357
350
358
* ** maxH**
351
-
359
+
352
360
* type: ` Number `
353
361
* required: ` false `
354
362
* default: ` Infinity `
355
363
356
364
栅格元素的最大高度,值为` rowHeight ` 的倍数。
357
-
365
+
358
366
如果` h ` 大于` maxH ` ,则` maxH ` 的值会被` h ` 覆盖。
359
367
360
368
* ** isDraggable**
361
-
369
+
362
370
* type: ` Boolean `
363
371
* required: ` false `
364
372
* default: ` null `
365
373
366
374
标识栅格元素是否可拖拽。如果值为` null ` 则取决于父容器。
367
375
368
376
* ** isResizable**
369
-
377
+
370
378
* type: ` Boolean `
371
379
* required: ` false `
372
380
* default: ` null `
373
381
374
382
标识栅格元素是否可调整大小。如果值为` null ` 则取决于父容器。
375
383
376
384
* ** static**
377
-
385
+
378
386
* type: ` Boolean `
379
387
* required: ` false `
380
388
* default: ` false `
381
389
382
390
标识栅格元素是否为静态的(无法拖拽、调整大小或被其他元素移动)。
383
391
384
392
* ** dragIgnoreFrom**
385
-
393
+
386
394
* type: ` String `
387
395
* required: ` false `
388
396
* default: ` 'a, button' `
@@ -392,7 +400,7 @@ Also check https://cli.vuejs.org/guide/build-targets.html#library
392
400
请参考 [ interact.js docs] ( http://interactjs.io/docs/#ignorable-selectors ) 中的` ignoreFrom ` 。
393
401
394
402
* ** dragAllowFrom**
395
-
403
+
396
404
* type: ` String `
397
405
* required: ` false `
398
406
* default: ` null `
@@ -404,7 +412,7 @@ Also check https://cli.vuejs.org/guide/build-targets.html#library
404
412
请参考 [ interact.js docs] ( http://interactjs.io/docs/#ignorable-selectors ) 中的` allowFrom ` 。
405
413
406
414
* ** resizeIgnoreFrom**
407
-
415
+
408
416
* type: ` String `
409
417
* required: ` false `
410
418
* default: ` 'a, button' `
@@ -419,7 +427,7 @@ Also check https://cli.vuejs.org/guide/build-targets.html#library
419
427
420
428
每一个栅格元素` grid-item ` 上都可以添加监听器,用于监听移动和调整大小事件,这样父级Vue对象就可以收到通知。
421
429
422
- [ 示例] ( https://jbaysolutions.github.io/vue-grid-layout/examples/02-events.html )
430
+ [ 示例] ( https://jbaysolutions.github.io/vue-grid-layout/examples/02-events.html )
423
431
424
432
```` html
425
433
@@ -453,7 +461,7 @@ Also check https://cli.vuejs.org/guide/build-targets.html#library
453
461
{{item.i}}
454
462
</grid-item >
455
463
</grid-layout >
456
- ````
464
+ ````
457
465
458
466
* ** layoutCreatedEvent**
459
467
@@ -518,12 +526,12 @@ Also check https://cli.vuejs.org/guide/build-targets.html#library
518
526
* ** resizeEvent**
519
527
520
528
调整大小时的事件
521
-
529
+
522
530
``` javascript
523
531
resizeEvent : function (i , newH , newW , newHPx , newWPx ){
524
532
console .log (" RESIZE i=" + i + " , H=" + newH + " , W=" + newW + " , H(px)=" + newHPx + " , W(px)=" + newWPx);
525
533
},
526
- ```
534
+ ```
527
535
528
536
* ** movedEvent**
529
537
@@ -538,21 +546,21 @@ Also check https://cli.vuejs.org/guide/build-targets.html#library
538
546
* ** resizedEvent**
539
547
540
548
调整大小后的事件
541
-
549
+
542
550
``` javascript
543
551
/**
544
- *
552
+ *
545
553
* @param i the item id/index
546
- * @param newH new height in grid rows
554
+ * @param newH new height in grid rows
547
555
* @param newW new width in grid columns
548
556
* @param newHPx new height in pixels
549
557
* @param newWPx new width in pixels
550
- *
558
+ *
551
559
*/
552
560
resizedEvent : function (i , newH , newW , newHPx , newWPx ){
553
561
console .log (" RESIZED i=" + i + " , H=" + newH + " , W=" + newW + " , H(px)=" + newHPx + " , W(px)=" + newWPx);
554
562
},
555
- ```
563
+ ```
556
564
557
565
558
566
## 如何贡献
0 commit comments