Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://awesomedevin.github.io/vue-waterfall2/

Waterfall adaptive plugin for vue and support lazy load , so easy!
https://awesomedevin.github.io/vue-waterfall2/

vue vue-waterfall2 vue3 waterfall-layout

Last synced: about 1 month ago
JSON representation

Waterfall adaptive plugin for vue and support lazy load , so easy!

Host: GitHub
URL: https://awesomedevin.github.io/vue-waterfall2/
Owner: AwesomeDevin
License: mit
Created: 2018-11-15T08:03:00.000Z (almost 6 years ago)
Default Branch: master
Last Pushed: 2024-06-19T16:41:55.000Z (5 months ago)
Last Synced: 2024-09-10T11:44:45.390Z (2 months ago)
Topics: vue, vue-waterfall2, vue3, waterfall-layout
Language: Vue
Homepage: https://awesomedevin.github.io/vue-waterfall2/#/
Size: 49.6 MB
Stars: 448
Watchers: 9
Forks: 87
Open Issues: 34
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        

#### [中文版文档](https://github.com/AwesomeDevin/vue-waterfall2/blob/master/CHINESE-README.md)

# Note: [email protected] is adapt for vue3, if your app is vue2, please use [email protected], [1.10.x document](https://github.com/AwesomeDevin/vue-waterfall2/tree/1.10.6)

# vue-waterfall2 

 1. auto adaption for width and height

 2. High degree of customization

 3. Swipe to the bottom to trigger on pc/android, pull up to trigger on ios

 4. Support lazy load(attribute with `lazy-src`)

 5. Easy to use, for PC/ios/android

![The demo on mobile device](https://raw.githubusercontent.com/AwesomeDevin/vue-waterfall2/master/src/assets/gifhome_240x514_17s.gif)

If you have some questions,welcome to describe issues、suggestions;Thank you for your Star !   

[Welcome to my blog  ！！！](https://github.com/AwesomeDevin/blog)

## Demo

[Common Demo](https://awesomedevin.github.io/vue-waterfall2/#/)  

[Lazyload Demo](https://awesomedevin.github.io/vue-waterfall2/#/lazy)  

[Vue2 Code Demo](https://codesandbox.io/embed/vue-template-99ps6)  

[Vue3 Code Demo](https://codesandbox.io/s/vue-waterfall2-local-demo-forked-d4hdcz?file=/src/components/waterfall.vue)

[GITHUB](https://github.com/Rise-Devin/vue-waterfall2)

```

npm i 

npm run dev

```

## Installation

```

 npm i vue-waterfall2@latest --save

```

##  Props

Name | Default | Type | Desc

-------- | -------- | -------- | --------

height | null | Number | height of container

col | 2  | Number |  The number of column

width | null | Number | The width of each column

gutterWidth | 10 | Number | The value of margin

data | [] | Array | data

isTransition | true | Boolean | load image with transition

lazyDistance | 300 | Number | The distance of image lazy loading

loadDistance | 300 | Number | The distance of loadmore

  

## Lazy Load

For images that need to be loaded lazily, the 'lazy-src' attribute needs to be used

```html

  

```

##  Events

Name | Data |   Desc

-------- | --- | -------- 

loadmore | - | Scroll to the bottom to trigger on PC /  pull up to trigger on Mobile  

scroll | obj | Scroll to trigger and get the infomation of scroll

finish | - | finish render

  

## $waterfall API

```

this.$waterfall.forceUpdate()   //forceUpdate

```

## Usage

Notes:

  1. when using `rem` to layout, calculate the width after adaptation before passing the value.

  2. Use the parent component of 'waterfall' if there is a problem with the style, remove CSS `scoped` and try it

##### main.js

```javascript

import { createApp } from "vue";

import waterfall from 'vue-waterfall2'

const app = createApp(App)

app.use(waterfall)

```

##### app.vue

```javascript

  


    loadmore mix 5列 8列 10列 


    

      


        

            {{item.title}}

            

                

                {{item.user}}

                

                    

                    {{item.liked}}  

                

            

        

      

    

    

  


/*

  notes:

  1. when using `rem` to layout, calculate the width after adaptation before passing the value.

  2. Use the parent component of 'waterfall' if there is a problem with the style, remove CSS 'scoped' and try it

*/

import Vue from 'vue'

	export default{

	    data(){

	        return{

	            data:[],

	            col:5,

	        }

	    },

	    computed:{

	      itemWidth(){  

	            return (138*0.5*(document.documentElement.clientWidth/375))  #rem to layout, Calculate the value of width 

	      },

	      gutterWidth(){

	            return (9*0.5*(document.documentElement.clientWidth/375)) #rem to layout, Calculate the value of margin 

	      }

	    },

	    methods:{

            scroll(scrollData){

                console.log(scrollData)

            },

	        switchCol(col){

	            this.col = col

	            console.log(this.col)

	      },

	      loadmore(index){

	            this.data = this.data.concat(this.data)

	      }

	    }

	}

```

## Stargazers 

[![Stargazers repo roster for @AwesomeDevin/vue-waterfall2](http://bytecrank.com/nastyox/reporoster/php/stargazersSVG.php?user=AwesomeDevin&repo=vue-waterfall2)](https://github.com/AwesomeDevin/vue-waterfall2/stargazers)

## Forkers 

[![Forkers repo roster for @AwesomeDevin/vue-waterfall2](http://bytecrank.com/nastyox/reporoster/php/forkersSVG.php?user=AwesomeDevin&repo=vue-waterfall2)](https://github.com/AwesomeDevin/vue-waterfall2/network/members)