react-grid-layout 1.3.1 → 1.3.2

package/README.md

@@ -14,6 +14,7 @@ or autogenerated.
 RGL is React-only and does not require jQuery.
 
 ![BitMEX UI](http://i.imgur.com/oo1NT6c.gif)
+
 > GIF from production usage on [BitMEX.com](https://www.bitmex.com)
 
 [**[Demo](https://react-grid-layout.github.io/react-grid-layout/) | [Changelog](/CHANGELOG.md) | [CodeSandbox Editable demo](https://codesandbox.io/s/5wy3rz5z1x?module=%2Fsrc%2FShowcaseLayout.js)**]
@@ -77,32 +78,32 @@ RGL is React-only and does not require jQuery.
 - [Statsout](https://statsout.com/)
 - [Datto RMM](https://www.datto.com/uk/products/rmm/)
 
-*Know of others? Create a PR to let me know!*
+_Know of others? Create a PR to let me know!_
 
 ## Features
 
-* 100% React - no jQuery
-* Compatible with server-rendered apps
-* Draggable widgets
-* Resizable widgets
-* Static widgets
-* Configurable packing: horizontal, vertical, or off
-* Bounds checking for dragging and resizing
-* 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 with CSS Transforms: [on](http://i.imgur.com/FTogpLp.jpg) / [off](http://i.imgur.com/gOveMm8.jpg), note paint (green) as % of time
-* Compatibility with `<React.StrictMode>`
-
-|Version         | Compatibility    |
-|----------------|------------------|
-| >= 0.17.0      | React 16 & 17    |
-| >= 0.11.3      | React 0.14 & 15  |
-| >= 0.10.0      | React 0.14       |
-| 0.8. - 0.9.2   | React 0.13       |
-| < 0.8          | React 0.12       |
+- 100% React - no jQuery
+- Compatible with server-rendered apps
+- Draggable widgets
+- Resizable widgets
+- Static widgets
+- Configurable packing: horizontal, vertical, or off
+- Bounds checking for dragging and resizing
+- 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 with CSS Transforms: [on](http://i.imgur.com/FTogpLp.jpg) / [off](http://i.imgur.com/gOveMm8.jpg), note paint (green) as % of time
+- Compatibility with `<React.StrictMode>`
+
+| Version      | Compatibility   |
+| ------------ | --------------- |
+| >= 0.17.0    | React 16 & 17   |
+| >= 0.11.3    | React 0.14 & 15 |
+| >= 0.10.0    | React 0.14      |
+| 0.8. - 0.9.2 | React 0.13      |
+| < 0.8        | React 0.12      |
 
 ## Installation
 
@@ -129,23 +130,29 @@ produce a grid with three items where:
 - users will be able to freely drag and resize item `c`
 
 ```js
-import GridLayout from 'react-grid-layout';
+import GridLayout from "react-grid-layout";
 
 class MyFirstGrid extends React.Component {
   render() {
     // layout is an array of objects, see the demo for more complete usage
     const layout = [
-      {i: 'a', x: 0, y: 0, w: 1, h: 2, static: true},
-      {i: 'b', x: 1, y: 0, w: 3, h: 2, minW: 2, maxW: 4},
-      {i: 'c', x: 4, y: 0, w: 1, h: 2}
+      { i: "a", x: 0, y: 0, w: 1, h: 2, static: true },
+      { i: "b", x: 1, y: 0, w: 3, h: 2, minW: 2, maxW: 4 },
+      { i: "c", x: 4, y: 0, w: 1, h: 2 }
     ];
     return (
-      <GridLayout className="layout" layout={layout} cols={12} rowHeight={30} width={1200}>
+      <GridLayout
+        className="layout"
+        layout={layout}
+        cols={12}
+        rowHeight={30}
+        width={1200}
+      >
         <div key="a">a</div>
         <div key="b">b</div>
         <div key="c">c</div>
       </GridLayout>
-    )
+    );
   }
 }
 ```
@@ -153,17 +160,23 @@ class MyFirstGrid extends React.Component {
 You may also choose to set layout properties directly on the children:
 
 ```js
-import GridLayout from 'react-grid-layout';
+import GridLayout from "react-grid-layout";
 
 class MyFirstGrid extends React.Component {
   render() {
     return (
       <GridLayout className="layout" cols={12} rowHeight={30} width={1200}>
-        <div key="a" data-grid={{x: 0, y: 0, w: 1, h: 2, static: true}}>a</div>
-        <div key="b" data-grid={{x: 1, y: 0, w: 3, h: 2, minW: 2, maxW: 4}}>b</div>
-        <div key="c" data-grid={{x: 4, y: 0, w: 1, h: 2}}>c</div>
+        <div key="a" data-grid={{ x: 0, y: 0, w: 1, h: 2, static: true }}>
+          a
+        </div>
+        <div key="b" data-grid={{ x: 1, y: 0, w: 3, h: 2, minW: 2, maxW: 4 }}>
+          b
+        </div>
+        <div key="c" data-grid={{ x: 4, y: 0, w: 1, h: 2 }}>
+          c
+        </div>
       </GridLayout>
-    )
+    );
   }
 }
 ```
@@ -178,21 +191,24 @@ excludes `React`, so it must be otherwise available in your application, either
 To make RGL responsive, use the `<ResponsiveReactGridLayout>` element:
 
 ```js
-import { Responsive as ResponsiveGridLayout } from 'react-grid-layout';
+import { Responsive as ResponsiveGridLayout } from "react-grid-layout";
 
 class MyResponsiveGrid extends React.Component {
   render() {
     // {lg: layout1, md: layout2, ...}
     const layouts = getLayoutsFromSomewhere();
     return (
-      <ResponsiveGridLayout className="layout" layouts={layouts}
-        breakpoints={{lg: 1200, md: 996, sm: 768, xs: 480, xxs: 0}}
-        cols={{lg: 12, md: 10, sm: 6, xs: 4, xxs: 2}}>
+      <ResponsiveGridLayout
+        className="layout"
+        layouts={layouts}
+        breakpoints={{ lg: 1200, md: 996, sm: 768, xs: 480, xxs: 0 }}
+        cols={{ lg: 12, md: 10, sm: 6, xs: 4, xxs: 2 }}
+      >
         <div key="1">1</div>
         <div key="2">2</div>
         <div key="3">3</div>
       </ResponsiveGridLayout>
-    )
+    );
   }
 }
 ```
@@ -215,7 +231,7 @@ positions on drag events. In simple cases a HOC `WidthProvider` can be used to a
 width upon initialization and window resize events.
 
 ```js
-import { Responsive, WidthProvider } from 'react-grid-layout';
+import { Responsive, WidthProvider } from "react-grid-layout";
 
 const ResponsiveGridLayout = WidthProvider(Responsive);
 
@@ -224,14 +240,17 @@ class MyResponsiveGrid extends React.Component {
     // {lg: layout1, md: layout2, ...}
     var layouts = getLayoutsFromSomewhere();
     return (
-      <ResponsiveGridLayout className="layout" layouts={layouts}
-        breakpoints={{lg: 1200, md: 996, sm: 768, xs: 480, xxs: 0}}
-        cols={{lg: 12, md: 10, sm: 6, xs: 4, xxs: 2}}>
+      <ResponsiveGridLayout
+        className="layout"
+        layouts={layouts}
+        breakpoints={{ lg: 1200, md: 996, sm: 768, xs: 480, xxs: 0 }}
+        cols={{ lg: 12, md: 10, sm: 6, xs: 4, xxs: 2 }}
+      >
         <div key="1">1</div>
         <div key="2">2</div>
         <div key="3">3</div>
       </ResponsiveGridLayout>
-    )
+    );
   }
 }
 ```
@@ -396,7 +415,9 @@ onDropDragOver: (e: DragOverEvent) => ?({|w?: number, h?: number|} | false),
 
 // Ref for getting a reference for the grid's wrapping div.
 // You can use this instead of a regular ref and the deprecated `ReactDOM.findDOMNode()`` function.
-innerRef: ?React.Ref<"div">,
+// Note that this type is React.Ref<HTMLDivElement> in TypeScript, Flow has a bug here
+// https://github.com/facebook/flow/issues/8671#issuecomment-862634865
+innerRef: {current: null | HTMLDivElement},
 ```
 
 ### Responsive Grid Layout Props
@@ -494,7 +515,6 @@ will be draggable, even if the item is marked `static: true`.
 
 `<ReactGridLayout>` has [an optimized `shouldComponentUpdate` implementation](lib/ReactGridLayout.jsx), but it relies on the user memoizing the `children` array:
 
-
 ```js
 // lib/ReactGridLayout.jsx
 // ...
@@ -517,7 +537,7 @@ If you memoize your children, you can take advantage of this, and reap faster re
 function MyGrid(props) {
   const children = React.useMemo(() => {
     return new Array(props.count).fill(undefined).map((val, idx) => {
-      return <div key={idx} data-grid={{x: idx, y: 1, w: 1, h: 1}} />;
+      return <div key={idx} data-grid={{ x: idx, y: 1, w: 1, h: 1 }} />;
     });
   }, [props.count]);
   return <ReactGridLayout cols={12}>{children}</ReactGridLayout>;
@@ -540,7 +560,7 @@ const CustomGridItemComponent = React.forwardRef(({style, className, ...props},
   return (
     <div style={{ /* styles */, ...style}} className={className} ref={ref}>
       {/* Some other content */}
-    </div>  
+    </div>
   );
 }
 ```

package/build/utils.js

@@ -779,8 +779,7 @@ function synchronizeLayoutWithChildren(initialLayout
       layout.push(cloneLayoutItem(exists));
     } else {
       if (!isProduction && child.props._grid) {
-        console.warn("`_grid` properties on children have been deprecated as of React 15.2. " + // eslint-disable-line
-        "Please use `data-grid` or add your properties directly to the `layout`.");
+        console.warn("`_grid` properties on children have been deprecated as of React 15.2. " + "Please use `data-grid` or add your properties directly to the `layout`.");
       }
 
       var g = child.props["data-grid"] || child.props._grid; // Hey, this item has a data-grid property, use it.
@@ -842,14 +841,6 @@ function validateLayout(layout
         throw new Error("ReactGridLayout: " + contextName + "[" + i + "]." + subProps[j] + " must be a number!");
       }
     }
-
-    if (item.i && typeof item.i !== "string") {
-      throw new Error("ReactGridLayout: " + contextName + "[" + i + "].i must be a string!");
-    }
-
-    if (item.static !== undefined && typeof item.static !== "boolean") {
-      throw new Error("ReactGridLayout: " + contextName + "[" + i + "].static must be a boolean!");
-    }
   }
 } // Legacy support for verticalCompact: false