src/modules/pagination/components/pagination-config.intf.ts
Defines the config object to be used with the Pagination component.
Properties |
|
| isExtended |
isExtended:
|
Type : boolean
|
| Optional |
|
If true, the component will be displayed in "extended" mode (an "extended-pagination" class is added to the element). Default: |
| itemsPerPage |
itemsPerPage:
|
Type : number
|
| Optional |
|
Number of items displayed on each page. The number of available pages for pagination is calculated based on this number. Default: |
| itemsPerPageIsPresent |
itemsPerPageIsPresent:
|
Type : boolean
|
| Optional |
|
If Default: |
| itemsPerPageOptions |
itemsPerPageOptions:
|
Type : number[]
|
| Optional |
|
Available options for items per page dropdown. Default : |
| page |
page:
|
Type : number
|
| Optional |
|
Current page index. Default: |
| pageInputIsPresent |
pageInputIsPresent:
|
Type : boolean
|
| Optional |
|
If Default: |
| pageNavIsPresent |
pageNavIsPresent:
|
Type : boolean
|
| Optional |
|
If Default: |
| totalItems |
totalItems:
|
Type : number
|
| Optional |
|
Number of items being paged in order to calculate number of pages for pagination. Default: |
export interface StarkPaginationConfig {
/**
* If true, the component will be displayed in "extended" mode (an "extended-pagination" class is added to the element).
*
* Default: `false`
*/
isExtended?: boolean;
/**
* Number of items displayed on each page. The number of available pages for pagination is calculated based on this number.
*
* Default: `itemsPerPageOptions[0]`
*/
itemsPerPage?: number;
/**
* Available options for items per page dropdown.
*
* Default : `[5,10,15]`
*/
itemsPerPageOptions?: number[];
/**
* If `false`, then itemsPerPage dropdown will not be present.
*
* Default: `true` on `"default"` mode, `false` on `"compact"` mode
*/
itemsPerPageIsPresent?: boolean;
/**
* Current page index.
*
* Default: `0`
*/
page?: number;
/**
* If `false`, then page nav bar will not be present.
*
* Default: `true`
*/
pageNavIsPresent?: boolean;
/**
* If `false`, then input box for page selection will not be present.
*
* Default: `true`
*/
pageInputIsPresent?: boolean;
/**
* Number of items being paged in order to calculate number of pages for pagination.
*
* Default: `0`
*/
totalItems?: number;
}