react-window 2.1.2 → 2.2.0-alpha.0

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

@@ -1,927 +0,0 @@
-{
-  "tags": {},
-  "filePath": "lib/components/list/List.tsx",
-  "description": "",
-  "displayName": "List",
-  "methods": [],
-  "props": {
-    "className": {
-      "defaultValue": null,
-      "description": "CSS class name.",
-      "name": "className",
-      "parent": {
-        "fileName": "react-window/node_modules/.pnpm/@types+react@19.1.8/node_modules/@types/react/index.d.ts",
-        "name": "HTMLAttributes"
-      },
-      "declarations": [
-        {
-          "fileName": "react-window/node_modules/.pnpm/@types+react@19.1.8/node_modules/@types/react/index.d.ts",
-          "name": "HTMLAttributes"
-        },
-        {
-          "fileName": "react-window/lib/components/list/types.ts",
-          "name": "TypeLiteral"
-        }
-      ],
-      "required": false,
-      "type": {
-        "name": "enum",
-        "raw": "string | undefined",
-        "value": [
-          {
-            "value": "undefined"
-          },
-          {
-            "value": "string"
-          }
-        ]
-      }
-    },
-    "style": {
-      "defaultValue": null,
-      "description": "Optional CSS properties.\nThe list of rows will fill the height defined by this style.",
-      "name": "style",
-      "parent": {
-        "fileName": "react-window/node_modules/.pnpm/@types+react@19.1.8/node_modules/@types/react/index.d.ts",
-        "name": "HTMLAttributes"
-      },
-      "declarations": [
-        {
-          "fileName": "react-window/node_modules/.pnpm/@types+react@19.1.8/node_modules/@types/react/index.d.ts",
-          "name": "HTMLAttributes"
-        },
-        {
-          "fileName": "react-window/lib/components/list/types.ts",
-          "name": "TypeLiteral"
-        }
-      ],
-      "required": false,
-      "type": {
-        "name": "enum",
-        "raw": "CSSProperties | undefined",
-        "value": [
-          {
-            "value": "undefined"
-          },
-          {
-            "value": "CSSProperties",
-            "description": "",
-            "fullComment": "",
-            "tags": {}
-          }
-        ]
-      }
-    },
-    "children": {
-      "defaultValue": null,
-      "description": "Additional content to be rendered within the list (above cells).\nThis property can be used to render things like overlays or tooltips.",
-      "name": "children",
-      "parent": {
-        "fileName": "react-window/node_modules/.pnpm/@types+react@19.1.8/node_modules/@types/react/index.d.ts",
-        "name": "DOMAttributes"
-      },
-      "declarations": [
-        {
-          "fileName": "react-window/node_modules/.pnpm/@types+react@19.1.8/node_modules/@types/react/index.d.ts",
-          "name": "DOMAttributes"
-        },
-        {
-          "fileName": "react-window/lib/components/list/types.ts",
-          "name": "TypeLiteral"
-        }
-      ],
-      "required": false,
-      "type": {
-        "name": "enum",
-        "raw": "ReactNode",
-        "value": [
-          {
-            "value": "undefined"
-          },
-          {
-            "value": "null"
-          },
-          {
-            "value": "string"
-          },
-          {
-            "value": "number"
-          },
-          {
-            "value": "bigint"
-          },
-          {
-            "value": "false"
-          },
-          {
-            "value": "true"
-          },
-          {
-            "value": "ReactElement<unknown, string | JSXElementConstructor<any>>",
-            "description": "Represents a JSX element.\n\nWhere {@link ReactNode} represents everything that can be rendered, `ReactElement`\nonly represents JSX.",
-            "fullComment": "Represents a JSX element.\n\nWhere {@link ReactNode} represents everything that can be rendered, `ReactElement`\nonly represents JSX.\n@template P The type of the props object\n@template T The type of the component or tag\n@example ```tsx\nconst element: ReactElement = <div />;\n```",
-            "tags": {
-              "template": "P The type of the props object\nT The type of the component or tag",
-              "example": "```tsx\nconst element: ReactElement = <div />;\n```"
-            }
-          },
-          {
-            "value": "Iterable<ReactNode>",
-            "description": "",
-            "fullComment": "",
-            "tags": {}
-          },
-          {
-            "value": "ReactPortal",
-            "description": "",
-            "fullComment": "",
-            "tags": {}
-          },
-          {
-            "value": "Promise<AwaitedReactNode>",
-            "description": "Represents the completion of an asynchronous operation",
-            "fullComment": "Represents the completion of an asynchronous operation",
-            "tags": {}
-          }
-        ]
-      }
-    },
-    "defaultHeight": {
-      "defaultValue": {
-        "value": "0"
-      },
-      "description": "Default height of list for initial render.\nThis value is important for server rendering.",
-      "name": "defaultHeight",
-      "declarations": [
-        {
-          "fileName": "react-window/lib/components/list/types.ts",
-          "name": "TypeLiteral"
-        }
-      ],
-      "required": false,
-      "type": {
-        "name": "enum",
-        "raw": "number | undefined",
-        "value": [
-          {
-            "value": "undefined"
-          },
-          {
-            "value": "number"
-          }
-        ]
-      }
-    },
-    "listRef": {
-      "defaultValue": null,
-      "description": "Ref used to interact with this component's imperative API.\n\nThis API has imperative methods for scrolling and a getter for the outermost DOM element.\n\n⚠️ The `useListRef` and `useListCallbackRef` hooks are exported for convenience use in TypeScript projects.",
-      "name": "listRef",
-      "declarations": [
-        {
-          "fileName": "react-window/lib/components/list/types.ts",
-          "name": "TypeLiteral"
-        }
-      ],
-      "required": false,
-      "type": {
-        "name": "enum",
-        "raw": "Ref<ListImperativeAPI> | undefined",
-        "value": [
-          {
-            "value": "undefined"
-          },
-          {
-            "value": "null"
-          },
-          {
-            "value": "(instance: ListImperativeAPI | null) => void | (() => VoidOrUndefinedOnly)",
-            "description": "",
-            "fullComment": "",
-            "tags": {}
-          },
-          {
-            "value": "RefObject<ListImperativeAPI | null>",
-            "description": "Created by {@link createRef}, or {@link useRef} when passed `null`.",
-            "fullComment": "Created by {@link createRef}, or {@link useRef} when passed `null`.\n@template T The type of the ref's value.\n@example ```tsx\nconst ref = createRef<HTMLDivElement>();\n\nref.current = document.createElement('div'); // Error\n```",
-            "tags": {
-              "template": "T The type of the ref's value.",
-              "example": "```tsx\nconst ref = createRef<HTMLDivElement>();\n\nref.current = document.createElement('div'); // Error\n```"
-            }
-          }
-        ]
-      }
-    },
-    "onResize": {
-      "defaultValue": null,
-      "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": false,
-      "type": {
-        "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": {}
-          }
-        ]
-      }
-    },
-    "onRowsRendered": {
-      "defaultValue": null,
-      "description": "Callback notified when the range of visible rows changes.",
-      "name": "onRowsRendered",
-      "declarations": [
-        {
-          "fileName": "react-window/lib/components/list/types.ts",
-          "name": "TypeLiteral"
-        }
-      ],
-      "required": false,
-      "type": {
-        "name": "enum",
-        "raw": "((visibleRows: { startIndex: number; stopIndex: number; }, allRows: { startIndex: number; stopIndex: number; }) => void) | undefined",
-        "value": [
-          {
-            "value": "undefined"
-          },
-          {
-            "value": "(visibleRows: { startIndex: number; stopIndex: number; }, allRows: { startIndex: number; stopIndex: number; }) => void",
-            "description": "",
-            "fullComment": "",
-            "tags": {}
-          }
-        ]
-      }
-    },
-    "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": false,
-      "type": {
-        "name": "enum",
-        "raw": "number | undefined",
-        "value": [
-          {
-            "value": "undefined"
-          },
-          {
-            "value": "number"
-          }
-        ]
-      }
-    },
-    "rowComponent": {
-      "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",
-      "declarations": [
-        {
-          "fileName": "react-window/lib/components/list/types.ts",
-          "name": "TypeLiteral"
-        }
-      ],
-      "required": true,
-      "type": {
-        "name": "(props: { ariaAttributes: { \"aria-posinset\": number; \"aria-setsize\": number; role: \"listitem\"; }; index: number; style: CSSProperties; } & RowProps) => ReactNode"
-      }
-    },
-    "rowCount": {
-      "defaultValue": null,
-      "description": "Number of items to be rendered in the list.",
-      "name": "rowCount",
-      "declarations": [
-        {
-          "fileName": "react-window/lib/components/list/types.ts",
-          "name": "TypeLiteral"
-        }
-      ],
-      "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": "string | number | ((index: number, cellProps: RowProps) => number)",
-        "value": [
-          {
-            "value": "string"
-          },
-          {
-            "value": "number"
-          },
-          {
-            "value": "(index: number, cellProps: RowProps) => number",
-            "description": "",
-            "fullComment": "",
-            "tags": {}
-          }
-        ]
-      }
-    },
-    "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": true,
-      "type": {
-        "name": "ExcludeForbiddenKeys<RowProps>"
-      }
-    },
-    "tagName": {
-      "defaultValue": {
-        "value": "\"div\" as TagName"
-      },
-      "description": "Can be used to override the root HTML element rendered by the List component.\nThe default value is \"div\", meaning that List renders an HTMLDivElement as its root.\n\n⚠️ In most use cases the default ARIA roles are sufficient and this prop is not needed.",
-      "name": "tagName",
-      "declarations": [
-        {
-          "fileName": "react-window/lib/components/list/types.ts",
-          "name": "TypeLiteral"
-        }
-      ],
-      "required": false,
-      "type": {
-        "name": "enum",
-        "raw": "keyof IntrinsicElements | undefined",
-        "value": [
-          {
-            "value": "undefined"
-          },
-          {
-            "value": "\"symbol\""
-          },
-          {
-            "value": "\"object\""
-          },
-          {
-            "value": "\"slot\""
-          },
-          {
-            "value": "\"style\""
-          },
-          {
-            "value": "\"title\""
-          },
-          {
-            "value": "\"search\""
-          },
-          {
-            "value": "\"article\""
-          },
-          {
-            "value": "\"button\""
-          },
-          {
-            "value": "\"dialog\""
-          },
-          {
-            "value": "\"figure\""
-          },
-          {
-            "value": "\"form\""
-          },
-          {
-            "value": "\"img\""
-          },
-          {
-            "value": "\"link\""
-          },
-          {
-            "value": "\"main\""
-          },
-          {
-            "value": "\"menu\""
-          },
-          {
-            "value": "\"menuitem\""
-          },
-          {
-            "value": "\"option\""
-          },
-          {
-            "value": "\"switch\""
-          },
-          {
-            "value": "\"table\""
-          },
-          {
-            "value": "\"text\""
-          },
-          {
-            "value": "\"time\""
-          },
-          {
-            "value": "\"a\""
-          },
-          {
-            "value": "\"abbr\""
-          },
-          {
-            "value": "\"address\""
-          },
-          {
-            "value": "\"area\""
-          },
-          {
-            "value": "\"aside\""
-          },
-          {
-            "value": "\"audio\""
-          },
-          {
-            "value": "\"b\""
-          },
-          {
-            "value": "\"base\""
-          },
-          {
-            "value": "\"bdi\""
-          },
-          {
-            "value": "\"bdo\""
-          },
-          {
-            "value": "\"big\""
-          },
-          {
-            "value": "\"blockquote\""
-          },
-          {
-            "value": "\"body\""
-          },
-          {
-            "value": "\"br\""
-          },
-          {
-            "value": "\"canvas\""
-          },
-          {
-            "value": "\"caption\""
-          },
-          {
-            "value": "\"center\""
-          },
-          {
-            "value": "\"cite\""
-          },
-          {
-            "value": "\"code\""
-          },
-          {
-            "value": "\"col\""
-          },
-          {
-            "value": "\"colgroup\""
-          },
-          {
-            "value": "\"data\""
-          },
-          {
-            "value": "\"datalist\""
-          },
-          {
-            "value": "\"dd\""
-          },
-          {
-            "value": "\"del\""
-          },
-          {
-            "value": "\"details\""
-          },
-          {
-            "value": "\"dfn\""
-          },
-          {
-            "value": "\"div\""
-          },
-          {
-            "value": "\"dl\""
-          },
-          {
-            "value": "\"dt\""
-          },
-          {
-            "value": "\"em\""
-          },
-          {
-            "value": "\"embed\""
-          },
-          {
-            "value": "\"fieldset\""
-          },
-          {
-            "value": "\"figcaption\""
-          },
-          {
-            "value": "\"footer\""
-          },
-          {
-            "value": "\"h1\""
-          },
-          {
-            "value": "\"h2\""
-          },
-          {
-            "value": "\"h3\""
-          },
-          {
-            "value": "\"h4\""
-          },
-          {
-            "value": "\"h5\""
-          },
-          {
-            "value": "\"h6\""
-          },
-          {
-            "value": "\"head\""
-          },
-          {
-            "value": "\"header\""
-          },
-          {
-            "value": "\"hgroup\""
-          },
-          {
-            "value": "\"hr\""
-          },
-          {
-            "value": "\"html\""
-          },
-          {
-            "value": "\"i\""
-          },
-          {
-            "value": "\"iframe\""
-          },
-          {
-            "value": "\"input\""
-          },
-          {
-            "value": "\"ins\""
-          },
-          {
-            "value": "\"kbd\""
-          },
-          {
-            "value": "\"keygen\""
-          },
-          {
-            "value": "\"label\""
-          },
-          {
-            "value": "\"legend\""
-          },
-          {
-            "value": "\"li\""
-          },
-          {
-            "value": "\"map\""
-          },
-          {
-            "value": "\"mark\""
-          },
-          {
-            "value": "\"meta\""
-          },
-          {
-            "value": "\"meter\""
-          },
-          {
-            "value": "\"nav\""
-          },
-          {
-            "value": "\"noindex\""
-          },
-          {
-            "value": "\"noscript\""
-          },
-          {
-            "value": "\"ol\""
-          },
-          {
-            "value": "\"optgroup\""
-          },
-          {
-            "value": "\"output\""
-          },
-          {
-            "value": "\"p\""
-          },
-          {
-            "value": "\"param\""
-          },
-          {
-            "value": "\"picture\""
-          },
-          {
-            "value": "\"pre\""
-          },
-          {
-            "value": "\"progress\""
-          },
-          {
-            "value": "\"q\""
-          },
-          {
-            "value": "\"rp\""
-          },
-          {
-            "value": "\"rt\""
-          },
-          {
-            "value": "\"ruby\""
-          },
-          {
-            "value": "\"s\""
-          },
-          {
-            "value": "\"samp\""
-          },
-          {
-            "value": "\"script\""
-          },
-          {
-            "value": "\"section\""
-          },
-          {
-            "value": "\"select\""
-          },
-          {
-            "value": "\"small\""
-          },
-          {
-            "value": "\"source\""
-          },
-          {
-            "value": "\"span\""
-          },
-          {
-            "value": "\"strong\""
-          },
-          {
-            "value": "\"sub\""
-          },
-          {
-            "value": "\"summary\""
-          },
-          {
-            "value": "\"sup\""
-          },
-          {
-            "value": "\"template\""
-          },
-          {
-            "value": "\"tbody\""
-          },
-          {
-            "value": "\"td\""
-          },
-          {
-            "value": "\"textarea\""
-          },
-          {
-            "value": "\"tfoot\""
-          },
-          {
-            "value": "\"th\""
-          },
-          {
-            "value": "\"thead\""
-          },
-          {
-            "value": "\"tr\""
-          },
-          {
-            "value": "\"track\""
-          },
-          {
-            "value": "\"u\""
-          },
-          {
-            "value": "\"ul\""
-          },
-          {
-            "value": "\"var\""
-          },
-          {
-            "value": "\"video\""
-          },
-          {
-            "value": "\"wbr\""
-          },
-          {
-            "value": "\"webview\""
-          },
-          {
-            "value": "\"svg\""
-          },
-          {
-            "value": "\"animate\""
-          },
-          {
-            "value": "\"animateMotion\""
-          },
-          {
-            "value": "\"animateTransform\""
-          },
-          {
-            "value": "\"circle\""
-          },
-          {
-            "value": "\"clipPath\""
-          },
-          {
-            "value": "\"defs\""
-          },
-          {
-            "value": "\"desc\""
-          },
-          {
-            "value": "\"ellipse\""
-          },
-          {
-            "value": "\"feBlend\""
-          },
-          {
-            "value": "\"feColorMatrix\""
-          },
-          {
-            "value": "\"feComponentTransfer\""
-          },
-          {
-            "value": "\"feComposite\""
-          },
-          {
-            "value": "\"feConvolveMatrix\""
-          },
-          {
-            "value": "\"feDiffuseLighting\""
-          },
-          {
-            "value": "\"feDisplacementMap\""
-          },
-          {
-            "value": "\"feDistantLight\""
-          },
-          {
-            "value": "\"feDropShadow\""
-          },
-          {
-            "value": "\"feFlood\""
-          },
-          {
-            "value": "\"feFuncA\""
-          },
-          {
-            "value": "\"feFuncB\""
-          },
-          {
-            "value": "\"feFuncG\""
-          },
-          {
-            "value": "\"feFuncR\""
-          },
-          {
-            "value": "\"feGaussianBlur\""
-          },
-          {
-            "value": "\"feImage\""
-          },
-          {
-            "value": "\"feMerge\""
-          },
-          {
-            "value": "\"feMergeNode\""
-          },
-          {
-            "value": "\"feMorphology\""
-          },
-          {
-            "value": "\"feOffset\""
-          },
-          {
-            "value": "\"fePointLight\""
-          },
-          {
-            "value": "\"feSpecularLighting\""
-          },
-          {
-            "value": "\"feSpotLight\""
-          },
-          {
-            "value": "\"feTile\""
-          },
-          {
-            "value": "\"feTurbulence\""
-          },
-          {
-            "value": "\"filter\""
-          },
-          {
-            "value": "\"foreignObject\""
-          },
-          {
-            "value": "\"g\""
-          },
-          {
-            "value": "\"image\""
-          },
-          {
-            "value": "\"line\""
-          },
-          {
-            "value": "\"linearGradient\""
-          },
-          {
-            "value": "\"marker\""
-          },
-          {
-            "value": "\"mask\""
-          },
-          {
-            "value": "\"metadata\""
-          },
-          {
-            "value": "\"mpath\""
-          },
-          {
-            "value": "\"path\""
-          },
-          {
-            "value": "\"pattern\""
-          },
-          {
-            "value": "\"polygon\""
-          },
-          {
-            "value": "\"polyline\""
-          },
-          {
-            "value": "\"radialGradient\""
-          },
-          {
-            "value": "\"rect\""
-          },
-          {
-            "value": "\"set\""
-          },
-          {
-            "value": "\"stop\""
-          },
-          {
-            "value": "\"textPath\""
-          },
-          {
-            "value": "\"tspan\""
-          },
-          {
-            "value": "\"use\""
-          },
-          {
-            "value": "\"view\""
-          }
-        ]
-      }
-    }
-  }
-}