blackteay/vant
1
0
Fork 0
mirror of https://gitee.com/vant-contrib/vant.git synced 2025-04-06 03:57:59 +08:00
Code Issues Projects Releases Wiki Activity

docs(Waterfall): add deprecation tip

Browse Source
This commit is contained in:
chenjiahan 2021-04-13 20:24:44 +08:00 committed by neverland
parent e38c5d27e0
commit 3224a8978f
1 changed files with 14 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
packages/vant-waterfall/README.md
View File

@ -1,5 +1,7 @@
# Waterfall 瀑布流 # Waterfall 瀑布流
Tips: Waterfall 组件已废弃，请使用 List 组件代替。
### Install ### Install
#### NPM #### NPM
@ -35,14 +37,15 @@ import Waterfall from '@vant/waterfall';
export default { export default {
directives: { directives: {
WaterfallLower: Waterfall('lower'), WaterfallLower: Waterfall('lower'),
WaterfallUpper: Waterfall('upper') WaterfallUpper: Waterfall('upper'),
} },
}; };
``` ```
### 代码演示 ### 代码演示
#### 基础用法 #### 基础用法
使用 `v-waterfall-lower` 监听滚动到达底部，并执行相应函数。若是函数执行中需要异步加载数据，可以将 `waterfall-disabled` 指定的值置为 true，禁止 `v-waterfall-lower` 监听滚动事件 使用 `v-waterfall-lower` 监听滚动到达底部，并执行相应函数。若是函数执行中需要异步加载数据，可以将 `waterfall-disabled` 指定的值置为 true，禁止 `v-waterfall-lower` 监听滚动事件
注意：`waterfall-disabled` 传入的是 vue 对象中表示是否禁止瀑布流触发 key 值，类型是字符串 注意：`waterfall-disabled` 传入的是 vue 对象中表示是否禁止瀑布流触发 key 值，类型是字符串
@ -62,12 +65,12 @@ export default {
data() { data() {
return { return {
list: [0, 1, 2, 3, 4, 5, 6, 7, 8, 9], list: [0, 1, 2, 3, 4, 5, 6, 7, 8, 9],
disabled: false disabled: false,
}; };
}, },
directives: { directives: {
WaterfallLower: Waterfall('lower') WaterfallLower: Waterfall('lower'),
}, },
methods: { methods: {
@ -79,16 +82,16 @@ export default {
} }
this.disabled = false; this.disabled = false;
}, 200); }, 200);
} },
} },
}; };
``` ```
### API ### API
| 参数 | 说明 | 类型 | 默认值 | 版本 | | 参数 | 说明 | 类型 | 默认值 | 版本 |
|------|------|------|------|------| | --- | --- | --- | --- | --- |
| v-waterfall-lower | 滚动到底部, 触发执行的函数 | *Function* | - | - | | v-waterfall-lower | 滚动到底部, 触发执行的函数 | _Function_ | - | - |
| v-waterfall-upper | 滚动到顶部, 触发执行的函数 | *Function* | - | - | | v-waterfall-upper | 滚动到顶部, 触发执行的函数 | _Function_ | - | - |
| waterfall-disabled | 在 vue 对象中表示是否禁止瀑布流触发的 key 值 | *string* | - | - | | waterfall-disabled | 在 vue 对象中表示是否禁止瀑布流触发的 key 值 | _string_ | - | - |
| waterfall-offset | 触发瀑布流加载的阈值 | *number* | `300` | - | | waterfall-offset | 触发瀑布流加载的阈值 | _number_ | `300` | - |