igniteui-react-grids
Version:
Ignite UI React grid components.
219 lines (215 loc) • 7.74 kB
TypeScript
import * as React from 'react';
import { IgrOverlaySettings } from "./igr-overlay-settings";
import { IgrPaginatorResourceStrings } from "./igr-paginator-resource-strings";
import { IgrNumberEventArgs } from "igniteui-react";
import { IgrPageCancellableEventArgs } from "./igr-page-cancellable-event-args";
import { IgrPageEventArgs } from "./igr-page-event-args";
import { Paginator } from "./Paginator";
import { ReactRenderer, PortalManager } from "igniteui-react-core";
import { ContentChildrenManager } from "igniteui-react-core";
/**
* Paginator component description
* @igxParent IgxGridComponent, IgxTreeGridComponent, IgxHierarchicalGridComponent, IgxPivotGridComponent, *
*/
export declare class IgrPaginator<P extends IIgrPaginatorProps = IIgrPaginatorProps> extends React.Component<P & Omit<React.HTMLAttributes<HTMLElement>, keyof P>, {}> {
protected createImplementation(): Paginator;
protected _implementation: any;
protected mounted: boolean;
get nativeElement(): HTMLElement;
/**
* @hidden
*/
get i(): Paginator; /**
* @hidden
*/
static _createFromInternal(internal: any): IgrPaginator;
protected _renderer: ReactRenderer;
protected _portalManager: PortalManager;
protected onImplementationCreated(): void;
protected _contentChildrenManager: ContentChildrenManager;
constructor(props: P & Omit<React.HTMLAttributes<HTMLElement>, keyof P>);
componentDidMount(): void;
shouldComponentUpdate(nextProps: any, nextState: any): boolean;
render(): React.DetailedReactHTMLElement<{
ref: (ref: any) => void;
className: (P & Omit<React.HTMLAttributes<HTMLElement>, keyof P>)["className"];
style: {};
children: any[];
}, any>;
protected _elRef: HTMLElement;
protected _getMainRef(ref: any): void;
/**
* Total pages calculated from totalRecords and perPage
*/
get totalPages(): number;
set totalPages(v: number);
/**
* Gets/Sets the current page of the paginator.
* The default is 0.
* ```typescript
* let page = this.paginator.page;
* ```
* @memberof IgxPaginatorComponent
*/
get page(): number;
set page(v: number);
/**
* Gets/Sets the number of visible items per page in the paginator.
* The default is 15.
* ```typescript
* let itemsPerPage = this.paginator.perPage;
* ```
* @memberof IgxPaginatorComponent
*/
get perPage(): number;
set perPage(v: number);
/**
* Sets the total records.
* ```typescript
* let totalRecords = this.paginator.totalRecords;
* ```
* @memberof IgxPaginatorComponent
*/
get totalRecords(): number;
set totalRecords(v: number);
/**
* Sets custom options in the select of the paginator
* ```typescript
* let options = this.paginator.selectOptions;
* ```
* @memberof IgxPaginatorComponent
*/
get selectOptions(): number[];
set selectOptions(v: number[]);
get overlaySettings(): IgrOverlaySettings;
set overlaySettings(v: IgrOverlaySettings);
/**
* An accessor that sets the resource strings.
* By default it uses EN resources.
*/
get resourceStrings(): IgrPaginatorResourceStrings;
set resourceStrings(v: IgrPaginatorResourceStrings);
/**
* Returns if the current page is the last page.
* ```typescript
* const lastPage = this.paginator.isLastPage;
* ```
*/
get isLastPage(): boolean;
/**
* Returns if the current page is the first page.
* ```typescript
* const lastPage = this.paginator.isFirstPage;
* ```
*/
get isFirstPage(): boolean;
get name(): string;
set name(v: string);
findByName(name: string): any;
protected __p: string;
protected _hasUserValues: Set<string>;
protected get hasUserValues(): Set<string>;
protected __m(propertyName: string): void;
protected _stylingContainer: any;
protected _stylingParent: any;
protected _inStyling: boolean;
protected _styling(container: any, component: any, parent?: any): void;
setNativeElement(element: any): void;
/**
* Goes to the next page of the `IgxPaginatorComponent`, if the paginator is not already at the last page.
* ```typescript
* this.paginator.nextPage();
* ```
* @memberof IgxPaginatorComponent
*/
nextPage(): void;
/**
* Goes to the previous page of the `IgxPaginatorComponent`, if the paginator is not already at the first page.
* ```typescript
* this.paginator.previousPage();
* ```
* @memberof IgxPaginatorComponent
*/
previousPage(): void;
/**
* Goes to the desired page index.
* ```typescript
* this.paginator.paginate(1);
* ```
* val
* @memberof IgxPaginatorComponent
* @param * val
*/
paginate(val: number): void;
private _perPageChange;
private _perPageChange_wrapped;
get perPageChange(): (s: IgrPaginator, e: IgrNumberEventArgs) => void;
set perPageChange(ev: (s: IgrPaginator, e: IgrNumberEventArgs) => void);
private _pageChange;
private _pageChange_wrapped;
get pageChange(): (s: IgrPaginator, e: IgrNumberEventArgs) => void;
set pageChange(ev: (s: IgrPaginator, e: IgrNumberEventArgs) => void);
private _paging;
private _paging_wrapped;
get paging(): (s: IgrPaginator, e: IgrPageCancellableEventArgs) => void;
set paging(ev: (s: IgrPaginator, e: IgrPageCancellableEventArgs) => void);
private _pagingDone;
private _pagingDone_wrapped;
get pagingDone(): (s: IgrPaginator, e: IgrPageEventArgs) => void;
set pagingDone(ev: (s: IgrPaginator, e: IgrPageEventArgs) => void);
}
export interface IIgrPaginatorProps {
children?: React.ReactNode;
id?: string | undefined;
className?: string | undefined;
style?: React.CSSProperties | undefined;
/**
* Total pages calculated from totalRecords and perPage
*/
totalPages?: number | string;
/**
* Gets/Sets the current page of the paginator.
* The default is 0.
* ```typescript
* let page = this.paginator.page;
* ```
* @memberof IgxPaginatorComponent
*/
page?: number | string;
/**
* Gets/Sets the number of visible items per page in the paginator.
* The default is 15.
* ```typescript
* let itemsPerPage = this.paginator.perPage;
* ```
* @memberof IgxPaginatorComponent
*/
perPage?: number | string;
/**
* Sets the total records.
* ```typescript
* let totalRecords = this.paginator.totalRecords;
* ```
* @memberof IgxPaginatorComponent
*/
totalRecords?: number | string;
/**
* Sets custom options in the select of the paginator
* ```typescript
* let options = this.paginator.selectOptions;
* ```
* @memberof IgxPaginatorComponent
*/
selectOptions?: number[];
overlaySettings?: IgrOverlaySettings;
/**
* An accessor that sets the resource strings.
* By default it uses EN resources.
*/
resourceStrings?: IgrPaginatorResourceStrings;
name?: string;
perPageChange?: (s: IgrPaginator, e: IgrNumberEventArgs) => void;
pageChange?: (s: IgrPaginator, e: IgrNumberEventArgs) => void;
paging?: (s: IgrPaginator, e: IgrPageCancellableEventArgs) => void;
pagingDone?: (s: IgrPaginator, e: IgrPageEventArgs) => void;
}