Skip to content

Commit

Permalink
0.16.0
Browse files Browse the repository at this point in the history
  • Loading branch information
inokawa committed Oct 31, 2023
1 parent 3cb0516 commit e6adca1
Show file tree
Hide file tree
Showing 14 changed files with 78 additions and 78 deletions.
32 changes: 16 additions & 16 deletions docs/API.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,20 +5,20 @@
### Functions

- [VList](API.md#vlist)
- [VGrid](API.md#vgrid)
- [WVList](API.md#wvlist)
- [experimental\_VGrid](API.md#experimental_vgrid)

### Interfaces

- [CacheSnapshot](interfaces/CacheSnapshot.md)
- [ScrollToIndexOpts](interfaces/ScrollToIndexOpts.md)
- [VListProps](interfaces/VListProps.md)
- [VListHandle](interfaces/VListHandle.md)
- [WVListProps](interfaces/WVListProps.md)
- [WVListHandle](interfaces/WVListHandle.md)
- [VGridProps](interfaces/VGridProps.md)
- [VGridHandle](interfaces/VGridHandle.md)
- [CustomCellComponentProps](interfaces/CustomCellComponentProps.md)
- [WVListProps](interfaces/WVListProps.md)
- [WVListHandle](interfaces/WVListHandle.md)
- [CustomViewportComponentProps](interfaces/CustomViewportComponentProps.md)
- [CustomItemComponentProps](interfaces/CustomItemComponentProps.md)

Expand Down Expand Up @@ -54,17 +54,17 @@ node_modules/@types/react/index.d.ts:395

___

### VGrid
### WVList

**VGrid**(`props`): `ReactNode`
**WVList**(`props`): `ReactNode`

Virtualized grid component. See [VGridProps](interfaces/VGridProps.md) and [VGridHandle](interfaces/VGridHandle.md).
Virtualized list component controlled by the window scrolling. See [WVListProps](interfaces/WVListProps.md) and [WVListHandle](interfaces/WVListHandle.md).

#### Parameters

| Name | Type |
| :------ | :------ |
| `props` | [`VGridProps`](interfaces/VGridProps.md) & `RefAttributes`<[`VGridHandle`](interfaces/VGridHandle.md)\> |
| `props` | [`WVListProps`](interfaces/WVListProps.md) & `RefAttributes`<[`WVListHandle`](interfaces/WVListHandle.md)\> |

#### Returns

Expand All @@ -76,17 +76,17 @@ node_modules/@types/react/index.d.ts:395

___

### WVList
### experimental\_VGrid

**WVList**(`props`): `ReactNode`
**experimental_VGrid**(`props`): `ReactNode`

Virtualized list component controlled by the window scrolling. See [WVListProps](interfaces/WVListProps.md) and [WVListHandle](interfaces/WVListHandle.md).
Virtualized grid component. See [VGridProps](interfaces/VGridProps.md) and [VGridHandle](interfaces/VGridHandle.md).

#### Parameters

| Name | Type |
| :------ | :------ |
| `props` | [`WVListProps`](interfaces/WVListProps.md) & `RefAttributes`<[`WVListHandle`](interfaces/WVListHandle.md)\> |
| `props` | [`VGridProps`](interfaces/VGridProps.md) & `RefAttributes`<[`VGridHandle`](interfaces/VGridHandle.md)\> |

#### Returns

Expand All @@ -104,7 +104,7 @@ node_modules/@types/react/index.d.ts:395

#### Defined in

[src/core/types.ts:19](https://github.com/inokawa/virtua/blob/187dff7d/src/core/types.ts#L19)
[src/core/types.ts:19](https://github.com/inokawa/virtua/blob/3cb05164/src/core/types.ts#L19)

___

Expand All @@ -114,7 +114,7 @@ ___

#### Defined in

[src/react/VGrid.tsx:49](https://github.com/inokawa/virtua/blob/187dff7d/src/react/VGrid.tsx#L49)
[src/react/VGrid.tsx:49](https://github.com/inokawa/virtua/blob/3cb05164/src/react/VGrid.tsx#L49)

___

Expand All @@ -124,7 +124,7 @@ ___

#### Defined in

[src/react/Viewport.tsx:9](https://github.com/inokawa/virtua/blob/187dff7d/src/react/Viewport.tsx#L9)
[src/react/Viewport.tsx:9](https://github.com/inokawa/virtua/blob/3cb05164/src/react/Viewport.tsx#L9)

___

Expand All @@ -134,7 +134,7 @@ ___

#### Defined in

[src/react/Viewport.tsx:63](https://github.com/inokawa/virtua/blob/187dff7d/src/react/Viewport.tsx#L63)
[src/react/Viewport.tsx:63](https://github.com/inokawa/virtua/blob/3cb05164/src/react/Viewport.tsx#L63)

___

Expand All @@ -144,4 +144,4 @@ ___

#### Defined in

[src/react/ListItem.tsx:22](https://github.com/inokawa/virtua/blob/187dff7d/src/react/ListItem.tsx#L22)
[src/react/ListItem.tsx:22](https://github.com/inokawa/virtua/blob/3cb05164/src/react/ListItem.tsx#L22)
2 changes: 1 addition & 1 deletion docs/interfaces/CacheSnapshot.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,4 +18,4 @@ Serializable cache snapshot.

#### Defined in

[src/core/types.ts:16](https://github.com/inokawa/virtua/blob/187dff7d/src/core/types.ts#L16)
[src/core/types.ts:16](https://github.com/inokawa/virtua/blob/3cb05164/src/core/types.ts#L16)
6 changes: 3 additions & 3 deletions docs/interfaces/CustomCellComponentProps.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Interface: CustomCellComponentProps

Props of customized cell component for [VGrid](../API.md#vgrid).
Props of customized cell component for [experimental_VGrid](../API.md#experimental_vgrid).

## Table of contents

Expand All @@ -17,7 +17,7 @@ Props of customized cell component for [VGrid](../API.md#vgrid).

#### Defined in

[src/react/VGrid.tsx:45](https://github.com/inokawa/virtua/blob/187dff7d/src/react/VGrid.tsx#L45)
[src/react/VGrid.tsx:45](https://github.com/inokawa/virtua/blob/3cb05164/src/react/VGrid.tsx#L45)

___

Expand All @@ -27,4 +27,4 @@ ___

#### Defined in

[src/react/VGrid.tsx:46](https://github.com/inokawa/virtua/blob/187dff7d/src/react/VGrid.tsx#L46)
[src/react/VGrid.tsx:46](https://github.com/inokawa/virtua/blob/3cb05164/src/react/VGrid.tsx#L46)
4 changes: 2 additions & 2 deletions docs/interfaces/CustomItemComponentProps.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Props of customized item component for [VList](../API.md#vlist).

#### Defined in

[src/react/ListItem.tsx:18](https://github.com/inokawa/virtua/blob/187dff7d/src/react/ListItem.tsx#L18)
[src/react/ListItem.tsx:18](https://github.com/inokawa/virtua/blob/3cb05164/src/react/ListItem.tsx#L18)

___

Expand All @@ -27,4 +27,4 @@ ___

#### Defined in

[src/react/ListItem.tsx:19](https://github.com/inokawa/virtua/blob/187dff7d/src/react/ListItem.tsx#L19)
[src/react/ListItem.tsx:19](https://github.com/inokawa/virtua/blob/3cb05164/src/react/ListItem.tsx#L19)
10 changes: 5 additions & 5 deletions docs/interfaces/CustomViewportComponentProps.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Renderable item elements.

#### Defined in

[src/react/Viewport.tsx:22](https://github.com/inokawa/virtua/blob/187dff7d/src/react/Viewport.tsx#L22)
[src/react/Viewport.tsx:22](https://github.com/inokawa/virtua/blob/3cb05164/src/react/Viewport.tsx#L22)

___

Expand All @@ -34,7 +34,7 @@ Attributes that should be passed to the scrollable element.

#### Defined in

[src/react/Viewport.tsx:26](https://github.com/inokawa/virtua/blob/187dff7d/src/react/Viewport.tsx#L26)
[src/react/Viewport.tsx:26](https://github.com/inokawa/virtua/blob/3cb05164/src/react/Viewport.tsx#L26)

___

Expand All @@ -46,7 +46,7 @@ Total height of items. It's undefined if component is not vertically scrollable.

#### Defined in

[src/react/Viewport.tsx:30](https://github.com/inokawa/virtua/blob/187dff7d/src/react/Viewport.tsx#L30)
[src/react/Viewport.tsx:30](https://github.com/inokawa/virtua/blob/3cb05164/src/react/Viewport.tsx#L30)

___

Expand All @@ -58,7 +58,7 @@ Total width of items. It's undefined if component is not horizontally scrollable

#### Defined in

[src/react/Viewport.tsx:34](https://github.com/inokawa/virtua/blob/187dff7d/src/react/Viewport.tsx#L34)
[src/react/Viewport.tsx:34](https://github.com/inokawa/virtua/blob/3cb05164/src/react/Viewport.tsx#L34)

___

Expand All @@ -70,4 +70,4 @@ Currently component is scrolling or not.

#### Defined in

[src/react/Viewport.tsx:38](https://github.com/inokawa/virtua/blob/187dff7d/src/react/Viewport.tsx#L38)
[src/react/Viewport.tsx:38](https://github.com/inokawa/virtua/blob/3cb05164/src/react/Viewport.tsx#L38)
4 changes: 2 additions & 2 deletions docs/interfaces/ScrollToIndexOpts.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Alignment of item.

#### Defined in

[src/core/types.ts:30](https://github.com/inokawa/virtua/blob/187dff7d/src/core/types.ts#L30)
[src/core/types.ts:30](https://github.com/inokawa/virtua/blob/3cb05164/src/core/types.ts#L30)

___

Expand All @@ -36,4 +36,4 @@ If true, scrolling animates smoothly with [`behavior: smooth` of scrollTo](https

#### Defined in

[src/core/types.ts:36](https://github.com/inokawa/virtua/blob/187dff7d/src/core/types.ts#L36)
[src/core/types.ts:36](https://github.com/inokawa/virtua/blob/3cb05164/src/core/types.ts#L36)
14 changes: 7 additions & 7 deletions docs/interfaces/VGridHandle.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Interface: VGridHandle

Methods of [VGrid](../API.md#vgrid).
Methods of [experimental_VGrid](../API.md#experimental_vgrid).

## Table of contents

Expand Down Expand Up @@ -37,7 +37,7 @@ Scroll to the item specified by index.

#### Defined in

[src/react/VGrid.tsx:136](https://github.com/inokawa/virtua/blob/187dff7d/src/react/VGrid.tsx#L136)
[src/react/VGrid.tsx:136](https://github.com/inokawa/virtua/blob/3cb05164/src/react/VGrid.tsx#L136)

___

Expand All @@ -60,7 +60,7 @@ Scroll to the given offset.

#### Defined in

[src/react/VGrid.tsx:142](https://github.com/inokawa/virtua/blob/187dff7d/src/react/VGrid.tsx#L142)
[src/react/VGrid.tsx:142](https://github.com/inokawa/virtua/blob/3cb05164/src/react/VGrid.tsx#L142)

___

Expand All @@ -83,7 +83,7 @@ Scroll by the given offset.

#### Defined in

[src/react/VGrid.tsx:148](https://github.com/inokawa/virtua/blob/187dff7d/src/react/VGrid.tsx#L148)
[src/react/VGrid.tsx:148](https://github.com/inokawa/virtua/blob/3cb05164/src/react/VGrid.tsx#L148)

## Properties

Expand All @@ -95,7 +95,7 @@ Get current scrollTop or scrollLeft.

#### Defined in

[src/react/VGrid.tsx:122](https://github.com/inokawa/virtua/blob/187dff7d/src/react/VGrid.tsx#L122)
[src/react/VGrid.tsx:122](https://github.com/inokawa/virtua/blob/3cb05164/src/react/VGrid.tsx#L122)

___

Expand All @@ -107,7 +107,7 @@ Get current scrollHeight or scrollWidth.

#### Defined in

[src/react/VGrid.tsx:126](https://github.com/inokawa/virtua/blob/187dff7d/src/react/VGrid.tsx#L126)
[src/react/VGrid.tsx:126](https://github.com/inokawa/virtua/blob/3cb05164/src/react/VGrid.tsx#L126)

___

Expand All @@ -119,4 +119,4 @@ Get current offsetHeight or offsetWidth.

#### Defined in

[src/react/VGrid.tsx:130](https://github.com/inokawa/virtua/blob/187dff7d/src/react/VGrid.tsx#L130)
[src/react/VGrid.tsx:130](https://github.com/inokawa/virtua/blob/3cb05164/src/react/VGrid.tsx#L130)
20 changes: 10 additions & 10 deletions docs/interfaces/VGridProps.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Interface: VGridProps

Props of [VGrid](../API.md#vgrid).
Props of [experimental_VGrid](../API.md#experimental_vgrid).

## Hierarchy

Expand Down Expand Up @@ -107,7 +107,7 @@ A function to create elements rendered by this component.

#### Defined in

[src/react/VGrid.tsx:158](https://github.com/inokawa/virtua/blob/187dff7d/src/react/VGrid.tsx#L158)
[src/react/VGrid.tsx:158](https://github.com/inokawa/virtua/blob/3cb05164/src/react/VGrid.tsx#L158)

___

Expand All @@ -119,7 +119,7 @@ Total row length of grid.

#### Defined in

[src/react/VGrid.tsx:171](https://github.com/inokawa/virtua/blob/187dff7d/src/react/VGrid.tsx#L171)
[src/react/VGrid.tsx:171](https://github.com/inokawa/virtua/blob/3cb05164/src/react/VGrid.tsx#L171)

___

Expand All @@ -131,7 +131,7 @@ Total column length of grid.

#### Defined in

[src/react/VGrid.tsx:175](https://github.com/inokawa/virtua/blob/187dff7d/src/react/VGrid.tsx#L175)
[src/react/VGrid.tsx:175](https://github.com/inokawa/virtua/blob/3cb05164/src/react/VGrid.tsx#L175)

___

Expand All @@ -147,7 +147,7 @@ Cell height hint for unmeasured items. It's recommended to specify this prop if

#### Defined in

[src/react/VGrid.tsx:180](https://github.com/inokawa/virtua/blob/187dff7d/src/react/VGrid.tsx#L180)
[src/react/VGrid.tsx:180](https://github.com/inokawa/virtua/blob/3cb05164/src/react/VGrid.tsx#L180)

___

Expand All @@ -163,7 +163,7 @@ Cell width hint for unmeasured items. It's recommended to specify this prop if i

#### Defined in

[src/react/VGrid.tsx:185](https://github.com/inokawa/virtua/blob/187dff7d/src/react/VGrid.tsx#L185)
[src/react/VGrid.tsx:185](https://github.com/inokawa/virtua/blob/3cb05164/src/react/VGrid.tsx#L185)

___

Expand All @@ -179,7 +179,7 @@ Number of items to render above/below the visible bounds of the grid. You can in

#### Defined in

[src/react/VGrid.tsx:190](https://github.com/inokawa/virtua/blob/187dff7d/src/react/VGrid.tsx#L190)
[src/react/VGrid.tsx:190](https://github.com/inokawa/virtua/blob/3cb05164/src/react/VGrid.tsx#L190)

___

Expand All @@ -191,7 +191,7 @@ If set, the specified amount of rows will be mounted in the initial rendering re

#### Defined in

[src/react/VGrid.tsx:194](https://github.com/inokawa/virtua/blob/187dff7d/src/react/VGrid.tsx#L194)
[src/react/VGrid.tsx:194](https://github.com/inokawa/virtua/blob/3cb05164/src/react/VGrid.tsx#L194)

___

Expand All @@ -203,7 +203,7 @@ If set, the specified amount of cols will be mounted in the initial rendering re

#### Defined in

[src/react/VGrid.tsx:198](https://github.com/inokawa/virtua/blob/187dff7d/src/react/VGrid.tsx#L198)
[src/react/VGrid.tsx:198](https://github.com/inokawa/virtua/blob/3cb05164/src/react/VGrid.tsx#L198)

___

Expand All @@ -222,7 +222,7 @@ Customized components for advanced usage.

#### Defined in

[src/react/VGrid.tsx:202](https://github.com/inokawa/virtua/blob/187dff7d/src/react/VGrid.tsx#L202)
[src/react/VGrid.tsx:202](https://github.com/inokawa/virtua/blob/3cb05164/src/react/VGrid.tsx#L202)

___

Expand Down
Loading

0 comments on commit e6adca1

Please sign in to comment.