Skip to content

Commit

Permalink
0.40.2
Browse files Browse the repository at this point in the history
  • Loading branch information
inokawa committed Mar 8, 2025
1 parent 0ce0cc2 commit 09183c1
Show file tree
Hide file tree
Showing 42 changed files with 334 additions and 300 deletions.
2 changes: 1 addition & 1 deletion docs/react/functions/VList.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).

Expand Down
2 changes: 1 addition & 1 deletion docs/react/functions/Virtualizer.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).

Expand Down
2 changes: 1 addition & 1 deletion docs/react/functions/WindowVirtualizer.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).

Expand Down
2 changes: 1 addition & 1 deletion docs/react/functions/experimental_VGrid.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).

Expand Down
4 changes: 2 additions & 2 deletions docs/react/interfaces/CacheSnapshot.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand All @@ -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)
6 changes: 3 additions & 3 deletions docs/react/interfaces/CustomCellComponentProps.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).

Expand All @@ -14,12 +14,12 @@ 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)

***

### children

> **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)
8 changes: 4 additions & 4 deletions docs/react/interfaces/CustomContainerComponentProps.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,30 +4,30 @@

# 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

### style

> **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)

***

### children

> **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)

***

### ref?

> `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
10 changes: 5 additions & 5 deletions docs/react/interfaces/CustomItemComponentProps.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).

Expand All @@ -14,30 +14,30 @@ 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)

***

### index

> **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)

***

### children

> **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)

***

### ref?

> `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
8 changes: 4 additions & 4 deletions docs/react/interfaces/ScrollToIndexOpts.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,15 @@

# 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

### align?

> `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.

Expand All @@ -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).

Expand All @@ -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.

Expand Down
20 changes: 10 additions & 10 deletions docs/react/interfaces/VGridHandle.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).

Expand All @@ -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.

Expand Down Expand Up @@ -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.

Expand Down Expand Up @@ -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.

Expand Down Expand Up @@ -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.

Expand All @@ -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.

Expand All @@ -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.

Expand All @@ -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.

Expand All @@ -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.

Expand All @@ -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.
Loading

0 comments on commit 09183c1

Please sign in to comment.