Widgets may be added or removed without rebuilding grid
Layout can be serialized and restored
Responsive breakpoints
Separate layouts per responsive breakpoint
Grid Items placed using CSS Transforms
Performance: on / off, note paint (green) as % of time
Usage
Use ReactGridLayout like any other component.
var ReactGridLayout = require('react-grid-layout');//...render: function() { // layout is an array of objects, see the demo var layout = getOrGenerateLayout(); return ( <ReactGridLayout className="layout" layout={layout} cols={12} rowHeight={30}> <div key={1}>1</div> <div key={2}>2</div> <div key={3}>3</div
You can also set layout properties directly on the children:
A module usable in a <script> tag is included here. It uses a UMD shim and
excludes React, so it must be otherwise available in your application, either via RequireJS or on window.React.
Responsive Usage
To make RGL responsive, use the <ResponsiveReactGridLayout> element:
When in responsive mode, you should supply at least one breakpoint via the layouts property.
When using layouts, it is best to supply as many breakpoints as possible, especially the largest one.
If the largest is provided, RGL will attempt to interpolate the rest.
For the time being, it is not possible to supply responsive mappings via the _grid property on individual
items, but that is coming soon.
Grid Layout Props
RGL supports the following properties (see the source for the final word on this):
//// Basic props//// If true, the container height swells and contracts to fit contentsautoSize: React.PropTypes.bool,// {name: pxVal}, e.g. {lg: 1200, md: 996, sm: 768, xs: 480}breakpoints: React.PropTypes.object,// Number of columns in this layout.cols: React.PropTypes.number,// A selector that will not be draggable.draggableCancel: React.PropTypes.string,// A selector for the draggable handlerdraggableHandle: React.PropTypes.string,// If true, the layout will compact verticallyverticalCompact: React.PropTypes.bool,// Layout is an array of object with the format:// {x: Number, y: Number, w: Number, h: Number}// The index into the layout must match the key used on each item component.// If you choose to use custom keys, you can specify that key in the layout// array objects like so:// {i: String, x: Number, y: Number, w: Number, h: Number}layout
Responsive Grid Layout Props
The responsive grid layout can be used instead. It supports all of the props above, excepting layout.
The new properties and changes are:
// {name: pxVal}, e.g. {lg: 1200, md: 996, sm: 768, xs: 480}// Breakpoint names are arbitrary but must match in the cols and layouts objects.breakpoints: React.PropTypes.object,// # of cols. This is a breakpoint -> cols map, e.g. {lg: 12, md: 10, ...}cols: React.PropTypes.object,// layouts is an object mapping breakpoints to layouts.// e.g. {lg: Layout, md: Layout, ...}layouts: React.PropTypes.object//// Callbacks//// Calls back with breakpoint and new # colsonBreakpointChange: React.PropTypes.func,// Callback so you can save the layout.// Calls back with (currentLayout, allLayouts). allLayouts are keyed by breakpoint.onLayoutChange: React.PropTypes.func
Grid Item Props
RGL supports the following properties on grid items or layout items. When initializing a grid,
build a layout array (as in the first example above), or attach this object as the _grid property
to each of your child elements (as in the second example).
Note that if a grid item is provided but incomplete (missing one of x, y, w, or h), an error
will be thrown so you can correct your layout.
If no properties are provided for a grid item, one will be generated with a width and height of 1.
You can set minimums and maximums for each dimension. This is for resizing; it of course has no effect if resizing
is disabled. Errors will be thrown if your mins and maxes overlap incorrectly, or your initial dimensions
are out of range.
Any GridItem properties defined directly on the layout item will take precedence over globally-set options. For
example, if the layout has the property isDraggable: false, but the grid item has isDraggable: true, the item
will be draggable.
{ // These are all in grid units, not pixels x: React.PropTypes.number.isRequired, y: React.PropTypes.number.isRequired, w: React.PropTypes.number.isRequired, h: React.PropTypes.number.isRequired, minW: React.PropTypes.number, maxW: React.PropTypes.number, minH: React.PropTypes.number, maxH: React.PropTypes.number, // If true, equal to `isDraggable: false, isResizable: false`. static: React.PropTypes.bool, // If false, will not be draggable. Overrides `static`. isDraggable: React.PropTypes.bool, // If false, will not be resizable. Overrides `static`. isResizable: React.PropTypes.bool, className: React.PropTypes.string, // Selector for draggable handle handle: React.PropTypes.string, // Selector for draggable cancel (see react-draggable) cancel: React.PropTypes.string