react-window 2.0.0-alpha.4 → 2.0.0-alpha.6

package/docs/generated/js-docs/List.json

@@ -137,67 +137,90 @@
         ]
       }
     },
-    "rowComponent": {
+    "onResize": {
       "defaultValue": null,
-      "description": "React component responsible for rendering a row.\n\nThis component will receive an `index` and `style` prop by default.\nAdditionally it will receive prop values passed to `rowProps`.\n\n⚠️ The prop types for this component are exported as `RowComponentProps`",
-      "name": "rowComponent",
+      "description": "Callback notified when the List's outermost HTMLElement resizes.\nThis may be used to (re)scroll a row into view.",
+      "name": "onResize",
       "declarations": [
         {
           "fileName": "react-window/lib/components/list/types.ts",
           "name": "TypeLiteral"
         }
       ],
-      "required": true,
+      "required": false,
       "type": {
-        "name": "(props: { index: number; style: CSSProperties; } & RowProps) => ReactNode"
+        "name": "enum",
+        "raw": "((size: { height: number; width: number; }, prevSize: { height: number; width: number; }) => void) | undefined",
+        "value": [
+          {
+            "value": "undefined"
+          },
+          {
+            "value": "(size: { height: number; width: number; }, prevSize: { height: number; width: number; }) => void",
+            "description": "",
+            "fullComment": "",
+            "tags": {}
+          }
+        ]
       }
     },
-    "rowCount": {
+    "onRowsRendered": {
       "defaultValue": null,
-      "description": "Number of items to be rendered in the list.",
-      "name": "rowCount",
+      "description": "Callback notified when the range of visible rows changes.",
+      "name": "onRowsRendered",
       "declarations": [
         {
           "fileName": "react-window/lib/components/list/types.ts",
           "name": "TypeLiteral"
         }
       ],
-      "required": true,
+      "required": false,
       "type": {
-        "name": "number"
+        "name": "enum",
+        "raw": "((args: { startIndex: number; stopIndex: number; }) => void) | undefined",
+        "value": [
+          {
+            "value": "undefined"
+          },
+          {
+            "value": "(args: { startIndex: number; stopIndex: number; }) => void",
+            "description": "",
+            "fullComment": "",
+            "tags": {}
+          }
+        ]
       }
     },
-    "rowHeight": {
-      "defaultValue": null,
-      "description": "Row height (in pixels) or a function that returns a row height (in pixels) given its index and `rowProps` data.",
-      "name": "rowHeight",
+    "overscanCount": {
+      "defaultValue": {
+        "value": "3"
+      },
+      "description": "How many additional rows to render outside of the visible area.\nThis can reduce visual flickering near the edges of a list when scrolling.",
+      "name": "overscanCount",
       "declarations": [
         {
           "fileName": "react-window/lib/components/list/types.ts",
           "name": "TypeLiteral"
         }
       ],
-      "required": true,
+      "required": false,
       "type": {
         "name": "enum",
-        "raw": "number | ((index: number, rowProps: RowProps) => number)",
+        "raw": "number | undefined",
         "value": [
           {
-            "value": "number"
+            "value": "undefined"
           },
           {
-            "value": "(index: number, rowProps: RowProps) => number",
-            "description": "",
-            "fullComment": "",
-            "tags": {}
+            "value": "number"
           }
         ]
       }
     },
-    "rowProps": {
+    "rowComponent": {
       "defaultValue": null,
-      "description": "Additional props to be passed to the rowComponent.\n\n⚠️ This object must not contain either an `index` or `style` prop.",
-      "name": "rowProps",
+      "description": "React component responsible for rendering a row.\n\nThis component will receive an `index` and `style` prop by default.\nAdditionally it will receive prop values passed to `rowProps`.\n\n⚠️ The prop types for this component are exported as `RowComponentProps`",
+      "name": "rowComponent",
       "declarations": [
         {
           "fileName": "react-window/lib/components/list/types.ts",
@@ -206,29 +229,47 @@
       ],
       "required": true,
       "type": {
-        "name": "ExcludeForbiddenKeys<RowProps>"
+        "name": "(props: { index: number; style: CSSProperties; } & RowProps) => ReactNode"
       }
     },
-    "onRowsRendered": {
+    "rowCount": {
       "defaultValue": null,
-      "description": "Callback notified when the range of visible rows changes.",
-      "name": "onRowsRendered",
+      "description": "Number of items to be rendered in the list.",
+      "name": "rowCount",
       "declarations": [
         {
           "fileName": "react-window/lib/components/list/types.ts",
           "name": "TypeLiteral"
         }
       ],
-      "required": false,
+      "required": true,
+      "type": {
+        "name": "number"
+      }
+    },
+    "rowHeight": {
+      "defaultValue": null,
+      "description": "Row height; the following formats are supported:\n- number of pixels (number)\n- percentage of the grid's current height (string)\n- function that returns the row height (in pixels) given an index and `cellProps`",
+      "name": "rowHeight",
+      "declarations": [
+        {
+          "fileName": "react-window/lib/components/list/types.ts",
+          "name": "TypeLiteral"
+        }
+      ],
+      "required": true,
       "type": {
         "name": "enum",
-        "raw": "((args: { startIndex: number; stopIndex: number; }) => void) | undefined",
+        "raw": "string | number | ((index: number, cellProps: RowProps) => number)",
         "value": [
           {
-            "value": "undefined"
+            "value": "string"
           },
           {
-            "value": "(args: { startIndex: number; stopIndex: number; }) => void",
+            "value": "number"
+          },
+          {
+            "value": "(index: number, cellProps: RowProps) => number",
             "description": "",
             "fullComment": "",
             "tags": {}
@@ -236,30 +277,19 @@
         ]
       }
     },
-    "overscanCount": {
-      "defaultValue": {
-        "value": "3"
-      },
-      "description": "How many additional rows to render outside of the visible area.\nThis can reduce visual flickering near the edges of a list when scrolling.",
-      "name": "overscanCount",
+    "rowProps": {
+      "defaultValue": null,
+      "description": "Additional props to be passed to the row-rendering component.\nList will automatically re-render rows when values in this object change.\n\n⚠️ This object must not contain either an `index` or `style` prop.",
+      "name": "rowProps",
       "declarations": [
         {
           "fileName": "react-window/lib/components/list/types.ts",
           "name": "TypeLiteral"
         }
       ],
-      "required": false,
+      "required": true,
       "type": {
-        "name": "enum",
-        "raw": "number | undefined",
-        "value": [
-          {
-            "value": "undefined"
-          },
-          {
-            "value": "number"
-          }
-        ]
+        "name": "ExcludeForbiddenKeys<RowProps>"
       }
     }
   }

package/docs/index.html

@@ -20,8 +20,8 @@
     />
     <meta property="og:image:width" content="1500" />
     <meta property="og:image:height" content="500" />
-    <script type="module" crossorigin src="/assets/index-D8tyZCWm.js"></script>
-    <link rel="stylesheet" crossorigin href="/assets/index-BsBvdJUI.css">
+    <script type="module" crossorigin src="/assets/index-DoMrhaC7.js"></script>
+    <link rel="stylesheet" crossorigin href="/assets/index-BRVPsmMd.css">
   </head>
   <body>
     <div id="root"></div>