# Props

<template>
  <ListView
    func="required.call.function.name.string"
    type="auto"
    unique-key="id"
    :query="{}"
    :autoload="-1"
    :preload="200"
    :cache-timeout="0"
    :scroll-x="false"
  >
    <!--  slot  -->
  </ListView>
</template>
Name Type Default Description
*func string \ function - vuex 注入的 API 列表中的某个函数名,或一个 请求接口的函数<Promise>
type string auto 场景值中的 type:jumppagesinceIdseenIds
query object - 需要透传到 API 层的数据
uniqueKey string id 每个元素在 v-for 的时候都需要一个 key,这个参数是 key 的键名
autoload number -1 是否当列表滚动到底部时自动加载下一页,-1 代表无限加载
preload number 200 列表底部距离可视窗口多少px时就触发网络请求
cacheTimeout number 0 你可以设置一个数把数据存储到LocalStorage
scrollX boolean false 如果列表是横向滚动,设为true能够正确的做数据懒加载

# uniqueKey

支持嵌套数据查找,如:

[
  {
    "type": "xxx",
    "data": {
      "id": 1,
      "name": "test"
    }
  },
  {
    "type": "xxx",
    "data": {
      "id": 2,
      "name": "test"
    }
  }
]

uniqueKey is data.id

# Events

Name Type Default Description
success function - 当数据请求成功时,可传入该函数来回调(SSR时将在mounted里自动调用一次)
error function - 当数据请求失败时,可传入该函数来回调(仅客户端发请求时生效)

# success

{
  "params": "<object> | 本次发请求的参数",
  "data": "<object> | 接口的响应数据",
  "refresh": "<boolean> | 是否下拉刷新"
}

# error

params:

{
  "error": "接口返回的 error 对象"
}