Skip to content

Commit

Permalink
feat(docs): change paging API from data-table to list (Teradata#1089)
Browse files Browse the repository at this point in the history
* feat(docs): change paging API from data-table to list

* chore(): update
  • Loading branch information
emoralesb05 authored Jan 16, 2018
1 parent 926c6fe commit 05330bf
Showing 1 changed file with 22 additions and 11 deletions.
33 changes: 22 additions & 11 deletions src/platform/core/paging/README.md
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

0 comments on commit 05330bf

Please sign in to comment.