docs(): update docs

This commit is contained in:
mhartington
2016-09-26 21:11:46 -04:00
parent eb2b879b37
commit dbfc183cac
6 changed files with 36 additions and 7 deletions

View File

@ -36,6 +36,9 @@ export class NavPop {
} }
} }
/**
* @private
*/
@HostListener('click') @HostListener('click')
onClick(): boolean { onClick(): boolean {
// If no target, or if target is _self, prevent default browser behavior // If no target, or if target is _self, prevent default browser behavior

View File

@ -66,6 +66,9 @@ export class NavPush {
} }
} }
/**
* @private
*/
@HostListener('click') @HostListener('click')
onClick(): boolean { onClick(): boolean {
if (this._nav) { if (this._nav) {

View File

@ -17,10 +17,6 @@ import { isTrueProperty } from '../../util/util';
* <ion-scroll scrollX="true" scrollY="true"> * <ion-scroll scrollX="true" scrollY="true">
* </ion-scroll> * </ion-scroll>
* ``` * ```
* @property {boolean} [scrollX] - whether to enable scrolling along the X axis
* @property {boolean} [scrollY] - whether to enable scrolling along the Y axis; requires the following CSS declaration: ion-scroll { white-space: nowrap; }
* @property {boolean} [zoom] - whether to enable zooming
* @property {number} [maxZoom] - set the max zoom amount for ion-scroll
* @demo /docs/v2/demos/src/scroll/ * @demo /docs/v2/demos/src/scroll/
*/ */
@Component({ @Component({
@ -44,6 +40,9 @@ export class Scroll {
_zoom: boolean = false; _zoom: boolean = false;
_maxZoom: number = 1; _maxZoom: number = 1;
/**
* @input {boolean} whether to enable scrolling along the X axis
*/
@Input() @Input()
get scrollX() { get scrollX() {
return this._scrollX; return this._scrollX;
@ -52,6 +51,9 @@ export class Scroll {
this._scrollX = isTrueProperty(val); this._scrollX = isTrueProperty(val);
} }
/**
* @input {boolean} whether to enable scrolling along the Y axis; requires the following CSS declaration: ion-scroll { white-space: nowrap; }
*/
@Input() @Input()
get scrollY() { get scrollY() {
return this._scrollY; return this._scrollY;
@ -60,6 +62,9 @@ export class Scroll {
this._scrollY = isTrueProperty(val); this._scrollY = isTrueProperty(val);
} }
/**
* @input {boolean} whether to enable zooming
*/
@Input() @Input()
get zoom() { get zoom() {
return this._zoom; return this._zoom;
@ -68,6 +73,9 @@ export class Scroll {
this._zoom = isTrueProperty(val); this._zoom = isTrueProperty(val);
} }
/**
* @input {number} set the max zoom amount for ion-scroll
*/
@Input() @Input()
get maxZoom() { get maxZoom() {
return this._maxZoom; return this._maxZoom;

View File

@ -862,6 +862,10 @@ export class Slide {
constructor( constructor(
elementRef: ElementRef, elementRef: ElementRef,
/**
* @private
*/
@Host() public slides: Slides @Host() public slides: Slides
) { ) {
this.ele = elementRef.nativeElement; this.ele = elementRef.nativeElement;
@ -870,6 +874,9 @@ export class Slide {
slides.rapidUpdate(); slides.rapidUpdate();
} }
/**
* @private
*/
ngOnDestroy() { ngOnDestroy() {
this.slides.rapidUpdate(); this.slides.rapidUpdate();
} }

View File

@ -4,6 +4,9 @@ import { Directive } from '@angular/core';
* @name Thumbnail * @name Thumbnail
* @module ionic * @module ionic
* @description * @description
* A Thumbnail is a component that creates a squated image for an item.
* Thumbnail's can be place on the left or right side of an itemt with the `item-left` or `item-right` directive.
* @see {@link /docs/v2/components/#thumbnail-list Thumbnail Component Docs}
*/ */
@Directive({ @Directive({
selector: 'ion-thumbnail' selector: 'ion-thumbnail'

View File

@ -158,21 +158,26 @@ export class ViewController {
} }
/** /**
* onDidDismiss * Called when the current viewController has be successfully dismissed
*/ */
onDidDismiss(callback: Function) { onDidDismiss(callback: Function) {
this._onDidDismiss = callback; this._onDidDismiss = callback;
} }
/** /**
* onWillDismiss * Called when the current viewController will be dismissed
*/ */
onWillDismiss(callback: Function) { onWillDismiss(callback: Function) {
this._onWillDismiss = callback; this._onWillDismiss = callback;
} }
/** /**
* dismiss * Dismiss the current viewController
* @param {any} [data] Data that you want to return when the viewController is dismissed.
* @param {any} [role ]
* @param {NavOptions} NavOptions Options for the dismiss navigation.
* @returns {any} data Returns the data passed in, if any.
*
*/ */
dismiss(data?: any, role?: any, navOptions: NavOptions = {}) { dismiss(data?: any, role?: any, navOptions: NavOptions = {}) {
let options = merge({}, this._leavingOpts, navOptions); let options = merge({}, this._leavingOpts, navOptions);