Skip to content

Commit

Permalink
0.1.11
Browse files Browse the repository at this point in the history
  • Loading branch information
inokawa committed Apr 22, 2023
1 parent 6085b71 commit bac8825
Show file tree
Hide file tree
Showing 7 changed files with 75 additions and 27 deletions.
4 changes: 2 additions & 2 deletions docs/API.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ node_modules/@types/react/index.d.ts:361

#### Defined in

[src/react/List.tsx:202](https://github.com/inokawa/virtua/blob/0778171/src/react/List.tsx#L202)
[src/react/List.tsx:203](https://github.com/inokawa/virtua/blob/6085b71/src/react/List.tsx#L203)

___

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

#### Defined in

[src/react/List.tsx:139](https://github.com/inokawa/virtua/blob/0778171/src/react/List.tsx#L139)
[src/react/List.tsx:140](https://github.com/inokawa/virtua/blob/6085b71/src/react/List.tsx#L140)
4 changes: 2 additions & 2 deletions docs/interfaces/CustomItemComponentProps.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@

#### Defined in

[src/react/List.tsx:198](https://github.com/inokawa/virtua/blob/0778171/src/react/List.tsx#L198)
[src/react/List.tsx:199](https://github.com/inokawa/virtua/blob/6085b71/src/react/List.tsx#L199)

___

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

#### Defined in

[src/react/List.tsx:199](https://github.com/inokawa/virtua/blob/0778171/src/react/List.tsx#L199)
[src/react/List.tsx:200](https://github.com/inokawa/virtua/blob/6085b71/src/react/List.tsx#L200)
12 changes: 6 additions & 6 deletions docs/interfaces/CustomWindowComponentProps.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@

#### Defined in

[src/react/List.tsx:101](https://github.com/inokawa/virtua/blob/0778171/src/react/List.tsx#L101)
[src/react/List.tsx:102](https://github.com/inokawa/virtua/blob/6085b71/src/react/List.tsx#L102)

___

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

#### Defined in

[src/react/List.tsx:102](https://github.com/inokawa/virtua/blob/0778171/src/react/List.tsx#L102)
[src/react/List.tsx:103](https://github.com/inokawa/virtua/blob/6085b71/src/react/List.tsx#L103)

___

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

#### Defined in

[src/react/List.tsx:103](https://github.com/inokawa/virtua/blob/0778171/src/react/List.tsx#L103)
[src/react/List.tsx:104](https://github.com/inokawa/virtua/blob/6085b71/src/react/List.tsx#L104)

___

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

#### Defined in

[src/react/List.tsx:104](https://github.com/inokawa/virtua/blob/0778171/src/react/List.tsx#L104)
[src/react/List.tsx:105](https://github.com/inokawa/virtua/blob/6085b71/src/react/List.tsx#L105)

___

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

#### Defined in

[src/react/List.tsx:105](https://github.com/inokawa/virtua/blob/0778171/src/react/List.tsx#L105)
[src/react/List.tsx:106](https://github.com/inokawa/virtua/blob/6085b71/src/react/List.tsx#L106)

___

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

#### Defined in

[src/react/List.tsx:106](https://github.com/inokawa/virtua/blob/0778171/src/react/List.tsx#L106)
[src/react/List.tsx:107](https://github.com/inokawa/virtua/blob/6085b71/src/react/List.tsx#L107)
8 changes: 4 additions & 4 deletions docs/interfaces/ListHandle.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Get current scrollTop or scrollLeft.

#### Defined in

[src/react/List.tsx:217](https://github.com/inokawa/virtua/blob/0778171/src/react/List.tsx#L217)
[src/react/List.tsx:218](https://github.com/inokawa/virtua/blob/6085b71/src/react/List.tsx#L218)

___

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

#### Defined in

[src/react/List.tsx:221](https://github.com/inokawa/virtua/blob/0778171/src/react/List.tsx#L221)
[src/react/List.tsx:222](https://github.com/inokawa/virtua/blob/6085b71/src/react/List.tsx#L222)

## Methods

Expand All @@ -58,7 +58,7 @@ Scroll to the item specified by index.

#### Defined in

[src/react/List.tsx:226](https://github.com/inokawa/virtua/blob/0778171/src/react/List.tsx#L226)
[src/react/List.tsx:227](https://github.com/inokawa/virtua/blob/6085b71/src/react/List.tsx#L227)

___

Expand All @@ -80,4 +80,4 @@ Scroll to the item specified by offset.

#### Defined in

[src/react/List.tsx:231](https://github.com/inokawa/virtua/blob/0778171/src/react/List.tsx#L231)
[src/react/List.tsx:232](https://github.com/inokawa/virtua/blob/6085b71/src/react/List.tsx#L232)
68 changes: 58 additions & 10 deletions docs/interfaces/ListProps.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,8 @@ Props of [List](../API.md#list).
- [element](ListProps.md#element)
- [itemElement](ListProps.md#itemelement)
- [onEndReached](ListProps.md#onendreached)
- [onScroll](ListProps.md#onscroll)
- [onScrollStop](ListProps.md#onscrollstop)

## Properties

Expand All @@ -27,7 +29,7 @@ Elements rendered by this component.

#### Defined in

[src/react/List.tsx:241](https://github.com/inokawa/virtua/blob/0778171/src/react/List.tsx#L241)
[src/react/List.tsx:242](https://github.com/inokawa/virtua/blob/6085b71/src/react/List.tsx#L242)

___

Expand All @@ -43,7 +45,7 @@ Item size hint for unmeasured items. It's recommended to specify this prop if it

#### Defined in

[src/react/List.tsx:246](https://github.com/inokawa/virtua/blob/0778171/src/react/List.tsx#L246)
[src/react/List.tsx:247](https://github.com/inokawa/virtua/blob/6085b71/src/react/List.tsx#L247)

___

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

#### Defined in

[src/react/List.tsx:251](https://github.com/inokawa/virtua/blob/0778171/src/react/List.tsx#L251)
[src/react/List.tsx:252](https://github.com/inokawa/virtua/blob/6085b71/src/react/List.tsx#L252)

___

Expand All @@ -71,7 +73,7 @@ If true, rendered as a horizontally scrollable list. Otherwise rendered as a ver

#### Defined in

[src/react/List.tsx:255](https://github.com/inokawa/virtua/blob/0778171/src/react/List.tsx#L255)
[src/react/List.tsx:256](https://github.com/inokawa/virtua/blob/6085b71/src/react/List.tsx#L256)

___

Expand All @@ -83,7 +85,7 @@ You have to set true if you use this component under `direction: rtl` style.

#### Defined in

[src/react/List.tsx:259](https://github.com/inokawa/virtua/blob/0778171/src/react/List.tsx#L259)
[src/react/List.tsx:260](https://github.com/inokawa/virtua/blob/6085b71/src/react/List.tsx#L260)

___

Expand All @@ -99,7 +101,7 @@ Number of items to be the margin from the end of the scroll. See also [onEndReac

#### Defined in

[src/react/List.tsx:264](https://github.com/inokawa/virtua/blob/0778171/src/react/List.tsx#L264)
[src/react/List.tsx:265](https://github.com/inokawa/virtua/blob/6085b71/src/react/List.tsx#L265)

___

Expand All @@ -111,7 +113,7 @@ Inline style prop to override style of scrollable element.

#### Defined in

[src/react/List.tsx:268](https://github.com/inokawa/virtua/blob/0778171/src/react/List.tsx#L268)
[src/react/List.tsx:269](https://github.com/inokawa/virtua/blob/6085b71/src/react/List.tsx#L269)

___

Expand All @@ -127,7 +129,7 @@ DefaultWindow

#### Defined in

[src/react/List.tsx:273](https://github.com/inokawa/virtua/blob/0778171/src/react/List.tsx#L273)
[src/react/List.tsx:274](https://github.com/inokawa/virtua/blob/6085b71/src/react/List.tsx#L274)

___

Expand All @@ -143,7 +145,7 @@ Customized element type for item element.

#### Defined in

[src/react/List.tsx:278](https://github.com/inokawa/virtua/blob/0778171/src/react/List.tsx#L278)
[src/react/List.tsx:279](https://github.com/inokawa/virtua/blob/6085b71/src/react/List.tsx#L279)

___

Expand All @@ -163,4 +165,50 @@ Callback invoked when scrolling reached to the end. The margin from the end is s

#### Defined in

[src/react/List.tsx:282](https://github.com/inokawa/virtua/blob/0778171/src/react/List.tsx#L282)
[src/react/List.tsx:283](https://github.com/inokawa/virtua/blob/6085b71/src/react/List.tsx#L283)

___

### onScroll

`Optional` **onScroll**: (`offset`: `number`) => `void`

#### Type declaration

▸ (`offset`): `void`

Callback invoked whenever scroll offset changes.

##### Parameters

| Name | Type |
| :------ | :------ |
| `offset` | `number` |

##### Returns

`void`

#### Defined in

[src/react/List.tsx:287](https://github.com/inokawa/virtua/blob/6085b71/src/react/List.tsx#L287)

___

### onScrollStop

`Optional` **onScrollStop**: () => `void`

#### Type declaration

▸ (): `void`

Callback invoked when scrolling stops.

##### Returns

`void`

#### Defined in

[src/react/List.tsx:291](https://github.com/inokawa/virtua/blob/6085b71/src/react/List.tsx#L291)
4 changes: 2 additions & 2 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "virtua",
"version": "0.1.10",
"version": "0.1.11",
"description": "A zero-config, fast and small (3kB) virtual list component for React.",
"main": "lib/index.js",
"module": "lib/index.mjs",
Expand Down

0 comments on commit bac8825

Please sign in to comment.