javascript/ionic-framework
1
0
Fork 0
mirror of https://github.com/ionic-team/ionic-framework.git synced 2025-08-20 04:14:21 +08:00
Code Issues Packages Projects Releases Wiki Activity

docs(refresher): update API docs for refresher and demo

Browse Source 
references #5207
This commit is contained in:
Brandy Carney
2016-03-01 12:08:01 -05:00
parent 1f3db2ad1e
commit 5ca2a55f14
2 changed files with 14 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
demos/refresher/main.html
View File

@ -1,5 +1,5 @@
<ion-toolbar> <ion-toolbar>
<ion-title>Pull To Refresh</ion-title> <ion-title>Refresher</ion-title>
</ion-toolbar> </ion-toolbar>

25
ionic/components/refresher/refresher.ts
View File

@ -10,12 +10,12 @@ import {CSS, pointerCoord, transitionEnd} from '../../util/dom';
/** /**
* @name Refresher * @name Refresher
* @description * @description
* Allows you to add Pull-To-Refresh to an Content component. * The Refresher provides pull-to-refresh functionality on a content component.
* Place `ion-refresher` as the first child of your `ion-content` element. * Place the `ion-refresher` as the first child of your `ion-content` element.
* *
* Pages can then can listen to the refreshers various output events. The * Pages can then listen to the refresher's various output events. The
* `refresh` output event is the one that's fired when the user has pulled * `refresh` output event is fired when the user has pulled down far
* down far enough to kick off the refreshing process. Once the async operation * enough to kick off the refreshing process. Once the async operation
* has completed and the refreshing should end, call `complete()`. * has completed and the refreshing should end, call `complete()`.
* *
* @usage * @usage
@ -71,13 +71,14 @@ import {CSS, pointerCoord, transitionEnd} from '../../util/dom';
* *
* ## Further Customizing Refresher Content * ## Further Customizing Refresher Content
* *
* The `ion-refresh` component holds the refresh logic, and it requires a * The `ion-refresher` component holds the refresh logic.
* child refresher content component for its display. The `ion-refresher-content` * It requires a child component in order to display the content.
* component is Ionic's default that shows the actual display of the refresher * Ionic uses `ion-refresher-content` by default. This component
* and changes its look depending on the refresher's state. With this separation, * displays the refresher and changes the look depending
* it also allows developers to create their own refresher content components. * on the refresher's state. Separating these components
* Ideas include having some cool SVG or CSS animations that are customized to * allows developers to create their own refresher content
* your app and animates the various refresher states to your liking. * components. You could replace our default content with
* custom SVG or CSS animations.
* *
* @demo /docs/v2/demos/refresher/ * @demo /docs/v2/demos/refresher/
* *