分页组件
laypage
提供了前端的分页逻辑,使得我们可以很灵活处理不同量级的数据,从而提升渲染效率。
API | 描述 |
---|---|
var laypage = layui.laypage | 获得 laypage 模块。 |
laypage.render(options) | laypage 组件渲染,核心方法。 |
laypage.render(options);
options
: 基础属性配置项。#详见属性属性名 | 描述 | 类型 | 默认值 |
---|---|---|---|
elem |
绑定分页容器。值可以是容器
|
string DOM |
- |
count |
数据总数。一般通过后端得到 |
number | - |
limit |
每页显示的条数。 |
number |
|
limits |
每页条数的选择项。 若 |
array |
|
curr |
初始化当前页码。 |
number |
|
groups |
连续出现的页码数量 |
number |
|
prev |
自定义“上一页”的内容,支持传入普通文本和 HTML |
string |
|
next |
自定义“下一页”的内容,用法同上。 |
string |
|
first |
自定义“首页”的内容,用法同上。 |
string |
|
last |
自定义“尾页”的内容,用法同上。 |
string |
自动获得 |
layout |
自定义分页功能区域排版。可自由排列,可选值有:
|
array | |
limitTemplet 2.8.18+ |
用于自定义条目模板,如:
|
function | - |
skipText 2.8.18+ |
用于自定义跳页区域文本,如:
|
array | - |
countText 2.9.1+ |
用于自定义总数区域文本,如:
|
array | - |
theme |
自定义主题。支持传入:颜色值或任意普通字符。如:
|
string | - |
hash |
设置 |
string | - |
分页跳转后的回调函数。函数返回两个参数:
|
laypage 组件只负责分页本身的逻辑,具体的数据请求及对应的视图渲染需要另外去完成。laypage 不仅能应用在一般的异步分页上,还可直接对一段已知数据进行分页展现,如 table 组件的分页就是采用的 laypage。