inteligr8/alfresco-ng2-components
1
0
Fork 0
mirror of https://github.com/Alfresco/alfresco-ng2-components.git synced 2025-07-31 17:38:48 +00:00
Code Issues Packages Projects Releases Wiki Activity

[ADF-1769] Added prop tables and fixed script (#2896)

Browse Source 
* [ADF-1769] Added prop tables and fixed script

* [ADF-1769] Corrected JSDoc formatting errors

* [ADF-1769] Restored default column to prop tables
This commit is contained in:
Andy Stark
2018-01-31 09:22:05 +00:00
committed by Eugenio Romano
parent 8a4959d172
commit 900fd70d63
56 changed files with 601 additions and 519 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
docs/pagination.component.md
View File

@@ -29,21 +29,21 @@ Adds pagination to the component it is used with.
### Properties
| Name | Type | Default | Description |
| ---- | ---- | ------- | ----------- |
| pagination | Pagination | | Pagination object |
| supportedPageSizes | Array<number> | [ 25, 50, 100 ] | An array of page sizes |
| target | PaginatedComponent | | Component that provides custom pagination support |
| Name | Type | Default value | Description |
| ---- | ---- | ------------- | ----------- |
| target | `PaginatedComponent` | | Component that provides custom pagination support. |
| supportedPageSizes | `number[]` | `[5, 25, 50, 100]` | An array of page sizes. |
| pagination | `Pagination` | | Pagination object. |
### 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 |
| change | `EventEmitter<PaginationQueryParams>` | Emitted when paginaton changes in any way. |
| changePageNumber | `EventEmitter<Pagination>` | Emitted when the page number changes. |
| changePageSize | `EventEmitter<Pagination>` | Emitted when the page size changes. |
| nextPage | `EventEmitter<Pagination>` | Emitted when the next page is requested. |
| prevPage | `EventEmitter<Pagination>` | Emitted when the previous page is requested. |
## Details
@@ -71,3 +71,7 @@ export interface PaginatedComponent {
Your component needs to provide a `pagination` subject to allow Pagination component to reflect to changes.
Every time user interacts with the Pagination, it will call the `updatePagination` method and pass the parameters.
## See also
- [Infinite Pagination component](infinite-pagination.component.md)