javascript/ionic-framework
1
0
Fork 0
mirror of https://github.com/ionic-team/ionic-framework.git synced 2025-08-23 14:01:20 +08:00
Code Issues Packages Projects Releases Wiki Activity

docs(ionicDirectives): add docs for IONIC_DIRECTIVES

Browse Source
This commit is contained in:
Mike Hartington
2016-04-19 14:18:40 -04:00
parent 8d8cc4c097
commit 902fbd0f62
1 changed files with 92 additions and 68 deletions
Download Patch File Download Diff File Expand all files Collapse all files

160
ionic/config/directives.ts
View File

@ -44,79 +44,103 @@ import {ShowWhen, HideWhen} from '../components/show-hide-when/show-hide-when';
/** /**
* @name IONIC_DIRECTIVES * @name IONIC_DIRECTIVES
* @private
* @description * @description
* The core Ionic directives as well as Angular's CORE_DIRECTIVES and * The core Ionic directives as well as Angular's `CORE_DIRECTIVES` and `FORM_DIRECTIVES` are
* FORM_DIRECTIVES. Automatically available in every [@Page](../Page/) template. * avaialbe automatically when you bootstrap your app with the `@App` decorator. This means
* if you are using custom components you no longer need to import `IONIC_DIRECTIVES` as they
* are part of the `@App`s default directives.
* *
* **Angular** * If you would like to **not** have them included by default, you would need to bootstrap
* the app differently.
*
* Instead of starting your app like so:
*
* ```typescript
* @App({
* template: "<ion-nav></ion-nav>"
* })
*
* export class MyApp{
*
* }
* ```
*
* We would use Angulars default way of bootstrap an app, import `IONIC_DIRECTIVES` and `ionicProviders`, then
* declare `ionicProviders` as a dependencey.
*
* ```typescript
* import {IONIC_DIRECTIVES, ionicProviders} from 'ionic-angular';
* import {bootstrap} from 'angular2/platform/browser';
*
* @Component({
* //default selector, and theme.
* directives: [IONIC_DIRECTIVES]
* })
* class App {}
*
* bootstrap(App,ionicProviders())
* ```
*
*
*
* #### Angular
* - CORE_DIRECTIVES * - CORE_DIRECTIVES
* - FORM_DIRECTIVES * - FORM_DIRECTIVES
* *
* **Content** * #### Ionic
* - Menu * - Menu
* - MenuToggle * - MenuToggle
* - MenuClose * - MenuClose
* * - Badge
* - Button * - Button
* - Blur * - Blur
* - Content * - Content
* - Scroll * - Scroll
* - InfiniteScroll * - InfiniteScroll
* - InfiniteScrollContent * - InfiniteScrollContent
* - Refresher * - Refresher
* - RefresherContent * - RefresherContent
* * - Img
* **Lists** * - List
* - List * - ListHeader
* - ListHeader * - Item
* - Item * - ItemSliding
* - ItemSliding * - VirtualScroll
* - VirtualScroll * - VirtualItem
* - VirtualFor * - VirtualHeader
* * - VirtualFooter
* **Slides** * - Slides
* - Slides * - Slide
* - Slide * - SlideLazy
* - SlideLazy * - Tabs
* * - Tab
* **Tabs** * - Toolbar
* - Tabs * - ToolbarTitle
* - Tab * - ToolbarItem
* * - Icon
* **Toolbar** * - Spinner
* - Toolbar * - Searchbar
* - ToolbarTitle * - SearchbarInput
* - ToolbarItem * - Segment
* * - SegmentButton
* **Media** * - Checkbox
* - Icon * - RadioGroup
* - Spinner * - RadioButton
* * - Select
* **Forms** * - Option
* - Searchbar * - Toggle
* - Segment * - TextArea
* - SegmentButton * - TextInput
* - Checkbox * - Label
* - RadioGroup * - Nav
* - RadioButton * - NavbarTemplate
* - Select * - Navbar
* - Option * - NavPush
* - Toggle * - NavPop
* - TextInput * - NavRouter
* - Label * - IdRef
* * - ShowWhen
* **Nav** * - HideWhen
* - Nav
* - NavbarTemplate
* - Navbar
* - NavPush
* - NavPop
* - NavRouter
* - IdRef
*
* - ShowWhen
* - HideWhen
*/ */
export const IONIC_DIRECTIVES = [ export const IONIC_DIRECTIVES = [
// Angular // Angular