Paginator .d.ts updated

pull/3689/head
Tuğçe Küçükoğlu 2023-03-01 14:45:54 +03:00
parent c4c39c8c9f
commit 056f644a17
1 changed files with 49 additions and 24 deletions

View File

@ -1,6 +1,18 @@
/**
*
* Paginator is a generic component to display content in paged format.
*
* - [Paginator](https://www.primefaces.org/primevue/paginator)
*
* @module paginator
*
*/
import { VNode } from 'vue'; import { VNode } from 'vue';
import { ClassComponent, GlobalComponentConstructor } from '../ts-helpers'; import { ClassComponent, GlobalComponentConstructor } from '../ts-helpers';
/**
* Paginator page state metadata.
*/
export interface PageState { export interface PageState {
/** /**
* Index of first record * Index of first record
@ -20,25 +32,28 @@ export interface PageState {
pageCount?: number; pageCount?: number;
} }
/**
* Defines valid properties in Paginator component.
*/
export interface PaginatorProps { export interface PaginatorProps {
/** /**
* Number of total records. * Number of total records.
* Default value is 0. * @defaultValue 0
*/ */
totalRecords?: number | undefined; totalRecords?: number | undefined;
/** /**
* Data count to display per page. * Data count to display per page.
* Default value is 0. * @defaultValue 0
*/ */
rows?: number | undefined; rows?: number | undefined;
/** /**
* Zero-relative number of the first row to be displayed. * Zero-relative number of the first row to be displayed.
* Default value is 0. * @defaultValue 0
*/ */
first?: number | undefined; first?: number | undefined;
/** /**
* Number of page links to display. * Number of page links to display.
* Default value is 5. * @defaultValue 5
*/ */
pageLinkSize?: number | undefined; pageLinkSize?: number | undefined;
/** /**
@ -60,7 +75,7 @@ export interface PaginatorProps {
*/ */
template?: any | string; template?: any | string;
/** /**
* Template of the current page report element. It displays information about the pagination state. Default value is ({currentPage} of {totalPages}) whereas available placeholders are the following; * Template of the current page report element. It displays information about the pagination state. Available placeholders are the following;
* *
* - {currentPage} * - {currentPage}
* - {totalPages} * - {totalPages}
@ -68,58 +83,77 @@ export interface PaginatorProps {
* - {first} * - {first}
* - {last} * - {last}
* - {totalRecords} * - {totalRecords}
*
* @defaultValue ({currentPage} of {totalPages})
*/ */
currentPageReportTemplate?: string | undefined; currentPageReportTemplate?: string | undefined;
/** /**
* Whether to show the paginator even there is only one page. * Whether to show the paginator even there is only one page.
* Default value is true. * @defaultValue true
*/ */
alwaysShow?: boolean | undefined; alwaysShow?: boolean | undefined;
} }
/**
* Defines valid slots in Paginator component.
*/
export interface PaginatorSlots { export interface PaginatorSlots {
/** /**
* Custom start template. * Custom start template.
* @param {Object} scope - start slot's params. * @param {Object} scope - start slot's params.
*/ */
start: (scope: { start(scope: {
/** /**
* Current state * Current state
* @see PageState * @see PageState
*/ */
state: PageState; state: PageState;
}) => VNode[]; }): VNode[];
/** /**
* Custom end template. * Custom end template.
* @param {Object} scope - end slot's params. * @param {Object} scope - end slot's params.
*/ */
end: (scope: { end(scope: {
/** /**
* Current state * Current state
* @see PageState * @see PageState
*/ */
state: PageState; state: PageState;
}) => VNode[]; }): VNode[];
} }
export declare type PaginatorEmits = { /**
* Defines valid emits in Paginator component.
*/
export interface PaginatorEmits {
/** /**
* Emitted when the first changes. * Emitted when the first changes.
* @param {number} value - New value. * @param {number} value - New value.
*/ */
'update:first': (value: number) => void; 'update:first'(value: number): void;
/** /**
* Emitted when the rows changes. * Emitted when the rows changes.
* @param {number} value - New value. * @param {number} value - New value.
*/ */
'update:rows': (value: number) => void; 'update:rows'(value: number): void;
/** /**
* Callback to invoke when page changes, the event object contains information about the new state. * Callback to invoke when page changes, the event object contains information about the new state.
* @param {PageState} event - New page state. * @param {PageState} event - New page state.
*/ */
page: (event: PageState) => void; page(event: PageState): void;
}; }
/**
* **PrimeVue - Paginator**
*
* _Paginator is a generic widget to display content in paged format._
*
* [Live Demo](https://www.primevue.org/paginator/)
* --- ---
* ![PrimeVue](https://primefaces.org/cdn/primevue/images/logo-100.png)
*
* @group Component
*/
declare class Paginator extends ClassComponent<PaginatorProps, PaginatorSlots, PaginatorEmits> {} declare class Paginator extends ClassComponent<PaginatorProps, PaginatorSlots, PaginatorEmits> {}
declare module '@vue/runtime-core' { declare module '@vue/runtime-core' {
@ -128,13 +162,4 @@ declare module '@vue/runtime-core' {
} }
} }
/**
*
* Paginator is a generic component to display content in paged format.
*
* Demos:
*
* - [Paginator](https://www.primefaces.org/primevue/paginator)
*
*/
export default Paginator; export default Paginator;