docs(config): add default values

This commit is contained in:
mhartington
2015-12-01 10:35:27 -05:00
parent c61336842f
commit 994cdfe8f9

View File

@@ -54,9 +54,53 @@ import {isObject, isDefined, isFunction, isArray, extend} from '../util/util';
* The last way we could configure is through URL query strings. This is useful for testing while in the browser.
* Simply add `?ionic<PROPERTYNAME>=<value>` to the url.
*
* ```
* ```bash
* http://localhost:8100/?ionicTabbarPlacement=bottom
* ```
*
* A config value can come from anywhere and be anything, but there are a default set of values.
*
* ``` javascript
* // iOS
* activator: 'highlight',
* actionSheetEnter: 'action-sheet-slide-in',
* actionSheetLeave: 'action-sheet-slide-out',
* actionSheetCancelIcon: '',
* actionSheetDestructiveIcon: '',
* backButtonText: 'Back',
* backButtonIcon: 'ion-ios-arrow-back',
* iconMode: 'ios',
* menuType: 'reveal',
* modalEnter: 'modal-slide-in',
* modalLeave: 'modal-slide-out',
* pageTransition: 'ios-transition',
* pageTransitionDelay: 16,
* popupEnter: 'popup-pop-in',
* popupLeave: 'popup-pop-out',
* tabbarPlacement: 'bottom',
* // MD
* activator: 'ripple',
* actionSheetEnter: 'action-sheet-md-slide-in',
* actionSheetLeave: 'action-sheet-md-slide-out',
* actionSheetCancelIcon: 'ion-md-close',
* actionSheetDestructiveIcon: 'ion-md-trash',
* backButtonText: '',
* backButtonIcon: 'ion-md-arrow-back',
* iconMode: 'md',
* menuType: 'overlay',
* modalEnter: 'modal-md-slide-in',
* modalLeave: 'modal-md-slide-out',
* pageTransition: 'md-transition',
* pageTransitionDelay: 120,
* popupEnter: 'popup-md-pop-in',
* popupLeave: 'popup-md-pop-out',
* tabbarHighlight: true,
* tabbarPlacement: 'top',
* tabSubPages: true,
* ```
*
*
**/
export class Config {