1Introduction
- description:分页器 UI
- author:ydr.me
- create:2016-05-09 17:55
- update:2018年10月17日14:49:34
- github:https://github.com/blearjs/blear.ui.pagination
2Example
// 前端使用
var Pagination = require('blear.ui.pagination');
new Pagination({
el: '#pagination'
});
3Static
3.1.defaults
3.1.1.defaults.el
- 类型:
String | HTMLElement
- 说明:容器,如果容器不为空,则以容器的 html 作为分页模板
3.1.2.defaults.mode
- 类型:
String
- 说明:分页模式,可选值:
simple
、range
- 默认:
"simple"
simple 模式
range 模式(可视区为 7)
3.1.3.defaults.range
- 类型:
Number
- 说明:分页可视范围,只在
range
模式下有效 - 默认:
7
3.1.4.defaults.total
- 类型:
Number
- 说明:分页总数
- 默认:
1
3.1.5.defaults.page
- 类型:
Number
- 说明:当前分页
- 默认:
1
3.1.6.defaults.prev
- 类型:
String
- 说明:前一页文本
- 默认:
"≪"
3.1.7.defaults.next
- 类型:
String
- 说明:后一页文本
- 默认:
"≫"
3.1.8.defaults.ellipsis
- 类型:
String
- 说明:省略文本
- 默认:
"..."
3.1.9.defaults.format
- 类型:
String
- 说明:分页 URL 格式,使用
%#%
来表示分页页码(参考自 wordpress) - 默认:
"?page=%#%"
3.1.10.defaults.onChange(page, next: [configs])
- 类型:
Function
- 说明:页码改变之后
- 默认:
function onChange(page, next) { next(); }
3.1.10.1onChange: page
- 类型:
Number
- 说明:页码
3.1.10.2onChange: next
- 类型:
Function
- 说明:页码处理完毕之后回调,可以更新当前页码以及当前页码总数,详细见下一条说明
3.1.10.2.1next: [configs]
- 类型:
object
- 说明:当前页码以及页码总数,格式为
{page: number, total: number}
// 改变当前页码为 123,页码总数改变为 456 next({page: 123, total: 456});
- 默认:
undefined
4new Pagination(options)
实例化一个分页器。options
默认值为 .defaults
。
5Prototype
5.1#change(page): this
主动改变页码。
5.1.1page
- 类型:
Number
- 说明:页码
5.2#render(configs): this
主动渲染分页器。
5.2.1configs
- 类型:
Object
- 说明:分页配置
5.2.2configs.page
- 类型:
Number
- 说明:当前页码
5.2.3configs.total
- 类型:
Number
- 说明:总页数
5.3#destroy()
销毁实例。
6Events
6.1change(page)
分页点击变化后触发。
6.1.1page
- 类型:
Number
- 说明:当前点击的分页值
7Dependencies
- blear.classes.pagination
- blear.core.attribute
- blear.core.event
- blear.core.selector
- blear.ui
- blear.utils.array
- blear.utils.object
8Reference
无。