Update docs and fix typos (#7776)

* docs(input): fix typo

* docs(scroll): add note about required CSS for scrollY

* docs(config): add swipeBackEnabled to config properties list

* docs(component generator): fix broken link in template comment

* docs(directive generator): fix broken link in template comment
This commit is contained in:
Alex Muramoto
2016-08-18 12:20:25 -07:00
committed by Mike Hartington
parent de12a4e905
commit 97b57f1b53
8 changed files with 8 additions and 7 deletions

View File

@ -135,7 +135,7 @@ export class TextInput extends InputBase {
* however, with Ionic wrapping the native HTML text area element, Ionic * however, with Ionic wrapping the native HTML text area element, Ionic
* is able to better handle the user experience and interactivity. * is able to better handle the user experience and interactivity.
* *
* Not that `<ion-textarea>` must load its value from the `value` or * Note that `<ion-textarea>` must load its value from the `value` or
* `[(ngModel)]` attribute. Unlike the native `<textarea>` element, * `[(ngModel)]` attribute. Unlike the native `<textarea>` element,
* `<ion-textarea>` does not support loading its value from the * `<ion-textarea>` does not support loading its value from the
* textarea's inner content. * textarea's inner content.

View File

@ -18,7 +18,7 @@ import { Ion } from '../ion';
* </ion-scroll> * </ion-scroll>
* ``` * ```
*@property {boolean} [scrollX] - whether to enable scrolling along the X axis *@property {boolean} [scrollX] - whether to enable scrolling along the X axis
*@property {boolean} [scrollY] - whether to enable scrolling along the Y 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 {boolean} [zoom] - whether to enable zooming
*@property {number} [maxZoom] - set the max zoom amount for ion-scroll *@property {number} [maxZoom] - set the max zoom amount for ion-scroll
* @demo /docs/v2/demos/scroll/ * @demo /docs/v2/demos/scroll/

View File

@ -100,6 +100,7 @@ import { isObject, isDefined, isFunction, isArray } from '../util/util';
* | `popoverLeave` | `string` | The name of the transition to use while a popover is dismissed. | * | `popoverLeave` | `string` | The name of the transition to use while a popover is dismissed. |
* | `prodMode` | `boolean` | Disable development mode, which turns off assertions and other checks within the framework. One important assertion this disables verifies that a change detection pass does not result in additional changes to any bindings (also known as unidirectional data flow). * | `prodMode` | `boolean` | Disable development mode, which turns off assertions and other checks within the framework. One important assertion this disables verifies that a change detection pass does not result in additional changes to any bindings (also known as unidirectional data flow).
* | `spinner` | `string` | The default spinner to use when a name is not defined. | * | `spinner` | `string` | The default spinner to use when a name is not defined. |
* | `swipeBackEnabled` | `boolean` | Whether native iOS swipe to go back functionality is enabled.
* | `tabsHighlight` | `boolean` | Whether to show a highlight line under the tab when it is selected. | * | `tabsHighlight` | `boolean` | Whether to show a highlight line under the tab when it is selected. |
* | `tabsLayout` | `string` | The layout to use for all tabs. Available options: `"icon-top"`, `"icon-left"`, `"icon-right"`, `"icon-bottom"`, `"icon-hide"`, `"title-hide"`. | * | `tabsLayout` | `string` | The layout to use for all tabs. Available options: `"icon-top"`, `"icon-left"`, `"icon-right"`, `"icon-bottom"`, `"icon-hide"`, `"title-hide"`. |
* | `tabsPlacement` | `string` | The position of the tabs relative to the content. Available options: `"top"`, `"bottom"` | * | `tabsPlacement` | `string` | The position of the tabs relative to the content. Available options: `"top"`, `"bottom"` |

View File

@ -1,7 +1,7 @@
<!-- <!--
Generated template for the <%= jsClassName %> component. Generated template for the <%= jsClassName %> component.
See https://angular.io/docs/ts/latest/api/core/ComponentMetadata-class.html See https://angular.io/docs/ts/latest/api/core/index/ComponentMetadata-class.html
for more info on Angular 2 Components. for more info on Angular 2 Components.
--> -->
<div> <div>

View File

@ -3,7 +3,7 @@ import { Component } from '@angular/core';
/* /*
Generated class for the <%= jsClassName %> component. Generated class for the <%= jsClassName %> component.
See https://angular.io/docs/ts/latest/api/core/ComponentMetadata-class.html See https://angular.io/docs/ts/latest/api/core/index/ComponentMetadata-class.html
for more info on Angular 2 Components. for more info on Angular 2 Components.
*/ */
@Component({ @Component({

View File

@ -3,7 +3,7 @@ import { Component } from '@angular/core';
/* /*
Generated class for the <%= jsClassName %> component. Generated class for the <%= jsClassName %> component.
See https://angular.io/docs/ts/latest/api/core/ComponentMetadata-class.html See https://angular.io/docs/ts/latest/api/core/index/ComponentMetadata-class.html
for more info on Angular 2 Components. for more info on Angular 2 Components.
*/ */
@Component({ @Component({

View File

@ -3,7 +3,7 @@ import { Directive } from '@angular/core';
/* /*
Generated class for the <%= jsClassName %> directive. Generated class for the <%= jsClassName %> directive.
See https://angular.io/docs/ts/latest/api/core/DirectiveMetadata-class.html See https://angular.io/docs/ts/latest/api/core/index/DirectiveMetadata-class.html
for more info on Angular 2 Directives. for more info on Angular 2 Directives.
*/ */
@Directive({ @Directive({

View File

@ -3,7 +3,7 @@ import { Directive } from '@angular/core';
/* /*
Generated class for the <%= jsClassName %> directive. Generated class for the <%= jsClassName %> directive.
See https://angular.io/docs/ts/latest/api/core/DirectiveMetadata-class.html See https://angular.io/docs/ts/latest/api/core/index/DirectiveMetadata-class.html
for more info on Angular 2 Directives. for more info on Angular 2 Directives.
*/ */
@Directive({ @Directive({