Files
vxe-table/types/pager.d.ts
2024-04-21 13:23:22 +08:00

124 lines
2.1 KiB
TypeScript

import { VXETableComponent } from './component'
/**
* 分页
*/
export declare class VxePager extends VXETableComponent {
/**
* 自定义布局
*/
layouts?: Array<'Home' | 'PrevJump' | 'PrevPage' | 'Number' | 'JumpNumber' | 'NextPage' | 'NextJump' | 'End' | 'Sizes' | 'Jump' | 'FullJump' | 'PageCount' | 'Total'>;
/**
* 当前页
*/
currentPage?: number;
/**
* 加载中
*/
loading?: boolean;
/**
* 每页大小
*/
pageSize?: number;
/**
* 总条数
*/
total?: number;
/**
* 显示页码按钮的数量
*/
pagerCount?: number;
/**
* 每页大小选项列表
*/
pageSizes?: number[];
/**
* 列对其方式
*/
align?: string;
/**
* 带边框
*/
border?: boolean;
/**
* 带背景颜色
*/
background?: boolean;
/**
* 配套的样式
*/
perfect?: boolean;
/**
* 当只有一页时隐藏
*/
autoHidden?: boolean;
/**
* 自定义图标
*/
iconPrevPage?: string;
iconJumpPrev?: string;
iconJumpNext?: string;
iconNextPage?: string;
iconJumpMore?: string;
}
export class Pager extends VxePager {}
export interface PagerOptions {
/**
* 自定义布局
*/
layouts?: Array<'PrevJump' | 'PrevPage' | 'Number' | 'JumpNumber' | 'NextPage' | 'NextJump' | 'Sizes' | 'Jump' | 'FullJump' | 'PageCount' | 'Total'>;
/**
* 当前页
*/
currentPage?: number;
/**
* 加载中
*/
loading?: boolean;
/**
* 每页大小
*/
pageSize?: number;
/**
* 总条数
*/
total?: number;
/**
* 显示页码按钮的数量
*/
pagerCount?: number;
/**
* 每页大小选项列表
*/
pageSizes?: number[];
/**
* 列对其方式
*/
align?: string;
/**
* 带边框
*/
border?: boolean;
/**
* 带背景颜色
*/
background?: boolean;
/**
* 配套的样式
*/
perfect?: boolean;
/**
* 当只有一页时隐藏
*/
autoHidden?: boolean;
/**
* 自定义图标
*/
iconPrevPage?: string;
iconJumpPrev?: string;
iconJumpNext?: string;
iconNextPage?: string;
iconJumpMore?: string;
}