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

docs(content): add description and usage

Browse Source
This commit is contained in:
Drew Rygh
2015-09-08 15:39:19 -05:00
parent 158657a2ec
commit 2375eb2235
1 changed files with 17 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

23
ionic/components/content/content.ts
View File

@ -9,7 +9,18 @@ import {hasFocusedTextInput} from '../../util/dom';
/** /**
* @name ionContent * @name ionContent
* @description * @description
* TODO * The ionContent component provides an easy to use content area that can be configured to use Ionic's custom Scroll View, or the built in overflow scrolling of the browser.
*
* While we recommend using the custom Scroll features in Ionic in most cases, sometimes (for performance reasons) only the browser's native overflow scrolling will suffice, and so we've made it easy to toggle between the Ionic scroll implementation and overflow scrolling.
*
* You can implement pull-to-refresh with the ionRefresher component.
*
* @usage
* ```html
* <ion-content>
* Add your content here!
* </ion-content>
* ```
* *
*/ */
@Component({ @Component({
@ -23,9 +34,8 @@ import {hasFocusedTextInput} from '../../util/dom';
}) })
export class Content extends Ion { export class Content extends Ion {
/** /**
* TODO * @param {ElementRef} elementRef A reference to the component's DOM element.
* @param {ElementRef} elementRef TODO * @param {IonicConfig} config The config object to change content's default settings.
* @param {IonicConfig} config TODO
*/ */
constructor(elementRef: ElementRef, config: IonicConfig) { constructor(elementRef: ElementRef, config: IonicConfig) {
super(elementRef, config); super(elementRef, config);
@ -34,6 +44,7 @@ export class Content extends Ion {
/** /**
* TODO * TODO
* @private
*/ */
onInit() { onInit() {
super.onInit(); super.onInit();
@ -78,8 +89,8 @@ export class Content extends Ion {
/** /**
* Scroll to the specified position. * Scroll to the specified position.
* @param {TODO} x TODO * @param {TODO} x The x-value to scroll to.
* @param {TODO} y TODO * @param {TODO} y The y-value to scroll to.
* @param {Number} duration Duration of the scroll animation. * @param {Number} duration Duration of the scroll animation.
* @param {TODO} tolerance TODO * @param {TODO} tolerance TODO
* @returns {TODO} TODO * @returns {TODO} TODO