diff --git a/docs/react/functions/VList.md b/docs/react/functions/VList.md index 091a5806..d999fa58 100644 --- a/docs/react/functions/VList.md +++ b/docs/react/functions/VList.md @@ -6,7 +6,7 @@ > **VList**(`props`): `ReactNode` -Defined in: [src/react/VList.tsx:43](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/react/VList.tsx#L43) +Defined in: [src/react/VList.tsx:43](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/react/VList.tsx#L43) Virtualized list component. See [VListProps](../interfaces/VListProps.md) and [VListHandle](../interfaces/VListHandle.md). diff --git a/docs/react/functions/Virtualizer.md b/docs/react/functions/Virtualizer.md index 55b2858d..cdbea5af 100644 --- a/docs/react/functions/Virtualizer.md +++ b/docs/react/functions/Virtualizer.md @@ -6,7 +6,7 @@ > **Virtualizer**(`props`): `ReactNode` -Defined in: [src/react/Virtualizer.tsx:171](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/react/Virtualizer.tsx#L171) +Defined in: [src/react/Virtualizer.tsx:171](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/react/Virtualizer.tsx#L171) Customizable list virtualizer for advanced usage. See [VirtualizerProps](../interfaces/VirtualizerProps.md) and [VirtualizerHandle](../interfaces/VirtualizerHandle.md). diff --git a/docs/react/functions/WindowVirtualizer.md b/docs/react/functions/WindowVirtualizer.md index 8d637595..7855cd7a 100644 --- a/docs/react/functions/WindowVirtualizer.md +++ b/docs/react/functions/WindowVirtualizer.md @@ -6,7 +6,7 @@ > **WindowVirtualizer**(`props`): `ReactNode` -Defined in: [src/react/WindowVirtualizer.tsx:121](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/react/WindowVirtualizer.tsx#L121) +Defined in: [src/react/WindowVirtualizer.tsx:121](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/react/WindowVirtualizer.tsx#L121) [Virtualizer](Virtualizer.md) controlled by the window scrolling. See [WindowVirtualizerProps](../interfaces/WindowVirtualizerProps.md) and [WindowVirtualizerHandle](../interfaces/WindowVirtualizerHandle.md). diff --git a/docs/react/functions/experimental_VGrid.md b/docs/react/functions/experimental_VGrid.md index 620a325f..a364938d 100644 --- a/docs/react/functions/experimental_VGrid.md +++ b/docs/react/functions/experimental_VGrid.md @@ -6,7 +6,7 @@ > **experimental\_VGrid**(`props`): `ReactNode` -Defined in: [src/react/VGrid.tsx:205](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/react/VGrid.tsx#L205) +Defined in: [src/react/VGrid.tsx:216](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/react/VGrid.tsx#L216) Virtualized grid component. See [VGridProps](../interfaces/VGridProps.md) and [VGridHandle](../interfaces/VGridHandle.md). diff --git a/docs/react/interfaces/CacheSnapshot.md b/docs/react/interfaces/CacheSnapshot.md index eca009b9..89029086 100644 --- a/docs/react/interfaces/CacheSnapshot.md +++ b/docs/react/interfaces/CacheSnapshot.md @@ -4,7 +4,7 @@ # Interface: CacheSnapshot -Defined in: [src/core/types.ts:15](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/core/types.ts#L15) +Defined in: [src/core/types.ts:15](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/core/types.ts#L15) Serializable cache snapshot. @@ -16,4 +16,4 @@ Serializable cache snapshot. > **\[cacheSymbol\]**: `never` -Defined in: [src/core/types.ts:16](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/core/types.ts#L16) +Defined in: [src/core/types.ts:16](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/core/types.ts#L16) diff --git a/docs/react/interfaces/CustomCellComponentProps.md b/docs/react/interfaces/CustomCellComponentProps.md index 51d7e1d4..8c9e20d3 100644 --- a/docs/react/interfaces/CustomCellComponentProps.md +++ b/docs/react/interfaces/CustomCellComponentProps.md @@ -4,7 +4,7 @@ # Interface: CustomCellComponentProps -Defined in: [src/react/VGrid.tsx:34](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/react/VGrid.tsx#L34) +Defined in: [src/react/VGrid.tsx:37](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/react/VGrid.tsx#L37) Props of customized cell component for [VGrid](../functions/experimental_VGrid.md). @@ -14,7 +14,7 @@ Props of customized cell component for [VGrid](../functions/experimental_VGrid.m > **style**: `CSSProperties` -Defined in: [src/react/VGrid.tsx:35](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/react/VGrid.tsx#L35) +Defined in: [src/react/VGrid.tsx:38](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/react/VGrid.tsx#L38) *** @@ -22,4 +22,4 @@ Defined in: [src/react/VGrid.tsx:35](https://github.com/inokawa/virtua/blob/6f0a > **children**: `ReactNode` -Defined in: [src/react/VGrid.tsx:36](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/react/VGrid.tsx#L36) +Defined in: [src/react/VGrid.tsx:39](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/react/VGrid.tsx#L39) diff --git a/docs/react/interfaces/CustomContainerComponentProps.md b/docs/react/interfaces/CustomContainerComponentProps.md index 277f08af..215b7b11 100644 --- a/docs/react/interfaces/CustomContainerComponentProps.md +++ b/docs/react/interfaces/CustomContainerComponentProps.md @@ -4,7 +4,7 @@ # Interface: CustomContainerComponentProps -Defined in: [src/react/types.ts:9](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/react/types.ts#L9) +Defined in: [src/react/types.ts:9](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/react/types.ts#L9) ## Properties @@ -12,7 +12,7 @@ Defined in: [src/react/types.ts:9](https://github.com/inokawa/virtua/blob/6f0a2c > **style**: `CSSProperties` -Defined in: [src/react/types.ts:10](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/react/types.ts#L10) +Defined in: [src/react/types.ts:10](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/react/types.ts#L10) *** @@ -20,7 +20,7 @@ Defined in: [src/react/types.ts:10](https://github.com/inokawa/virtua/blob/6f0a2 > **children**: `ReactNode` -Defined in: [src/react/types.ts:11](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/react/types.ts#L11) +Defined in: [src/react/types.ts:11](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/react/types.ts#L11) *** @@ -28,6 +28,6 @@ Defined in: [src/react/types.ts:11](https://github.com/inokawa/virtua/blob/6f0a2 > `optional` **ref**: `LegacyRef`\<`any`\> -Defined in: [src/react/types.ts:15](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/react/types.ts#L15) +Defined in: [src/react/types.ts:15](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/react/types.ts#L15) only available after React 19 diff --git a/docs/react/interfaces/CustomItemComponentProps.md b/docs/react/interfaces/CustomItemComponentProps.md index fdfe103e..03f9aa66 100644 --- a/docs/react/interfaces/CustomItemComponentProps.md +++ b/docs/react/interfaces/CustomItemComponentProps.md @@ -4,7 +4,7 @@ # Interface: CustomItemComponentProps -Defined in: [src/react/types.ts:24](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/react/types.ts#L24) +Defined in: [src/react/types.ts:24](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/react/types.ts#L24) Props of customized item component for [Virtualizer](../functions/Virtualizer.md) or [WindowVirtualizer](../functions/WindowVirtualizer.md). @@ -14,7 +14,7 @@ Props of customized item component for [Virtualizer](../functions/Virtualizer.md > **style**: `CSSProperties` -Defined in: [src/react/types.ts:25](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/react/types.ts#L25) +Defined in: [src/react/types.ts:25](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/react/types.ts#L25) *** @@ -22,7 +22,7 @@ Defined in: [src/react/types.ts:25](https://github.com/inokawa/virtua/blob/6f0a2 > **index**: `number` -Defined in: [src/react/types.ts:26](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/react/types.ts#L26) +Defined in: [src/react/types.ts:26](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/react/types.ts#L26) *** @@ -30,7 +30,7 @@ Defined in: [src/react/types.ts:26](https://github.com/inokawa/virtua/blob/6f0a2 > **children**: `ReactNode` -Defined in: [src/react/types.ts:27](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/react/types.ts#L27) +Defined in: [src/react/types.ts:27](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/react/types.ts#L27) *** @@ -38,6 +38,6 @@ Defined in: [src/react/types.ts:27](https://github.com/inokawa/virtua/blob/6f0a2 > `optional` **ref**: `LegacyRef`\<`any`\> -Defined in: [src/react/types.ts:31](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/react/types.ts#L31) +Defined in: [src/react/types.ts:31](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/react/types.ts#L31) only available after React 19 diff --git a/docs/react/interfaces/ScrollToIndexOpts.md b/docs/react/interfaces/ScrollToIndexOpts.md index 51f7b062..2d580641 100644 --- a/docs/react/interfaces/ScrollToIndexOpts.md +++ b/docs/react/interfaces/ScrollToIndexOpts.md @@ -4,7 +4,7 @@ # Interface: ScrollToIndexOpts -Defined in: [src/core/types.ts:21](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/core/types.ts#L21) +Defined in: [src/core/types.ts:21](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/core/types.ts#L21) ## Properties @@ -12,7 +12,7 @@ Defined in: [src/core/types.ts:21](https://github.com/inokawa/virtua/blob/6f0a2c > `optional` **align**: [`ScrollToIndexAlign`](../type-aliases/ScrollToIndexAlign.md) -Defined in: [src/core/types.ts:32](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/core/types.ts#L32) +Defined in: [src/core/types.ts:32](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/core/types.ts#L32) Alignment of item. @@ -33,7 +33,7 @@ Alignment of item. > `optional` **smooth**: `boolean` -Defined in: [src/core/types.ts:38](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/core/types.ts#L38) +Defined in: [src/core/types.ts:38](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/core/types.ts#L38) If true, scrolling animates smoothly with [`behavior: smooth` of scrollTo](https://developer.mozilla.org/en-US/docs/Web/API/Element/scrollTo#behavior). @@ -45,7 +45,7 @@ If true, scrolling animates smoothly with [`behavior: smooth` of scrollTo](https > `optional` **offset**: `number` -Defined in: [src/core/types.ts:43](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/core/types.ts#L43) +Defined in: [src/core/types.ts:43](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/core/types.ts#L43) Additional offset from the scrolled position. diff --git a/docs/react/interfaces/VGridHandle.md b/docs/react/interfaces/VGridHandle.md index 02e12687..c83d5023 100644 --- a/docs/react/interfaces/VGridHandle.md +++ b/docs/react/interfaces/VGridHandle.md @@ -4,7 +4,7 @@ # Interface: VGridHandle -Defined in: [src/react/VGrid.tsx:102](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/react/VGrid.tsx#L102) +Defined in: [src/react/VGrid.tsx:105](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/react/VGrid.tsx#L105) Methods of [VGrid](../functions/experimental_VGrid.md). @@ -14,7 +14,7 @@ Methods of [VGrid](../functions/experimental_VGrid.md). > **scrollToIndex**(`indexX`, `indexY`): `void` -Defined in: [src/react/VGrid.tsx:132](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/react/VGrid.tsx#L132) +Defined in: [src/react/VGrid.tsx:135](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/react/VGrid.tsx#L135) Scroll to the item specified by index. @@ -42,7 +42,7 @@ vertical index of item > **scrollTo**(`offsetX`, `offsetY`): `void` -Defined in: [src/react/VGrid.tsx:138](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/react/VGrid.tsx#L138) +Defined in: [src/react/VGrid.tsx:141](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/react/VGrid.tsx#L141) Scroll to the given offset. @@ -70,7 +70,7 @@ offset from top > **scrollBy**(`offsetX`, `offsetY`): `void` -Defined in: [src/react/VGrid.tsx:144](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/react/VGrid.tsx#L144) +Defined in: [src/react/VGrid.tsx:147](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/react/VGrid.tsx#L147) Scroll by the given offset. @@ -98,7 +98,7 @@ vertical offset from current position > `readonly` **scrollTop**: `number` -Defined in: [src/react/VGrid.tsx:106](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/react/VGrid.tsx#L106) +Defined in: [src/react/VGrid.tsx:109](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/react/VGrid.tsx#L109) Get current scrollTop. @@ -108,7 +108,7 @@ Get current scrollTop. > `readonly` **scrollLeft**: `number` -Defined in: [src/react/VGrid.tsx:110](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/react/VGrid.tsx#L110) +Defined in: [src/react/VGrid.tsx:113](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/react/VGrid.tsx#L113) Get current scrollLeft. @@ -118,7 +118,7 @@ Get current scrollLeft. > `readonly` **scrollHeight**: `number` -Defined in: [src/react/VGrid.tsx:114](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/react/VGrid.tsx#L114) +Defined in: [src/react/VGrid.tsx:117](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/react/VGrid.tsx#L117) Get current scrollHeight. @@ -128,7 +128,7 @@ Get current scrollHeight. > `readonly` **scrollWidth**: `number` -Defined in: [src/react/VGrid.tsx:118](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/react/VGrid.tsx#L118) +Defined in: [src/react/VGrid.tsx:121](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/react/VGrid.tsx#L121) Get current scrollWidth. @@ -138,7 +138,7 @@ Get current scrollWidth. > `readonly` **viewportHeight**: `number` -Defined in: [src/react/VGrid.tsx:122](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/react/VGrid.tsx#L122) +Defined in: [src/react/VGrid.tsx:125](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/react/VGrid.tsx#L125) Get current offsetHeight. @@ -148,6 +148,6 @@ Get current offsetHeight. > `readonly` **viewportWidth**: `number` -Defined in: [src/react/VGrid.tsx:126](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/react/VGrid.tsx#L126) +Defined in: [src/react/VGrid.tsx:129](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/react/VGrid.tsx#L129) Get current offsetWidth. diff --git a/docs/react/interfaces/VGridProps.md b/docs/react/interfaces/VGridProps.md index eb2d6e00..2afaba0b 100644 --- a/docs/react/interfaces/VGridProps.md +++ b/docs/react/interfaces/VGridProps.md @@ -4,7 +4,7 @@ # Interface: VGridProps -Defined in: [src/react/VGrid.tsx:150](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/react/VGrid.tsx#L150) +Defined in: [src/react/VGrid.tsx:153](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/react/VGrid.tsx#L153) Props of [VGrid](../functions/experimental_VGrid.md). @@ -18,7 +18,7 @@ Props of [VGrid](../functions/experimental_VGrid.md). > **children**: (`arg`) => `ReactNode` -Defined in: [src/react/VGrid.tsx:154](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/react/VGrid.tsx#L154) +Defined in: [src/react/VGrid.tsx:157](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/react/VGrid.tsx#L157) A function to create elements rendered by this component. @@ -48,7 +48,7 @@ column index of cell > **row**: `number` -Defined in: [src/react/VGrid.tsx:167](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/react/VGrid.tsx#L167) +Defined in: [src/react/VGrid.tsx:170](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/react/VGrid.tsx#L170) Total row length of grid. @@ -58,7 +58,7 @@ Total row length of grid. > **col**: `number` -Defined in: [src/react/VGrid.tsx:171](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/react/VGrid.tsx#L171) +Defined in: [src/react/VGrid.tsx:174](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/react/VGrid.tsx#L174) Total column length of grid. @@ -68,7 +68,7 @@ Total column length of grid. > `optional` **cellHeight**: `number` -Defined in: [src/react/VGrid.tsx:176](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/react/VGrid.tsx#L176) +Defined in: [src/react/VGrid.tsx:179](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/react/VGrid.tsx#L179) Cell height hint for unmeasured items. It's recommended to specify this prop if item sizes are fixed and known, or much larger than the defaultValue. It will help to reduce scroll jump when items are measured. @@ -84,7 +84,7 @@ Cell height hint for unmeasured items. It's recommended to specify this prop if > `optional` **cellWidth**: `number` -Defined in: [src/react/VGrid.tsx:181](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/react/VGrid.tsx#L181) +Defined in: [src/react/VGrid.tsx:184](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/react/VGrid.tsx#L184) Cell width hint for unmeasured items. It's recommended to specify this prop if item sizes are fixed and known, or much larger than the defaultValue. It will help to reduce scroll jump when items are measured. @@ -100,7 +100,7 @@ Cell width hint for unmeasured items. It's recommended to specify this prop if i > `optional` **overscan**: `number` -Defined in: [src/react/VGrid.tsx:186](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/react/VGrid.tsx#L186) +Defined in: [src/react/VGrid.tsx:189](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/react/VGrid.tsx#L189) Number of items to render above/below the visible bounds of the grid. Lower value will give better performance but you can increase to avoid showing blank items in fast scrolling. @@ -116,7 +116,7 @@ Number of items to render above/below the visible bounds of the grid. Lower valu > `optional` **initialRowCount**: `number` -Defined in: [src/react/VGrid.tsx:190](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/react/VGrid.tsx#L190) +Defined in: [src/react/VGrid.tsx:193](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/react/VGrid.tsx#L193) If set, the specified amount of rows will be mounted in the initial rendering regardless of the container size. This prop is mostly for SSR. @@ -126,7 +126,7 @@ If set, the specified amount of rows will be mounted in the initial rendering re > `optional` **initialColCount**: `number` -Defined in: [src/react/VGrid.tsx:194](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/react/VGrid.tsx#L194) +Defined in: [src/react/VGrid.tsx:197](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/react/VGrid.tsx#L197) If set, the specified amount of cols will be mounted in the initial rendering regardless of the container size. This prop is mostly for SSR. @@ -136,7 +136,7 @@ If set, the specified amount of cols will be mounted in the initial rendering re > `optional` **item**: keyof IntrinsicElements \| [`CustomCellComponent`](../type-aliases/CustomCellComponent.md) -Defined in: [src/react/VGrid.tsx:199](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/react/VGrid.tsx#L199) +Defined in: [src/react/VGrid.tsx:202](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/react/VGrid.tsx#L202) Component or element type for cell element. This component will get [CustomCellComponentProps](CustomCellComponentProps.md) as props. @@ -148,6 +148,40 @@ Component or element type for cell element. This component will get [CustomCellC *** +### onScroll()? + +> `optional` **onScroll**: (`offset`) => `void` + +Defined in: [src/react/VGrid.tsx:206](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/react/VGrid.tsx#L206) + +Callback invoked whenever scroll offset changes. + +#### Parameters + +##### offset + +`number` + +#### Returns + +`void` + +*** + +### onScrollEnd()? + +> `optional` **onScrollEnd**: () => `void` + +Defined in: [src/react/VGrid.tsx:210](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/react/VGrid.tsx#L210) + +Callback invoked when scrolling stops. + +#### Returns + +`void` + +*** + ### className? > `optional` **className**: `string` diff --git a/docs/react/interfaces/VListHandle.md b/docs/react/interfaces/VListHandle.md index f8946dc3..fd970bf1 100644 --- a/docs/react/interfaces/VListHandle.md +++ b/docs/react/interfaces/VListHandle.md @@ -4,7 +4,7 @@ # Interface: VListHandle -Defined in: [src/react/VList.tsx:12](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/react/VList.tsx#L12) +Defined in: [src/react/VList.tsx:12](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/react/VList.tsx#L12) Methods of [VList](../functions/VList.md). @@ -18,7 +18,7 @@ Methods of [VList](../functions/VList.md). > **getItemOffset**(`index`): `number` -Defined in: [src/react/Virtualizer.tsx:67](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/react/Virtualizer.tsx#L67) +Defined in: [src/react/Virtualizer.tsx:67](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/react/Virtualizer.tsx#L67) Get item offset from start. @@ -44,7 +44,7 @@ index of item > **getItemSize**(`index`): `number` -Defined in: [src/react/Virtualizer.tsx:72](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/react/Virtualizer.tsx#L72) +Defined in: [src/react/Virtualizer.tsx:72](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/react/Virtualizer.tsx#L72) Get item size. @@ -70,7 +70,7 @@ index of item > **scrollToIndex**(`index`, `opts`?): `void` -Defined in: [src/react/Virtualizer.tsx:78](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/react/Virtualizer.tsx#L78) +Defined in: [src/react/Virtualizer.tsx:78](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/react/Virtualizer.tsx#L78) Scroll to the item specified by index. @@ -102,7 +102,7 @@ options > **scrollTo**(`offset`): `void` -Defined in: [src/react/Virtualizer.tsx:83](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/react/Virtualizer.tsx#L83) +Defined in: [src/react/Virtualizer.tsx:83](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/react/Virtualizer.tsx#L83) Scroll to the given offset. @@ -128,7 +128,7 @@ offset from start > **scrollBy**(`offset`): `void` -Defined in: [src/react/Virtualizer.tsx:88](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/react/Virtualizer.tsx#L88) +Defined in: [src/react/Virtualizer.tsx:88](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/react/Virtualizer.tsx#L88) Scroll by the given offset. @@ -154,7 +154,7 @@ offset from current position > `readonly` **cache**: [`CacheSnapshot`](CacheSnapshot.md) -Defined in: [src/react/Virtualizer.tsx:42](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/react/Virtualizer.tsx#L42) +Defined in: [src/react/Virtualizer.tsx:42](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/react/Virtualizer.tsx#L42) Get current [CacheSnapshot](CacheSnapshot.md). @@ -168,7 +168,7 @@ Get current [CacheSnapshot](CacheSnapshot.md). > `readonly` **scrollOffset**: `number` -Defined in: [src/react/Virtualizer.tsx:46](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/react/Virtualizer.tsx#L46) +Defined in: [src/react/Virtualizer.tsx:46](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/react/Virtualizer.tsx#L46) Get current scrollTop, or scrollLeft if horizontal: true. @@ -182,7 +182,7 @@ Get current scrollTop, or scrollLeft if horizontal: true. > `readonly` **scrollSize**: `number` -Defined in: [src/react/Virtualizer.tsx:50](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/react/Virtualizer.tsx#L50) +Defined in: [src/react/Virtualizer.tsx:50](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/react/Virtualizer.tsx#L50) Get current scrollHeight, or scrollWidth if horizontal: true. @@ -196,7 +196,7 @@ Get current scrollHeight, or scrollWidth if horizontal: true. > `readonly` **viewportSize**: `number` -Defined in: [src/react/Virtualizer.tsx:54](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/react/Virtualizer.tsx#L54) +Defined in: [src/react/Virtualizer.tsx:54](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/react/Virtualizer.tsx#L54) Get current offsetHeight, or offsetWidth if horizontal: true. @@ -210,7 +210,7 @@ Get current offsetHeight, or offsetWidth if horizontal: true. > **findStartIndex**: () => `number` -Defined in: [src/react/Virtualizer.tsx:58](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/react/Virtualizer.tsx#L58) +Defined in: [src/react/Virtualizer.tsx:58](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/react/Virtualizer.tsx#L58) Find the start index of visible range of items. @@ -228,7 +228,7 @@ Find the start index of visible range of items. > **findEndIndex**: () => `number` -Defined in: [src/react/Virtualizer.tsx:62](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/react/Virtualizer.tsx#L62) +Defined in: [src/react/Virtualizer.tsx:62](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/react/Virtualizer.tsx#L62) Find the end index of visible range of items. diff --git a/docs/react/interfaces/VListProps.md b/docs/react/interfaces/VListProps.md index f59fb1cf..b60b1af0 100644 --- a/docs/react/interfaces/VListProps.md +++ b/docs/react/interfaces/VListProps.md @@ -4,7 +4,7 @@ # Interface: VListProps -Defined in: [src/react/VList.tsx:17](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/react/VList.tsx#L17) +Defined in: [src/react/VList.tsx:17](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/react/VList.tsx#L17) Props of [VList](../functions/VList.md). @@ -18,7 +18,7 @@ Props of [VList](../functions/VList.md). > `optional` **reverse**: `boolean` -Defined in: [src/react/VList.tsx:37](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/react/VList.tsx#L37) +Defined in: [src/react/VList.tsx:37](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/react/VList.tsx#L37) If true, items are aligned to the end of the list when total size of items are smaller than viewport size. It's useful for chat like app. @@ -28,7 +28,7 @@ If true, items are aligned to the end of the list when total size of items are s > **children**: `ReactNode` \| (`index`) => `ReactElement` -Defined in: [src/react/Virtualizer.tsx:100](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/react/Virtualizer.tsx#L100) +Defined in: [src/react/Virtualizer.tsx:100](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/react/Virtualizer.tsx#L100) Elements rendered by this component. @@ -44,7 +44,7 @@ You can also pass a function and set [VirtualizerProps.count](VirtualizerProps.m > `optional` **onScroll**: (`offset`) => `void` -Defined in: [src/react/Virtualizer.tsx:161](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/react/Virtualizer.tsx#L161) +Defined in: [src/react/Virtualizer.tsx:161](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/react/Virtualizer.tsx#L161) Callback invoked whenever scroll offset changes. @@ -70,7 +70,7 @@ Current scrollTop, or scrollLeft if horizontal: true. > `optional` **shift**: `boolean` -Defined in: [src/react/Virtualizer.tsx:120](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/react/Virtualizer.tsx#L120) +Defined in: [src/react/Virtualizer.tsx:120](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/react/Virtualizer.tsx#L120) While true is set, scroll position will be maintained from the end not usual start when items are added to/removed from start. It's recommended to set false if you add to/remove from mid/end of the list because it can cause unexpected behavior. This prop is useful for reverse infinite scrolling. @@ -84,7 +84,7 @@ While true is set, scroll position will be maintained from the end not usual sta > `optional` **count**: `number` -Defined in: [src/react/Virtualizer.tsx:104](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/react/Virtualizer.tsx#L104) +Defined in: [src/react/Virtualizer.tsx:104](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/react/Virtualizer.tsx#L104) If you set a function to [VirtualizerProps.children](VirtualizerProps.md#children), you have to set total number of items to this prop. @@ -98,7 +98,7 @@ If you set a function to [VirtualizerProps.children](VirtualizerProps.md#childre > `optional` **overscan**: `number` -Defined in: [src/react/Virtualizer.tsx:109](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/react/Virtualizer.tsx#L109) +Defined in: [src/react/Virtualizer.tsx:109](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/react/Virtualizer.tsx#L109) Number of items to render above/below the visible bounds of the list. Lower value will give better performance but you can increase to avoid showing blank items in fast scrolling. @@ -118,7 +118,7 @@ Number of items to render above/below the visible bounds of the list. Lower valu > `optional` **itemSize**: `number` -Defined in: [src/react/Virtualizer.tsx:116](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/react/Virtualizer.tsx#L116) +Defined in: [src/react/Virtualizer.tsx:116](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/react/Virtualizer.tsx#L116) Item size hint for unmeasured items. It will help to reduce scroll jump when items are measured if used properly. @@ -135,7 +135,7 @@ Item size hint for unmeasured items. It will help to reduce scroll jump when ite > `optional` **horizontal**: `boolean` -Defined in: [src/react/Virtualizer.tsx:124](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/react/Virtualizer.tsx#L124) +Defined in: [src/react/Virtualizer.tsx:124](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/react/Virtualizer.tsx#L124) If true, rendered as a horizontally scrollable list. Otherwise rendered as a vertically scrollable list. @@ -149,7 +149,7 @@ If true, rendered as a horizontally scrollable list. Otherwise rendered as a ver > `optional` **keepMounted**: `number`[] -Defined in: [src/react/Virtualizer.tsx:128](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/react/Virtualizer.tsx#L128) +Defined in: [src/react/Virtualizer.tsx:128](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/react/Virtualizer.tsx#L128) List of indexes that should be always mounted, even when off screen. @@ -163,7 +163,7 @@ List of indexes that should be always mounted, even when off screen. > `optional` **cache**: [`CacheSnapshot`](CacheSnapshot.md) -Defined in: [src/react/Virtualizer.tsx:134](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/react/Virtualizer.tsx#L134) +Defined in: [src/react/Virtualizer.tsx:134](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/react/Virtualizer.tsx#L134) You can restore cache by passing a [CacheSnapshot](CacheSnapshot.md) on mount. This is useful when you want to restore scroll position after navigation. The snapshot can be obtained from [VirtualizerHandle.cache](VirtualizerHandle.md#cache). @@ -179,7 +179,7 @@ You can restore cache by passing a [CacheSnapshot](CacheSnapshot.md) on mount. T > `optional` **ssrCount**: `number` -Defined in: [src/react/Virtualizer.tsx:142](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/react/Virtualizer.tsx#L142) +Defined in: [src/react/Virtualizer.tsx:142](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/react/Virtualizer.tsx#L142) A prop for SSR. If set, the specified amount of items will be mounted in the initial rendering regardless of the container size until hydrated. @@ -193,7 +193,7 @@ A prop for SSR. If set, the specified amount of items will be mounted in the ini > `optional` **item**: [`CustomItemComponent`](../type-aliases/CustomItemComponent.md) \| keyof IntrinsicElements -Defined in: [src/react/Virtualizer.tsx:152](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/react/Virtualizer.tsx#L152) +Defined in: [src/react/Virtualizer.tsx:152](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/react/Virtualizer.tsx#L152) Component or element type for item element. This component will get [CustomItemComponentProps](CustomItemComponentProps.md) as props. @@ -213,7 +213,7 @@ Component or element type for item element. This component will get [CustomItemC > `optional` **onScrollEnd**: () => `void` -Defined in: [src/react/Virtualizer.tsx:165](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/react/Virtualizer.tsx#L165) +Defined in: [src/react/Virtualizer.tsx:165](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/react/Virtualizer.tsx#L165) Callback invoked when scrolling stops. diff --git a/docs/react/interfaces/VirtualizerHandle.md b/docs/react/interfaces/VirtualizerHandle.md index 3ff04124..d993589d 100644 --- a/docs/react/interfaces/VirtualizerHandle.md +++ b/docs/react/interfaces/VirtualizerHandle.md @@ -4,7 +4,7 @@ # Interface: VirtualizerHandle -Defined in: [src/react/Virtualizer.tsx:38](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/react/Virtualizer.tsx#L38) +Defined in: [src/react/Virtualizer.tsx:38](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/react/Virtualizer.tsx#L38) Methods of [Virtualizer](../functions/Virtualizer.md). @@ -18,7 +18,7 @@ Methods of [Virtualizer](../functions/Virtualizer.md). > **getItemOffset**(`index`): `number` -Defined in: [src/react/Virtualizer.tsx:67](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/react/Virtualizer.tsx#L67) +Defined in: [src/react/Virtualizer.tsx:67](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/react/Virtualizer.tsx#L67) Get item offset from start. @@ -40,7 +40,7 @@ index of item > **getItemSize**(`index`): `number` -Defined in: [src/react/Virtualizer.tsx:72](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/react/Virtualizer.tsx#L72) +Defined in: [src/react/Virtualizer.tsx:72](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/react/Virtualizer.tsx#L72) Get item size. @@ -62,7 +62,7 @@ index of item > **scrollToIndex**(`index`, `opts`?): `void` -Defined in: [src/react/Virtualizer.tsx:78](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/react/Virtualizer.tsx#L78) +Defined in: [src/react/Virtualizer.tsx:78](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/react/Virtualizer.tsx#L78) Scroll to the item specified by index. @@ -90,7 +90,7 @@ options > **scrollTo**(`offset`): `void` -Defined in: [src/react/Virtualizer.tsx:83](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/react/Virtualizer.tsx#L83) +Defined in: [src/react/Virtualizer.tsx:83](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/react/Virtualizer.tsx#L83) Scroll to the given offset. @@ -112,7 +112,7 @@ offset from start > **scrollBy**(`offset`): `void` -Defined in: [src/react/Virtualizer.tsx:88](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/react/Virtualizer.tsx#L88) +Defined in: [src/react/Virtualizer.tsx:88](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/react/Virtualizer.tsx#L88) Scroll by the given offset. @@ -134,7 +134,7 @@ offset from current position > `readonly` **cache**: [`CacheSnapshot`](CacheSnapshot.md) -Defined in: [src/react/Virtualizer.tsx:42](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/react/Virtualizer.tsx#L42) +Defined in: [src/react/Virtualizer.tsx:42](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/react/Virtualizer.tsx#L42) Get current [CacheSnapshot](CacheSnapshot.md). @@ -144,7 +144,7 @@ Get current [CacheSnapshot](CacheSnapshot.md). > `readonly` **scrollOffset**: `number` -Defined in: [src/react/Virtualizer.tsx:46](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/react/Virtualizer.tsx#L46) +Defined in: [src/react/Virtualizer.tsx:46](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/react/Virtualizer.tsx#L46) Get current scrollTop, or scrollLeft if horizontal: true. @@ -154,7 +154,7 @@ Get current scrollTop, or scrollLeft if horizontal: true. > `readonly` **scrollSize**: `number` -Defined in: [src/react/Virtualizer.tsx:50](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/react/Virtualizer.tsx#L50) +Defined in: [src/react/Virtualizer.tsx:50](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/react/Virtualizer.tsx#L50) Get current scrollHeight, or scrollWidth if horizontal: true. @@ -164,7 +164,7 @@ Get current scrollHeight, or scrollWidth if horizontal: true. > `readonly` **viewportSize**: `number` -Defined in: [src/react/Virtualizer.tsx:54](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/react/Virtualizer.tsx#L54) +Defined in: [src/react/Virtualizer.tsx:54](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/react/Virtualizer.tsx#L54) Get current offsetHeight, or offsetWidth if horizontal: true. @@ -174,7 +174,7 @@ Get current offsetHeight, or offsetWidth if horizontal: true. > **findStartIndex**: () => `number` -Defined in: [src/react/Virtualizer.tsx:58](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/react/Virtualizer.tsx#L58) +Defined in: [src/react/Virtualizer.tsx:58](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/react/Virtualizer.tsx#L58) Find the start index of visible range of items. @@ -188,7 +188,7 @@ Find the start index of visible range of items. > **findEndIndex**: () => `number` -Defined in: [src/react/Virtualizer.tsx:62](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/react/Virtualizer.tsx#L62) +Defined in: [src/react/Virtualizer.tsx:62](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/react/Virtualizer.tsx#L62) Find the end index of visible range of items. diff --git a/docs/react/interfaces/VirtualizerProps.md b/docs/react/interfaces/VirtualizerProps.md index 61cfb972..a749ce18 100644 --- a/docs/react/interfaces/VirtualizerProps.md +++ b/docs/react/interfaces/VirtualizerProps.md @@ -4,7 +4,7 @@ # Interface: VirtualizerProps -Defined in: [src/react/Virtualizer.tsx:94](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/react/Virtualizer.tsx#L94) +Defined in: [src/react/Virtualizer.tsx:94](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/react/Virtualizer.tsx#L94) Props of [Virtualizer](../functions/Virtualizer.md). @@ -14,7 +14,7 @@ Props of [Virtualizer](../functions/Virtualizer.md). > **children**: `ReactNode` \| (`index`) => `ReactElement` -Defined in: [src/react/Virtualizer.tsx:100](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/react/Virtualizer.tsx#L100) +Defined in: [src/react/Virtualizer.tsx:100](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/react/Virtualizer.tsx#L100) Elements rendered by this component. @@ -26,7 +26,7 @@ You can also pass a function and set [VirtualizerProps.count](VirtualizerProps.m > `optional` **count**: `number` -Defined in: [src/react/Virtualizer.tsx:104](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/react/Virtualizer.tsx#L104) +Defined in: [src/react/Virtualizer.tsx:104](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/react/Virtualizer.tsx#L104) If you set a function to [VirtualizerProps.children](VirtualizerProps.md#children), you have to set total number of items to this prop. @@ -36,7 +36,7 @@ If you set a function to [VirtualizerProps.children](VirtualizerProps.md#childre > `optional` **overscan**: `number` -Defined in: [src/react/Virtualizer.tsx:109](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/react/Virtualizer.tsx#L109) +Defined in: [src/react/Virtualizer.tsx:109](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/react/Virtualizer.tsx#L109) Number of items to render above/below the visible bounds of the list. Lower value will give better performance but you can increase to avoid showing blank items in fast scrolling. @@ -52,7 +52,7 @@ Number of items to render above/below the visible bounds of the list. Lower valu > `optional` **itemSize**: `number` -Defined in: [src/react/Virtualizer.tsx:116](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/react/Virtualizer.tsx#L116) +Defined in: [src/react/Virtualizer.tsx:116](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/react/Virtualizer.tsx#L116) Item size hint for unmeasured items. It will help to reduce scroll jump when items are measured if used properly. @@ -65,7 +65,7 @@ Item size hint for unmeasured items. It will help to reduce scroll jump when ite > `optional` **shift**: `boolean` -Defined in: [src/react/Virtualizer.tsx:120](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/react/Virtualizer.tsx#L120) +Defined in: [src/react/Virtualizer.tsx:120](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/react/Virtualizer.tsx#L120) While true is set, scroll position will be maintained from the end not usual start when items are added to/removed from start. It's recommended to set false if you add to/remove from mid/end of the list because it can cause unexpected behavior. This prop is useful for reverse infinite scrolling. @@ -75,7 +75,7 @@ While true is set, scroll position will be maintained from the end not usual sta > `optional` **horizontal**: `boolean` -Defined in: [src/react/Virtualizer.tsx:124](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/react/Virtualizer.tsx#L124) +Defined in: [src/react/Virtualizer.tsx:124](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/react/Virtualizer.tsx#L124) If true, rendered as a horizontally scrollable list. Otherwise rendered as a vertically scrollable list. @@ -85,7 +85,7 @@ If true, rendered as a horizontally scrollable list. Otherwise rendered as a ver > `optional` **keepMounted**: `number`[] -Defined in: [src/react/Virtualizer.tsx:128](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/react/Virtualizer.tsx#L128) +Defined in: [src/react/Virtualizer.tsx:128](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/react/Virtualizer.tsx#L128) List of indexes that should be always mounted, even when off screen. @@ -95,7 +95,7 @@ List of indexes that should be always mounted, even when off screen. > `optional` **cache**: [`CacheSnapshot`](CacheSnapshot.md) -Defined in: [src/react/Virtualizer.tsx:134](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/react/Virtualizer.tsx#L134) +Defined in: [src/react/Virtualizer.tsx:134](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/react/Virtualizer.tsx#L134) You can restore cache by passing a [CacheSnapshot](CacheSnapshot.md) on mount. This is useful when you want to restore scroll position after navigation. The snapshot can be obtained from [VirtualizerHandle.cache](VirtualizerHandle.md#cache). @@ -107,7 +107,7 @@ You can restore cache by passing a [CacheSnapshot](CacheSnapshot.md) on mount. T > `optional` **startMargin**: `number` -Defined in: [src/react/Virtualizer.tsx:138](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/react/Virtualizer.tsx#L138) +Defined in: [src/react/Virtualizer.tsx:138](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/react/Virtualizer.tsx#L138) If you put an element before virtualizer, you have to define its height with this prop. @@ -117,7 +117,7 @@ If you put an element before virtualizer, you have to define its height with thi > `optional` **ssrCount**: `number` -Defined in: [src/react/Virtualizer.tsx:142](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/react/Virtualizer.tsx#L142) +Defined in: [src/react/Virtualizer.tsx:142](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/react/Virtualizer.tsx#L142) A prop for SSR. If set, the specified amount of items will be mounted in the initial rendering regardless of the container size until hydrated. @@ -127,7 +127,7 @@ A prop for SSR. If set, the specified amount of items will be mounted in the ini > `optional` **as**: [`CustomContainerComponent`](../type-aliases/CustomContainerComponent.md) \| keyof IntrinsicElements -Defined in: [src/react/Virtualizer.tsx:147](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/react/Virtualizer.tsx#L147) +Defined in: [src/react/Virtualizer.tsx:147](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/react/Virtualizer.tsx#L147) Component or element type for container element. @@ -143,7 +143,7 @@ Component or element type for container element. > `optional` **item**: [`CustomItemComponent`](../type-aliases/CustomItemComponent.md) \| keyof IntrinsicElements -Defined in: [src/react/Virtualizer.tsx:152](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/react/Virtualizer.tsx#L152) +Defined in: [src/react/Virtualizer.tsx:152](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/react/Virtualizer.tsx#L152) Component or element type for item element. This component will get [CustomItemComponentProps](CustomItemComponentProps.md) as props. @@ -159,7 +159,7 @@ Component or element type for item element. This component will get [CustomItemC > `optional` **scrollRef**: `RefObject`\<`null` \| `HTMLElement`\> -Defined in: [src/react/Virtualizer.tsx:156](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/react/Virtualizer.tsx#L156) +Defined in: [src/react/Virtualizer.tsx:156](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/react/Virtualizer.tsx#L156) Reference to the scrollable element. The default will get the direct parent element of virtualizer. @@ -169,7 +169,7 @@ Reference to the scrollable element. The default will get the direct parent elem > `optional` **onScroll**: (`offset`) => `void` -Defined in: [src/react/Virtualizer.tsx:161](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/react/Virtualizer.tsx#L161) +Defined in: [src/react/Virtualizer.tsx:161](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/react/Virtualizer.tsx#L161) Callback invoked whenever scroll offset changes. @@ -191,7 +191,7 @@ Current scrollTop, or scrollLeft if horizontal: true. > `optional` **onScrollEnd**: () => `void` -Defined in: [src/react/Virtualizer.tsx:165](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/react/Virtualizer.tsx#L165) +Defined in: [src/react/Virtualizer.tsx:165](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/react/Virtualizer.tsx#L165) Callback invoked when scrolling stops. diff --git a/docs/react/interfaces/WindowVirtualizerHandle.md b/docs/react/interfaces/WindowVirtualizerHandle.md index 6cb37978..59d47a04 100644 --- a/docs/react/interfaces/WindowVirtualizerHandle.md +++ b/docs/react/interfaces/WindowVirtualizerHandle.md @@ -4,7 +4,7 @@ # Interface: WindowVirtualizerHandle -Defined in: [src/react/WindowVirtualizer.tsx:33](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/react/WindowVirtualizer.tsx#L33) +Defined in: [src/react/WindowVirtualizer.tsx:33](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/react/WindowVirtualizer.tsx#L33) Methods of [WindowVirtualizer](../functions/WindowVirtualizer.md). @@ -14,7 +14,7 @@ Methods of [WindowVirtualizer](../functions/WindowVirtualizer.md). > **scrollToIndex**(`index`, `opts`?): `void` -Defined in: [src/react/WindowVirtualizer.tsx:51](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/react/WindowVirtualizer.tsx#L51) +Defined in: [src/react/WindowVirtualizer.tsx:51](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/react/WindowVirtualizer.tsx#L51) Scroll to the item specified by index. @@ -42,7 +42,7 @@ options > `readonly` **cache**: [`CacheSnapshot`](CacheSnapshot.md) -Defined in: [src/react/WindowVirtualizer.tsx:37](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/react/WindowVirtualizer.tsx#L37) +Defined in: [src/react/WindowVirtualizer.tsx:37](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/react/WindowVirtualizer.tsx#L37) Get current [CacheSnapshot](CacheSnapshot.md). @@ -52,7 +52,7 @@ Get current [CacheSnapshot](CacheSnapshot.md). > **findStartIndex**: () => `number` -Defined in: [src/react/WindowVirtualizer.tsx:41](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/react/WindowVirtualizer.tsx#L41) +Defined in: [src/react/WindowVirtualizer.tsx:41](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/react/WindowVirtualizer.tsx#L41) Find the start index of visible range of items. @@ -66,7 +66,7 @@ Find the start index of visible range of items. > **findEndIndex**: () => `number` -Defined in: [src/react/WindowVirtualizer.tsx:45](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/react/WindowVirtualizer.tsx#L45) +Defined in: [src/react/WindowVirtualizer.tsx:45](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/react/WindowVirtualizer.tsx#L45) Find the end index of visible range of items. diff --git a/docs/react/interfaces/WindowVirtualizerProps.md b/docs/react/interfaces/WindowVirtualizerProps.md index 911e705c..0f090797 100644 --- a/docs/react/interfaces/WindowVirtualizerProps.md +++ b/docs/react/interfaces/WindowVirtualizerProps.md @@ -4,7 +4,7 @@ # Interface: WindowVirtualizerProps -Defined in: [src/react/WindowVirtualizer.tsx:57](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/react/WindowVirtualizer.tsx#L57) +Defined in: [src/react/WindowVirtualizer.tsx:57](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/react/WindowVirtualizer.tsx#L57) Props of [WindowVirtualizer](../functions/WindowVirtualizer.md). @@ -14,7 +14,7 @@ Props of [WindowVirtualizer](../functions/WindowVirtualizer.md). > **children**: `ReactNode` \| (`index`) => `ReactElement` -Defined in: [src/react/WindowVirtualizer.tsx:63](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/react/WindowVirtualizer.tsx#L63) +Defined in: [src/react/WindowVirtualizer.tsx:63](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/react/WindowVirtualizer.tsx#L63) Elements rendered by this component. @@ -26,7 +26,7 @@ You can also pass a function and set [WindowVirtualizerProps.count](WindowVirtua > `optional` **count**: `number` -Defined in: [src/react/WindowVirtualizer.tsx:67](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/react/WindowVirtualizer.tsx#L67) +Defined in: [src/react/WindowVirtualizer.tsx:67](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/react/WindowVirtualizer.tsx#L67) If you set a function to [WindowVirtualizerProps.children](WindowVirtualizerProps.md#children), you have to set total number of items to this prop. @@ -36,7 +36,7 @@ If you set a function to [WindowVirtualizerProps.children](WindowVirtualizerProp > `optional` **overscan**: `number` -Defined in: [src/react/WindowVirtualizer.tsx:72](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/react/WindowVirtualizer.tsx#L72) +Defined in: [src/react/WindowVirtualizer.tsx:72](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/react/WindowVirtualizer.tsx#L72) Number of items to render above/below the visible bounds of the list. Lower value will give better performance but you can increase to avoid showing blank items in fast scrolling. @@ -52,7 +52,7 @@ Number of items to render above/below the visible bounds of the list. Lower valu > `optional` **itemSize**: `number` -Defined in: [src/react/WindowVirtualizer.tsx:79](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/react/WindowVirtualizer.tsx#L79) +Defined in: [src/react/WindowVirtualizer.tsx:79](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/react/WindowVirtualizer.tsx#L79) Item size hint for unmeasured items. It will help to reduce scroll jump when items are measured if used properly. @@ -65,7 +65,7 @@ Item size hint for unmeasured items. It will help to reduce scroll jump when ite > `optional` **shift**: `boolean` -Defined in: [src/react/WindowVirtualizer.tsx:83](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/react/WindowVirtualizer.tsx#L83) +Defined in: [src/react/WindowVirtualizer.tsx:83](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/react/WindowVirtualizer.tsx#L83) While true is set, scroll position will be maintained from the end not usual start when items are added to/removed from start. It's recommended to set false if you add to/remove from mid/end of the list because it can cause unexpected behavior. This prop is useful for reverse infinite scrolling. @@ -75,7 +75,7 @@ While true is set, scroll position will be maintained from the end not usual sta > `optional` **horizontal**: `boolean` -Defined in: [src/react/WindowVirtualizer.tsx:87](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/react/WindowVirtualizer.tsx#L87) +Defined in: [src/react/WindowVirtualizer.tsx:87](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/react/WindowVirtualizer.tsx#L87) If true, rendered as a horizontally scrollable list. Otherwise rendered as a vertically scrollable list. @@ -85,7 +85,7 @@ If true, rendered as a horizontally scrollable list. Otherwise rendered as a ver > `optional` **cache**: [`CacheSnapshot`](CacheSnapshot.md) -Defined in: [src/react/WindowVirtualizer.tsx:93](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/react/WindowVirtualizer.tsx#L93) +Defined in: [src/react/WindowVirtualizer.tsx:93](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/react/WindowVirtualizer.tsx#L93) You can restore cache by passing a [CacheSnapshot](CacheSnapshot.md) on mount. This is useful when you want to restore scroll position after navigation. The snapshot can be obtained from [WindowVirtualizerHandle.cache](WindowVirtualizerHandle.md#cache). @@ -97,7 +97,7 @@ You can restore cache by passing a [CacheSnapshot](CacheSnapshot.md) on mount. T > `optional` **ssrCount**: `number` -Defined in: [src/react/WindowVirtualizer.tsx:97](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/react/WindowVirtualizer.tsx#L97) +Defined in: [src/react/WindowVirtualizer.tsx:97](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/react/WindowVirtualizer.tsx#L97) A prop for SSR. If set, the specified amount of items will be mounted in the initial rendering regardless of the container size until hydrated. @@ -107,7 +107,7 @@ A prop for SSR. If set, the specified amount of items will be mounted in the ini > `optional` **as**: [`CustomContainerComponent`](../type-aliases/CustomContainerComponent.md) \| keyof IntrinsicElements -Defined in: [src/react/WindowVirtualizer.tsx:102](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/react/WindowVirtualizer.tsx#L102) +Defined in: [src/react/WindowVirtualizer.tsx:102](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/react/WindowVirtualizer.tsx#L102) Component or element type for container element. @@ -123,7 +123,7 @@ Component or element type for container element. > `optional` **item**: [`CustomItemComponent`](../type-aliases/CustomItemComponent.md) \| keyof IntrinsicElements -Defined in: [src/react/WindowVirtualizer.tsx:107](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/react/WindowVirtualizer.tsx#L107) +Defined in: [src/react/WindowVirtualizer.tsx:107](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/react/WindowVirtualizer.tsx#L107) Component or element type for item element. This component will get [CustomItemComponentProps](CustomItemComponentProps.md) as props. @@ -139,7 +139,7 @@ Component or element type for item element. This component will get [CustomItemC > `optional` **onScroll**: () => `void` -Defined in: [src/react/WindowVirtualizer.tsx:111](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/react/WindowVirtualizer.tsx#L111) +Defined in: [src/react/WindowVirtualizer.tsx:111](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/react/WindowVirtualizer.tsx#L111) Callback invoked whenever scroll offset changes. @@ -153,7 +153,7 @@ Callback invoked whenever scroll offset changes. > `optional` **onScrollEnd**: () => `void` -Defined in: [src/react/WindowVirtualizer.tsx:115](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/react/WindowVirtualizer.tsx#L115) +Defined in: [src/react/WindowVirtualizer.tsx:115](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/react/WindowVirtualizer.tsx#L115) Callback invoked when scrolling stops. diff --git a/docs/react/type-aliases/CustomCellComponent.md b/docs/react/type-aliases/CustomCellComponent.md index 8011046e..1b1cec17 100644 --- a/docs/react/type-aliases/CustomCellComponent.md +++ b/docs/react/type-aliases/CustomCellComponent.md @@ -6,4 +6,4 @@ > **CustomCellComponent**: `React.ForwardRefExoticComponent`\<`React.PropsWithoutRef`\<[`CustomCellComponentProps`](../interfaces/CustomCellComponentProps.md)\> & `React.RefAttributes`\<`any`\>\> -Defined in: [src/react/VGrid.tsx:39](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/react/VGrid.tsx#L39) +Defined in: [src/react/VGrid.tsx:42](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/react/VGrid.tsx#L42) diff --git a/docs/react/type-aliases/CustomContainerComponent.md b/docs/react/type-aliases/CustomContainerComponent.md index 31dd884c..3f655645 100644 --- a/docs/react/type-aliases/CustomContainerComponent.md +++ b/docs/react/type-aliases/CustomContainerComponent.md @@ -6,4 +6,4 @@ > **CustomContainerComponent**: `ComponentType`\<[`CustomContainerComponentProps`](../interfaces/CustomContainerComponentProps.md)\> -Defined in: [src/react/types.ts:18](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/react/types.ts#L18) +Defined in: [src/react/types.ts:18](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/react/types.ts#L18) diff --git a/docs/react/type-aliases/CustomItemComponent.md b/docs/react/type-aliases/CustomItemComponent.md index 12209520..65efe461 100644 --- a/docs/react/type-aliases/CustomItemComponent.md +++ b/docs/react/type-aliases/CustomItemComponent.md @@ -6,4 +6,4 @@ > **CustomItemComponent**: `ComponentType`\<[`CustomItemComponentProps`](../interfaces/CustomItemComponentProps.md)\> -Defined in: [src/react/types.ts:34](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/react/types.ts#L34) +Defined in: [src/react/types.ts:34](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/react/types.ts#L34) diff --git a/docs/react/type-aliases/ScrollToIndexAlign.md b/docs/react/type-aliases/ScrollToIndexAlign.md index de24ec91..6d3e86a3 100644 --- a/docs/react/type-aliases/ScrollToIndexAlign.md +++ b/docs/react/type-aliases/ScrollToIndexAlign.md @@ -6,4 +6,4 @@ > **ScrollToIndexAlign**: `"start"` \| `"center"` \| `"end"` \| `"nearest"` -Defined in: [src/core/types.ts:19](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/core/types.ts#L19) +Defined in: [src/core/types.ts:19](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/core/types.ts#L19) diff --git a/docs/react/type-aliases/ViewportComponentAttributes.md b/docs/react/type-aliases/ViewportComponentAttributes.md index cf930557..56c38106 100644 --- a/docs/react/type-aliases/ViewportComponentAttributes.md +++ b/docs/react/type-aliases/ViewportComponentAttributes.md @@ -6,4 +6,4 @@ > **ViewportComponentAttributes**: `Pick`\<`React.HTMLAttributes`\<`HTMLElement`\>, `"className"` \| `"style"` \| `"id"` \| `"role"` \| `"tabIndex"` \| `"onKeyDown"` \| `"onWheel"`\> & `React.AriaAttributes` -Defined in: [src/react/types.ts:3](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/react/types.ts#L3) +Defined in: [src/react/types.ts:3](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/react/types.ts#L3) diff --git a/docs/solid/functions/VList.md b/docs/solid/functions/VList.md index 355dc7a2..d7881d57 100644 --- a/docs/solid/functions/VList.md +++ b/docs/solid/functions/VList.md @@ -6,7 +6,7 @@ > **VList**\<`T`\>(`props`): `Element` -Defined in: [src/solid/VList.tsx:38](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/solid/VList.tsx#L38) +Defined in: [src/solid/VList.tsx:38](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/solid/VList.tsx#L38) Virtualized list component. See [VListProps](../interfaces/VListProps.md) and [VListHandle](../interfaces/VListHandle.md). diff --git a/docs/solid/functions/Virtualizer.md b/docs/solid/functions/Virtualizer.md index 8d79137f..2b4614bc 100644 --- a/docs/solid/functions/Virtualizer.md +++ b/docs/solid/functions/Virtualizer.md @@ -6,7 +6,7 @@ > **Virtualizer**\<`T`\>(`props`): `Element` -Defined in: [src/solid/Virtualizer.tsx:154](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/solid/Virtualizer.tsx#L154) +Defined in: [src/solid/Virtualizer.tsx:154](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/solid/Virtualizer.tsx#L154) Customizable list virtualizer for advanced usage. See [VirtualizerProps](../interfaces/VirtualizerProps.md) and [VirtualizerHandle](../interfaces/VirtualizerHandle.md). diff --git a/docs/solid/functions/WindowVirtualizer.md b/docs/solid/functions/WindowVirtualizer.md index 7de860f4..f70b3009 100644 --- a/docs/solid/functions/WindowVirtualizer.md +++ b/docs/solid/functions/WindowVirtualizer.md @@ -6,7 +6,7 @@ > **WindowVirtualizer**\<`T`\>(`props`): `Element` -Defined in: [src/solid/WindowVirtualizer.tsx:98](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/solid/WindowVirtualizer.tsx#L98) +Defined in: [src/solid/WindowVirtualizer.tsx:98](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/solid/WindowVirtualizer.tsx#L98) [Virtualizer](Virtualizer.md) controlled by the window scrolling. See [WindowVirtualizerProps](../interfaces/WindowVirtualizerProps.md) and [WindowVirtualizerHandle](../interfaces/WindowVirtualizerHandle.md). diff --git a/docs/solid/interfaces/VListHandle.md b/docs/solid/interfaces/VListHandle.md index 41a8a970..2f6d462b 100644 --- a/docs/solid/interfaces/VListHandle.md +++ b/docs/solid/interfaces/VListHandle.md @@ -4,7 +4,7 @@ # Interface: VListHandle -Defined in: [src/solid/VList.tsx:15](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/solid/VList.tsx#L15) +Defined in: [src/solid/VList.tsx:15](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/solid/VList.tsx#L15) Methods of [VList](../functions/VList.md). @@ -18,7 +18,7 @@ Methods of [VList](../functions/VList.md). > **getItemOffset**(`index`): `number` -Defined in: [src/solid/Virtualizer.tsx:62](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/solid/Virtualizer.tsx#L62) +Defined in: [src/solid/Virtualizer.tsx:62](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/solid/Virtualizer.tsx#L62) Get item offset from start. @@ -44,7 +44,7 @@ index of item > **getItemSize**(`index`): `number` -Defined in: [src/solid/Virtualizer.tsx:67](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/solid/Virtualizer.tsx#L67) +Defined in: [src/solid/Virtualizer.tsx:67](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/solid/Virtualizer.tsx#L67) Get item size. @@ -70,7 +70,7 @@ index of item > **scrollToIndex**(`index`, `opts`?): `void` -Defined in: [src/solid/Virtualizer.tsx:73](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/solid/Virtualizer.tsx#L73) +Defined in: [src/solid/Virtualizer.tsx:73](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/solid/Virtualizer.tsx#L73) Scroll to the item specified by index. @@ -102,7 +102,7 @@ options > **scrollTo**(`offset`): `void` -Defined in: [src/solid/Virtualizer.tsx:78](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/solid/Virtualizer.tsx#L78) +Defined in: [src/solid/Virtualizer.tsx:78](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/solid/Virtualizer.tsx#L78) Scroll to the given offset. @@ -128,7 +128,7 @@ offset from start > **scrollBy**(`offset`): `void` -Defined in: [src/solid/Virtualizer.tsx:83](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/solid/Virtualizer.tsx#L83) +Defined in: [src/solid/Virtualizer.tsx:83](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/solid/Virtualizer.tsx#L83) Scroll by the given offset. @@ -154,7 +154,7 @@ offset from current position > `readonly` **scrollOffset**: `number` -Defined in: [src/solid/Virtualizer.tsx:41](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/solid/Virtualizer.tsx#L41) +Defined in: [src/solid/Virtualizer.tsx:41](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/solid/Virtualizer.tsx#L41) Get current scrollTop, or scrollLeft if horizontal: true. @@ -168,7 +168,7 @@ Get current scrollTop, or scrollLeft if horizontal: true. > `readonly` **scrollSize**: `number` -Defined in: [src/solid/Virtualizer.tsx:45](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/solid/Virtualizer.tsx#L45) +Defined in: [src/solid/Virtualizer.tsx:45](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/solid/Virtualizer.tsx#L45) Get current scrollHeight, or scrollWidth if horizontal: true. @@ -182,7 +182,7 @@ Get current scrollHeight, or scrollWidth if horizontal: true. > `readonly` **viewportSize**: `number` -Defined in: [src/solid/Virtualizer.tsx:49](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/solid/Virtualizer.tsx#L49) +Defined in: [src/solid/Virtualizer.tsx:49](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/solid/Virtualizer.tsx#L49) Get current offsetHeight, or offsetWidth if horizontal: true. @@ -196,7 +196,7 @@ Get current offsetHeight, or offsetWidth if horizontal: true. > **findStartIndex**: () => `number` -Defined in: [src/solid/Virtualizer.tsx:53](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/solid/Virtualizer.tsx#L53) +Defined in: [src/solid/Virtualizer.tsx:53](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/solid/Virtualizer.tsx#L53) Find the start index of visible range of items. @@ -214,7 +214,7 @@ Find the start index of visible range of items. > **findEndIndex**: () => `number` -Defined in: [src/solid/Virtualizer.tsx:57](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/solid/Virtualizer.tsx#L57) +Defined in: [src/solid/Virtualizer.tsx:57](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/solid/Virtualizer.tsx#L57) Find the end index of visible range of items. diff --git a/docs/solid/interfaces/VListProps.md b/docs/solid/interfaces/VListProps.md index b866b67e..5f83304a 100644 --- a/docs/solid/interfaces/VListProps.md +++ b/docs/solid/interfaces/VListProps.md @@ -4,7 +4,7 @@ # Interface: VListProps\ -Defined in: [src/solid/VList.tsx:20](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/solid/VList.tsx#L20) +Defined in: [src/solid/VList.tsx:20](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/solid/VList.tsx#L20) Props of [VList](../functions/VList.md). @@ -22,7 +22,7 @@ Props of [VList](../functions/VList.md). > **children**: (`data`, `index`) => `Element` -Defined in: [src/solid/Virtualizer.tsx:101](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/solid/Virtualizer.tsx#L101) +Defined in: [src/solid/Virtualizer.tsx:101](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/solid/Virtualizer.tsx#L101) The elements renderer function. @@ -50,7 +50,7 @@ The elements renderer function. > `optional` **onScroll**: (`offset`) => `void` -Defined in: [src/solid/Virtualizer.tsx:144](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/solid/Virtualizer.tsx#L144) +Defined in: [src/solid/Virtualizer.tsx:144](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/solid/Virtualizer.tsx#L144) Callback invoked whenever scroll offset changes. @@ -76,7 +76,7 @@ Current scrollTop, or scrollLeft if horizontal: true. > `optional` **shift**: `boolean` -Defined in: [src/solid/Virtualizer.tsx:131](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/solid/Virtualizer.tsx#L131) +Defined in: [src/solid/Virtualizer.tsx:131](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/solid/Virtualizer.tsx#L131) While true is set, scroll position will be maintained from the end not usual start when items are added to/removed from start. It's recommended to set false if you add to/remove from mid/end of the list because it can cause unexpected behavior. This prop is useful for reverse infinite scrolling. @@ -90,7 +90,7 @@ While true is set, scroll position will be maintained from the end not usual sta > `optional` **ref**: (`handle`?) => `void` -Defined in: [src/solid/Virtualizer.tsx:93](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/solid/Virtualizer.tsx#L93) +Defined in: [src/solid/Virtualizer.tsx:93](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/solid/Virtualizer.tsx#L93) Get reference to [VirtualizerHandle](VirtualizerHandle.md). @@ -114,7 +114,7 @@ Get reference to [VirtualizerHandle](VirtualizerHandle.md). > **data**: `T`[] -Defined in: [src/solid/Virtualizer.tsx:97](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/solid/Virtualizer.tsx#L97) +Defined in: [src/solid/Virtualizer.tsx:97](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/solid/Virtualizer.tsx#L97) The data items rendered by this component. @@ -128,7 +128,7 @@ The data items rendered by this component. > `optional` **overscan**: `number` -Defined in: [src/solid/Virtualizer.tsx:106](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/solid/Virtualizer.tsx#L106) +Defined in: [src/solid/Virtualizer.tsx:106](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/solid/Virtualizer.tsx#L106) Number of items to render above/below the visible bounds of the list. Lower value will give better performance but you can increase to avoid showing blank items in fast scrolling. @@ -148,7 +148,7 @@ Number of items to render above/below the visible bounds of the list. Lower valu > `optional` **itemSize**: `number` -Defined in: [src/solid/Virtualizer.tsx:127](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/solid/Virtualizer.tsx#L127) +Defined in: [src/solid/Virtualizer.tsx:127](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/solid/Virtualizer.tsx#L127) Item size hint for unmeasured items. It will help to reduce scroll jump when items are measured if used properly. @@ -165,7 +165,7 @@ Item size hint for unmeasured items. It will help to reduce scroll jump when ite > `optional` **horizontal**: `boolean` -Defined in: [src/solid/Virtualizer.tsx:135](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/solid/Virtualizer.tsx#L135) +Defined in: [src/solid/Virtualizer.tsx:135](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/solid/Virtualizer.tsx#L135) If true, rendered as a horizontally scrollable list. Otherwise rendered as a vertically scrollable list. @@ -179,7 +179,7 @@ If true, rendered as a horizontally scrollable list. Otherwise rendered as a ver > `optional` **onScrollEnd**: () => `void` -Defined in: [src/solid/Virtualizer.tsx:148](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/solid/Virtualizer.tsx#L148) +Defined in: [src/solid/Virtualizer.tsx:148](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/solid/Virtualizer.tsx#L148) Callback invoked when scrolling stops. @@ -1080,7 +1080,7 @@ Defines the human readable text alternative of aria-valuenow for a range widget. > `optional` **style**: `CSSProperties` -Defined in: [src/solid/types.ts:7](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/solid/types.ts#L7) +Defined in: [src/solid/types.ts:7](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/solid/types.ts#L7) #### Inherited from diff --git a/docs/solid/interfaces/VirtualizerHandle.md b/docs/solid/interfaces/VirtualizerHandle.md index a8428fed..df2af6be 100644 --- a/docs/solid/interfaces/VirtualizerHandle.md +++ b/docs/solid/interfaces/VirtualizerHandle.md @@ -4,7 +4,7 @@ # Interface: VirtualizerHandle -Defined in: [src/solid/Virtualizer.tsx:37](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/solid/Virtualizer.tsx#L37) +Defined in: [src/solid/Virtualizer.tsx:37](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/solid/Virtualizer.tsx#L37) Methods of [Virtualizer](../functions/Virtualizer.md). @@ -18,7 +18,7 @@ Methods of [Virtualizer](../functions/Virtualizer.md). > **getItemOffset**(`index`): `number` -Defined in: [src/solid/Virtualizer.tsx:62](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/solid/Virtualizer.tsx#L62) +Defined in: [src/solid/Virtualizer.tsx:62](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/solid/Virtualizer.tsx#L62) Get item offset from start. @@ -40,7 +40,7 @@ index of item > **getItemSize**(`index`): `number` -Defined in: [src/solid/Virtualizer.tsx:67](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/solid/Virtualizer.tsx#L67) +Defined in: [src/solid/Virtualizer.tsx:67](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/solid/Virtualizer.tsx#L67) Get item size. @@ -62,7 +62,7 @@ index of item > **scrollToIndex**(`index`, `opts`?): `void` -Defined in: [src/solid/Virtualizer.tsx:73](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/solid/Virtualizer.tsx#L73) +Defined in: [src/solid/Virtualizer.tsx:73](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/solid/Virtualizer.tsx#L73) Scroll to the item specified by index. @@ -90,7 +90,7 @@ options > **scrollTo**(`offset`): `void` -Defined in: [src/solid/Virtualizer.tsx:78](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/solid/Virtualizer.tsx#L78) +Defined in: [src/solid/Virtualizer.tsx:78](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/solid/Virtualizer.tsx#L78) Scroll to the given offset. @@ -112,7 +112,7 @@ offset from start > **scrollBy**(`offset`): `void` -Defined in: [src/solid/Virtualizer.tsx:83](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/solid/Virtualizer.tsx#L83) +Defined in: [src/solid/Virtualizer.tsx:83](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/solid/Virtualizer.tsx#L83) Scroll by the given offset. @@ -134,7 +134,7 @@ offset from current position > `readonly` **scrollOffset**: `number` -Defined in: [src/solid/Virtualizer.tsx:41](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/solid/Virtualizer.tsx#L41) +Defined in: [src/solid/Virtualizer.tsx:41](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/solid/Virtualizer.tsx#L41) Get current scrollTop, or scrollLeft if horizontal: true. @@ -144,7 +144,7 @@ Get current scrollTop, or scrollLeft if horizontal: true. > `readonly` **scrollSize**: `number` -Defined in: [src/solid/Virtualizer.tsx:45](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/solid/Virtualizer.tsx#L45) +Defined in: [src/solid/Virtualizer.tsx:45](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/solid/Virtualizer.tsx#L45) Get current scrollHeight, or scrollWidth if horizontal: true. @@ -154,7 +154,7 @@ Get current scrollHeight, or scrollWidth if horizontal: true. > `readonly` **viewportSize**: `number` -Defined in: [src/solid/Virtualizer.tsx:49](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/solid/Virtualizer.tsx#L49) +Defined in: [src/solid/Virtualizer.tsx:49](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/solid/Virtualizer.tsx#L49) Get current offsetHeight, or offsetWidth if horizontal: true. @@ -164,7 +164,7 @@ Get current offsetHeight, or offsetWidth if horizontal: true. > **findStartIndex**: () => `number` -Defined in: [src/solid/Virtualizer.tsx:53](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/solid/Virtualizer.tsx#L53) +Defined in: [src/solid/Virtualizer.tsx:53](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/solid/Virtualizer.tsx#L53) Find the start index of visible range of items. @@ -178,7 +178,7 @@ Find the start index of visible range of items. > **findEndIndex**: () => `number` -Defined in: [src/solid/Virtualizer.tsx:57](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/solid/Virtualizer.tsx#L57) +Defined in: [src/solid/Virtualizer.tsx:57](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/solid/Virtualizer.tsx#L57) Find the end index of visible range of items. diff --git a/docs/solid/interfaces/VirtualizerProps.md b/docs/solid/interfaces/VirtualizerProps.md index 5cab082b..005d1ecb 100644 --- a/docs/solid/interfaces/VirtualizerProps.md +++ b/docs/solid/interfaces/VirtualizerProps.md @@ -4,7 +4,7 @@ # Interface: VirtualizerProps\ -Defined in: [src/solid/Virtualizer.tsx:89](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/solid/Virtualizer.tsx#L89) +Defined in: [src/solid/Virtualizer.tsx:89](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/solid/Virtualizer.tsx#L89) Props of [Virtualizer](../functions/Virtualizer.md). @@ -18,7 +18,7 @@ Props of [Virtualizer](../functions/Virtualizer.md). > `optional` **ref**: (`handle`?) => `void` -Defined in: [src/solid/Virtualizer.tsx:93](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/solid/Virtualizer.tsx#L93) +Defined in: [src/solid/Virtualizer.tsx:93](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/solid/Virtualizer.tsx#L93) Get reference to [VirtualizerHandle](VirtualizerHandle.md). @@ -38,7 +38,7 @@ Get reference to [VirtualizerHandle](VirtualizerHandle.md). > **data**: `T`[] -Defined in: [src/solid/Virtualizer.tsx:97](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/solid/Virtualizer.tsx#L97) +Defined in: [src/solid/Virtualizer.tsx:97](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/solid/Virtualizer.tsx#L97) The data items rendered by this component. @@ -48,7 +48,7 @@ The data items rendered by this component. > **children**: (`data`, `index`) => `Element` -Defined in: [src/solid/Virtualizer.tsx:101](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/solid/Virtualizer.tsx#L101) +Defined in: [src/solid/Virtualizer.tsx:101](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/solid/Virtualizer.tsx#L101) The elements renderer function. @@ -72,7 +72,7 @@ The elements renderer function. > `optional` **overscan**: `number` -Defined in: [src/solid/Virtualizer.tsx:106](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/solid/Virtualizer.tsx#L106) +Defined in: [src/solid/Virtualizer.tsx:106](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/solid/Virtualizer.tsx#L106) Number of items to render above/below the visible bounds of the list. Lower value will give better performance but you can increase to avoid showing blank items in fast scrolling. @@ -88,7 +88,7 @@ Number of items to render above/below the visible bounds of the list. Lower valu > `optional` **as**: `ValidComponent` -Defined in: [src/solid/Virtualizer.tsx:111](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/solid/Virtualizer.tsx#L111) +Defined in: [src/solid/Virtualizer.tsx:111](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/solid/Virtualizer.tsx#L111) Component or element type for container element. @@ -104,7 +104,7 @@ Component or element type for container element. > `optional` **item**: `ValidComponent` -Defined in: [src/solid/Virtualizer.tsx:116](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/solid/Virtualizer.tsx#L116) +Defined in: [src/solid/Virtualizer.tsx:116](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/solid/Virtualizer.tsx#L116) Component or element type for item element. @@ -120,7 +120,7 @@ Component or element type for item element. > `optional` **scrollRef**: `HTMLElement` -Defined in: [src/solid/Virtualizer.tsx:120](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/solid/Virtualizer.tsx#L120) +Defined in: [src/solid/Virtualizer.tsx:120](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/solid/Virtualizer.tsx#L120) Reference to the scrollable element. The default will get the direct parent element of virtualizer. @@ -130,7 +130,7 @@ Reference to the scrollable element. The default will get the direct parent elem > `optional` **itemSize**: `number` -Defined in: [src/solid/Virtualizer.tsx:127](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/solid/Virtualizer.tsx#L127) +Defined in: [src/solid/Virtualizer.tsx:127](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/solid/Virtualizer.tsx#L127) Item size hint for unmeasured items. It will help to reduce scroll jump when items are measured if used properly. @@ -143,7 +143,7 @@ Item size hint for unmeasured items. It will help to reduce scroll jump when ite > `optional` **shift**: `boolean` -Defined in: [src/solid/Virtualizer.tsx:131](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/solid/Virtualizer.tsx#L131) +Defined in: [src/solid/Virtualizer.tsx:131](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/solid/Virtualizer.tsx#L131) While true is set, scroll position will be maintained from the end not usual start when items are added to/removed from start. It's recommended to set false if you add to/remove from mid/end of the list because it can cause unexpected behavior. This prop is useful for reverse infinite scrolling. @@ -153,7 +153,7 @@ While true is set, scroll position will be maintained from the end not usual sta > `optional` **horizontal**: `boolean` -Defined in: [src/solid/Virtualizer.tsx:135](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/solid/Virtualizer.tsx#L135) +Defined in: [src/solid/Virtualizer.tsx:135](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/solid/Virtualizer.tsx#L135) If true, rendered as a horizontally scrollable list. Otherwise rendered as a vertically scrollable list. @@ -163,7 +163,7 @@ If true, rendered as a horizontally scrollable list. Otherwise rendered as a ver > `optional` **startMargin**: `number` -Defined in: [src/solid/Virtualizer.tsx:139](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/solid/Virtualizer.tsx#L139) +Defined in: [src/solid/Virtualizer.tsx:139](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/solid/Virtualizer.tsx#L139) If you put an element before virtualizer, you have to define its height with this prop. @@ -173,7 +173,7 @@ If you put an element before virtualizer, you have to define its height with thi > `optional` **onScroll**: (`offset`) => `void` -Defined in: [src/solid/Virtualizer.tsx:144](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/solid/Virtualizer.tsx#L144) +Defined in: [src/solid/Virtualizer.tsx:144](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/solid/Virtualizer.tsx#L144) Callback invoked whenever scroll offset changes. @@ -195,7 +195,7 @@ Current scrollTop, or scrollLeft if horizontal: true. > `optional` **onScrollEnd**: () => `void` -Defined in: [src/solid/Virtualizer.tsx:148](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/solid/Virtualizer.tsx#L148) +Defined in: [src/solid/Virtualizer.tsx:148](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/solid/Virtualizer.tsx#L148) Callback invoked when scrolling stops. diff --git a/docs/solid/interfaces/WindowVirtualizerHandle.md b/docs/solid/interfaces/WindowVirtualizerHandle.md index 04054962..99e53e98 100644 --- a/docs/solid/interfaces/WindowVirtualizerHandle.md +++ b/docs/solid/interfaces/WindowVirtualizerHandle.md @@ -4,7 +4,7 @@ # Interface: WindowVirtualizerHandle -Defined in: [src/solid/WindowVirtualizer.tsx:32](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/solid/WindowVirtualizer.tsx#L32) +Defined in: [src/solid/WindowVirtualizer.tsx:32](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/solid/WindowVirtualizer.tsx#L32) Methods of [WindowVirtualizer](../functions/WindowVirtualizer.md). @@ -14,7 +14,7 @@ Methods of [WindowVirtualizer](../functions/WindowVirtualizer.md). > **scrollToIndex**(`index`, `opts`?): `void` -Defined in: [src/solid/WindowVirtualizer.tsx:46](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/solid/WindowVirtualizer.tsx#L46) +Defined in: [src/solid/WindowVirtualizer.tsx:46](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/solid/WindowVirtualizer.tsx#L46) Scroll to the item specified by index. @@ -42,7 +42,7 @@ options > **findStartIndex**: () => `number` -Defined in: [src/solid/WindowVirtualizer.tsx:36](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/solid/WindowVirtualizer.tsx#L36) +Defined in: [src/solid/WindowVirtualizer.tsx:36](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/solid/WindowVirtualizer.tsx#L36) Find the start index of visible range of items. @@ -56,7 +56,7 @@ Find the start index of visible range of items. > **findEndIndex**: () => `number` -Defined in: [src/solid/WindowVirtualizer.tsx:40](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/solid/WindowVirtualizer.tsx#L40) +Defined in: [src/solid/WindowVirtualizer.tsx:40](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/solid/WindowVirtualizer.tsx#L40) Find the end index of visible range of items. diff --git a/docs/solid/interfaces/WindowVirtualizerProps.md b/docs/solid/interfaces/WindowVirtualizerProps.md index d9b3219a..28960e31 100644 --- a/docs/solid/interfaces/WindowVirtualizerProps.md +++ b/docs/solid/interfaces/WindowVirtualizerProps.md @@ -4,7 +4,7 @@ # Interface: WindowVirtualizerProps\ -Defined in: [src/solid/WindowVirtualizer.tsx:52](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/solid/WindowVirtualizer.tsx#L52) +Defined in: [src/solid/WindowVirtualizer.tsx:52](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/solid/WindowVirtualizer.tsx#L52) Props of [WindowVirtualizer](../functions/WindowVirtualizer.md). @@ -18,7 +18,7 @@ Props of [WindowVirtualizer](../functions/WindowVirtualizer.md). > `optional` **ref**: (`handle`?) => `void` -Defined in: [src/solid/WindowVirtualizer.tsx:56](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/solid/WindowVirtualizer.tsx#L56) +Defined in: [src/solid/WindowVirtualizer.tsx:56](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/solid/WindowVirtualizer.tsx#L56) Get reference to [WindowVirtualizerHandle](WindowVirtualizerHandle.md). @@ -38,7 +38,7 @@ Get reference to [WindowVirtualizerHandle](WindowVirtualizerHandle.md). > **data**: `T`[] -Defined in: [src/solid/WindowVirtualizer.tsx:60](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/solid/WindowVirtualizer.tsx#L60) +Defined in: [src/solid/WindowVirtualizer.tsx:60](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/solid/WindowVirtualizer.tsx#L60) The data items rendered by this component. @@ -48,7 +48,7 @@ The data items rendered by this component. > **children**: (`data`, `index`) => `Element` -Defined in: [src/solid/WindowVirtualizer.tsx:64](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/solid/WindowVirtualizer.tsx#L64) +Defined in: [src/solid/WindowVirtualizer.tsx:64](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/solid/WindowVirtualizer.tsx#L64) The elements renderer function. @@ -72,7 +72,7 @@ The elements renderer function. > `optional` **overscan**: `number` -Defined in: [src/solid/WindowVirtualizer.tsx:69](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/solid/WindowVirtualizer.tsx#L69) +Defined in: [src/solid/WindowVirtualizer.tsx:69](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/solid/WindowVirtualizer.tsx#L69) Number of items to render above/below the visible bounds of the list. Lower value will give better performance but you can increase to avoid showing blank items in fast scrolling. @@ -88,7 +88,7 @@ Number of items to render above/below the visible bounds of the list. Lower valu > `optional` **itemSize**: `number` -Defined in: [src/solid/WindowVirtualizer.tsx:76](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/solid/WindowVirtualizer.tsx#L76) +Defined in: [src/solid/WindowVirtualizer.tsx:76](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/solid/WindowVirtualizer.tsx#L76) Item size hint for unmeasured items. It will help to reduce scroll jump when items are measured if used properly. @@ -101,7 +101,7 @@ Item size hint for unmeasured items. It will help to reduce scroll jump when ite > `optional` **shift**: `boolean` -Defined in: [src/solid/WindowVirtualizer.tsx:80](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/solid/WindowVirtualizer.tsx#L80) +Defined in: [src/solid/WindowVirtualizer.tsx:80](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/solid/WindowVirtualizer.tsx#L80) While true is set, scroll position will be maintained from the end not usual start when items are added to/removed from start. It's recommended to set false if you add to/remove from mid/end of the list because it can cause unexpected behavior. This prop is useful for reverse infinite scrolling. @@ -111,7 +111,7 @@ While true is set, scroll position will be maintained from the end not usual sta > `optional` **horizontal**: `boolean` -Defined in: [src/solid/WindowVirtualizer.tsx:84](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/solid/WindowVirtualizer.tsx#L84) +Defined in: [src/solid/WindowVirtualizer.tsx:84](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/solid/WindowVirtualizer.tsx#L84) If true, rendered as a horizontally scrollable list. Otherwise rendered as a vertically scrollable list. @@ -121,7 +121,7 @@ If true, rendered as a horizontally scrollable list. Otherwise rendered as a ver > `optional` **onScroll**: () => `void` -Defined in: [src/solid/WindowVirtualizer.tsx:88](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/solid/WindowVirtualizer.tsx#L88) +Defined in: [src/solid/WindowVirtualizer.tsx:88](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/solid/WindowVirtualizer.tsx#L88) Callback invoked whenever scroll offset changes. @@ -135,7 +135,7 @@ Callback invoked whenever scroll offset changes. > `optional` **onScrollEnd**: () => `void` -Defined in: [src/solid/WindowVirtualizer.tsx:92](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/solid/WindowVirtualizer.tsx#L92) +Defined in: [src/solid/WindowVirtualizer.tsx:92](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/solid/WindowVirtualizer.tsx#L92) Callback invoked when scrolling stops. diff --git a/docs/svelte/API.md b/docs/svelte/API.md index bf6ece52..9d586dd8 100644 --- a/docs/svelte/API.md +++ b/docs/svelte/API.md @@ -12,14 +12,6 @@ - [VirtualizerHandle](interfaces/VirtualizerHandle.md) - [WindowVirtualizerProps](interfaces/WindowVirtualizerProps.md) -## Type Aliases - -- [VList](type-aliases/VList.md) - -## Variables - -- [VList](variables/VList.md) - ## References ### Virtualizer @@ -31,3 +23,11 @@ Renames and re-exports [VList](variables/VList.md) ### WindowVirtualizer Renames and re-exports [VList](variables/VList.md) + +## Type Aliases + +- [VList](type-aliases/VList.md) + +## Variables + +- [VList](variables/VList.md) diff --git a/docs/svelte/interfaces/VListHandle.md b/docs/svelte/interfaces/VListHandle.md index a4bbd464..f52a5039 100644 --- a/docs/svelte/interfaces/VListHandle.md +++ b/docs/svelte/interfaces/VListHandle.md @@ -4,7 +4,7 @@ # Interface: VListHandle -Defined in: [src/svelte/VList.type.ts:25](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/svelte/VList.type.ts#L25) +Defined in: [src/svelte/VList.type.ts:25](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/svelte/VList.type.ts#L25) Methods of [VList](../type-aliases/VList.md). @@ -18,7 +18,7 @@ Methods of [VList](../type-aliases/VList.md). > **getItemOffset**(`index`): `number` -Defined in: [src/svelte/Virtualizer.type.ts:99](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/svelte/Virtualizer.type.ts#L99) +Defined in: [src/svelte/Virtualizer.type.ts:99](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/svelte/Virtualizer.type.ts#L99) Get item offset from start. @@ -44,7 +44,7 @@ index of item > **getItemSize**(`index`): `number` -Defined in: [src/svelte/Virtualizer.type.ts:104](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/svelte/Virtualizer.type.ts#L104) +Defined in: [src/svelte/Virtualizer.type.ts:104](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/svelte/Virtualizer.type.ts#L104) Get item size. @@ -70,7 +70,7 @@ index of item > **scrollToIndex**(`index`, `opts`?): `void` -Defined in: [src/svelte/Virtualizer.type.ts:110](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/svelte/Virtualizer.type.ts#L110) +Defined in: [src/svelte/Virtualizer.type.ts:110](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/svelte/Virtualizer.type.ts#L110) Scroll to the item specified by index. @@ -102,7 +102,7 @@ options > **scrollTo**(`offset`): `void` -Defined in: [src/svelte/Virtualizer.type.ts:115](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/svelte/Virtualizer.type.ts#L115) +Defined in: [src/svelte/Virtualizer.type.ts:115](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/svelte/Virtualizer.type.ts#L115) Scroll to the given offset. @@ -128,7 +128,7 @@ offset from start > **scrollBy**(`offset`): `void` -Defined in: [src/svelte/Virtualizer.type.ts:120](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/svelte/Virtualizer.type.ts#L120) +Defined in: [src/svelte/Virtualizer.type.ts:120](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/svelte/Virtualizer.type.ts#L120) Scroll by the given offset. @@ -154,7 +154,7 @@ offset from current position > **getScrollOffset**: () => `number` -Defined in: [src/svelte/Virtualizer.type.ts:78](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/svelte/Virtualizer.type.ts#L78) +Defined in: [src/svelte/Virtualizer.type.ts:78](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/svelte/Virtualizer.type.ts#L78) Get current scrollTop, or scrollLeft if horizontal: true. @@ -172,7 +172,7 @@ Get current scrollTop, or scrollLeft if horizontal: true. > **getScrollSize**: () => `number` -Defined in: [src/svelte/Virtualizer.type.ts:82](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/svelte/Virtualizer.type.ts#L82) +Defined in: [src/svelte/Virtualizer.type.ts:82](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/svelte/Virtualizer.type.ts#L82) Get current scrollHeight, or scrollWidth if horizontal: true. @@ -190,7 +190,7 @@ Get current scrollHeight, or scrollWidth if horizontal: true. > **getViewportSize**: () => `number` -Defined in: [src/svelte/Virtualizer.type.ts:86](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/svelte/Virtualizer.type.ts#L86) +Defined in: [src/svelte/Virtualizer.type.ts:86](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/svelte/Virtualizer.type.ts#L86) Get current offsetHeight, or offsetWidth if horizontal: true. @@ -208,7 +208,7 @@ Get current offsetHeight, or offsetWidth if horizontal: true. > **findStartIndex**: () => `number` -Defined in: [src/svelte/Virtualizer.type.ts:90](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/svelte/Virtualizer.type.ts#L90) +Defined in: [src/svelte/Virtualizer.type.ts:90](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/svelte/Virtualizer.type.ts#L90) Find the start index of visible range of items. @@ -226,7 +226,7 @@ Find the start index of visible range of items. > **findEndIndex**: () => `number` -Defined in: [src/svelte/Virtualizer.type.ts:94](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/svelte/Virtualizer.type.ts#L94) +Defined in: [src/svelte/Virtualizer.type.ts:94](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/svelte/Virtualizer.type.ts#L94) Find the end index of visible range of items. diff --git a/docs/svelte/interfaces/VListProps.md b/docs/svelte/interfaces/VListProps.md index 7d5a1bd7..5e0c3a5d 100644 --- a/docs/svelte/interfaces/VListProps.md +++ b/docs/svelte/interfaces/VListProps.md @@ -4,7 +4,7 @@ # Interface: VListProps\ -Defined in: [src/svelte/VList.type.ts:7](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/svelte/VList.type.ts#L7) +Defined in: [src/svelte/VList.type.ts:7](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/svelte/VList.type.ts#L7) Props of [VList](../type-aliases/VList.md). @@ -22,7 +22,7 @@ Props of [VList](../type-aliases/VList.md). > **children**: `Snippet`\<\[`T`, `number`\]\> -Defined in: [src/svelte/Virtualizer.type.ts:16](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/svelte/Virtualizer.type.ts#L16) +Defined in: [src/svelte/Virtualizer.type.ts:16](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/svelte/Virtualizer.type.ts#L16) The elements renderer snippet. @@ -36,7 +36,7 @@ The elements renderer snippet. > `optional` **shift**: `boolean` -Defined in: [src/svelte/Virtualizer.type.ts:51](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/svelte/Virtualizer.type.ts#L51) +Defined in: [src/svelte/Virtualizer.type.ts:51](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/svelte/Virtualizer.type.ts#L51) While true is set, scroll position will be maintained from the end not usual start when items are added to/removed from start. It's recommended to set false if you add to/remove from mid/end of the list because it can cause unexpected behavior. This prop is useful for reverse infinite scrolling. @@ -50,7 +50,7 @@ While true is set, scroll position will be maintained from the end not usual sta > **data**: `T`[] -Defined in: [src/svelte/Virtualizer.type.ts:12](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/svelte/Virtualizer.type.ts#L12) +Defined in: [src/svelte/Virtualizer.type.ts:12](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/svelte/Virtualizer.type.ts#L12) The data items rendered by this component. @@ -64,7 +64,7 @@ The data items rendered by this component. > `optional` **overscan**: `number` -Defined in: [src/svelte/Virtualizer.type.ts:36](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/svelte/Virtualizer.type.ts#L36) +Defined in: [src/svelte/Virtualizer.type.ts:36](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/svelte/Virtualizer.type.ts#L36) Number of items to render above/below the visible bounds of the list. You can increase to avoid showing blank items in fast scrolling. @@ -84,7 +84,7 @@ Number of items to render above/below the visible bounds of the list. You can in > `optional` **itemSize**: `number` -Defined in: [src/svelte/Virtualizer.type.ts:47](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/svelte/Virtualizer.type.ts#L47) +Defined in: [src/svelte/Virtualizer.type.ts:47](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/svelte/Virtualizer.type.ts#L47) Item size hint for unmeasured items. It will help to reduce scroll jump when items are measured if used properly. @@ -101,7 +101,7 @@ Item size hint for unmeasured items. It will help to reduce scroll jump when ite > `optional` **horizontal**: `boolean` -Defined in: [src/svelte/Virtualizer.type.ts:55](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/svelte/Virtualizer.type.ts#L55) +Defined in: [src/svelte/Virtualizer.type.ts:55](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/svelte/Virtualizer.type.ts#L55) If true, rendered as a horizontally scrollable list. Otherwise rendered as a vertically scrollable list. @@ -115,7 +115,7 @@ If true, rendered as a horizontally scrollable list. Otherwise rendered as a ver > `optional` **onscroll**: (`offset`) => `void` -Defined in: [src/svelte/Virtualizer.type.ts:64](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/svelte/Virtualizer.type.ts#L64) +Defined in: [src/svelte/Virtualizer.type.ts:64](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/svelte/Virtualizer.type.ts#L64) Callback invoked whenever scroll offset changes. @@ -141,7 +141,7 @@ Current scrollTop, or scrollLeft if horizontal: true. > `optional` **onscrollend**: () => `void` -Defined in: [src/svelte/Virtualizer.type.ts:68](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/svelte/Virtualizer.type.ts#L68) +Defined in: [src/svelte/Virtualizer.type.ts:68](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/svelte/Virtualizer.type.ts#L68) Callback invoked when scrolling stops. @@ -159,7 +159,7 @@ Callback invoked when scrolling stops. > `optional` **getKey**: (`data`, `index`) => `string` \| `number` -Defined in: [src/svelte/Virtualizer.type.ts:21](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/svelte/Virtualizer.type.ts#L21) +Defined in: [src/svelte/Virtualizer.type.ts:21](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/svelte/Virtualizer.type.ts#L21) Function that returns the key of an item in the list. It's recommended to specify whenever possible for performance. diff --git a/docs/svelte/interfaces/VirtualizerHandle.md b/docs/svelte/interfaces/VirtualizerHandle.md index 3ed86df6..50d655a1 100644 --- a/docs/svelte/interfaces/VirtualizerHandle.md +++ b/docs/svelte/interfaces/VirtualizerHandle.md @@ -4,7 +4,7 @@ # Interface: VirtualizerHandle -Defined in: [src/svelte/Virtualizer.type.ts:74](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/svelte/Virtualizer.type.ts#L74) +Defined in: [src/svelte/Virtualizer.type.ts:74](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/svelte/Virtualizer.type.ts#L74) Methods of [Virtualizer](../variables/VList.md). @@ -18,7 +18,7 @@ Methods of [Virtualizer](../variables/VList.md). > **getItemOffset**(`index`): `number` -Defined in: [src/svelte/Virtualizer.type.ts:99](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/svelte/Virtualizer.type.ts#L99) +Defined in: [src/svelte/Virtualizer.type.ts:99](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/svelte/Virtualizer.type.ts#L99) Get item offset from start. @@ -40,7 +40,7 @@ index of item > **getItemSize**(`index`): `number` -Defined in: [src/svelte/Virtualizer.type.ts:104](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/svelte/Virtualizer.type.ts#L104) +Defined in: [src/svelte/Virtualizer.type.ts:104](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/svelte/Virtualizer.type.ts#L104) Get item size. @@ -62,7 +62,7 @@ index of item > **scrollToIndex**(`index`, `opts`?): `void` -Defined in: [src/svelte/Virtualizer.type.ts:110](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/svelte/Virtualizer.type.ts#L110) +Defined in: [src/svelte/Virtualizer.type.ts:110](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/svelte/Virtualizer.type.ts#L110) Scroll to the item specified by index. @@ -90,7 +90,7 @@ options > **scrollTo**(`offset`): `void` -Defined in: [src/svelte/Virtualizer.type.ts:115](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/svelte/Virtualizer.type.ts#L115) +Defined in: [src/svelte/Virtualizer.type.ts:115](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/svelte/Virtualizer.type.ts#L115) Scroll to the given offset. @@ -112,7 +112,7 @@ offset from start > **scrollBy**(`offset`): `void` -Defined in: [src/svelte/Virtualizer.type.ts:120](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/svelte/Virtualizer.type.ts#L120) +Defined in: [src/svelte/Virtualizer.type.ts:120](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/svelte/Virtualizer.type.ts#L120) Scroll by the given offset. @@ -134,7 +134,7 @@ offset from current position > **getScrollOffset**: () => `number` -Defined in: [src/svelte/Virtualizer.type.ts:78](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/svelte/Virtualizer.type.ts#L78) +Defined in: [src/svelte/Virtualizer.type.ts:78](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/svelte/Virtualizer.type.ts#L78) Get current scrollTop, or scrollLeft if horizontal: true. @@ -148,7 +148,7 @@ Get current scrollTop, or scrollLeft if horizontal: true. > **getScrollSize**: () => `number` -Defined in: [src/svelte/Virtualizer.type.ts:82](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/svelte/Virtualizer.type.ts#L82) +Defined in: [src/svelte/Virtualizer.type.ts:82](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/svelte/Virtualizer.type.ts#L82) Get current scrollHeight, or scrollWidth if horizontal: true. @@ -162,7 +162,7 @@ Get current scrollHeight, or scrollWidth if horizontal: true. > **getViewportSize**: () => `number` -Defined in: [src/svelte/Virtualizer.type.ts:86](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/svelte/Virtualizer.type.ts#L86) +Defined in: [src/svelte/Virtualizer.type.ts:86](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/svelte/Virtualizer.type.ts#L86) Get current offsetHeight, or offsetWidth if horizontal: true. @@ -176,7 +176,7 @@ Get current offsetHeight, or offsetWidth if horizontal: true. > **findStartIndex**: () => `number` -Defined in: [src/svelte/Virtualizer.type.ts:90](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/svelte/Virtualizer.type.ts#L90) +Defined in: [src/svelte/Virtualizer.type.ts:90](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/svelte/Virtualizer.type.ts#L90) Find the start index of visible range of items. @@ -190,7 +190,7 @@ Find the start index of visible range of items. > **findEndIndex**: () => `number` -Defined in: [src/svelte/Virtualizer.type.ts:94](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/svelte/Virtualizer.type.ts#L94) +Defined in: [src/svelte/Virtualizer.type.ts:94](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/svelte/Virtualizer.type.ts#L94) Find the end index of visible range of items. diff --git a/docs/svelte/interfaces/VirtualizerProps.md b/docs/svelte/interfaces/VirtualizerProps.md index 6b456559..8d2e9889 100644 --- a/docs/svelte/interfaces/VirtualizerProps.md +++ b/docs/svelte/interfaces/VirtualizerProps.md @@ -4,7 +4,7 @@ # Interface: VirtualizerProps\ -Defined in: [src/svelte/Virtualizer.type.ts:8](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/svelte/Virtualizer.type.ts#L8) +Defined in: [src/svelte/Virtualizer.type.ts:8](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/svelte/Virtualizer.type.ts#L8) Props of [Virtualizer](../variables/VList.md). @@ -18,7 +18,7 @@ Props of [Virtualizer](../variables/VList.md). > **data**: `T`[] -Defined in: [src/svelte/Virtualizer.type.ts:12](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/svelte/Virtualizer.type.ts#L12) +Defined in: [src/svelte/Virtualizer.type.ts:12](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/svelte/Virtualizer.type.ts#L12) The data items rendered by this component. @@ -28,7 +28,7 @@ The data items rendered by this component. > **children**: `Snippet`\<\[`T`, `number`\]\> -Defined in: [src/svelte/Virtualizer.type.ts:16](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/svelte/Virtualizer.type.ts#L16) +Defined in: [src/svelte/Virtualizer.type.ts:16](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/svelte/Virtualizer.type.ts#L16) The elements renderer snippet. @@ -38,7 +38,7 @@ The elements renderer snippet. > `optional` **getKey**: (`data`, `index`) => `string` \| `number` -Defined in: [src/svelte/Virtualizer.type.ts:21](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/svelte/Virtualizer.type.ts#L21) +Defined in: [src/svelte/Virtualizer.type.ts:21](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/svelte/Virtualizer.type.ts#L21) Function that returns the key of an item in the list. It's recommended to specify whenever possible for performance. @@ -68,7 +68,7 @@ defaultGetKey (returns index of item) > `optional` **as**: keyof SvelteHTMLElements -Defined in: [src/svelte/Virtualizer.type.ts:26](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/svelte/Virtualizer.type.ts#L26) +Defined in: [src/svelte/Virtualizer.type.ts:26](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/svelte/Virtualizer.type.ts#L26) Component or element type for container element. @@ -84,7 +84,7 @@ Component or element type for container element. > `optional` **item**: keyof SvelteHTMLElements -Defined in: [src/svelte/Virtualizer.type.ts:31](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/svelte/Virtualizer.type.ts#L31) +Defined in: [src/svelte/Virtualizer.type.ts:31](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/svelte/Virtualizer.type.ts#L31) Component or element type for item element. @@ -100,7 +100,7 @@ Component or element type for item element. > `optional` **overscan**: `number` -Defined in: [src/svelte/Virtualizer.type.ts:36](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/svelte/Virtualizer.type.ts#L36) +Defined in: [src/svelte/Virtualizer.type.ts:36](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/svelte/Virtualizer.type.ts#L36) Number of items to render above/below the visible bounds of the list. You can increase to avoid showing blank items in fast scrolling. @@ -116,7 +116,7 @@ Number of items to render above/below the visible bounds of the list. You can in > `optional` **scrollRef**: `HTMLElement` -Defined in: [src/svelte/Virtualizer.type.ts:40](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/svelte/Virtualizer.type.ts#L40) +Defined in: [src/svelte/Virtualizer.type.ts:40](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/svelte/Virtualizer.type.ts#L40) Reference to the scrollable element. The default will get the direct parent element of virtualizer. @@ -126,7 +126,7 @@ Reference to the scrollable element. The default will get the direct parent elem > `optional` **itemSize**: `number` -Defined in: [src/svelte/Virtualizer.type.ts:47](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/svelte/Virtualizer.type.ts#L47) +Defined in: [src/svelte/Virtualizer.type.ts:47](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/svelte/Virtualizer.type.ts#L47) Item size hint for unmeasured items. It will help to reduce scroll jump when items are measured if used properly. @@ -139,7 +139,7 @@ Item size hint for unmeasured items. It will help to reduce scroll jump when ite > `optional` **shift**: `boolean` -Defined in: [src/svelte/Virtualizer.type.ts:51](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/svelte/Virtualizer.type.ts#L51) +Defined in: [src/svelte/Virtualizer.type.ts:51](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/svelte/Virtualizer.type.ts#L51) While true is set, scroll position will be maintained from the end not usual start when items are added to/removed from start. It's recommended to set false if you add to/remove from mid/end of the list because it can cause unexpected behavior. This prop is useful for reverse infinite scrolling. @@ -149,7 +149,7 @@ While true is set, scroll position will be maintained from the end not usual sta > `optional` **horizontal**: `boolean` -Defined in: [src/svelte/Virtualizer.type.ts:55](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/svelte/Virtualizer.type.ts#L55) +Defined in: [src/svelte/Virtualizer.type.ts:55](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/svelte/Virtualizer.type.ts#L55) If true, rendered as a horizontally scrollable list. Otherwise rendered as a vertically scrollable list. @@ -159,7 +159,7 @@ If true, rendered as a horizontally scrollable list. Otherwise rendered as a ver > `optional` **startMargin**: `number` -Defined in: [src/svelte/Virtualizer.type.ts:59](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/svelte/Virtualizer.type.ts#L59) +Defined in: [src/svelte/Virtualizer.type.ts:59](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/svelte/Virtualizer.type.ts#L59) If you put an element before virtualizer, you have to define its height with this prop. @@ -169,7 +169,7 @@ If you put an element before virtualizer, you have to define its height with thi > `optional` **onscroll**: (`offset`) => `void` -Defined in: [src/svelte/Virtualizer.type.ts:64](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/svelte/Virtualizer.type.ts#L64) +Defined in: [src/svelte/Virtualizer.type.ts:64](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/svelte/Virtualizer.type.ts#L64) Callback invoked whenever scroll offset changes. @@ -191,7 +191,7 @@ Current scrollTop, or scrollLeft if horizontal: true. > `optional` **onscrollend**: () => `void` -Defined in: [src/svelte/Virtualizer.type.ts:68](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/svelte/Virtualizer.type.ts#L68) +Defined in: [src/svelte/Virtualizer.type.ts:68](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/svelte/Virtualizer.type.ts#L68) Callback invoked when scrolling stops. diff --git a/docs/svelte/interfaces/WindowVirtualizerProps.md b/docs/svelte/interfaces/WindowVirtualizerProps.md index b320cd53..b83d12a3 100644 --- a/docs/svelte/interfaces/WindowVirtualizerProps.md +++ b/docs/svelte/interfaces/WindowVirtualizerProps.md @@ -4,7 +4,7 @@ # Interface: WindowVirtualizerProps\ -Defined in: [src/svelte/WindowVirtualizer.type.ts:7](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/svelte/WindowVirtualizer.type.ts#L7) +Defined in: [src/svelte/WindowVirtualizer.type.ts:7](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/svelte/WindowVirtualizer.type.ts#L7) Props of [WindowVirtualizer](../variables/VList.md). @@ -18,7 +18,7 @@ Props of [WindowVirtualizer](../variables/VList.md). > **data**: `T`[] -Defined in: [src/svelte/WindowVirtualizer.type.ts:11](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/svelte/WindowVirtualizer.type.ts#L11) +Defined in: [src/svelte/WindowVirtualizer.type.ts:11](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/svelte/WindowVirtualizer.type.ts#L11) The data items rendered by this component. @@ -28,7 +28,7 @@ The data items rendered by this component. > **children**: `Snippet`\<\[`T`, `number`\]\> -Defined in: [src/svelte/WindowVirtualizer.type.ts:15](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/svelte/WindowVirtualizer.type.ts#L15) +Defined in: [src/svelte/WindowVirtualizer.type.ts:15](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/svelte/WindowVirtualizer.type.ts#L15) The elements renderer snippet. @@ -38,7 +38,7 @@ The elements renderer snippet. > `optional` **getKey**: (`data`, `index`) => `string` \| `number` -Defined in: [src/svelte/WindowVirtualizer.type.ts:20](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/svelte/WindowVirtualizer.type.ts#L20) +Defined in: [src/svelte/WindowVirtualizer.type.ts:20](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/svelte/WindowVirtualizer.type.ts#L20) Function that returns the key of an item in the list. It's recommended to specify whenever possible for performance. @@ -68,7 +68,7 @@ defaultGetKey (returns index of item) > `optional` **overscan**: `number` -Defined in: [src/svelte/WindowVirtualizer.type.ts:25](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/svelte/WindowVirtualizer.type.ts#L25) +Defined in: [src/svelte/WindowVirtualizer.type.ts:25](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/svelte/WindowVirtualizer.type.ts#L25) Number of items to render above/below the visible bounds of the list. You can increase to avoid showing blank items in fast scrolling. @@ -84,7 +84,7 @@ Number of items to render above/below the visible bounds of the list. You can in > `optional` **itemSize**: `number` -Defined in: [src/svelte/WindowVirtualizer.type.ts:32](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/svelte/WindowVirtualizer.type.ts#L32) +Defined in: [src/svelte/WindowVirtualizer.type.ts:32](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/svelte/WindowVirtualizer.type.ts#L32) Item size hint for unmeasured items. It will help to reduce scroll jump when items are measured if used properly. @@ -97,7 +97,7 @@ Item size hint for unmeasured items. It will help to reduce scroll jump when ite > `optional` **shift**: `boolean` -Defined in: [src/svelte/WindowVirtualizer.type.ts:36](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/svelte/WindowVirtualizer.type.ts#L36) +Defined in: [src/svelte/WindowVirtualizer.type.ts:36](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/svelte/WindowVirtualizer.type.ts#L36) While true is set, scroll position will be maintained from the end not usual start when items are added to/removed from start. It's recommended to set false if you add to/remove from mid/end of the list because it can cause unexpected behavior. This prop is useful for reverse infinite scrolling. @@ -107,7 +107,7 @@ While true is set, scroll position will be maintained from the end not usual sta > `optional` **horizontal**: `boolean` -Defined in: [src/svelte/WindowVirtualizer.type.ts:40](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/svelte/WindowVirtualizer.type.ts#L40) +Defined in: [src/svelte/WindowVirtualizer.type.ts:40](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/svelte/WindowVirtualizer.type.ts#L40) If true, rendered as a horizontally scrollable list. Otherwise rendered as a vertically scrollable list. @@ -117,7 +117,7 @@ If true, rendered as a horizontally scrollable list. Otherwise rendered as a ver > `optional` **onscroll**: () => `void` -Defined in: [src/svelte/WindowVirtualizer.type.ts:44](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/svelte/WindowVirtualizer.type.ts#L44) +Defined in: [src/svelte/WindowVirtualizer.type.ts:44](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/svelte/WindowVirtualizer.type.ts#L44) Callback invoked whenever scroll offset changes. @@ -131,7 +131,7 @@ Callback invoked whenever scroll offset changes. > `optional` **onscrollend**: () => `void` -Defined in: [src/svelte/WindowVirtualizer.type.ts:48](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/svelte/WindowVirtualizer.type.ts#L48) +Defined in: [src/svelte/WindowVirtualizer.type.ts:48](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/svelte/WindowVirtualizer.type.ts#L48) Callback invoked when scrolling stops. diff --git a/docs/vue/classes/VList.md b/docs/vue/classes/VList.md index 18b93b5b..a887933f 100644 --- a/docs/vue/classes/VList.md +++ b/docs/vue/classes/VList.md @@ -4,7 +4,7 @@ # Class: VList -Defined in: [src/vue/VList.tsx:58](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/vue/VList.tsx#L58) +Defined in: [src/vue/VList.tsx:58](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/vue/VList.tsx#L58) ## Methods @@ -12,7 +12,7 @@ Defined in: [src/vue/VList.tsx:58](https://github.com/inokawa/virtua/blob/6f0a2c > **getItemOffset**(`index`): `number` -Defined in: [src/vue/Virtualizer.tsx:60](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/vue/Virtualizer.tsx#L60) +Defined in: [src/vue/Virtualizer.tsx:60](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/vue/Virtualizer.tsx#L60) Get item offset from start. @@ -34,7 +34,7 @@ index of item > **getItemSize**(`index`): `number` -Defined in: [src/vue/Virtualizer.tsx:65](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/vue/Virtualizer.tsx#L65) +Defined in: [src/vue/Virtualizer.tsx:65](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/vue/Virtualizer.tsx#L65) Get item size. @@ -56,7 +56,7 @@ index of item > **scrollToIndex**(`index`, `opts`?): `void` -Defined in: [src/vue/Virtualizer.tsx:71](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/vue/Virtualizer.tsx#L71) +Defined in: [src/vue/Virtualizer.tsx:71](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/vue/Virtualizer.tsx#L71) Scroll to the item specified by index. @@ -84,7 +84,7 @@ options > **scrollTo**(`offset`): `void` -Defined in: [src/vue/Virtualizer.tsx:76](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/vue/Virtualizer.tsx#L76) +Defined in: [src/vue/Virtualizer.tsx:76](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/vue/Virtualizer.tsx#L76) Scroll to the given offset. @@ -106,7 +106,7 @@ offset from start > **scrollBy**(`offset`): `void` -Defined in: [src/vue/Virtualizer.tsx:81](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/vue/Virtualizer.tsx#L81) +Defined in: [src/vue/Virtualizer.tsx:81](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/vue/Virtualizer.tsx#L81) Scroll by the given offset. @@ -144,7 +144,7 @@ offset from current position > `readonly` **shift**: `boolean` = `Boolean` -Defined in: [src/vue/VList.tsx:37](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/vue/VList.tsx#L37) +Defined in: [src/vue/VList.tsx:37](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/vue/VList.tsx#L37) While true is set, scroll position will be maintained from the end not usual start when items are added to/removed from start. It's recommended to set false if you add to/remove from mid/end of the list because it can cause unexpected behavior. This prop is useful for reverse infinite scrolling. @@ -154,7 +154,7 @@ While true is set, scroll position will be maintained from the end not usual sta > `readonly` **data**: `unknown`[] -Defined in: [src/vue/VList.tsx:21](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/vue/VList.tsx#L21) +Defined in: [src/vue/VList.tsx:21](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/vue/VList.tsx#L21) The data items rendered by this component. @@ -164,7 +164,7 @@ The data items rendered by this component. > `readonly` `optional` **overscan**: `number` = `Number` -Defined in: [src/vue/VList.tsx:26](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/vue/VList.tsx#L26) +Defined in: [src/vue/VList.tsx:26](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/vue/VList.tsx#L26) Number of items to render above/below the visible bounds of the list. You can increase to avoid showing blank items in fast scrolling. @@ -180,7 +180,7 @@ Number of items to render above/below the visible bounds of the list. You can in > `readonly` `optional` **itemSize**: `number` = `Number` -Defined in: [src/vue/VList.tsx:33](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/vue/VList.tsx#L33) +Defined in: [src/vue/VList.tsx:33](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/vue/VList.tsx#L33) Item size hint for unmeasured items. It will help to reduce scroll jump when items are measured if used properly. @@ -193,7 +193,7 @@ Item size hint for unmeasured items. It will help to reduce scroll jump when ite > `readonly` **horizontal**: `boolean` = `Boolean` -Defined in: [src/vue/VList.tsx:41](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/vue/VList.tsx#L41) +Defined in: [src/vue/VList.tsx:41](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/vue/VList.tsx#L41) If true, rendered as a horizontally scrollable list. Otherwise rendered as a vertically scrollable list. @@ -203,7 +203,7 @@ If true, rendered as a horizontally scrollable list. Otherwise rendered as a ver > `readonly` `optional` **keepMounted**: `number`[] -Defined in: [src/vue/VList.tsx:55](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/vue/VList.tsx#L55) +Defined in: [src/vue/VList.tsx:55](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/vue/VList.tsx#L55) List of indexes that should be always mounted, even when off screen. @@ -213,7 +213,7 @@ List of indexes that should be always mounted, even when off screen. > `readonly` `optional` **ssrCount**: `number` = `Number` -Defined in: [src/vue/VList.tsx:45](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/vue/VList.tsx#L45) +Defined in: [src/vue/VList.tsx:45](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/vue/VList.tsx#L45) A prop for SSR. If set, the specified amount of items will be mounted in the initial rendering regardless of the container size until hydrated. @@ -239,7 +239,7 @@ A prop for SSR. If set, the specified amount of items will be mounted in the ini > `readonly` `optional` **itemProps**: `ItemProps` -Defined in: [src/vue/VList.tsx:51](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/vue/VList.tsx#L51) +Defined in: [src/vue/VList.tsx:51](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/vue/VList.tsx#L51) A function that provides properties/attributes for item element @@ -251,7 +251,7 @@ A function that provides properties/attributes for item element > `readonly` **scrollOffset**: `number` -Defined in: [src/vue/Virtualizer.tsx:39](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/vue/Virtualizer.tsx#L39) +Defined in: [src/vue/Virtualizer.tsx:39](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/vue/Virtualizer.tsx#L39) Get current scrollTop, or scrollLeft if horizontal: true. @@ -261,7 +261,7 @@ Get current scrollTop, or scrollLeft if horizontal: true. > `readonly` **scrollSize**: `number` -Defined in: [src/vue/Virtualizer.tsx:43](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/vue/Virtualizer.tsx#L43) +Defined in: [src/vue/Virtualizer.tsx:43](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/vue/Virtualizer.tsx#L43) Get current scrollHeight, or scrollWidth if horizontal: true. @@ -271,7 +271,7 @@ Get current scrollHeight, or scrollWidth if horizontal: true. > `readonly` **viewportSize**: `number` -Defined in: [src/vue/Virtualizer.tsx:47](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/vue/Virtualizer.tsx#L47) +Defined in: [src/vue/Virtualizer.tsx:47](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/vue/Virtualizer.tsx#L47) Get current offsetHeight, or offsetWidth if horizontal: true. @@ -281,7 +281,7 @@ Get current offsetHeight, or offsetWidth if horizontal: true. > **findStartIndex**: () => `number` -Defined in: [src/vue/Virtualizer.tsx:51](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/vue/Virtualizer.tsx#L51) +Defined in: [src/vue/Virtualizer.tsx:51](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/vue/Virtualizer.tsx#L51) Find the start index of visible range of items. @@ -295,7 +295,7 @@ Find the start index of visible range of items. > **findEndIndex**: () => `number` -Defined in: [src/vue/Virtualizer.tsx:55](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/vue/Virtualizer.tsx#L55) +Defined in: [src/vue/Virtualizer.tsx:55](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/vue/Virtualizer.tsx#L55) Find the end index of visible range of items. diff --git a/docs/vue/classes/Virtualizer.md b/docs/vue/classes/Virtualizer.md index 1a601a09..c447efed 100644 --- a/docs/vue/classes/Virtualizer.md +++ b/docs/vue/classes/Virtualizer.md @@ -4,7 +4,7 @@ # Class: Virtualizer -Defined in: [src/vue/Virtualizer.tsx:143](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/vue/Virtualizer.tsx#L143) +Defined in: [src/vue/Virtualizer.tsx:143](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/vue/Virtualizer.tsx#L143) ## Methods @@ -12,7 +12,7 @@ Defined in: [src/vue/Virtualizer.tsx:143](https://github.com/inokawa/virtua/blob > **getItemOffset**(`index`): `number` -Defined in: [src/vue/Virtualizer.tsx:60](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/vue/Virtualizer.tsx#L60) +Defined in: [src/vue/Virtualizer.tsx:60](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/vue/Virtualizer.tsx#L60) Get item offset from start. @@ -34,7 +34,7 @@ index of item > **getItemSize**(`index`): `number` -Defined in: [src/vue/Virtualizer.tsx:65](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/vue/Virtualizer.tsx#L65) +Defined in: [src/vue/Virtualizer.tsx:65](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/vue/Virtualizer.tsx#L65) Get item size. @@ -56,7 +56,7 @@ index of item > **scrollToIndex**(`index`, `opts`?): `void` -Defined in: [src/vue/Virtualizer.tsx:71](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/vue/Virtualizer.tsx#L71) +Defined in: [src/vue/Virtualizer.tsx:71](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/vue/Virtualizer.tsx#L71) Scroll to the item specified by index. @@ -84,7 +84,7 @@ options > **scrollTo**(`offset`): `void` -Defined in: [src/vue/Virtualizer.tsx:76](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/vue/Virtualizer.tsx#L76) +Defined in: [src/vue/Virtualizer.tsx:76](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/vue/Virtualizer.tsx#L76) Scroll to the given offset. @@ -106,7 +106,7 @@ offset from start > **scrollBy**(`offset`): `void` -Defined in: [src/vue/Virtualizer.tsx:81](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/vue/Virtualizer.tsx#L81) +Defined in: [src/vue/Virtualizer.tsx:81](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/vue/Virtualizer.tsx#L81) Scroll by the given offset. @@ -144,7 +144,7 @@ offset from current position > `readonly` **shift**: `boolean` = `Boolean` -Defined in: [src/vue/Virtualizer.tsx:104](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/vue/Virtualizer.tsx#L104) +Defined in: [src/vue/Virtualizer.tsx:104](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/vue/Virtualizer.tsx#L104) While true is set, scroll position will be maintained from the end not usual start when items are added to/removed from start. It's recommended to set false if you add to/remove from mid/end of the list because it can cause unexpected behavior. This prop is useful for reverse infinite scrolling. @@ -154,7 +154,7 @@ While true is set, scroll position will be maintained from the end not usual sta > `readonly` **data**: `unknown`[] -Defined in: [src/vue/Virtualizer.tsx:88](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/vue/Virtualizer.tsx#L88) +Defined in: [src/vue/Virtualizer.tsx:88](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/vue/Virtualizer.tsx#L88) The data items rendered by this component. @@ -164,7 +164,7 @@ The data items rendered by this component. > `readonly` `optional` **overscan**: `number` = `Number` -Defined in: [src/vue/Virtualizer.tsx:93](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/vue/Virtualizer.tsx#L93) +Defined in: [src/vue/Virtualizer.tsx:93](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/vue/Virtualizer.tsx#L93) Number of items to render above/below the visible bounds of the list. You can increase to avoid showing blank items in fast scrolling. @@ -180,7 +180,7 @@ Number of items to render above/below the visible bounds of the list. You can in > `readonly` `optional` **itemSize**: `number` = `Number` -Defined in: [src/vue/Virtualizer.tsx:100](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/vue/Virtualizer.tsx#L100) +Defined in: [src/vue/Virtualizer.tsx:100](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/vue/Virtualizer.tsx#L100) Item size hint for unmeasured items. It will help to reduce scroll jump when items are measured if used properly. @@ -193,7 +193,7 @@ Item size hint for unmeasured items. It will help to reduce scroll jump when ite > `readonly` **horizontal**: `boolean` = `Boolean` -Defined in: [src/vue/Virtualizer.tsx:108](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/vue/Virtualizer.tsx#L108) +Defined in: [src/vue/Virtualizer.tsx:108](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/vue/Virtualizer.tsx#L108) If true, rendered as a horizontally scrollable list. Otherwise rendered as a vertically scrollable list. @@ -203,7 +203,7 @@ If true, rendered as a horizontally scrollable list. Otherwise rendered as a ver > `readonly` `optional` **keepMounted**: `number`[] -Defined in: [src/vue/Virtualizer.tsx:140](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/vue/Virtualizer.tsx#L140) +Defined in: [src/vue/Virtualizer.tsx:140](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/vue/Virtualizer.tsx#L140) List of indexes that should be always mounted, even when off screen. @@ -213,7 +213,7 @@ List of indexes that should be always mounted, even when off screen. > `readonly` **startMargin**: `number` -Defined in: [src/vue/Virtualizer.tsx:112](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/vue/Virtualizer.tsx#L112) +Defined in: [src/vue/Virtualizer.tsx:112](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/vue/Virtualizer.tsx#L112) If you put an element before virtualizer, you have to define its height with this prop. @@ -223,7 +223,7 @@ If you put an element before virtualizer, you have to define its height with thi > `readonly` `optional` **ssrCount**: `number` = `Number` -Defined in: [src/vue/Virtualizer.tsx:116](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/vue/Virtualizer.tsx#L116) +Defined in: [src/vue/Virtualizer.tsx:116](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/vue/Virtualizer.tsx#L116) A prop for SSR. If set, the specified amount of items will be mounted in the initial rendering regardless of the container size until hydrated. @@ -233,7 +233,7 @@ A prop for SSR. If set, the specified amount of items will be mounted in the ini > `readonly` **as**: keyof `IntrinsicElementAttributes` -Defined in: [src/vue/Virtualizer.tsx:125](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/vue/Virtualizer.tsx#L125) +Defined in: [src/vue/Virtualizer.tsx:125](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/vue/Virtualizer.tsx#L125) Component or element type for container element. @@ -249,7 +249,7 @@ Component or element type for container element. > `readonly` **item**: keyof `IntrinsicElementAttributes` -Defined in: [src/vue/Virtualizer.tsx:130](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/vue/Virtualizer.tsx#L130) +Defined in: [src/vue/Virtualizer.tsx:130](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/vue/Virtualizer.tsx#L130) Component or element type for item element. @@ -265,7 +265,7 @@ Component or element type for item element. > `readonly` `optional` **scrollRef**: `HTMLElement` -Defined in: [src/vue/Virtualizer.tsx:120](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/vue/Virtualizer.tsx#L120) +Defined in: [src/vue/Virtualizer.tsx:120](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/vue/Virtualizer.tsx#L120) Reference to the scrollable element. The default will get the direct parent element of virtualizer. @@ -291,7 +291,7 @@ Reference to the scrollable element. The default will get the direct parent elem > `readonly` `optional` **itemProps**: `ItemProps` -Defined in: [src/vue/Virtualizer.tsx:136](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/vue/Virtualizer.tsx#L136) +Defined in: [src/vue/Virtualizer.tsx:136](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/vue/Virtualizer.tsx#L136) A function that provides properties/attributes for item element @@ -303,7 +303,7 @@ A function that provides properties/attributes for item element > `readonly` **scrollOffset**: `number` -Defined in: [src/vue/Virtualizer.tsx:39](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/vue/Virtualizer.tsx#L39) +Defined in: [src/vue/Virtualizer.tsx:39](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/vue/Virtualizer.tsx#L39) Get current scrollTop, or scrollLeft if horizontal: true. @@ -313,7 +313,7 @@ Get current scrollTop, or scrollLeft if horizontal: true. > `readonly` **scrollSize**: `number` -Defined in: [src/vue/Virtualizer.tsx:43](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/vue/Virtualizer.tsx#L43) +Defined in: [src/vue/Virtualizer.tsx:43](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/vue/Virtualizer.tsx#L43) Get current scrollHeight, or scrollWidth if horizontal: true. @@ -323,7 +323,7 @@ Get current scrollHeight, or scrollWidth if horizontal: true. > `readonly` **viewportSize**: `number` -Defined in: [src/vue/Virtualizer.tsx:47](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/vue/Virtualizer.tsx#L47) +Defined in: [src/vue/Virtualizer.tsx:47](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/vue/Virtualizer.tsx#L47) Get current offsetHeight, or offsetWidth if horizontal: true. @@ -333,7 +333,7 @@ Get current offsetHeight, or offsetWidth if horizontal: true. > **findStartIndex**: () => `number` -Defined in: [src/vue/Virtualizer.tsx:51](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/vue/Virtualizer.tsx#L51) +Defined in: [src/vue/Virtualizer.tsx:51](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/vue/Virtualizer.tsx#L51) Find the start index of visible range of items. @@ -347,7 +347,7 @@ Find the start index of visible range of items. > **findEndIndex**: () => `number` -Defined in: [src/vue/Virtualizer.tsx:55](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/vue/Virtualizer.tsx#L55) +Defined in: [src/vue/Virtualizer.tsx:55](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/vue/Virtualizer.tsx#L55) Find the end index of visible range of items. diff --git a/docs/vue/classes/WindowVirtualizer.md b/docs/vue/classes/WindowVirtualizer.md index 277d848a..a46acb72 100644 --- a/docs/vue/classes/WindowVirtualizer.md +++ b/docs/vue/classes/WindowVirtualizer.md @@ -4,7 +4,7 @@ # Class: WindowVirtualizer -Defined in: [src/vue/WindowVirtualizer.tsx:85](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/vue/WindowVirtualizer.tsx#L85) +Defined in: [src/vue/WindowVirtualizer.tsx:85](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/vue/WindowVirtualizer.tsx#L85) ## Properties @@ -28,7 +28,7 @@ Defined in: [src/vue/WindowVirtualizer.tsx:85](https://github.com/inokawa/virtua > `readonly` **shift**: `boolean` = `Boolean` -Defined in: [src/vue/WindowVirtualizer.tsx:68](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/vue/WindowVirtualizer.tsx#L68) +Defined in: [src/vue/WindowVirtualizer.tsx:68](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/vue/WindowVirtualizer.tsx#L68) While true is set, scroll position will be maintained from the end not usual start when items are added to/removed from start. It's recommended to set false if you add to/remove from mid/end of the list because it can cause unexpected behavior. This prop is useful for reverse infinite scrolling. @@ -38,7 +38,7 @@ While true is set, scroll position will be maintained from the end not usual sta > `readonly` **data**: `unknown`[] -Defined in: [src/vue/WindowVirtualizer.tsx:52](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/vue/WindowVirtualizer.tsx#L52) +Defined in: [src/vue/WindowVirtualizer.tsx:52](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/vue/WindowVirtualizer.tsx#L52) The data items rendered by this component. @@ -48,7 +48,7 @@ The data items rendered by this component. > `readonly` `optional` **overscan**: `number` = `Number` -Defined in: [src/vue/WindowVirtualizer.tsx:57](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/vue/WindowVirtualizer.tsx#L57) +Defined in: [src/vue/WindowVirtualizer.tsx:57](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/vue/WindowVirtualizer.tsx#L57) Number of items to render above/below the visible bounds of the list. You can increase to avoid showing blank items in fast scrolling. @@ -64,7 +64,7 @@ Number of items to render above/below the visible bounds of the list. You can in > `readonly` `optional` **itemSize**: `number` = `Number` -Defined in: [src/vue/WindowVirtualizer.tsx:64](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/vue/WindowVirtualizer.tsx#L64) +Defined in: [src/vue/WindowVirtualizer.tsx:64](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/vue/WindowVirtualizer.tsx#L64) Item size hint for unmeasured items. It will help to reduce scroll jump when items are measured if used properly. @@ -77,7 +77,7 @@ Item size hint for unmeasured items. It will help to reduce scroll jump when ite > `readonly` **horizontal**: `boolean` = `Boolean` -Defined in: [src/vue/WindowVirtualizer.tsx:72](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/vue/WindowVirtualizer.tsx#L72) +Defined in: [src/vue/WindowVirtualizer.tsx:72](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/vue/WindowVirtualizer.tsx#L72) If true, rendered as a horizontally scrollable list. Otherwise rendered as a vertically scrollable list. @@ -87,7 +87,7 @@ If true, rendered as a horizontally scrollable list. Otherwise rendered as a ver > `readonly` **as**: keyof `IntrinsicElementAttributes` -Defined in: [src/vue/WindowVirtualizer.tsx:77](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/vue/WindowVirtualizer.tsx#L77) +Defined in: [src/vue/WindowVirtualizer.tsx:77](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/vue/WindowVirtualizer.tsx#L77) Component or element type for container element. @@ -103,7 +103,7 @@ Component or element type for container element. > `readonly` **item**: keyof `IntrinsicElementAttributes` -Defined in: [src/vue/WindowVirtualizer.tsx:82](https://github.com/inokawa/virtua/blob/6f0a2cc73821555ca70fe196669f946c5e86c72d/src/vue/WindowVirtualizer.tsx#L82) +Defined in: [src/vue/WindowVirtualizer.tsx:82](https://github.com/inokawa/virtua/blob/0ce0cc2cff2931917967ae53679917fd6b9407b9/src/vue/WindowVirtualizer.tsx#L82) Component or element type for item element. diff --git a/package-lock.json b/package-lock.json index 2d749cc9..d74134d6 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "virtua", - "version": "0.40.1", + "version": "0.40.2", "lockfileVersion": 3, "requires": true, "packages": { "": { "name": "virtua", - "version": "0.40.1", + "version": "0.40.2", "license": "MIT", "devDependencies": { "@atlaskit/pragmatic-drag-and-drop": "^1.4.0", diff --git a/package.json b/package.json index 5f017afb..78d0a2c6 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "virtua", - "version": "0.40.1", + "version": "0.40.2", "description": "A zero-config, fast and small (~3kB) virtual list (and grid) component for React, Vue, Solid and Svelte.", "main": "lib/index.js", "module": "lib/index.mjs",