inteligr8/alfresco-ng2-components
1
0
Fork 0
mirror of https://github.com/Alfresco/alfresco-ng2-components.git synced 2026-09-09 18:03:21 +00:00
Code Issues Packages Projects Releases Wiki Activity

[ADF-2135] Updated tables of contents (#2822)

Browse Source
This commit is contained in:
Andy Stark
2018-01-12 13:26:11 +00:00
committed by Eugenio Romano
parent 72cfd7894d
commit 69e40ea1c0
17 changed files with 164 additions and 353 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/pagination.component.md
+11 -24
View File
@@ -4,19 +4,6 @@ Adds pagination to the component it is used with.
![](docassets/images/basic.png)
<!-- markdown-toc start - Don't edit this section. npm run toc to generate it-->
<!-- toc -->
- [Basic Usage](#basic-usage)
* [Properties](#properties)
* [Events](#events)
- [Details](#details)
<!-- tocstop -->
<!-- markdown-toc end -->
## Basic Usage
```html
@@ -43,20 +30,20 @@ Adds pagination to the component it is used with.
### Properties
| Name | Type | Default | Description |
| --- | --- | --- | --- |
| pagination | Pagination | | Pagination object |
| supportedPageSizes | Array&lt;number&gt; | [ 25, 50, 100 ] | An array of page sizes |
| target | PaginatedComponent | | Component that provides custom pagination support |
| ---- | ---- | ------- | ----------- |
| pagination | Pagination | | Pagination object |
| supportedPageSizes | Array&lt;number> | [ 25, 50, 100 ] | An array of page sizes |
| target | PaginatedComponent | | Component that provides custom pagination support |
### Events
| Name | Type | Description |
| --- | --- | --- |
| change | EventEmitter&lt;PaginationQueryParams&gt; | Triggered for any action in pagination |
| nextPage | EventEmitter&lt;Pagination&gt; | Triggered on next page action |
| prevPage | EventEmitter&lt;Pagination&gt; | Triggered on previous page action |
| changePageSize | EventEmitter&lt;Pagination&gt; | Triggered on page size change action |
| changePageNumber | EventEmitter&lt;Pagination&gt; | Triggered on page change action |
| ---- | ---- | ----------- |
| change | EventEmitter&lt;PaginationQueryParams> | Triggered for any action in pagination |
| nextPage | EventEmitter&lt;Pagination> | Triggered on next page action |
| prevPage | EventEmitter&lt;Pagination> | Triggered on previous page action |
| changePageSize | EventEmitter&lt;Pagination> | Triggered on page size change action |
| changePageNumber | EventEmitter&lt;Pagination> | Triggered on page change action |
## Details
@@ -83,4 +70,4 @@ 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.
Every time user interacts with the Pagination, it will call the `updatePagination` method and pass the parameters.