Skip to content

Commit

Permalink
0.12.0
Browse files Browse the repository at this point in the history
  • Loading branch information
inokawa committed Oct 9, 2023
1 parent 257e20b commit f41b76f
Show file tree
Hide file tree
Showing 13 changed files with 66 additions and 93 deletions.
21 changes: 5 additions & 16 deletions docs/API.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,6 @@
### Type Aliases

- [ScrollToIndexAlign](API.md#scrolltoindexalign)
- [ScrollMode](API.md#scrollmode)
- [CustomCellComponent](API.md#customcellcomponent)
- [ViewportComponentAttributes](API.md#viewportcomponentattributes)
- [CustomViewportComponent](API.md#customviewportcomponent)
Expand Down Expand Up @@ -109,17 +108,7 @@ Alignment of item when calling scrollToIndex method.

#### Defined in

[src/core/types.ts:25](https://github.com/inokawa/virtua/blob/c2ef64d1/src/core/types.ts#L25)

___

### ScrollMode

Ƭ **ScrollMode**: ``"reverse"`` \| ``"rtl"``

#### Defined in

[src/react/VList.tsx:46](https://github.com/inokawa/virtua/blob/c2ef64d1/src/react/VList.tsx#L46)
[src/core/types.ts:25](https://github.com/inokawa/virtua/blob/257e20bb/src/core/types.ts#L25)

___

Expand All @@ -129,7 +118,7 @@ ___

#### Defined in

[src/react/VGrid.tsx:51](https://github.com/inokawa/virtua/blob/c2ef64d1/src/react/VGrid.tsx#L51)
[src/react/VGrid.tsx:52](https://github.com/inokawa/virtua/blob/257e20bb/src/react/VGrid.tsx#L52)

___

Expand All @@ -139,7 +128,7 @@ ___

#### Defined in

[src/react/Viewport.tsx:9](https://github.com/inokawa/virtua/blob/c2ef64d1/src/react/Viewport.tsx#L9)
[src/react/Viewport.tsx:9](https://github.com/inokawa/virtua/blob/257e20bb/src/react/Viewport.tsx#L9)

___

Expand All @@ -149,7 +138,7 @@ ___

#### Defined in

[src/react/Viewport.tsx:63](https://github.com/inokawa/virtua/blob/c2ef64d1/src/react/Viewport.tsx#L63)
[src/react/Viewport.tsx:63](https://github.com/inokawa/virtua/blob/257e20bb/src/react/Viewport.tsx#L63)

___

Expand All @@ -159,4 +148,4 @@ ___

#### Defined in

[src/react/ListItem.tsx:23](https://github.com/inokawa/virtua/blob/c2ef64d1/src/react/ListItem.tsx#L23)
[src/react/ListItem.tsx:24](https://github.com/inokawa/virtua/blob/257e20bb/src/react/ListItem.tsx#L24)
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/c2ef64d1/src/core/types.ts#L16)
[src/core/types.ts:16](https://github.com/inokawa/virtua/blob/257e20bb/src/core/types.ts#L16)
4 changes: 2 additions & 2 deletions docs/interfaces/CustomCellComponentProps.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Props of customized cell component for [VGrid](../API.md#vgrid).

#### Defined in

[src/react/VGrid.tsx:47](https://github.com/inokawa/virtua/blob/c2ef64d1/src/react/VGrid.tsx#L47)
[src/react/VGrid.tsx:48](https://github.com/inokawa/virtua/blob/257e20bb/src/react/VGrid.tsx#L48)

___

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

#### Defined in

[src/react/VGrid.tsx:48](https://github.com/inokawa/virtua/blob/c2ef64d1/src/react/VGrid.tsx#L48)
[src/react/VGrid.tsx:49](https://github.com/inokawa/virtua/blob/257e20bb/src/react/VGrid.tsx#L49)
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:19](https://github.com/inokawa/virtua/blob/c2ef64d1/src/react/ListItem.tsx#L19)
[src/react/ListItem.tsx:20](https://github.com/inokawa/virtua/blob/257e20bb/src/react/ListItem.tsx#L20)

___

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

#### Defined in

[src/react/ListItem.tsx:20](https://github.com/inokawa/virtua/blob/c2ef64d1/src/react/ListItem.tsx#L20)
[src/react/ListItem.tsx:21](https://github.com/inokawa/virtua/blob/257e20bb/src/react/ListItem.tsx#L21)
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/c2ef64d1/src/react/Viewport.tsx#L22)
[src/react/Viewport.tsx:22](https://github.com/inokawa/virtua/blob/257e20bb/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/c2ef64d1/src/react/Viewport.tsx#L26)
[src/react/Viewport.tsx:26](https://github.com/inokawa/virtua/blob/257e20bb/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/c2ef64d1/src/react/Viewport.tsx#L30)
[src/react/Viewport.tsx:30](https://github.com/inokawa/virtua/blob/257e20bb/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/c2ef64d1/src/react/Viewport.tsx#L34)
[src/react/Viewport.tsx:34](https://github.com/inokawa/virtua/blob/257e20bb/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/c2ef64d1/src/react/Viewport.tsx#L38)
[src/react/Viewport.tsx:38](https://github.com/inokawa/virtua/blob/257e20bb/src/react/Viewport.tsx#L38)
12 changes: 6 additions & 6 deletions docs/interfaces/VGridHandle.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ Scroll to the item specified by index.

#### Defined in

[src/react/VGrid.tsx:171](https://github.com/inokawa/virtua/blob/c2ef64d1/src/react/VGrid.tsx#L171)
[src/react/VGrid.tsx:170](https://github.com/inokawa/virtua/blob/257e20bb/src/react/VGrid.tsx#L170)

___

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

#### Defined in

[src/react/VGrid.tsx:177](https://github.com/inokawa/virtua/blob/c2ef64d1/src/react/VGrid.tsx#L177)
[src/react/VGrid.tsx:176](https://github.com/inokawa/virtua/blob/257e20bb/src/react/VGrid.tsx#L176)

___

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

#### Defined in

[src/react/VGrid.tsx:183](https://github.com/inokawa/virtua/blob/c2ef64d1/src/react/VGrid.tsx#L183)
[src/react/VGrid.tsx:182](https://github.com/inokawa/virtua/blob/257e20bb/src/react/VGrid.tsx#L182)

## Properties

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

#### Defined in

[src/react/VGrid.tsx:157](https://github.com/inokawa/virtua/blob/c2ef64d1/src/react/VGrid.tsx#L157)
[src/react/VGrid.tsx:156](https://github.com/inokawa/virtua/blob/257e20bb/src/react/VGrid.tsx#L156)

___

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

#### Defined in

[src/react/VGrid.tsx:161](https://github.com/inokawa/virtua/blob/c2ef64d1/src/react/VGrid.tsx#L161)
[src/react/VGrid.tsx:160](https://github.com/inokawa/virtua/blob/257e20bb/src/react/VGrid.tsx#L160)

___

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

#### Defined in

[src/react/VGrid.tsx:165](https://github.com/inokawa/virtua/blob/c2ef64d1/src/react/VGrid.tsx#L165)
[src/react/VGrid.tsx:164](https://github.com/inokawa/virtua/blob/257e20bb/src/react/VGrid.tsx#L164)
31 changes: 9 additions & 22 deletions docs/interfaces/VGridProps.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,6 @@ Props of [VGrid](../API.md#vgrid).
- [overscan](VGridProps.md#overscan)
- [initialRowCount](VGridProps.md#initialrowcount)
- [initialColCount](VGridProps.md#initialcolcount)
- [rtl](VGridProps.md#rtl)
- [components](VGridProps.md#components)
- [className](VGridProps.md#classname)
- [style](VGridProps.md#style)
Expand Down Expand Up @@ -107,7 +106,7 @@ A function to create elements rendered by this component.

#### Defined in

[src/react/VGrid.tsx:193](https://github.com/inokawa/virtua/blob/c2ef64d1/src/react/VGrid.tsx#L193)
[src/react/VGrid.tsx:192](https://github.com/inokawa/virtua/blob/257e20bb/src/react/VGrid.tsx#L192)

___

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

#### Defined in

[src/react/VGrid.tsx:206](https://github.com/inokawa/virtua/blob/c2ef64d1/src/react/VGrid.tsx#L206)
[src/react/VGrid.tsx:205](https://github.com/inokawa/virtua/blob/257e20bb/src/react/VGrid.tsx#L205)

___

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

#### Defined in

[src/react/VGrid.tsx:210](https://github.com/inokawa/virtua/blob/c2ef64d1/src/react/VGrid.tsx#L210)
[src/react/VGrid.tsx:209](https://github.com/inokawa/virtua/blob/257e20bb/src/react/VGrid.tsx#L209)

___

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

#### Defined in

[src/react/VGrid.tsx:215](https://github.com/inokawa/virtua/blob/c2ef64d1/src/react/VGrid.tsx#L215)
[src/react/VGrid.tsx:214](https://github.com/inokawa/virtua/blob/257e20bb/src/react/VGrid.tsx#L214)

___

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

#### Defined in

[src/react/VGrid.tsx:220](https://github.com/inokawa/virtua/blob/c2ef64d1/src/react/VGrid.tsx#L220)
[src/react/VGrid.tsx:219](https://github.com/inokawa/virtua/blob/257e20bb/src/react/VGrid.tsx#L219)

___

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

#### Defined in

[src/react/VGrid.tsx:225](https://github.com/inokawa/virtua/blob/c2ef64d1/src/react/VGrid.tsx#L225)
[src/react/VGrid.tsx:224](https://github.com/inokawa/virtua/blob/257e20bb/src/react/VGrid.tsx#L224)

___

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

#### Defined in

[src/react/VGrid.tsx:229](https://github.com/inokawa/virtua/blob/c2ef64d1/src/react/VGrid.tsx#L229)
[src/react/VGrid.tsx:228](https://github.com/inokawa/virtua/blob/257e20bb/src/react/VGrid.tsx#L228)

___

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

#### Defined in

[src/react/VGrid.tsx:233](https://github.com/inokawa/virtua/blob/c2ef64d1/src/react/VGrid.tsx#L233)

___

### rtl

`Optional` **rtl**: `boolean`

You have to set true if you use this component under `direction: rtl` style.

#### Defined in

[src/react/VGrid.tsx:237](https://github.com/inokawa/virtua/blob/c2ef64d1/src/react/VGrid.tsx#L237)
[src/react/VGrid.tsx:232](https://github.com/inokawa/virtua/blob/257e20bb/src/react/VGrid.tsx#L232)

___

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

#### Defined in

[src/react/VGrid.tsx:241](https://github.com/inokawa/virtua/blob/c2ef64d1/src/react/VGrid.tsx#L241)
[src/react/VGrid.tsx:236](https://github.com/inokawa/virtua/blob/257e20bb/src/react/VGrid.tsx#L236)

___

Expand Down
14 changes: 7 additions & 7 deletions docs/interfaces/VListHandle.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ Scroll to the item specified by index.

#### Defined in

[src/react/VList.tsx:77](https://github.com/inokawa/virtua/blob/c2ef64d1/src/react/VList.tsx#L77)
[src/react/VList.tsx:75](https://github.com/inokawa/virtua/blob/257e20bb/src/react/VList.tsx#L75)

___

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

#### Defined in

[src/react/VList.tsx:82](https://github.com/inokawa/virtua/blob/c2ef64d1/src/react/VList.tsx#L82)
[src/react/VList.tsx:80](https://github.com/inokawa/virtua/blob/257e20bb/src/react/VList.tsx#L80)

___

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

#### Defined in

[src/react/VList.tsx:87](https://github.com/inokawa/virtua/blob/c2ef64d1/src/react/VList.tsx#L87)
[src/react/VList.tsx:85](https://github.com/inokawa/virtua/blob/257e20bb/src/react/VList.tsx#L85)

## Properties

Expand All @@ -94,7 +94,7 @@ Get current [CacheSnapshot](CacheSnapshot.md).

#### Defined in

[src/react/VList.tsx:59](https://github.com/inokawa/virtua/blob/c2ef64d1/src/react/VList.tsx#L59)
[src/react/VList.tsx:57](https://github.com/inokawa/virtua/blob/257e20bb/src/react/VList.tsx#L57)

___

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

#### Defined in

[src/react/VList.tsx:63](https://github.com/inokawa/virtua/blob/c2ef64d1/src/react/VList.tsx#L63)
[src/react/VList.tsx:61](https://github.com/inokawa/virtua/blob/257e20bb/src/react/VList.tsx#L61)

___

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

#### Defined in

[src/react/VList.tsx:67](https://github.com/inokawa/virtua/blob/c2ef64d1/src/react/VList.tsx#L67)
[src/react/VList.tsx:65](https://github.com/inokawa/virtua/blob/257e20bb/src/react/VList.tsx#L65)

___

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

#### Defined in

[src/react/VList.tsx:71](https://github.com/inokawa/virtua/blob/c2ef64d1/src/react/VList.tsx#L71)
[src/react/VList.tsx:69](https://github.com/inokawa/virtua/blob/257e20bb/src/react/VList.tsx#L69)
Loading

0 comments on commit f41b76f

Please sign in to comment.