Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(docs): change paging API from data-table to list #1089

Merged
merged 2 commits into from
Jan 16, 2018
Merged

feat(docs): change paging API from data-table to list #1089

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c1a8740
feat(docs): change paging API from data-table to list
Jan 16, 2018
18a2288
chore(): update
Jan 16, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 22 additions & 11 deletions src/platform/core/paging/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,17 +17,28 @@ export interface IPageChangeEvent {

## API Summary

Properties:

| Name | Type | Description |
| --- | --- | 650--- |
| `initialPage` | `number` | Sets starting page for the paging bar. Defaults to 1.
| `pageLinkCount?` | `number` | Amount of page navigation links for the paging bar. Defaults to 0.
| `firstLast?` | `boolean` | Shows or hides the first and last page buttons of the paging bar. Defaults to 'false'
| `pageSize?` | `number` | Selected page size for the pagination. Defaults to 50.
| `total` | `number` | Total rows for the pagination.
| `change` | `function($event: IPageChangeEvent)` | Method to be executed when page size changes or any button is clicked in the paging bar.
| `navigateToPage` | `function(page: number): boolean` | Navigates to a specific valid page. Returns 'true' if page is valid, else 'false'.
#### Inputs

+ initialPage?: number
+ Sets starting page for the paging bar. Defaults to 1.
+ pagingLinkCount?: number
+ Amount of page navigation links for the paging bar. Defaults to 0
+ firstLast?: boolean
+ Shows or hides the first and last page buttons of the paging bar. Defaults to 'false'
+ pageSize?: number
+ Selected page size for the pagination. Defaults to 50.
+ total: number
+ Total rows for the pagination.

#### Events

+ change: function($event: IPageChangeEvent)
+ Method to be executed when page size changes or any button is clicked in the paging bar.

#### Methods

+ navigateToPage: function(page: number)
+ Navigates to a specific valid page. Returns 'true' if page is valid, else 'false'.

## Setup

Expand Down