From 216374f93266a2af1791e93ab2c3fe0a25f3efdb Mon Sep 17 00:00:00 2001 From: mhartington Date: Fri, 11 Dec 2015 15:38:00 -0500 Subject: [PATCH] docs() --- ionic/components/scroll/pull-to-refresh.ts | 8 +-- ionic/config/decorators/page.ts | 2 +- ionic/config/directives.ts | 66 ++++++++++++++++++++++ 3 files changed, 71 insertions(+), 5 deletions(-) diff --git a/ionic/components/scroll/pull-to-refresh.ts b/ionic/components/scroll/pull-to-refresh.ts index 9d0ea7150b..81ec36422b 100644 --- a/ionic/components/scroll/pull-to-refresh.ts +++ b/ionic/components/scroll/pull-to-refresh.ts @@ -48,10 +48,10 @@ import {raf, ready, CSS} from '../../util/dom'; * } * ``` * - * @property {string} [pulling-icon] - the icon you want to display when you begin to pull down - * @property {string} [pulling-text] - the text you want to display when you begin to pull down - * @property {string} [refreshing-icon] - the icon you want to display when performing a refresh - * @property {string} [refreshing-text] - the text you want to display when performing a refresh + * @property {string} [pullingIcon] - the icon you want to display when you begin to pull down + * @property {string} [pullingText] - the text you want to display when you begin to pull down + * @property {string} [refreshingIcon] - the icon you want to display when performing a refresh + * @property {string} [refreshingText] - the text you want to display when performing a refresh * * @property {any} (refresh) - the methond on your class you want to perform when you refreshing * @property {any} (starting) - the methond on your class you want to perform when you start pulling down diff --git a/ionic/config/decorators/page.ts b/ionic/config/decorators/page.ts index 9f107b8607..028153506e 100644 --- a/ionic/config/decorators/page.ts +++ b/ionic/config/decorators/page.ts @@ -10,7 +10,7 @@ import {IONIC_DIRECTIVES} from '../directives'; * 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, which include all Ionic components and directives, + * Pages have all `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 components and directives to your pages: diff --git a/ionic/config/directives.ts b/ionic/config/directives.ts index cf7a6feaea..6b80006652 100644 --- a/ionic/config/directives.ts +++ b/ionic/config/directives.ts @@ -33,8 +33,74 @@ import {IdRef} from '../components/app/id'; import {ShowWhen, HideWhen} from '../components/show-hide-when/show-hide-when'; /** + * @name IONIC_DIRECTIVES + * @description * The core Ionic directives as well as Angular's CORE_DIRECTIVES and * FORM_DIRECTIVES. Automatically available in every [@Page](../Page/) template. + * + * **Angular** + * - CORE_DIRECTIVES + * - FORM_DIRECTIVES + * + * **Content** + * - OverlayNav + * - Menu + * - MenuToggle + * - MenuClose + * + * - Button + * - Blur + * - Content + * - Scroll + * - Refresher + * + * **Lists** + * - List + * - ListHeader + * - Item + * - ItemSliding + * + * **Slides** + * - Slides + * - Slide + * - SlideLazy + * + * **Tabs** + * - Tabs + * - Tab + * + * **Toolbar** + * - Toolbar + * - ToolbarTitle + * - ToolbarItem + * + * **Media** + * - Icon + * + * **Forms** + * - Searchbar + * - Segment + * - SegmentButton + * - Checkbox + * - RadioGroup + * - RadioButton + * - Toggle + * - TextInput + * - TextInputElement + * - Label + * + * **Nav** + * - Nav + * - NavbarTemplate + * - Navbar + * - NavPush + * - NavPop + * - NavRouter + * - IdRef + * + * - ShowWhen + * - HideWhen + */ export const IONIC_DIRECTIVES = [ // Angular