import {Directive, ElementRef, EventEmitter, Host, Input, Output, NgZone} from 'angular2/core' import {NgIf, NgClass} from 'angular2/common'; import {Content} from '../content/content'; import {Icon} from '../icon/icon'; import {isTrueProperty} from '../../util/util'; import {CSS, pointerCoord, transitionEnd} from '../../util/dom'; /** * @name Refresher * @description * Allows you to add Pull-To-Refresh to an Content component. * Place `ion-refresher` as the first child of your `ion-content` element. * * Pages can then can listen to the refreshers various output events. The * `refresh` output event is the one that's fired when the user has pulled * down far enough to kick off the refreshing process. Once the async operation * has completed and the refreshing should end, call `complete()`. * * @usage * ```html * * * * * * * * ``` * * ```ts * @Page({...}) * export class NewsFeedPage { * * doRefresh(refresher) { * console.log('Begin async operation', refresher); * * setTimeout(() => { * console.log('Async operation has ended'); * refresher.complete(); * }, 2000); * } * * } * ``` * * * ## Refresher Content * * By default, Ionic provides the pulling icon and refreshing spinner that * looks best for the platform the user is on. However, you can change the * default icon and spinner, along with adding text for each state by * adding properties to the child `ion-refresher-content` component. * * ```html * * * * * * * * * ``` * * * ## Further Customizing Refresher Content * * The `ion-refresh` component holds the refresh logic, and it requires a * child refresher content component for its display. The `ion-refresher-content` * component is Ionic's default that shows the actual display of the refresher * and changes its look depending on the refresher's state. With this separation, * it also allows developers to create their own refresher content components. * Ideas include having some cool SVG or CSS animations that are customized to * your app and animates the various refresher states to your liking. * * @demo /docs/v2/demos/refresher/ * */ @Directive({ selector: 'ion-refresher', host: { '[class.refresher-active]': 'state !== "inactive"' } }) export class Refresher { private _appliedStyles: boolean = false; private _didStart: boolean; private _lastStart: number = 0; private _lastCheck: number = 0; private _isEnabled: boolean = true; private _mDown: Function; private _mMove: Function; private _mUp: Function; private _tStart: Function; private _tMove: Function; private _tEnd: Function; /** * The current state which the refresher is in. The refresher's states include: * * - `inactive` - The refresher is not being pulled down or refreshing and is currently hidden. * - `pulling` - The user is actively pulling down the refresher, but has not reached the point yet that if the user lets go, it'll refresh. * - `cancelling` - The user pulled down the refresher and let go, but did not pull down far enough to kick off the `refreshing` state. After letting go, the refresher is in the `cancelling` state while it is closing, and will go back to the `inactive` state once closed. * - `ready` - The user has pulled down the refresher far enough that if they let go, it'll begin the `refreshing` state. * - `refreshing` - The refresher is actively waiting on the async operation to end. Once the refresh handler calls `complete()` it will begin the `completing` state. * - `completing` - The `refreshing` state has finished and the refresher is in the process of closing itself. Once closed, the refresher will go back to the `inactive` state. */ state: string = STATE_INACTIVE; /** * The Y coordinate of where the user started to the pull down the content. */ startY: number = null; /** * The current touch or mouse event's Y coordinate. */ currentY: number = null; /** * The distance between the start of the pull and the current touch or * mouse event's Y coordinate. */ deltaY: number = null; /** * A number representing how far down the user has pulled. * The number `0` represents the user hasn't pulled down at all. The * number `1`, and anything greater than `1`, represents that the user * has pulled far enough down that when they let go then the refresh will * happen. If they let go and the number is less than `1`, then the * refresh will not happen, and the content will return to it's original * position. */ progress: number = 0; /** * @input {number} The min distance the user must pull down until the * refresher can go into the `refreshing` state. Default is `60`. */ @Input() pullMin: number = 60; /** * @input {number} The maximum distance of the pull until the refresher * will automatically go into the `refreshing` state. By default, the pull * maximum will be the result of `pullMin + 60`. */ @Input() pullMax: number = null; /** * @input {number} How many milliseconds it takes to close the refresher. Default is `280`. */ @Input() closeDuration: number = 280; /** * @input {number} How many milliseconds it takes the refresher to to snap back to the `refreshing` state. Default is `280`. */ @Input() snapbackDuration: number = 280; /** * @input {boolean} If the refresher is enabled or not. Default is `true`. */ @Input() get enabled(): boolean { return this._isEnabled; } set enabled(val: boolean) { this._isEnabled = isTrueProperty(val); this._setListeners(this._isEnabled); } /** * @output {event} When the user lets go and has pulled down far enough, which would be * farther than the `pullMin`, then your refresh hander if fired and the state is * updated to `refreshing`. From within your refresh handler, you must call the * `complete()` method when your async operation has completed. */ @Output() refresh: EventEmitter = new EventEmitter(); /** * @output {event} While the user is pulling down the content and exposing the refresher. */ @Output() pulling: EventEmitter = new EventEmitter(); /** * @output {event} When the user begins to start pulling down. */ @Output() start: EventEmitter = new EventEmitter(); constructor( @Host() private _content: Content, private _zone: NgZone, elementRef: ElementRef ) { _content.addCssClass('has-refresher'); // deprecated warning let ele = elementRef.nativeElement; let deprecatedAttrs = ['pullingIcon', 'pullingText', 'refreshingIcon', 'refreshingText', 'spinner']; deprecatedAttrs.forEach(attrName => { if (ele.hasAttribute(attrName)) { console.warn(' property "' + attrName + '" should now be placed on the inner component instead of . Please review the Refresher docs for API updates.'); } }); if (!ele.children.length) { console.warn(' should now have an inner component. Please review the Refresher docs for API updates.'); } } private _onStart(ev: TouchEvent): any { // if multitouch then get out immediately if (ev.touches && ev.touches.length > 1) { return 1; } let coord = pointerCoord(ev); console.debug('Pull-to-refresh, onStart', ev.type, 'y:', coord.y); let now = Date.now(); if (this._lastStart + 100 > now) { return 2; } this._lastStart = now; if ( ev.type === 'mousedown' && !this._mMove) { this._mMove = this._content.addMouseMoveListener( this._onMove.bind(this) ); } this.startY = this.currentY = coord.y; this.progress = 0; if (!this.pullMax) { this.pullMax = (this.pullMin + 60); } } private _onMove(ev: TouchEvent): any { // this method can get called like a bazillion times per second, // so it's built to be as efficient as possible, and does its // best to do any DOM read/writes only when absolutely necessary console.debug('Pull-to-refresh, onMove', ev.type); // if multitouch then get out immediately if (ev.touches && ev.touches.length > 1) { return 1; } // do nothing if it's actively refreshing // or it's in the process of closing // or this was never a startY if (this.startY === null || this.state === STATE_REFRESHING || this.state === STATE_CANCELLING || this.state === STATE_COMPLETING) { return 2; } // if we just updated stuff less than 16ms ago // then don't check again, just chillout plz let now = Date.now(); if (this._lastCheck + 16 > now) { return 3; } // remember the last time we checked all this this._lastCheck = now; // get the current pointer coordinates let coord = pointerCoord(ev); this.currentY = coord.y; // it's now possible they could be pulling down the content // how far have they pulled so far? this.deltaY = (coord.y - this.startY); // don't bother if they're scrolling up // and have not already started dragging if (this.deltaY <= 0) { // the current Y is higher than the starting Y // so they scrolled up enough to be ignored this.progress = 0; if (this.state !== STATE_INACTIVE) { this._zone.run(() => { this.state = STATE_INACTIVE; }); } if (this._appliedStyles) { // reset the styles only if they were applied this._setCss(0, '', false, ''); return 5; } return 6; } if (this.state === STATE_INACTIVE) { // this refresh is not already actively pulling down // get the content's scrollTop let scrollHostScrollTop = this._content.getContentDimensions().scrollTop; // if the scrollTop is greater than zero then it's // not possible to pull the content down yet if (scrollHostScrollTop > 0) { this.progress = 0; this.startY = null; return 7; } // content scrolled all the way to the top, and dragging down this.state = STATE_PULLING; } // prevent native scroll events ev.preventDefault(); // the refresher is actively pulling at this point // move the scroll element within the content element this._setCss(this.deltaY, '0ms', true, ''); if (!this.deltaY) { // don't continue if there's no delta yet this.progress = 0; return 8; } // so far so good, let's run this all back within zone now this._zone.run(() => { this._onMoveInZone(); }); } private _onMoveInZone() { // set pull progress this.progress = (this.deltaY / this.pullMin); // emit "start" if it hasn't started yet if (!this._didStart) { this._didStart = true; this.start.emit(this); } // emit "pulling" on every move this.pulling.emit(this); // do nothing if the delta is less than the pull threshold if (this.deltaY < this.pullMin) { // ensure it stays in the pulling state, cuz its not ready yet this.state = STATE_PULLING; return 2; } if (this.deltaY > this.pullMax) { // they pulled farther than the max, so kick off the refresh this._beginRefresh(); return 3; } // pulled farther than the pull min!! // it is now in the `ready` state!! // if they let go then it'll refresh, kerpow!! this.state = STATE_READY; return 4; } private _onEnd(ev) { // only run in a zone when absolutely necessary if (this.state === STATE_READY) { this._zone.run(() => { // they pulled down far enough, so it's ready to refresh this._beginRefresh(); }); } else if (this.state === STATE_PULLING) { this._zone.run(() => { // they were pulling down, but didn't pull down far enough // set the content back to it's original location // and close the refresher // set that the refresh is actively cancelling this.cancel(); }); } // reset on any touchend/mouseup this.startY = null; if (this._mMove) { // we don't want to always listen to mousemoves // remove it if we're still listening this._mMove(); this._mMove = null; } } private _beginRefresh() { // assumes we're already back in a zone // they pulled down far enough, so it's ready to refresh this.state = STATE_REFRESHING; // place the content in a hangout position while it thinks this._setCss(this.pullMin,( this.snapbackDuration + 'ms'), true, ''); // emit "refresh" because it was pulled down far enough // and they let go to begin refreshing this.refresh.emit(this); } /** * Call `complete()` when your async operation has completed. * For example, the `refreshing` state is while the app is performing * an asynchronous operation, such as receiving more data from an * AJAX request. Once the data has been received, you then call this * method to signify that the refreshing has completed and to close * the refresher. This method also changes the refresher's state from * `refreshing` to `completing`. */ complete() { this._close(STATE_COMPLETING, '120ms'); } /** * Changes the refresher's state from `refreshing` to `cancelling`. */ cancel() { this._close(STATE_CANCELLING, ''); } private _close(state: string, delay: string) { var timer; function close(ev) { // closing is done, return to inactive state if (ev) { clearTimeout(timer); } this.state = STATE_INACTIVE; this.progress = 0; this._didStart = this.startY = this.currentY = this.deltaY = null; this._setCss(0, '0ms', false, ''); } // create fallback timer incase something goes wrong with transitionEnd event timer = setTimeout(close.bind(this), 600); // create transition end event on the content's scroll element this._content.onScrollElementTransitionEnd(close.bind(this)); // reset set the styles on the scroll element // set that the refresh is actively cancelling/completing this.state = state; this._setCss(0, '', true, delay); if (this._mMove) { // always remove the mousemove event this._mMove(); this._mMove = null; } } private _setCss(y: number, duration: string, overflowVisible: boolean, delay: string) { this._appliedStyles = (y > 0); var content = this._content; content.setScrollElementStyle(CSS.transform, ((y > 0) ? 'translateY(' + y + 'px) translateZ(0px)' : 'translateZ(0px)')); content.setScrollElementStyle(CSS.transitionDuration, duration); content.setScrollElementStyle(CSS.transitionDelay, delay); content.setScrollElementStyle('overflow', (overflowVisible ? 'hidden' : '')); } private _setListeners(shouldListen: boolean) { const self = this; const content = self._content; if (shouldListen) { // add listener outside of zone // touch handlers self._zone.runOutsideAngular(function() { if (!self._tStart) { self._tStart = content.addTouchStartListener( self._onStart.bind(self) ); } if (!self._tMove) { self._tMove = content.addTouchMoveListener( self._onMove.bind(self) ); } if (!self._tEnd) { self._tEnd = content.addTouchEndListener( self._onEnd.bind(self) ); } // mouse handlers // mousemove does not get added until mousedown fires if (!self._mDown) { self._mDown = content.addMouseDownListener( self._onStart.bind(self) ); } if (!self._mUp) { self._mUp = content.addMouseUpListener( self._onEnd.bind(self) ); } }); } else { // unregister event listeners from content element self._mDown && self._mDown(); self._mMove && self._mMove(); self._mUp && self._mUp(); self._tStart && self._tStart(); self._tMove && self._tMove(); self._tEnd && self._tEnd(); self._mDown = self._mMove = self._mUp = self._tStart = self._tMove = self._tEnd = null; } } /** * @private */ ngOnInit() { // bind event listeners // save the unregister listener functions to use onDestroy this._setListeners(this._isEnabled); } /** * @private */ ngOnDestroy() { this._setListeners(false); } } const STATE_INACTIVE = 'inactive'; const STATE_PULLING = 'pulling'; const STATE_READY = 'ready'; const STATE_REFRESHING = 'refreshing'; const STATE_CANCELLING = 'cancelling'; const STATE_COMPLETING = 'completing';