193 |
194 | ```
195 |
196 | ## 7. 兼容移动端
197 | 别忘记在index.html head中添加一下代码
198 | ```html
199 |
200 | ```
201 |
202 |
203 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | # vue-waterfall-easy 2.x
2 | 1. This is a vue component that contains waterfall flow layout and infinite scroll loading
3 | 2. Compared to other implementations,there is no need to specify the width and height of the image in the returned data
4 | 3. It is because of the second item that the image is preloaded and then layout
5 | 4. Responsive layout,adapt mobile
6 | 5. Simple to use
7 |
8 | ## [中文文档](https://github.com/lfyfly/vue-waterfall-easy/blob/master/README-CN.md)
9 | ## [Demo](https://lfyfly.github.io/vue-waterfall-easy/demo/)
10 | ## [code of demo](https://github.com/lfyfly/vue-waterfall-easy/blob/master/src/App.vue)
11 | ## [update list](https://github.com/lfyfly/vue-waterfall-easy/issues/8)
12 | ## [github](https://github.com/lfyfly/vue-waterfall-easy)
13 |
14 | ## 1. Usage
15 | ### 1.1 Installation
16 |
17 | ```
18 | npm install vue-waterfall-easy --save
19 | ```
20 |
21 | ### 1.2 es6 import
22 | ```js
23 | import vueWaterfallEasy from 'vue-waterfall-easy'
24 | ```
25 | ```js
26 |
27 | export default {
28 | name: 'app',
29 | components: {
30 | vueWaterfallEasy
31 | }
32 | }
33 | ```
34 | ### 1.3 scripts import
35 | [download vueWaterfallEasy.js](https://github.com/lfyfly/vue-waterfall-easy/blob/master/src/vue-waterfall-easy/script/vueWaterfallEasy.js)
36 | ```html
37 |
38 |
39 | ```
40 | ```js
41 | new Vue({
42 | el: '#app',
43 | components: {
44 | vueWaterfallEasy
45 | }
46 | })
47 | ```
48 | ### 1.4 Supports require.js and sea.js module import
49 |
50 | ## 2. Basic example
51 | html
52 | ```html
53 |
54 | ```
55 |
56 | **If imgArr is a replacement update, the data returned by the getData method new request overwrites the original data.**
57 |
58 | **If imgArr is an incremental update, the data returned by the new request of getData method is merged with the original data. At this time, it is not recommended to use the replacement update, which will waste performance. The following example is an incremental update.**
59 |
60 | js
61 |
62 | ```js
63 | import vueWaterfallEasy from './vue-waterfall-easy/vue-waterfall-easy.vue'
64 | import axios from 'axios'
65 | export default {
66 | name: 'app',
67 | data() {
68 | return {
69 | imgsArr: [],
70 | group: 0,// request param
71 | }
72 | },
73 | components: {
74 | vueWaterfallEasy
75 | },
76 | methods: {
77 | getData() {
78 | // In the real environment,the backend will return a new image array based on the parameter group.
79 | // Here I simulate it with a stunned json file.
80 | axios.get('./static/mock/data.json?group=' + this.group)
81 | .then(res => {
82 | this.imgsArr = this.imgsArr.concat(res.data)
83 | this.group++
84 | })
85 | },
86 | },
87 | created() {
88 | this.getData()
89 | }
90 | }
91 | ```
92 | [more detail see App.vue file](https://github.com/lfyfly/vue-waterfall-easy/blob/master/src/App.vue)
93 |
94 | ## 3. Props
95 | props | type | default | description
96 | ---|---|---|---
97 | width | Number | - | Container width（px）,default is 100% relative parent element width,**Due to the responsiveness,all its parent's width must be 100% relative to the browser window at this time**,See the example after the table **If it is fixed width, you must set the width prop **, not just its parent element set fixed width
98 | height | Number\|String | - | Container height, the default unit `px` for the value of the `Number` type, the unit can be specified when the value is the type of `String` **When you do not specify the `height` value, the default is relative to the height of the parent element 100%, then the parent element must have a height**
99 | gap | Number | 20 | [Pc] space between pictures(px)
100 | mobileGap | Number | 8 | [Mobile] space between pictures(px)
101 | imgsArr | Array | [] | **required** Data used to render the waterfall stream Each array element is an object and must have `src` and `href` attributes. The `src` attribute represents the SRC attribute of the picture The `href` attribute represents the link to click to jump **if your key is not `src` and `href`, you can use the two properties of `srcKey` and `hrefKey` to do the key value replacement.**
102 | srcKey | String | 'src' | When the key value of your picture address is not `src`, you can use this property to replace it.
103 | hrefKey | String | 'href' | When the key value of your picture address is not `href`, you can use this property to replace it.
104 | imgWidth | Number | 240 | The width of the picture（px）
105 | maxCols | Number | 5 | Waterfall shows the maximum number of columns
106 | linkRange | String | 'card' | Identify click to trigger jump link range value: 'card' Whole card range 'img' image range 'custom' Customize the link range through slots
107 | isRouterLink | Boolean | false | Render the a tag when the value is false Render the router-link component when the value is true
108 | reachBottomDistance | Number | 0 | The distance(px) from the bottom of the container when the scrolling triggers the scrollReachBottom event
109 | loadingDotCount | Number | 3 | The number of default loading animation dots
110 | loadingDotStyle | Object | null | The style object of the small dots in the default loading element
111 | loadingTimeOut | Number | 500 | Preloading events less than 500ms milliseconds do not display loading animations,increasing the user experience
112 | cardAnimationClass | String | 'default-card-animation' | the animation className for the card
113 | enablePullDownEvent | Boolean | false | enable the drop-down event
114 |
115 | ## 4. Event
116 | event name | description
117 | ---|---
118 | scrollReachBottom | When the scroll bar scrolls to the bottom,it is used to trigger a request for new image data
119 | preloaded | Trigger every time image preloading is completed
120 | click | Trigger when the card is clicked,look at an example under the table
121 | imgError | Trigger when img load error
122 | pullDownMove | The mobile terminal takes effect, touches the pull-down event, and the first parameter can obtain the Y-axis moving distance difference, which is often used for pull-down refresh.
123 | pullDownEnd | The mobile terminal takes effect, and the touch pull-down event is raised by the finger, which is often used for pull-down refresh.
124 | click event demo
125 | ```html
126 |
127 | ```
128 | ```js
129 | clickFn(event, { index, value }) {
130 | // Prevent a tag jump
131 | event.preventDefault()
132 | // Do it only when you click on the image
133 | if (event.target.tagName.toLowerCase() == 'img') {
134 | console.log('img clicked',index, value)
135 | }
136 | }
137 | ```
138 | ## 5. methods
139 | ### 5.1 waterfallOver
140 | When the rolling load data is over, manual invoking will remove the scroll event.
141 | ```
142 | this.$refs.waterfall.waterfallOver()
143 | ```
144 | [more detail see App.vue](https://github.com/lfyfly/vue-waterfall-easy/blob/master/src/App.vue)
145 | ## 6. slot
146 | ### 6.1 default slot
147 | Custom picture description element
148 | #### parameter
149 | parameterpar | description
150 | ---|---
151 | props.index | The index of the image in the data array,starting from 0
152 | props.value | The value of imgsArr item
153 |
154 | ```html
155 |
156 |
'}\n },\n ]\n})\n\n\n\n// WEBPACK FOOTER //\n// ./src/router/index.js","// The Vue build version to load with the `import` command\n// (runtime-only or standalone) has been set in webpack.base.conf with an alias.\nimport Vue from 'vue'\nimport App from './App'\nimport router from './router'\nimport Promise from 'promise-polyfill'\n// To add to window\nif (!window.Promise) {\n window.Promise = Promise\n}\n/* eslint-disable no-new */\nnew Vue({\n el: '#app',\n router,\n template: '',\n components: { App }\n})\n\n\n\n// WEBPACK FOOTER //\n// ./src/main.js"],"sourceRoot":""}
--------------------------------------------------------------------------------