vlist 1.5.4 → 1.5.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +18 -18
- package/dist/features/autosize/feature.d.ts +1 -1
- package/dist/features/groups/feature.d.ts +1 -1
- package/dist/index.d.ts +1 -1
- package/dist/internals.d.ts +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -2,9 +2,9 @@
|
|
|
2
2
|
|
|
3
3
|
Lightweight, high-performance virtual list with zero dependencies and dimension-agnostic architecture.
|
|
4
4
|
|
|
5
|
-
**v1.5.
|
|
5
|
+
**v1.5.5** — [Changelog](./changelog.txt)
|
|
6
6
|
|
|
7
|
-
[](https://www.npmjs.com/package/vlist)
|
|
8
8
|
[](https://github.com/floor/vlist/actions/workflows/ci.yml)
|
|
9
9
|
[](https://github.com/floor/vlist/blob/main/LICENSE)
|
|
10
10
|
|
|
@@ -39,14 +39,14 @@ Lightweight, high-performance virtual list with zero dependencies and dimension-
|
|
|
39
39
|
## Installation
|
|
40
40
|
|
|
41
41
|
```bash
|
|
42
|
-
npm install
|
|
42
|
+
npm install vlist
|
|
43
43
|
```
|
|
44
44
|
|
|
45
45
|
## Quick Start
|
|
46
46
|
|
|
47
47
|
```typescript
|
|
48
|
-
import { vlist } from '
|
|
49
|
-
import '
|
|
48
|
+
import { vlist } from 'vlist'
|
|
49
|
+
import 'vlist/styles'
|
|
50
50
|
|
|
51
51
|
const list = vlist({
|
|
52
52
|
container: '#my-list',
|
|
@@ -71,7 +71,7 @@ list.on('item:click', ({ item }) => console.log(item))
|
|
|
71
71
|
Start with the base, add only what you need:
|
|
72
72
|
|
|
73
73
|
```typescript
|
|
74
|
-
import { vlist, withGrid, withGroups, withSelection } from '
|
|
74
|
+
import { vlist, withGrid, withGroups, withSelection } from 'vlist'
|
|
75
75
|
|
|
76
76
|
const list = vlist({
|
|
77
77
|
container: '#app',
|
|
@@ -111,7 +111,7 @@ More examples at **[vlist.io](https://vlist.io)**.
|
|
|
111
111
|
### Data Table
|
|
112
112
|
|
|
113
113
|
```typescript
|
|
114
|
-
import { vlist, withTable, withSelection } from '
|
|
114
|
+
import { vlist, withTable, withSelection } from 'vlist'
|
|
115
115
|
|
|
116
116
|
const table = vlist({
|
|
117
117
|
container: '#my-table',
|
|
@@ -139,7 +139,7 @@ table.on('column:resize', ({ key, width }) => { /* persist widths */ })
|
|
|
139
139
|
### Grid Layout
|
|
140
140
|
|
|
141
141
|
```typescript
|
|
142
|
-
import { vlist, withGrid, withScrollbar } from '
|
|
142
|
+
import { vlist, withGrid, withScrollbar } from 'vlist'
|
|
143
143
|
|
|
144
144
|
const gallery = vlist({
|
|
145
145
|
container: '#gallery',
|
|
@@ -162,7 +162,7 @@ const gallery = vlist({
|
|
|
162
162
|
### Sticky Headers
|
|
163
163
|
|
|
164
164
|
```typescript
|
|
165
|
-
import { vlist, withGroups } from '
|
|
165
|
+
import { vlist, withGroups } from 'vlist'
|
|
166
166
|
|
|
167
167
|
const contacts = vlist({
|
|
168
168
|
container: '#contacts',
|
|
@@ -188,7 +188,7 @@ Set `sticky: false` for inline headers (iMessage/WhatsApp style).
|
|
|
188
188
|
### Async Loading
|
|
189
189
|
|
|
190
190
|
```typescript
|
|
191
|
-
import { vlist, withAsync } from '
|
|
191
|
+
import { vlist, withAsync } from 'vlist'
|
|
192
192
|
|
|
193
193
|
const list = vlist({
|
|
194
194
|
container: '#list',
|
|
@@ -416,7 +416,7 @@ Use this when:
|
|
|
416
416
|
| SolidJS | [`vlist-solidjs`](https://github.com/floor/vlist-solidjs) | 0.5 KB gzip |
|
|
417
417
|
|
|
418
418
|
```bash
|
|
419
|
-
npm install
|
|
419
|
+
npm install vlist vlist-react # or vlist-vue / vlist-svelte / vlist-solidjs
|
|
420
420
|
```
|
|
421
421
|
|
|
422
422
|
Each adapter README has setup examples and API docs.
|
|
@@ -424,11 +424,11 @@ Each adapter README has setup examples and API docs.
|
|
|
424
424
|
## Styling
|
|
425
425
|
|
|
426
426
|
```typescript
|
|
427
|
-
import '
|
|
428
|
-
import '
|
|
429
|
-
import '
|
|
430
|
-
import '
|
|
431
|
-
import '
|
|
427
|
+
import 'vlist/styles' // core (always required)
|
|
428
|
+
import 'vlist/styles/grid' // when using withGrid()
|
|
429
|
+
import 'vlist/styles/masonry' // when using withMasonry()
|
|
430
|
+
import 'vlist/styles/table' // when using withTable()
|
|
431
|
+
import 'vlist/styles/extras' // optional (variants, loading states, animations)
|
|
432
432
|
```
|
|
433
433
|
|
|
434
434
|
| Import | Size | Contents |
|
|
@@ -516,7 +516,7 @@ With 100K items: **~26 DOM nodes** in the document (visible + overscan) instead
|
|
|
516
516
|
Fully typed. Generic over your item type:
|
|
517
517
|
|
|
518
518
|
```typescript
|
|
519
|
-
import { vlist, withGrid, type VList } from '
|
|
519
|
+
import { vlist, withGrid, type VList } from 'vlist'
|
|
520
520
|
|
|
521
521
|
interface Photo { id: number; url: string; title: string }
|
|
522
522
|
|
|
@@ -550,7 +550,7 @@ See [CHANGELOG.md](https://vlist.io/docs/CHANGELOG.md) for the full release hist
|
|
|
550
550
|
- **Docs & Examples:** [vlist.io](https://vlist.io)
|
|
551
551
|
- **Migration Guide:** [v0.9.0 Migration](https://vlist.io/docs/refactoring/v0.9.0-migration-guide.md)
|
|
552
552
|
- **GitHub:** [github.com/floor/vlist](https://github.com/floor/vlist)
|
|
553
|
-
- **NPM:** [
|
|
553
|
+
- **NPM:** [vlist](https://www.npmjs.com/package/vlist)
|
|
554
554
|
- **Issues:** [GitHub Issues](https://github.com/floor/vlist/issues)
|
|
555
555
|
|
|
556
556
|
---
|
|
@@ -48,7 +48,7 @@ export interface GroupsFeatureConfig {
|
|
|
48
48
|
* Adds grouped lists with sticky section headers.
|
|
49
49
|
*
|
|
50
50
|
* ```ts
|
|
51
|
-
* import { vlist, withGroups } from '
|
|
51
|
+
* import { vlist, withGroups } from 'vlist'
|
|
52
52
|
*
|
|
53
53
|
* const contacts = vlist({
|
|
54
54
|
* container: '#contacts',
|
package/dist/index.d.ts
CHANGED
package/dist/internals.d.ts
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* Advanced utilities for feature authors, custom renderers, and power users.
|
|
5
5
|
* These are implementation details — use at your own risk.
|
|
6
6
|
*
|
|
7
|
-
* For the stable public API, import from '
|
|
7
|
+
* For the stable public API, import from 'vlist' instead.
|
|
8
8
|
*
|
|
9
9
|
* @packageDocumentation
|
|
10
10
|
*/
|