diff --git a/ionic/components/modal/modal.ts b/ionic/components/modal/modal.ts index 14361e8a32..1ea962daea 100644 --- a/ionic/components/modal/modal.ts +++ b/ionic/components/modal/modal.ts @@ -7,7 +7,8 @@ import {makeComponent} from '../../config/decorators'; import * as util from 'ionic/util'; /** - * The Modal is a content pane that can go over the user's main view temporarily. Usually used for making a choice or editing an item. + * The Modal is a content pane that can go over the user's main view temporarily. + * Usually used for making a choice or editing an item. * * @usage * ```ts diff --git a/ionic/components/nav/nav-controller.ts b/ionic/components/nav/nav-controller.ts index a96acfb403..37b31379ca 100644 --- a/ionic/components/nav/nav-controller.ts +++ b/ionic/components/nav/nav-controller.ts @@ -15,16 +15,16 @@ import * as util from 'ionic/util'; * * NavController is the base class for navigation controller components like * [`Nav`](../Nav/) and [`Tab`](../../Tabs/Tab/). You use navigation controllers - * to navigate to [views](#creating_views) in your app. At a basic level, a - * navigation controller is an array of views representing a particular history + * to navigate to [pages](#creating_pages) in your app. At a basic level, a + * navigation controller is an array of pages representing a particular history * (of a Tab for example). This array can be manipulated to navigate throughout - * an app by pushing and popping views or inserting and removing them at + * an app by pushing and popping pages or inserting and removing them at * arbitrary locations in history. * - * The current view is the last one in the array, or the top of the stack if we - * think of it that way. [Pushing](#push) a new view onto the top of the - * navigation stack causes the new view to be animated in, while [popping](#pop) - * the current view will navigate to the previous view in the stack. + * The current page is the last one in the array, or the top of the stack if we + * think of it that way. [Pushing](#push) a new page onto the top of the + * navigation stack causes the new page to be animated in, while [popping](#pop) + * the current page will navigate to the previous page in the stack. * * Unless you are using a directive like [NavPush](../NavPush/), or need a * specific NavController, most times you will inject and use a reference to the @@ -71,16 +71,19 @@ import * as util from 'ionic/util'; * } * ``` * - *
@@ -56,7 +57,7 @@ import {NavController} from './nav-controller';
* <ion-nav>
* |
* |
- * Pane 3 +--------------------+
+ * Pane 3 +--------------------+ LoginPage
* Pane 2 +--------------------+ | Has header, animates into pane 1
* Pane 1 +--------------------+ | | +--------------------+
* | | Header (Pane 1) |<-----------------| Login |
@@ -95,27 +96,28 @@ import {NavController} from './nav-controller';
*
* ### Panes
*
- * NOTE: You don't have to do anything with panes, Ionic takes care of animated
- * transitions for you. This is an explanation of how Nav works to accompany the diagram above.
+ * NOTE: You don't have to do anything with panes because Ionic takes care of
+ * animated transitions for you. This is an explanation of how Nav works to
+ * accompany the diagram above.
*
- * When you push a new view onto the navigation stack using [NavController.push()](../NavController/#push)
- * or the [NavPush directive](../NavPush/), Nav animates the new view into the
+ * When you push a new page onto the navigation stack using [NavController.push()](../NavController/#push)
+ * or the [NavPush directive](../NavPush/), Nav animates the new page into the
* appropriate pane.
*
* Panes are the containers Nav creates to animate views into. They do not have
* any content of their own, as they are just a structural reference for where
- * views should animate into.
+ * the various parts of a page (header, footer, content) should animate into.
*
- * The easiest scenario is animating between views with the same structure. If
- * you have a view with a header and content, and navigate to another view that
- * also has a header and content, Nav can smoothly animate the incoming view into
- * the pane the exiting view is leaving. This allows for things like seamless header
- * animations between views that both have headers.
+ * The easiest scenario is animating between pages with the same structure. If
+ * you have a page with a header and content, and navigate to another page that
+ * also has a header and content, Nav can smoothly animate the incoming page
+ * into the pane the exiting page is leaving. This allows for things like
+ * seamless header animations between pages that both have headers.
*
- * But suppose you have a view with a header and content and want to navigate to
- * a view with no header. The view controller creates a new pane with no header
- * that is directly behind the current pane. It then animates the exiting view
- * out of the current pane and the new view into the new content-only pane.
+ * But suppose you have a page with a header and content and want to navigate to
+ * a page with no header. Nav creates a new pane with no header that is directly
+ * behind the current pane. It then animates the exiting page out of the current
+ * pane and the new page into the new content-only pane.
*
*/
@ConfigComponent({
diff --git a/ionic/components/tabs/tab.ts b/ionic/components/tabs/tab.ts
index a1e4159c41..1cc96cc37c 100644
--- a/ionic/components/tabs/tab.ts
+++ b/ionic/components/tabs/tab.ts
@@ -11,7 +11,7 @@ import {Tabs} from './tabs';
*
* Tab components are basic navigation controllers used with Tabs. Much like
* Nav, they are a subclass of NavController and can be used to navigate
- * to views and manipulate the navigation stack of a particular tab.
+ * to pages in and manipulate the navigation stack of a particular tab.
*
* For more information on using navigation controllers like Tab or [Nav](../../nav/Nav/),
* take a look at the [NavController API reference](../NavController/).
@@ -19,7 +19,7 @@ import {Tabs} from './tabs';
* See the [Tabs API reference](../Tabs/) for more details on configuring Tabs
* and the TabBar.
*
- * Like Nav, you must set a root view to be loaded initially for each Tab with
+ * Like Nav, you must set a root page to be loaded initially for each Tab with
* the 'root' property:
* ```
* import {GettingStartedPage} from 'getting-started';
@@ -82,9 +82,9 @@ export class Tab extends NavController {
injector: Injector,
zone: NgZone
) {
- // A Tab is both a container of many views, and is a view itself.
- // A Tab is one ViewController within it's Host Tabs (which extends NavController)
- // A Tab is a NavController for its child ViewControllers
+ // A Tab is both a container of many pages, and is a page itself.
+ // A Tab is one page within it's Host Tabs (which also extends NavController)
+ // A Tab is a NavController for its child pages
super(tabs, injector, elementRef, zone);
this.tabs = tabs;
diff --git a/ionic/config/decorators.ts b/ionic/config/decorators.ts
index 7c14afde28..ca23d68d1f 100644
--- a/ionic/config/decorators.ts
+++ b/ionic/config/decorators.ts
@@ -15,14 +15,17 @@ class PageImpl extends View {
}
/**
- * The Page decorator indicates that the decorated class is an Ionic
- * navigation view, meaning it can be navigated to using a [NavController](../../Nav/NavController/#creating_views)
+ * _For more information on how pages are created, see the [NavController API
+ * reference](../../Nav/NavController/#creating_pages)._
*
- * Ionic views have all [IONIC_DIRECTIVES](../IONIC_DIRECTIVES/), which include
- * all Ionic components, as well as Angular's [CORE_DIRECTIVES](https://angular.io/docs/js/latest/api/core/CORE_DIRECTIVES-const.html)
+ * The Page decorator indicates that the decorated class is an Ionic
+ * navigation component, meaning it can be navigated to using a NavController.
+ *
+ * Pages have all [IONIC_DIRECTIVES](../IONIC_DIRECTIVES/), which include
+ * all Ionic components and directives, as well as Angular's [CORE_DIRECTIVES](https://angular.io/docs/js/latest/api/core/CORE_DIRECTIVES-const.html)
* and [FORM_DIRECTIVES](https://angular.io/docs/js/latest/api/core/FORM_DIRECTIVES-const.html),
- * already provided to them, so you only need to supply custom directives to
- * your Ionic views:
+ * already provided to them, so you only need to supply custom components and
+ * directives to your pages:
*
* ```ts
* @Page({
@@ -53,21 +56,20 @@ class PageImpl extends View {
*```
* Alternatively, you could:
* ```ts
- * import {Checkbox} from 'ionic/ionic'
+ * import {Checkbox, Icon} from 'ionic/ionic'
* ```
* along with any other components and add them individually:
* ```
* @View({
- * directives: [Checkbox]
+ * directives: [Checkbox, Icon]
* })
* ```
- * However, using IONIC_DIRECTIVES will always Just Work :tm: with no
+ * However, using IONIC_DIRECTIVES will always *Just Work* with no
* performance overhead, so there is really no reason to not always use it.
*
- * Ionic views are also automatically wrapped in ``, so although you
- * may see these tags if you inspect your markup, you don't need to include them
- * in your templates.
- *
+ * Pages have their content automatically wrapped in ``, so although
+ * you may see these tags if you inspect your markup, you don't need to include
+ * them in your templates.
*/
export function Page(args) {
return function(cls) {