mirror of
https://github.com/ionic-team/ionic-framework.git
synced 2025-08-20 04:14:21 +08:00
docs(): update docs
This commit is contained in:
@ -36,6 +36,9 @@ export class NavPop {
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* @private
|
||||
*/
|
||||
@HostListener('click')
|
||||
onClick(): boolean {
|
||||
// If no target, or if target is _self, prevent default browser behavior
|
||||
|
@ -66,6 +66,9 @@ export class NavPush {
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* @private
|
||||
*/
|
||||
@HostListener('click')
|
||||
onClick(): boolean {
|
||||
if (this._nav) {
|
||||
|
@ -17,10 +17,6 @@ import { isTrueProperty } from '../../util/util';
|
||||
* <ion-scroll scrollX="true" scrollY="true">
|
||||
* </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/
|
||||
*/
|
||||
@Component({
|
||||
@ -44,6 +40,9 @@ export class Scroll {
|
||||
_zoom: boolean = false;
|
||||
_maxZoom: number = 1;
|
||||
|
||||
/**
|
||||
* @input {boolean} whether to enable scrolling along the X axis
|
||||
*/
|
||||
@Input()
|
||||
get scrollX() {
|
||||
return this._scrollX;
|
||||
@ -52,6 +51,9 @@ export class Scroll {
|
||||
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()
|
||||
get scrollY() {
|
||||
return this._scrollY;
|
||||
@ -60,6 +62,9 @@ export class Scroll {
|
||||
this._scrollY = isTrueProperty(val);
|
||||
}
|
||||
|
||||
/**
|
||||
* @input {boolean} whether to enable zooming
|
||||
*/
|
||||
@Input()
|
||||
get zoom() {
|
||||
return this._zoom;
|
||||
@ -68,6 +73,9 @@ export class Scroll {
|
||||
this._zoom = isTrueProperty(val);
|
||||
}
|
||||
|
||||
/**
|
||||
* @input {number} set the max zoom amount for ion-scroll
|
||||
*/
|
||||
@Input()
|
||||
get maxZoom() {
|
||||
return this._maxZoom;
|
||||
|
@ -862,6 +862,10 @@ export class Slide {
|
||||
|
||||
constructor(
|
||||
elementRef: ElementRef,
|
||||
|
||||
/**
|
||||
* @private
|
||||
*/
|
||||
@Host() public slides: Slides
|
||||
) {
|
||||
this.ele = elementRef.nativeElement;
|
||||
@ -870,6 +874,9 @@ export class Slide {
|
||||
slides.rapidUpdate();
|
||||
}
|
||||
|
||||
/**
|
||||
* @private
|
||||
*/
|
||||
ngOnDestroy() {
|
||||
this.slides.rapidUpdate();
|
||||
}
|
||||
|
@ -4,6 +4,9 @@ import { Directive } from '@angular/core';
|
||||
* @name Thumbnail
|
||||
* @module ionic
|
||||
* @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({
|
||||
selector: 'ion-thumbnail'
|
||||
|
@ -158,21 +158,26 @@ export class ViewController {
|
||||
}
|
||||
|
||||
/**
|
||||
* onDidDismiss
|
||||
* Called when the current viewController has be successfully dismissed
|
||||
*/
|
||||
onDidDismiss(callback: Function) {
|
||||
this._onDidDismiss = callback;
|
||||
}
|
||||
|
||||
/**
|
||||
* onWillDismiss
|
||||
* Called when the current viewController will be dismissed
|
||||
*/
|
||||
onWillDismiss(callback: Function) {
|
||||
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 = {}) {
|
||||
let options = merge({}, this._leavingOpts, navOptions);
|
||||
|
Reference in New Issue
Block a user