UNPKG

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