UNPKG

5.79 kBTypeScriptView Raw
1import { AnimationBuilder, Mode, SpinnerTypes, TabButtonLayout } from '../interface';
2import { PlatformConfig } from './platform';
3export interface IonicConfig {
4 /**
5 * When it's set to `false`, disables all animation and transition across the app.
6 * Can be useful to make ionic smoother in slow devices, when animations can't run smoothly.
7 */
8 animated?: boolean;
9 /**
10 * When it's set to `false`, it disables all material-design ripple-effects across the app.
11 * Defaults to `true`.
12 */
13 rippleEffect?: boolean;
14 /**
15 * The mode determines which platform styles to use for the whole application.
16 */
17 mode?: Mode;
18 /**
19 * Wherever ionic will respond to hardware go back buttons in an Android device.
20 * Defaults to `true` when ionic runs in a mobile device.
21 */
22 hardwareBackButton?: boolean;
23 /**
24 * Whenever clicking the top status bar should cause the scroll to top in an application.
25 * Defaults to `true` when ionic runs in a mobile device.
26 */
27 statusTap?: boolean;
28 /**
29 * Overrides the default icon in all `<ion-back-button>` components.
30 */
31 backButtonIcon?: string;
32 /**
33 * Overrides the default text in all `<ion-back-button>` components.
34 */
35 backButtonText?: string;
36 /**
37 * Overrides the default defaultHref in all `<ion-back-button>` components.
38 */
39 backButtonDefaultHref?: string;
40 /**
41 * Overrides the default icon in all `<ion-menu-button>` components.
42 */
43 menuIcon?: string;
44 /**
45 * Overrides the default menu type for all `<ion-menu>` components.
46 * By default the menu type is chosen based in the app's mode.
47 */
48 menuType?: string;
49 /**
50 * Overrides the default spinner in all `<ion-spinner>` components.
51 * By default the spinner type is chosen based in the mode (ios or md).
52 */
53 spinner?: SpinnerTypes;
54 /**
55 * Overrides the default spinner for all `ion-loading` overlays, ie. the ones
56 * created with `ion-loading-controller`.
57 */
58 loadingSpinner?: SpinnerTypes | null;
59 /**
60 * Overrides the default icon in all `<ion-refresh-content>` components.
61 */
62 refreshingIcon?: string;
63 /**
64 * Overrides the default spinner type in all `<ion-refresh-content>` components.
65 */
66 refreshingSpinner?: SpinnerTypes | null;
67 /**
68 * Overrides the default spinner type in all `<ion-infinite-scroll-content>` components.
69 */
70 infiniteLoadingSpinner?: SpinnerTypes | null;
71 /**
72 * Global switch that disables or enables "swipe-to-go-back" gesture across all
73 * `ion-nav` in your application.
74 */
75 swipeBackEnabled?: boolean;
76 /**
77 * Overrides the default "layout" of all `ion-bar-button` across the whole application.
78 */
79 tabButtonLayout?: TabButtonLayout;
80 /**
81 * Overrides the default "animation" of all `ion-nav` and `ion-router-outlet` across the whole application.
82 * This prop allows to replace the default transition and provide a custom one that applies to all navigation outlets.
83 */
84 navAnimation?: AnimationBuilder;
85 /**
86 * Provides a custom enter animation for all `ion-action-sheet`, overriding the default "animation".
87 */
88 actionSheetEnter?: AnimationBuilder;
89 /**
90 * Provides a custom enter animation for all `ion-alert`, overriding the default "animation".
91 */
92 alertEnter?: AnimationBuilder;
93 /**
94 * Provides a custom enter animation for all `ion-loading`, overriding the default "animation".
95 */
96 loadingEnter?: AnimationBuilder;
97 /**
98 * Provides a custom enter animation for all `ion-modal`, overriding the default "animation".
99 */
100 modalEnter?: AnimationBuilder;
101 /**
102 * Provides a custom enter animation for all `ion-popover`, overriding the default "animation".
103 */
104 popoverEnter?: AnimationBuilder;
105 /**
106 * Provides a custom enter animation for all `ion-toast`, overriding the default "animation".
107 */
108 toastEnter?: AnimationBuilder;
109 /**
110 * Provides a custom enter animation for all `ion-picker`, overriding the default "animation".
111 */
112 pickerEnter?: AnimationBuilder;
113 /**
114 * Provides a custom leave animation for all `ion-action-sheet`, overriding the default "animation".
115 */
116 actionSheetLeave?: AnimationBuilder;
117 /**
118 * Provides a custom leave animation for all `ion-alert`, overriding the default "animation".
119 */
120 alertLeave?: AnimationBuilder;
121 /**
122 * Provides a custom leave animation for all `ion-loading`, overriding the default "animation".
123 */
124 loadingLeave?: AnimationBuilder;
125 /**
126 * Provides a custom leave animation for all `ion-modal`, overriding the default "animation".
127 */
128 modalLeave?: AnimationBuilder;
129 /**
130 * Provides a custom leave animation for all `ion-popover`, overriding the default "animation".
131 */
132 popoverLeave?: AnimationBuilder;
133 /**
134 * Provides a custom leave animation for all `ion-toast`, overriding the default "animation".
135 */
136 toastLeave?: AnimationBuilder;
137 /**
138 * Provides a custom leave animation for all `ion-picker`, overriding the default "animation".
139 */
140 pickerLeave?: AnimationBuilder;
141 /**
142 * If `true`, Ionic will enable a basic DOM sanitizer on component properties that accept custom HTML.
143 */
144 sanitizerEnabled?: boolean;
145 /**
146 * Overrides the default platform detection methods.
147 */
148 platform?: PlatformConfig;
149 keyboardHeight?: number;
150 inputShims?: boolean;
151 scrollPadding?: boolean;
152 inputBlurring?: boolean;
153 scrollAssist?: boolean;
154 hideCaretOnScroll?: boolean;
155 persistConfig?: boolean;
156 _forceStatusbarPadding?: boolean;
157 _testing?: boolean;
158 _zoneGate?: (h: () => any) => any;
159 _ael?: (el: any, name: string, cb: any, opts: any) => any;
160 _rel?: (el: any, name: string, cb: any, opts: any) => any;
161 _ce?: (eventName: string, opts: any) => any;
162}
163export declare const setupConfig: (config: IonicConfig) => any;
164export declare const getMode: () => Mode;