Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/lhlyu/vue-virtual-waterfall
vue3 virtual waterfall component（Vue3虚拟瀑布流组件）
https://github.com/lhlyu/vue-virtual-waterfall
component typescript virtual-list vite vue vue-component vue3 vueuse waterfall
Last synced: 5 days ago
JSON representation
vue3 virtual waterfall component（Vue3虚拟瀑布流组件）
- Host: GitHub
- URL: https://github.com/lhlyu/vue-virtual-waterfall
- Owner: lhlyu
- License: mit
- Created: 2023-07-01T13:52:53.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-09-04T01:56:52.000Z (4 months ago)
- Last Synced: 2024-12-03T21:05:05.458Z (19 days ago)
- Topics: component, typescript, virtual-list, vite, vue, vue-component, vue3, vueuse, waterfall
- Language: Vue
- Homepage: https://waterfall.tatakai.top
- Size: 2.98 MB
- Stars: 139
- Watchers: 1
- Forks: 21
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- awesome-vue-3 - Vue Virtual Waterfall - A vue3 virtual waterfall component (Packages)
README
# vue-virtual-waterfall
> A Vue 3 virtual waterfall component
[](https://www.npmjs.com/package/@lhlyu/vue-virtual-waterfall)
[中文文档](./README.zh.md)
## Example
- [Example](https://waterfall.tatakai.top)
- [Example Source Code](./src/example/Example.vue)
## Usage
> pnpm add @lhlyu/vue-virtual-waterfall
- Local import
```ts
import { VirtualWaterfall } from '@lhlyu/vue-virtual-waterfall'
```
- Global import
```ts
import VueVirtualWaterfall from '@lhlyu/vue-virtual-waterfall'
app.use(VueVirtualWaterfall)
```
- Usage
```vue
![]()
```
- Nuxt3 Usage
[demo](https://codesandbox.io/p/devbox/vue-virtual-waterfall-nuxt-demo-h7g569)
### Attention!!!
**The `VirtualWaterfall` component wants to implement a virtual list, and the container that wraps it must indicate a
fixed height. The scrolling event can be bound to this container. If this component is hung under the body, the height
of the body also needs to be specified. The scrolling event can be bound to the `window`**
## Documentation
- Properties
| Field | Type | Default | Description |
|--------------------|--------------------------------------------|-----------------------------------------|---------------------------------------|
| virtual | boolean | true | Enable virtual list |
| rowKey | string | 'id' | Key for v-for |
| gap | number | 15 | Gap between each item |
| padding | number or string | 15 or '15px 15px' | Container's padding |
| preloadScreenCount | `[number, number]` | `[0, 0]` | Preload screen count `[above, below]` |
| itemMinWidth | number | 220 | Minimum width for each item |
| maxColumnCount | number | 10 | Maximum number of columns |
| minColumnCount | number | 2 | Minimum number of columns |
| items | any[] | [] | Data |
| calcItemHeight | `(item: any, itemWidth: number) => number` | `(item: any, itemWidth: number) => 250` | Method to calculate item height |
- Slots
| Event | Type | Description |
|---------|--------------------------------|------------------------|
| default | `{ item: any, index: number }` | Custom default content |