mirror of
https://github.com/Alfresco/alfresco-ng2-components.git
synced 2025-05-12 17:04:57 +00:00
66 lines
2.3 KiB
Markdown
66 lines
2.3 KiB
Markdown
---
|
|
Added: v2.0.0
|
|
Status: Active
|
|
---
|
|
# Infinite Pagination component
|
|
|
|
Adds "infinite" pagination to the component it is used with.
|
|
|
|
|
|
|
|
## Basic Usage
|
|
|
|
```html
|
|
<adf-infinite-pagination
|
|
[pageSize]="pageSize"
|
|
[loading]="infiniteLoading"
|
|
(loadMore)="loadNextPage($event)">
|
|
</adf-infinite-pagination>
|
|
```
|
|
|
|
## Integrating with Document List
|
|
|
|
```html
|
|
<adf-document-list #documentList ...></adf-document-list>
|
|
|
|
<adf-infinite-pagination
|
|
[target]="documentList"
|
|
[loading="documentList.infiniteLoading">
|
|
</adf-infinite-pagination>
|
|
```
|
|
|
|
### Properties
|
|
|
|
| Name | Type | Default value | Description |
|
|
| ---- | ---- | ------------- | ----------- |
|
|
| pagination | `Pagination` | | Pagination object. |
|
|
| target | `PaginatedComponent` | | Component that provides custom pagination support. |
|
|
| pageSize | `number` | `InfinitePaginationComponent.DEFAULT_PAGE_SIZE` | Number of items that are added with each "load more" event. |
|
|
| isLoading | `boolean` | `false` | Is a new page loading? |
|
|
|
|
### Events
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| loadMore | `EventEmitter<Pagination>` | Emitted when the "Load More" button is clicked. |
|
|
|
|
## Details
|
|
|
|
Pagination is the process of dividing a list into separate ranges or "pages" with a
|
|
certain number of items each. This allows a long list to be delivered in manageable pieces
|
|
rather than all at once. "Infinite" pagination means that there is no upper limit on
|
|
the number of items that can be displayed visually; a single page is shown initially but
|
|
the user can extend the list one page at a time by clicking a "Load More" button.
|
|
|
|
The `loadMore` event is emitted when the button is pressed. It is passed a
|
|
[Pagination](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/Pagination.md)
|
|
parameter which contains the details of the current page (the start offset of the
|
|
page within the list to be shown, whether there are more items left to show, etc).
|
|
|
|
See the [Pagination component](pagination.component.md) for more information about the alternative "finite" pagination scheme.
|
|
|
|
## See also
|
|
|
|
- [Document list component](../content-services/document-list.component.md)
|
|
- [Pagination component](pagination.component.md)
|