Skip to content

Commit

Permalink
0.20.0
Browse files Browse the repository at this point in the history
  • Loading branch information
inokawa committed Jan 7, 2024
1 parent facd068 commit b217006
Show file tree
Hide file tree
Showing 20 changed files with 971 additions and 1,586 deletions.
54 changes: 27 additions & 27 deletions docs/classes/vue.VList.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,13 +26,13 @@
- [$options](vue.VList.md#$options)
- [$forceUpdate](vue.VList.md#$forceupdate)
- [$nextTick](vue.VList.md#$nexttick)
- [shift](vue.VList.md#shift)
- [onScroll](vue.VList.md#onscroll)
- [shift](vue.VList.md#shift)
- [data](vue.VList.md#data)
- [overscan](vue.VList.md#overscan)
- [initialItemSize](vue.VList.md#initialitemsize)
- [itemSize](vue.VList.md#itemsize)
- [horizontal](vue.VList.md#horizontal)
- [onScrollStop](vue.VList.md#onscrollstop)
- [onScrollEnd](vue.VList.md#onscrollend)
- [onRangeChange](vue.VList.md#onrangechange)
- [scrollOffset](vue.VList.md#scrolloffset)
- [scrollSize](vue.VList.md#scrollsize)
Expand Down Expand Up @@ -87,7 +87,7 @@ Scroll to the item specified by index.

#### Defined in

[src/vue/VList.tsx:49](https://github.com/inokawa/virtua/blob/de57a89c/src/vue/VList.tsx#L49)
[src/vue/VList.tsx:51](https://github.com/inokawa/virtua/blob/facd0683/src/vue/VList.tsx#L51)

___

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

#### Defined in

[src/vue/VList.tsx:54](https://github.com/inokawa/virtua/blob/de57a89c/src/vue/VList.tsx#L54)
[src/vue/VList.tsx:56](https://github.com/inokawa/virtua/blob/facd0683/src/vue/VList.tsx#L56)

___

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

#### Defined in

[src/vue/VList.tsx:59](https://github.com/inokawa/virtua/blob/de57a89c/src/vue/VList.tsx#L59)
[src/vue/VList.tsx:61](https://github.com/inokawa/virtua/blob/facd0683/src/vue/VList.tsx#L61)

## Properties

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

### $props

• **$props**: `Partial`\<\{ `shift`: `boolean` = Boolean; `overscan`: `number` ; `horizontal`: `boolean` = Boolean }\> & `Omit`\<\{ `shift`: `boolean` = Boolean; `data`: `unknown`[] ; `overscan`: `number` ; `horizontal`: `boolean` = Boolean; `initialItemSize?`: `number` = Number; `onScroll`: `undefined` \| (...`args`: [offset: number]) => `any` ; `onScrollStop`: `undefined` \| (...`args`: []) => `any` ; `onRangeChange`: `undefined` \| (...`args`: [startIndex: number, endIndex: number]) => `any` } & `VNodeProps` & `AllowedComponentProps` & `ComponentCustomProps` & `Readonly`\<`ExtractPropTypes`\<\{ `data`: \{ `type`: `ArrayConstructor` = Array; `required`: ``true`` = true } ; `overscan`: \{ `type`: `NumberConstructor` = Number; `default`: `number` = 4 } ; `initialItemSize`: `NumberConstructor` = Number; `shift`: `BooleanConstructor` = Boolean; `horizontal`: `BooleanConstructor` = Boolean }\>\> & \{ `onScroll`: `undefined` \| (...`args`: [offset: number]) => `any` ; `onScrollStop`: `undefined` \| (...`args`: []) => `any` ; `onRangeChange`: `undefined` \| (...`args`: [startIndex: number, endIndex: number]) => `any` }, `DefaultKeys`\<\{ `data`: \{ `type`: `ArrayConstructor` = Array; `required`: ``true`` = true } ; `overscan`: \{ `type`: `NumberConstructor` = Number; `default`: `number` = 4 } ; `initialItemSize`: `NumberConstructor` = Number; `shift`: `BooleanConstructor` = Boolean; `horizontal`: `BooleanConstructor` = Boolean }\>\>
• **$props**: `Partial`\<\{ `shift`: `boolean` = Boolean; `overscan`: `number` ; `horizontal`: `boolean` = Boolean }\> & `Omit`\<\{ `shift`: `boolean` = Boolean; `data`: `unknown`[] ; `overscan`: `number` ; `horizontal`: `boolean` = Boolean; `itemSize?`: `number` = Number; `onScroll`: `undefined` \| (...`args`: [offset: number]) => `any` ; `onScrollEnd`: `undefined` \| (...`args`: []) => `any` ; `onRangeChange`: `undefined` \| (...`args`: [startIndex: number, endIndex: number]) => `any` } & `VNodeProps` & `AllowedComponentProps` & `ComponentCustomProps` & `Readonly`\<`ExtractPropTypes`\<\{ `data`: \{ `type`: `ArrayConstructor` = Array; `required`: ``true`` = true } ; `overscan`: \{ `type`: `NumberConstructor` = Number; `default`: `number` = 4 } ; `itemSize`: `NumberConstructor` = Number; `shift`: `BooleanConstructor` = Boolean; `horizontal`: `BooleanConstructor` = Boolean }\>\> & \{ `onScroll`: `undefined` \| (...`args`: [offset: number]) => `any` ; `onScrollEnd`: `undefined` \| (...`args`: []) => `any` ; `onRangeChange`: `undefined` \| (...`args`: [startIndex: number, endIndex: number]) => `any` }, `DefaultKeys`\<\{ `data`: \{ `type`: `ArrayConstructor` = Array; `required`: ``true`` = true } ; `overscan`: \{ `type`: `NumberConstructor` = Number; `default`: `number` = 4 } ; `itemSize`: `NumberConstructor` = Number; `shift`: `BooleanConstructor` = Boolean; `horizontal`: `BooleanConstructor` = Boolean }\>\>

#### Defined in

Expand Down Expand Up @@ -217,7 +217,7 @@ ___

### $emit

**$emit**: (`event`: ``"scroll"``, ...`args`: [offset: number]) => `void` & (`event`: ``"scrollStop"``, ...`args`: []) => `void` & (`event`: ``"rangeChange"``, ...`args`: [startIndex: number, endIndex: number]) => `void`
**$emit**: (`event`: ``"scroll"``, ...`args`: [offset: number]) => `void` & (`event`: ``"scrollEnd"``, ...`args`: []) => `void` & (`event`: ``"rangeChange"``, ...`args`: [startIndex: number, endIndex: number]) => `void`

#### Defined in

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

### $options

**$options**: `ComponentOptionsBase`\<`ResolveProps`\<\{ `data`: \{ `type`: `ArrayConstructor` = Array; `required`: ``true`` = true } ; `overscan`: \{ `type`: `NumberConstructor` = Number; `default`: `number` = 4 } ; `initialItemSize`: `NumberConstructor` = Number; `shift`: `BooleanConstructor` = Boolean; `horizontal`: `BooleanConstructor` = Boolean }, \{ `scroll`: (`offset`: `number`) => `void` ; `scrollStop`: () => `void` ; `rangeChange`: (`startIndex`: `number`, `endIndex`: `number`) => `void` }\>, `VListHandle`, {}, {}, {}, `ComponentOptionsMixin`, `ComponentOptionsMixin`, \{ `scroll`: (`offset`: `number`) => `void` ; `scrollStop`: () => `void` ; `rangeChange`: (`startIndex`: `number`, `endIndex`: `number`) => `void` }, `string`, \{ `shift`: `boolean` = Boolean; `overscan`: `number` ; `horizontal`: `boolean` = Boolean }, {}, `string`, `SlotsType`\<\{ `default`: `any` }\>\> & `MergedComponentOptionsOverride`
**$options**: `ComponentOptionsBase`\<`ResolveProps`\<\{ `data`: \{ `type`: `ArrayConstructor` = Array; `required`: ``true`` = true } ; `overscan`: \{ `type`: `NumberConstructor` = Number; `default`: `number` = 4 } ; `itemSize`: `NumberConstructor` = Number; `shift`: `BooleanConstructor` = Boolean; `horizontal`: `BooleanConstructor` = Boolean }, \{ `scroll`: (`offset`: `number`) => `void` ; `scrollEnd`: () => `void` ; `rangeChange`: (`startIndex`: `number`, `endIndex`: `number`) => `void` }\>, `VListHandle`, {}, {}, {}, `ComponentOptionsMixin`, `ComponentOptionsMixin`, \{ `scroll`: (`offset`: `number`) => `void` ; `scrollEnd`: () => `void` ; `rangeChange`: (`startIndex`: `number`, `endIndex`: `number`) => `void` }, `string`, \{ `shift`: `boolean` = Boolean; `overscan`: `number` ; `horizontal`: `boolean` = Boolean }, {}, `string`, `SlotsType`\<\{ `default`: `any` }\>\> & `MergedComponentOptionsOverride`

#### Defined in

Expand Down Expand Up @@ -295,6 +295,12 @@ node_modules/@vue/runtime-core/dist/runtime-core.d.ts:130

___

### onScroll

**onScroll**: `undefined` \| (...`args`: [offset: number]) => `any`

___

### shift

`Readonly` **shift**: `boolean` = `Boolean`
Expand All @@ -303,13 +309,7 @@ While true is set, scroll position will be maintained from the end not usual sta

#### Defined in

[src/vue/VList.tsx:82](https://github.com/inokawa/virtua/blob/de57a89c/src/vue/VList.tsx#L82)

___

### onScroll

**onScroll**: `undefined` \| (...`args`: [offset: number]) => `any`
[src/vue/VList.tsx:84](https://github.com/inokawa/virtua/blob/facd0683/src/vue/VList.tsx#L84)

___

Expand All @@ -321,7 +321,7 @@ The data items rendered by this component.

#### Defined in

[src/vue/VList.tsx:66](https://github.com/inokawa/virtua/blob/de57a89c/src/vue/VList.tsx#L66)
[src/vue/VList.tsx:68](https://github.com/inokawa/virtua/blob/facd0683/src/vue/VList.tsx#L68)

___

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

#### Defined in

[src/vue/VList.tsx:71](https://github.com/inokawa/virtua/blob/de57a89c/src/vue/VList.tsx#L71)
[src/vue/VList.tsx:73](https://github.com/inokawa/virtua/blob/facd0683/src/vue/VList.tsx#L73)

___

### initialItemSize
### itemSize

`Optional` `Readonly` **initialItemSize**: `number` = `Number`
`Optional` `Readonly` **itemSize**: `number` = `Number`

Item size hint for unmeasured items. It will help to reduce scroll jump when items are measured if used properly.

Expand All @@ -354,7 +354,7 @@ Item size hint for unmeasured items. It will help to reduce scroll jump when ite

#### Defined in

[src/vue/VList.tsx:78](https://github.com/inokawa/virtua/blob/de57a89c/src/vue/VList.tsx#L78)
[src/vue/VList.tsx:80](https://github.com/inokawa/virtua/blob/facd0683/src/vue/VList.tsx#L80)

___

Expand All @@ -366,13 +366,13 @@ If true, rendered as a horizontally scrollable list. Otherwise rendered as a ver

#### Defined in

[src/vue/VList.tsx:86](https://github.com/inokawa/virtua/blob/de57a89c/src/vue/VList.tsx#L86)
[src/vue/VList.tsx:88](https://github.com/inokawa/virtua/blob/facd0683/src/vue/VList.tsx#L88)

___

### onScrollStop
### onScrollEnd

**onScrollStop**: `undefined` \| (...`args`: []) => `any`
**onScrollEnd**: `undefined` \| (...`args`: []) => `any`

___

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

#### Defined in

[src/vue/VList.tsx:35](https://github.com/inokawa/virtua/blob/de57a89c/src/vue/VList.tsx#L35)
[src/vue/VList.tsx:37](https://github.com/inokawa/virtua/blob/facd0683/src/vue/VList.tsx#L37)

___

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

#### Defined in

[src/vue/VList.tsx:39](https://github.com/inokawa/virtua/blob/de57a89c/src/vue/VList.tsx#L39)
[src/vue/VList.tsx:41](https://github.com/inokawa/virtua/blob/facd0683/src/vue/VList.tsx#L41)

___

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

#### Defined in

[src/vue/VList.tsx:43](https://github.com/inokawa/virtua/blob/de57a89c/src/vue/VList.tsx#L43)
[src/vue/VList.tsx:45](https://github.com/inokawa/virtua/blob/facd0683/src/vue/VList.tsx#L45)
2 changes: 1 addition & 1 deletion docs/interfaces/react.CacheSnapshot.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,4 +20,4 @@ Serializable cache snapshot.

#### Defined in

[src/core/types.ts:8](https://github.com/inokawa/virtua/blob/de57a89c/src/core/types.ts#L8)
[src/core/types.ts:8](https://github.com/inokawa/virtua/blob/facd0683/src/core/types.ts#L8)
4 changes: 2 additions & 2 deletions docs/interfaces/react.CustomCellComponentProps.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ Props of customized cell component for [VGrid](../modules/react.md#experimental_

#### Defined in

[src/react/VGrid.tsx:42](https://github.com/inokawa/virtua/blob/de57a89c/src/react/VGrid.tsx#L42)
[src/react/VGrid.tsx:89](https://github.com/inokawa/virtua/blob/facd0683/src/react/VGrid.tsx#L89)

___

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

#### Defined in

[src/react/VGrid.tsx:43](https://github.com/inokawa/virtua/blob/de57a89c/src/react/VGrid.tsx#L43)
[src/react/VGrid.tsx:90](https://github.com/inokawa/virtua/blob/facd0683/src/react/VGrid.tsx#L90)
30 changes: 30 additions & 0 deletions docs/interfaces/react.CustomContainerComponentProps.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# Interface: CustomContainerComponentProps

[react](../modules/react.md).CustomContainerComponentProps

## Table of contents

### Properties

- [style](react.CustomContainerComponentProps.md#style)
- [children](react.CustomContainerComponentProps.md#children)

## Properties

### style

**style**: `CSSProperties`

#### Defined in

[src/react/types.ts:10](https://github.com/inokawa/virtua/blob/facd0683/src/react/types.ts#L10)

___

### children

**children**: `ReactNode`

#### Defined in

[src/react/types.ts:11](https://github.com/inokawa/virtua/blob/facd0683/src/react/types.ts#L11)
8 changes: 4 additions & 4 deletions docs/interfaces/react.CustomItemComponentProps.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

[react](../modules/react.md).CustomItemComponentProps

Props of customized item component for [VList](../modules/react.md#vlist).
Props of customized item component for [Virtualizer](../modules/react.md#virtualizer) or [WindowVirtualizer](../modules/react.md#windowvirtualizer).

## Table of contents

Expand All @@ -20,7 +20,7 @@ Props of customized item component for [VList](../modules/react.md#vlist).

#### Defined in

[src/react/ListItem.tsx:18](https://github.com/inokawa/virtua/blob/de57a89c/src/react/ListItem.tsx#L18)
[src/react/ListItem.tsx:18](https://github.com/inokawa/virtua/blob/facd0683/src/react/ListItem.tsx#L18)

___

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

#### Defined in

[src/react/ListItem.tsx:19](https://github.com/inokawa/virtua/blob/de57a89c/src/react/ListItem.tsx#L19)
[src/react/ListItem.tsx:19](https://github.com/inokawa/virtua/blob/facd0683/src/react/ListItem.tsx#L19)

___

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

#### Defined in

[src/react/ListItem.tsx:20](https://github.com/inokawa/virtua/blob/de57a89c/src/react/ListItem.tsx#L20)
[src/react/ListItem.tsx:20](https://github.com/inokawa/virtua/blob/facd0683/src/react/ListItem.tsx#L20)
75 changes: 0 additions & 75 deletions docs/interfaces/react.CustomViewportComponentProps.md

This file was deleted.

4 changes: 2 additions & 2 deletions docs/interfaces/react.ScrollToIndexOpts.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Alignment of item.

#### Defined in

[src/core/types.ts:22](https://github.com/inokawa/virtua/blob/de57a89c/src/core/types.ts#L22)
[src/core/types.ts:22](https://github.com/inokawa/virtua/blob/facd0683/src/core/types.ts#L22)

___

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

#### Defined in

[src/core/types.ts:28](https://github.com/inokawa/virtua/blob/de57a89c/src/core/types.ts#L28)
[src/core/types.ts:28](https://github.com/inokawa/virtua/blob/facd0683/src/core/types.ts#L28)
Loading

0 comments on commit b217006

Please sign in to comment.