vant/docs/examples-docs/zh-CN/waterfall.md
Yao fcb9a4a8a9 [new feature] Docs: waterfall 文档优化 (#175)
* doc: change waterfall docs

* change pr template
2017-10-09 17:14:04 +08:00

2.9 KiB
Raw Blame History

Waterfall 瀑布流

使用指南

全局注册

Waterfall引入后就自动全局安装。如果需要,可以再次手动安装:

import Vue from 'vue';
import { Waterfall } from 'vant';

Waterfall.install(Vue);

局部注册

如果你只是想在某个组件中使用Waterfall,可以在对应组件中注册Waterfall指令,这样只能在你注册的组件中使用Waterfall

import { Waterfall } from 'vant';

export default {
  directives: {
    WaterfallLower: Waterfall('lower'),
    WaterfallUpper: Waterfall('upper')
  }
};

代码演示

基础用法

使用 v-waterfall-lower 监听滚动到达底部,并执行相应函数。若是函数执行中需要异步加载数据,可以将 waterfall-disabled 指定的值置为 false禁止 v-waterfall-lower 监听滚动事件

注意:waterfall-disabled 传入的是 vue 对象中表示是否禁止瀑布流触发 key 值,类型是字符串 :::demo 基础用法

<p class="page-desc">当即将滚动到元素底部时,会自动加载更多</p>
<ul
  v-waterfall-lower="loadMore"
  waterfall-disabled="isWaterfallDisabled"
  waterfall-offset="400">
  <li v-for="(item, index) in list">{{ item }}</li>
</ul>

:::

API

参数 说明 类型 默认值 可选值
v-waterfall-lower 滚动到底部, 触发执行的函数 Function -
v-waterfall-upper 滚动到顶部, 触发执行的函数 Function -
waterfall-disabled 在 vue 对象中表示是否禁止瀑布流触发的 key 值 String -
waterfall-offset 触发瀑布流加载的阈值 Number 300