alfresco-ng2-components/docs/pagination.component.md

Pagination Component

Adds pagination to the component it is used with.

• Basic Usage
  • Properties
  • Events
• Details

Basic Usage

<adf-pagination
    [pagination]="pagination"
    [supportedPageSizes]="sizes"
    (change)="onChange($event)"
    (nextPage)="onNextPage($event)"
    (prevPage)="onPreviousPage($event)"
    (changePageSize)="onChangePageSize($event)"
    (changePageNumber)="onChangePageNumber($event)">
</adf-pagination>

Properties

Name	Type	Default	Description
pagination	Pagination		Pagination object
supportedPageSizes	Array<number>	[ 25, 50, 100 ]	An array of page sizes

Events

Name	Type	Description
change	EventEmitter<PaginationQueryParams>	Triggered for any action in pagination
nextPage	EventEmitter<Pagination>	Triggered on next page action
prevPage	EventEmitter<Pagination>	Triggered on previous page action
changePageSize	EventEmitter<Pagination>	Triggered on page size change action
changePageNumber	EventEmitter<Pagination>	Triggered on page change action

Details

The pagination object is a generic component to paginate component. The Alfresco API are paginated and return a Pagination object. You can use the pagination object to feed the pagination component and then listen to the event which returns the current pagination and query again the API with the options chosen by the user.

Each event helps to detect the certain action that user have made using the component.

For change event, a PaginationQueryParams (including the query params supported by the REST API, skipCount and maxItems) is returned.

For all events other than change, a new Pagination object is returned as in the folowing example, with updated properties to be used to query further.