vue-grid-layout
Version:
A draggable and resizable grid layout, as a Vue component.
66 lines (64 loc) • 29 kB
HTML
<html lang="en-US">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<title>Properties | Vue Grid Layout - ️A grid layout system for Vue.js</title>
<meta name="generator" content="VuePress 1.9.7">
<link rel="icon" href="/vue-grid-layout/favicon.ico">
<link rel="apple-touch-icon" sizes="180x180" href="https://jbaysolutions.github.io/vue-grid-layout/assets/favicon/apple-touch-icon.png">
<meta name="description" content="A draggable and resizable grid layout, as a Vue component.">
<meta property="article:modified_time" content="2022-07-28T15:52:51.000Z">
<meta property="og:title" content="Properties — Vue Grid Layout">
<meta property="og:description" content="A draggable and resizable grid layout, as a Vue component.">
<meta property="og:type" content="article">
<meta property="og:url" content="/guide/properties.html">
<meta name="twitter:title" content="Properties — Vue Grid Layout">
<meta name="twitter:description" content="A draggable and resizable grid layout, as a Vue component.">
<meta name="twitter:url" content="/guide/properties.html">
<meta name="twitter:card" content="summary_large_image">
<link rel="preload" href="/vue-grid-layout/assets/css/0.styles.62040b1f.css" as="style"><link rel="preload" href="/vue-grid-layout/assets/js/app.3b46d3a7.js" as="script"><link rel="preload" href="/vue-grid-layout/assets/js/5.fbd53fc9.js" as="script"><link rel="preload" href="/vue-grid-layout/assets/js/4.9a10d8f3.js" as="script"><link rel="preload" href="/vue-grid-layout/assets/js/41.d0334a36.js" as="script"><link rel="prefetch" href="/vue-grid-layout/assets/js/1.f5920396.js"><link rel="prefetch" href="/vue-grid-layout/assets/js/10.b35cd169.js"><link rel="prefetch" href="/vue-grid-layout/assets/js/11.33825800.js"><link rel="prefetch" href="/vue-grid-layout/assets/js/12.1a4f2982.js"><link rel="prefetch" href="/vue-grid-layout/assets/js/13.d9abf441.js"><link rel="prefetch" href="/vue-grid-layout/assets/js/14.2ee2c0bb.js"><link rel="prefetch" href="/vue-grid-layout/assets/js/15.dda8bb4d.js"><link rel="prefetch" href="/vue-grid-layout/assets/js/16.decab905.js"><link rel="prefetch" href="/vue-grid-layout/assets/js/17.17d1fea8.js"><link rel="prefetch" href="/vue-grid-layout/assets/js/18.072d74f9.js"><link rel="prefetch" href="/vue-grid-layout/assets/js/19.a5bd48b6.js"><link rel="prefetch" href="/vue-grid-layout/assets/js/20.a6f7c401.js"><link rel="prefetch" href="/vue-grid-layout/assets/js/21.f07a4293.js"><link rel="prefetch" href="/vue-grid-layout/assets/js/22.8c77b52b.js"><link rel="prefetch" href="/vue-grid-layout/assets/js/23.166522b1.js"><link rel="prefetch" href="/vue-grid-layout/assets/js/24.f224653c.js"><link rel="prefetch" href="/vue-grid-layout/assets/js/25.123f3476.js"><link rel="prefetch" href="/vue-grid-layout/assets/js/26.3627e157.js"><link rel="prefetch" href="/vue-grid-layout/assets/js/27.24596d70.js"><link rel="prefetch" href="/vue-grid-layout/assets/js/28.de97d8c2.js"><link rel="prefetch" href="/vue-grid-layout/assets/js/29.902100f1.js"><link rel="prefetch" href="/vue-grid-layout/assets/js/30.6bfee860.js"><link rel="prefetch" href="/vue-grid-layout/assets/js/31.567ea2fd.js"><link rel="prefetch" href="/vue-grid-layout/assets/js/32.72b82452.js"><link rel="prefetch" href="/vue-grid-layout/assets/js/33.6b852b0b.js"><link rel="prefetch" href="/vue-grid-layout/assets/js/34.35990edb.js"><link rel="prefetch" href="/vue-grid-layout/assets/js/35.8b6fa6f0.js"><link rel="prefetch" href="/vue-grid-layout/assets/js/36.a0e45802.js"><link rel="prefetch" href="/vue-grid-layout/assets/js/37.bd32d898.js"><link rel="prefetch" href="/vue-grid-layout/assets/js/38.a192efbf.js"><link rel="prefetch" href="/vue-grid-layout/assets/js/39.85b7f492.js"><link rel="prefetch" href="/vue-grid-layout/assets/js/40.d8f3d249.js"><link rel="prefetch" href="/vue-grid-layout/assets/js/42.f7542798.js"><link rel="prefetch" href="/vue-grid-layout/assets/js/43.d5ada079.js"><link rel="prefetch" href="/vue-grid-layout/assets/js/44.690b0248.js"><link rel="prefetch" href="/vue-grid-layout/assets/js/45.c4a5f6c2.js"><link rel="prefetch" href="/vue-grid-layout/assets/js/46.d847dd7f.js"><link rel="prefetch" href="/vue-grid-layout/assets/js/47.44f6af27.js"><link rel="prefetch" href="/vue-grid-layout/assets/js/48.fc0b14e5.js"><link rel="prefetch" href="/vue-grid-layout/assets/js/49.dd4cba1a.js"><link rel="prefetch" href="/vue-grid-layout/assets/js/50.4186651e.js"><link rel="prefetch" href="/vue-grid-layout/assets/js/51.32fc51c3.js"><link rel="prefetch" href="/vue-grid-layout/assets/js/52.2124af42.js"><link rel="prefetch" href="/vue-grid-layout/assets/js/53.a5360cb7.js"><link rel="prefetch" href="/vue-grid-layout/assets/js/54.7a70587f.js"><link rel="prefetch" href="/vue-grid-layout/assets/js/55.65df1d6e.js"><link rel="prefetch" href="/vue-grid-layout/assets/js/56.2bde5fd7.js"><link rel="prefetch" href="/vue-grid-layout/assets/js/57.f38265c1.js"><link rel="prefetch" href="/vue-grid-layout/assets/js/58.7970354a.js"><link rel="prefetch" href="/vue-grid-layout/assets/js/59.af080563.js"><link rel="prefetch" href="/vue-grid-layout/assets/js/6.eae6137a.js"><link rel="prefetch" href="/vue-grid-layout/assets/js/60.3afbbfc8.js"><link rel="prefetch" href="/vue-grid-layout/assets/js/61.8b9ba428.js"><link rel="prefetch" href="/vue-grid-layout/assets/js/62.a0c81243.js"><link rel="prefetch" href="/vue-grid-layout/assets/js/63.d8c2ffd8.js"><link rel="prefetch" href="/vue-grid-layout/assets/js/7.c2af6ee4.js"><link rel="prefetch" href="/vue-grid-layout/assets/js/8.b45e893b.js"><link rel="prefetch" href="/vue-grid-layout/assets/js/9.b9c5a1a2.js"><link rel="prefetch" href="/vue-grid-layout/assets/js/vendors~docsearch.254ba4e3.js">
<link rel="stylesheet" href="/vue-grid-layout/assets/css/0.styles.62040b1f.css">
</head>
<body>
<div id="app" data-server-rendered="true"><div class="theme-container" data-v-6394a605><header class="navbar"><div class="sidebar-button"><svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" role="img" viewBox="0 0 448 512" class="icon"><path fill="currentColor" d="M436 124H12c-6.627 0-12-5.373-12-12V80c0-6.627 5.373-12 12-12h424c6.627 0 12 5.373 12 12v32c0 6.627-5.373 12-12 12zm0 160H12c-6.627 0-12-5.373-12-12v-32c0-6.627 5.373-12 12-12h424c6.627 0 12 5.373 12 12v32c0 6.627-5.373 12-12 12zm0 160H12c-6.627 0-12-5.373-12-12v-32c0-6.627 5.373-12 12-12h424c6.627 0 12 5.373 12 12v32c0 6.627-5.373 12-12 12z"></path></svg></div> <a href="/vue-grid-layout/" class="home-link router-link-active"><img src="/vue-grid-layout/assets/img/logo.png" alt="Vue Grid Layout - ️A grid layout system for Vue.js" class="logo"> <span class="site-name can-hide">Vue Grid Layout - ️A grid layout system for Vue.js</span></a> <div class="links"><form id="search-form" role="search" class="algolia-search-wrapper search-box"><input id="algolia-search-input" class="search-query"></form> <nav class="nav-links can-hide"><div class="nav-item"><a href="/vue-grid-layout/" class="nav-link">
Home
</a></div><div class="nav-item"><a href="/vue-grid-layout/guide/" class="nav-link router-link-active">
Guide
</a></div><div class="nav-item"><a href="/vue-grid-layout/changelog/" class="nav-link">
Changelog
</a></div><div class="nav-item"><div class="dropdown-wrapper"><button type="button" aria-label="Select language" class="dropdown-title"><span class="title">Languages</span> <span class="arrow down"></span></button> <button type="button" aria-label="Select language" class="mobile-dropdown-title"><span class="title">Languages</span> <span class="arrow right"></span></button> <ul class="nav-dropdown" style="display:none;"><li class="dropdown-item"><!----> <a href="/vue-grid-layout/guide/properties.html" aria-current="page" class="nav-link router-link-exact-active router-link-active">
English
</a></li><li class="dropdown-item"><!----> <a href="/vue-grid-layout/zh/guide/properties.html" class="nav-link">
简体中文
</a></li></ul></div></div> <a href="https://github.com/jbaysolutions/vue-grid-layout" target="_blank" rel="noopener noreferrer" class="repo-link">
GitHub
<span><svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" focusable="false" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15" class="icon outbound"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path> <polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg> <span class="sr-only">(opens new window)</span></span></a></nav></div></header> <div class="sidebar-mask"></div> <aside class="sidebar"><nav class="nav-links"><div class="nav-item"><a href="/vue-grid-layout/" class="nav-link">
Home
</a></div><div class="nav-item"><a href="/vue-grid-layout/guide/" class="nav-link router-link-active">
Guide
</a></div><div class="nav-item"><a href="/vue-grid-layout/changelog/" class="nav-link">
Changelog
</a></div><div class="nav-item"><div class="dropdown-wrapper"><button type="button" aria-label="Select language" class="dropdown-title"><span class="title">Languages</span> <span class="arrow down"></span></button> <button type="button" aria-label="Select language" class="mobile-dropdown-title"><span class="title">Languages</span> <span class="arrow right"></span></button> <ul class="nav-dropdown" style="display:none;"><li class="dropdown-item"><!----> <a href="/vue-grid-layout/guide/properties.html" aria-current="page" class="nav-link router-link-exact-active router-link-active">
English
</a></li><li class="dropdown-item"><!----> <a href="/vue-grid-layout/zh/guide/properties.html" class="nav-link">
简体中文
</a></li></ul></div></div> <a href="https://github.com/jbaysolutions/vue-grid-layout" target="_blank" rel="noopener noreferrer" class="repo-link">
GitHub
<span><svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" focusable="false" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15" class="icon outbound"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path> <polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg> <span class="sr-only">(opens new window)</span></span></a></nav> <div class="carbon-ads" data-v-6394a605></div> <ul class="sidebar-links"><li><section class="sidebar-group depth-0"><p class="sidebar-heading open"><span>Guide</span> <!----></p> <ul class="sidebar-links sidebar-group-items"><li><a href="/vue-grid-layout/guide/" aria-current="page" class="sidebar-link">Installation</a></li><li><a href="/vue-grid-layout/guide/usage.html" class="sidebar-link">Usage</a></li><li><a href="/vue-grid-layout/guide/properties.html" aria-current="page" class="active sidebar-link">Properties</a><ul class="sidebar-sub-headers"><li class="sidebar-sub-header"><a href="/vue-grid-layout/guide/properties.html#gridlayout" class="sidebar-link">GridLayout</a></li><li class="sidebar-sub-header"><a href="/vue-grid-layout/guide/properties.html#griditem" class="sidebar-link">GridItem</a></li></ul></li><li><a href="/vue-grid-layout/guide/events.html" class="sidebar-link">Events</a></li><li><a href="/vue-grid-layout/guide/styling.html" class="sidebar-link">Styling</a></li></ul></section></li><li><section class="sidebar-group depth-0"><p class="sidebar-heading"><span>Examples</span> <!----></p> <ul class="sidebar-links sidebar-group-items"><li><a href="/vue-grid-layout/guide/01-basic.html" class="sidebar-link">01 - Basic</a></li><li><a href="/vue-grid-layout/guide/02-events.html" class="sidebar-link">02 - Move and resize events</a></li><li><a href="/vue-grid-layout/guide/03-multiple-grids.html" class="sidebar-link">03 - Multiple grids</a></li><li><a href="/vue-grid-layout/guide/04-allow-ignore.html" class="sidebar-link">04 - Drag allow/ignore elements</a></li><li><a href="/vue-grid-layout/guide/05-mirrored.html" class="sidebar-link">05 - Mirrored grid layout</a></li><li><a href="/vue-grid-layout/guide/06-responsive.html" class="sidebar-link">06 - Responsive</a></li><li><a href="/vue-grid-layout/guide/07-prevent-collision.html" class="sidebar-link">07 - Prevent Collision</a></li><li><a href="/vue-grid-layout/guide/08-responsive-predefined-layouts.html" class="sidebar-link">08 - Responsive with predefined layouts</a></li><li><a href="/vue-grid-layout/guide/09-dynamic-add-remove.html" class="sidebar-link">09 - Dynamic Add/Remove</a></li><li><a href="/vue-grid-layout/guide/10-drag-from-outside.html" class="sidebar-link">10 - Drag From Outside</a></li><li><a href="/vue-grid-layout/guide/11-bounded.html" class="sidebar-link">11 - Dragging grid items bounded to grid container</a></li></ul></section></li></ul> <footer class="footer" data-v-6394a605>
A product by:
<a href="https://www.jbaysolutions.com/" target="_blank" rel="noopener" class="footer-card" data-v-6394a605><img src="/vue-grid-layout/assets/img/logo-jbay.png" alt="JBay Solutions" data-v-6394a605></a></footer></aside> <main class="page"> <div class="theme-default-content content__default"><h1 id="properties"><a href="#properties" class="header-anchor">#</a> Properties</h1> <h2 id="gridlayout"><a href="#gridlayout" class="header-anchor">#</a> GridLayout</h2> <h3 id="layout"><a href="#layout" class="header-anchor">#</a> layout</h3> <ul><li>type: <code>Array</code></li> <li>required: <code>true</code></li></ul> <p>This is the initial layout of the grid.</p> <p>The value must be an <code>Array</code> of <code>Object</code> items. Each item must have <code>i</code>, <code>x</code>, <code>y</code>, <code>w</code> and <code>h</code> properties. Please refer to the documentation for <code>GridItem</code> below for more information.</p> <h3 id="responsivelayouts"><a href="#responsivelayouts" class="header-anchor">#</a> responsiveLayouts</h3> <ul><li>type: <code>Object</code></li> <li>required: <code>false</code></li> <li>default : <code>{}</code></li></ul> <p>This is the initial layouts of the grid per breakpoint if <code>responsive</code> is set to <code>true</code>.
The keys of the <code>Object</code> are breakpoint names and each value is an <code>Array</code> of <code>Object</code> items as defined by <code>layout</code> prop. eg:{ lg:[layout items], md:[layout items] }.
Setting the prop after the creation of the GridLayout has no effect.</p> <p>See also <a href="#responsive">responsive</a>, <a href="#breakpoints">breakpoints</a> and <a href="#cols">cols</a></p> <h3 id="colnum"><a href="#colnum" class="header-anchor">#</a> colNum</h3> <ul><li>type: <code>Number</code></li> <li>required: <code>false</code></li> <li>default: <code>12</code></li></ul> <p>Says how many columns the grid has.</p> <p>The value should be a <em>natural number</em>.</p> <h3 id="rowheight"><a href="#rowheight" class="header-anchor">#</a> rowHeight</h3> <ul><li>type: <code>Number</code></li> <li>required: <code>false</code></li> <li>default: <code>150</code></li></ul> <p>Says what is a height of a single row in pixels.</p> <h3 id="maxrows"><a href="#maxrows" class="header-anchor">#</a> maxRows</h3> <ul><li>type: <code>Number</code></li> <li>required: <code>false</code></li> <li>default: <code>Infinity</code></li></ul> <p>Says what is a maximal number of rows in the grid.</p> <h3 id="margin"><a href="#margin" class="header-anchor">#</a> margin</h3> <ul><li>type: <code>Array</code></li> <li>required: <code>false</code></li> <li>default: <code>[10, 10]</code></li></ul> <p>Says what are the margins of elements inside the grid.</p> <p>The value must be a two-element <code>Array</code> of <code>Number</code>. Each value is expressed in pixels. The first element is a margin horizontally, the second element is a vertical margin.</p> <h3 id="isdraggable"><a href="#isdraggable" class="header-anchor">#</a> isDraggable</h3> <ul><li>type: <code>Boolean</code></li> <li>required: <code>false</code></li> <li>default: <code>true</code></li></ul> <p>Says if the grids items are draggable.</p> <h3 id="isresizable"><a href="#isresizable" class="header-anchor">#</a> isResizable</h3> <ul><li>type: <code>Boolean</code></li> <li>required: <code>false</code></li> <li>default: <code>true</code></li></ul> <p>Says if the grids items are resizable.</p> <h3 id="ismirrored"><a href="#ismirrored" class="header-anchor">#</a> isMirrored</h3> <ul><li>type: <code>Boolean</code></li> <li>required: <code>false</code></li> <li>default: <code>false</code></li></ul> <p>Says if the RTL/LTR should be reversed.</p> <h3 id="autosize"><a href="#autosize" class="header-anchor">#</a> autoSize</h3> <ul><li>type: <code>Boolean</code></li> <li>required: <code>false</code></li> <li>default: <code>true</code></li></ul> <p>Says if the container height should swells and contracts to fit contents.</p> <h3 id="verticalcompact"><a href="#verticalcompact" class="header-anchor">#</a> verticalCompact</h3> <ul><li>type: <code>Boolean</code></li> <li>required: <code>false</code></li> <li>default: <code>true</code></li></ul> <p>Says if the layout should be compact vertically.</p> <h3 id="restoreondrag"><a href="#restoreondrag" class="header-anchor">#</a> restoreOnDrag</h3> <ul><li>type: <code>Boolean</code></li> <li>required: <code>false</code></li> <li>default: <code>false</code></li></ul> <p>Says if the moved grid items should be restored after an item has been dragged over.</p> <h3 id="preventcollision"><a href="#preventcollision" class="header-anchor">#</a> preventCollision</h3> <ul><li>type: <code>Boolean</code></li> <li>required: <code>false</code></li> <li>default: <code>false</code></li></ul> <p>Says if grid items will move when being dragged over.</p> <h3 id="usecsstransforms"><a href="#usecsstransforms" class="header-anchor">#</a> useCssTransforms</h3> <ul><li>type: <code>Boolean</code></li> <li>required: <code>false</code></li> <li>default: <code>true</code></li></ul> <p>Says if the CSS <code>transition-property: transform;</code> should be used.</p> <h3 id="responsive"><a href="#responsive" class="header-anchor">#</a> responsive</h3> <ul><li>type: <code>Boolean</code></li> <li>required: <code>false</code></li> <li>default: <code>false</code></li></ul> <p>Says if the layout should be responsive to window width</p> <p>See also <a href="#responsivelayouts">responsiveLayouts</a>, <a href="#breakpoints">breakpoints</a> and <a href="#cols">cols</a></p> <h3 id="breakpoints"><a href="#breakpoints" class="header-anchor">#</a> breakpoints</h3> <ul><li>type: <code>Object</code></li> <li>required: <code>false</code></li> <li>default: { lg: 1200, md: 996, sm: 768, xs: 480, xxs: 0 }</li></ul> <p>Breakpoints defined for responsive layout, the parameter represents the width of different devices:lg(large), md(medium), sm(small), xs(extra small). Sets widths on wich column number changes</p> <p>See also <a href="#responsivelayouts">responsiveLayouts</a> and <a href="#cols">cols</a></p> <h3 id="cols"><a href="#cols" class="header-anchor">#</a> cols</h3> <ul><li>type: <code>Object</code></li> <li>required: <code>false</code></li> <li>default: { lg: 12, md: 10, sm: 6, xs: 4, xxs: 2 }</li></ul> <p>Defines number of columns for each breakpoint</p> <h3 id="usestylecursor"><a href="#usestylecursor" class="header-anchor">#</a> useStyleCursor</h3> <ul><li>type: <code>Boolean</code></li> <li>required: <code>false</code></li> <li>default: <code>true</code></li></ul> <p>Says if set the <code>styleCursor</code> option to true. When dragging freezes, setting this value to <code>false</code> may alleviate problems.
<strong>This property is not reactive</strong></p> <h2 id="griditem"><a href="#griditem" class="header-anchor">#</a> GridItem</h2> <h3 id="i"><a href="#i" class="header-anchor">#</a> i</h3> <ul><li>type: <code>String</code></li> <li>required: <code>true</code></li></ul> <p>This is the unique identifier of the item.</p> <h3 id="x"><a href="#x" class="header-anchor">#</a> x</h3> <ul><li>type: <code>Number</code></li> <li>required: <code>true</code></li></ul> <p>Says what is a initial horizontal position of the item (in which column it should be placed).</p> <p>The value must be a <em>whole number</em>.</p> <h3 id="y"><a href="#y" class="header-anchor">#</a> y</h3> <ul><li>type: <code>Number</code></li> <li>required: <code>true</code></li></ul> <p>Says what is a initial vertical position of the item (in which row it should be placed).</p> <p>The value must be a <em>whole number</em>.</p> <h3 id="w"><a href="#w" class="header-anchor">#</a> w</h3> <ul><li>type: <code>Number</code></li> <li>required: <code>true</code></li></ul> <p>Says what is a initial width of the item.</p> <p>The value is a number that is multiplied by <code>colWidth</code>.</p> <h3 id="h"><a href="#h" class="header-anchor">#</a> h</h3> <ul><li>type: <code>Number</code></li> <li>required: <code>true</code></li></ul> <p>Says what is a initial height of the item.</p> <p>The value is a number that is multiplied by <code>rowHeight</code>.</p> <h3 id="minw"><a href="#minw" class="header-anchor">#</a> minW</h3> <ul><li>type: <code>Number</code></li> <li>required: <code>false</code></li> <li>default: <code>1</code></li></ul> <p>Says what is a minimal width of the item. If <code>w</code> will be smaller then <code>minW</code> then <code>w</code> will be set to <code>minW</code>.</p> <p>The value is a number that is multiplied by <code>colWidth</code>.</p> <h3 id="minh"><a href="#minh" class="header-anchor">#</a> minH</h3> <ul><li>type: <code>Number</code></li> <li>required: <code>false</code></li> <li>default: <code>1</code></li></ul> <p>Says what is a minimal hieght of the item. If <code>h</code> will be smaller then <code>minH</code> then <code>h</code> will be set to <code>minH</code>.</p> <p>The value is a number that is multiplied by <code>rowHeight</code>.</p> <h3 id="maxw"><a href="#maxw" class="header-anchor">#</a> maxW</h3> <ul><li>type: <code>Number</code></li> <li>required: <code>false</code></li> <li>default: <code>Infinity</code></li></ul> <p>Says what is a maximal width of the item. If <code>w</code> will be bigger then <code>maxW</code> then <code>w</code> will be set to <code>maxW</code>.</p> <p>The value is a number that is multiplied by <code>colWidth</code>.</p> <h3 id="maxh"><a href="#maxh" class="header-anchor">#</a> maxH</h3> <ul><li>type: <code>Number</code></li> <li>required: <code>false</code></li> <li>default: <code>Infinity</code></li></ul> <p>Says what is a maximal height of the item. If <code>h</code> will be bigger then <code>maxH</code> then <code>h</code> will be set to <code>maxH</code>.</p> <p>The value is a number that is multiplied by <code>rowHeight</code></p> <h3 id="isdraggable-2"><a href="#isdraggable-2" class="header-anchor">#</a> isDraggable</h3> <ul><li>type: <code>Boolean</code></li> <li>required: <code>false</code></li> <li>default: <code>null</code></li></ul> <p>Says if item is draggable.</p> <p>If default value is <code>null</code> then it's inherited from parent.</p> <h3 id="isresizable-2"><a href="#isresizable-2" class="header-anchor">#</a> isResizable</h3> <ul><li>type: <code>Boolean</code></li> <li>required: <code>false</code></li> <li>default: <code>null</code></li></ul> <p>Says if item is resizable.</p> <p>If default value is <code>null</code> then it's inherited from parent.</p> <h3 id="static"><a href="#static" class="header-anchor">#</a> static</h3> <ul><li>type: <code>Boolean</code></li> <li>required: <code>false</code></li> <li>default: <code>false</code></li></ul> <p>Says if item is static (won't be draggable, resizable or moved by other items).</p> <h3 id="dragignorefrom"><a href="#dragignorefrom" class="header-anchor">#</a> dragIgnoreFrom</h3> <ul><li>type: <code>String</code></li> <li>required: <code>false</code></li> <li>default: <code>'a, button'</code></li></ul> <p>Says which elements of the item shouldn't trigger drag event of the item.</p> <p>The value is <code>css-like</code> selector string.</p> <p>For more info please refer to <code>ignoreFrom</code> in <a href="http://interactjs.io/docs/#ignorable-selectors" target="_blank" rel="noopener noreferrer">interact.js docs<span><svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" focusable="false" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15" class="icon outbound"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path> <polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg> <span class="sr-only">(opens new window)</span></span></a>.</p> <h3 id="dragallowfrom"><a href="#dragallowfrom" class="header-anchor">#</a> dragAllowFrom</h3> <ul><li>type: <code>String</code></li> <li>required: <code>false</code></li> <li>default: <code>null</code></li></ul> <p>Says which elements of the item should trigger drag event of the item.</p> <p>The value is <code>css-like</code> selector string.</p> <p>If <code>null</code> then one can drag by any (excluding <code>dragIgnoreFrom</code>) element of the item.</p> <p>For more info please refer to <code>allowFrom</code> in <a href="http://interactjs.io/docs/#ignorable-selectors" target="_blank" rel="noopener noreferrer">interact.js docs<span><svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" focusable="false" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15" class="icon outbound"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path> <polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg> <span class="sr-only">(opens new window)</span></span></a>.</p> <h3 id="resizeignorefrom"><a href="#resizeignorefrom" class="header-anchor">#</a> resizeIgnoreFrom</h3> <ul><li>type: <code>String</code></li> <li>required: <code>false</code></li> <li>default: <code>'a, button'</code></li></ul> <p>Says which elements of the item shouldn't trigger resize event of the item.</p> <p>The value is <code>css-like</code> selector string.</p> <p>For more info please refer to <code>ignoreFrom</code> in <a href="http://interactjs.io/docs/#ignorable-selectors" target="_blank" rel="noopener noreferrer">interact.js docs<span><svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" focusable="false" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15" class="icon outbound"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path> <polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg> <span class="sr-only">(opens new window)</span></span></a>.</p> <h3 id="preserveaspectratio"><a href="#preserveaspectratio" class="header-anchor">#</a> preserveAspectRatio</h3> <ul><li>type: <code>Boolean</code></li> <li>required: <code>false</code></li> <li>default: <code>false</code></li></ul> <p>If 'true', forces the GridItem to preserve its aspect ratio when resizing.</p></div> <footer class="page-edit"><div class="edit-link"><a href="https://github.com/jbaysolutions/vue-grid-layout/edit/master/website/docs/guide/properties.md" target="_blank" rel="noopener noreferrer">Help improve this page!</a> <span><svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" focusable="false" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15" class="icon outbound"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path> <polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg> <span class="sr-only">(opens new window)</span></span></div> <div class="last-updated"><span class="prefix">Last Updated:</span> <span class="time">7/28/2022, 4:52:51 PM</span></div></footer> <div class="page-nav"><p class="inner"><span class="prev">
←
<a href="/vue-grid-layout/guide/usage.html" class="prev">
Usage
</a></span> <span class="next"><a href="/vue-grid-layout/guide/events.html">
Events
</a>
→
</span></p></div> </main></div><div class="global-ui"><!----></div></div>
<script src="/vue-grid-layout/assets/js/app.3b46d3a7.js" defer></script><script src="/vue-grid-layout/assets/js/5.fbd53fc9.js" defer></script><script src="/vue-grid-layout/assets/js/4.9a10d8f3.js" defer></script><script src="/vue-grid-layout/assets/js/41.d0334a36.js" defer></script>
</body>
</html>