From e4ba21bfe1e1c5101625b0f4b36d3a66fa9152fe Mon Sep 17 00:00:00 2001 From: mhartington Date: Wed, 7 Oct 2015 09:37:02 -0400 Subject: [PATCH] docs(ionicConfig): add inital config docs Close #256 --- ionic/config/config.ts | 31 +++++++++++++++++++++++++++++++ 1 file changed, 31 insertions(+) diff --git a/ionic/config/config.ts b/ionic/config/config.ts index a83e335079..db590a37c0 100644 --- a/ionic/config/config.ts +++ b/ionic/config/config.ts @@ -1,3 +1,11 @@ +/** +* @ngdoc service +* @name Config +* @module ionic +* @description +* IonicConfig allows you to set the modes of your components +*/ + import {IonicPlatform} from '../platform/platform'; import {isObject, isDefined, isFunction, extend} from '../util/util'; @@ -18,6 +26,29 @@ export class IonicConfig { /** * For setting and getting multiple config values */ + + /** + * @name settings() + * @description + * IonicConfig lets you change multiple or a single value in an apps mode configuration. Things such as tab placement, icon changes, and view animations can be set here. + * + * + * @usage + * ```ts + * import {IonicConfig} from 'ionic/ionic'; + * @App({ + * template: `` + * config: { + * backButtonText: 'Go Back', + * iconMode: 'ios', + * modalEnter: 'modal-slide-in', + * modalLeave: 'modal-slide-out', + * tabBarPlacement: 'bottom', + * viewTransition: 'ios', + * } + * }) + * ``` + */ settings() { const args = arguments;