-
Notifications
You must be signed in to change notification settings - Fork 13.5k
/
loading.tsx
209 lines (178 loc) · 5.81 KB
/
loading.tsx
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
import { Component, ComponentInterface, Element, Event, EventEmitter, Host, Method, Prop, h } from '@stencil/core';
import { config } from '../../global/config';
import { getIonMode } from '../../global/ionic-global';
import { AnimationBuilder, OverlayEventDetail, OverlayInterface, SpinnerTypes } from '../../interface';
import { BACKDROP, dismiss, eventMethod, prepareOverlay, present } from '../../utils/overlays';
import { sanitizeDOMString } from '../../utils/sanitization';
import { getClassMap } from '../../utils/theme';
import { iosEnterAnimation } from './animations/ios.enter';
import { iosLeaveAnimation } from './animations/ios.leave';
import { mdEnterAnimation } from './animations/md.enter';
import { mdLeaveAnimation } from './animations/md.leave';
/**
* @virtualProp {"ios" | "md"} mode - The mode determines which platform styles to use.
*/
@Component({
tag: 'ion-loading',
styleUrls: {
ios: 'loading.ios.scss',
md: 'loading.md.scss'
},
scoped: true
})
export class Loading implements ComponentInterface, OverlayInterface {
private durationTimeout: any;
presented = false;
mode = getIonMode(this);
@Element() el!: HTMLIonLoadingElement;
/** @internal */
@Prop() overlayIndex!: number;
/**
* If `true`, the keyboard will be automatically dismissed when the overlay is presented.
*/
@Prop() keyboardClose = true;
/**
* Animation to use when the loading indicator is presented.
*/
@Prop() enterAnimation?: AnimationBuilder;
/**
* Animation to use when the loading indicator is dismissed.
*/
@Prop() leaveAnimation?: AnimationBuilder;
/**
* Optional text content to display in the loading indicator.
*/
@Prop() message?: string;
/**
* Additional classes to apply for custom CSS. If multiple classes are
* provided they should be separated by spaces.
*/
@Prop() cssClass?: string | string[];
/**
* Number of milliseconds to wait before dismissing the loading indicator.
*/
@Prop() duration = 0;
/**
* If `true`, the loading indicator will be dismissed when the backdrop is clicked.
*/
@Prop() backdropDismiss = false;
/**
* If `true`, a backdrop will be displayed behind the loading indicator.
*/
@Prop() showBackdrop = true;
/**
* The name of the spinner to display.
*/
@Prop({ mutable: true }) spinner?: SpinnerTypes | null;
/**
* If `true`, the loading indicator will be translucent.
* Only applies when the mode is `"ios"` and the device supports
* [`backdrop-filter`](https://developer.mozilla.org/en-US/docs/Web/CSS/backdrop-filter#Browser_compatibility).
*/
@Prop() translucent = false;
/**
* If `true`, the loading indicator will animate.
*/
@Prop() animated = true;
/**
* Emitted after the loading has presented.
*/
@Event({ eventName: 'ionLoadingDidPresent' }) didPresent!: EventEmitter<void>;
/**
* Emitted before the loading has presented.
*/
@Event({ eventName: 'ionLoadingWillPresent' }) willPresent!: EventEmitter<void>;
/**
* Emitted before the loading has dismissed.
*/
@Event({ eventName: 'ionLoadingWillDismiss' }) willDismiss!: EventEmitter<OverlayEventDetail>;
/**
* Emitted after the loading has dismissed.
*/
@Event({ eventName: 'ionLoadingDidDismiss' }) didDismiss!: EventEmitter<OverlayEventDetail>;
constructor() {
prepareOverlay(this.el);
}
componentWillLoad() {
if (this.spinner === undefined) {
const mode = getIonMode(this);
this.spinner = config.get(
'loadingSpinner',
config.get('spinner', mode === 'ios' ? 'lines' : 'crescent')
);
}
}
/**
* Present the loading overlay after it has been created.
*/
@Method()
async present(): Promise<void> {
await present(this, 'loadingEnter', iosEnterAnimation, mdEnterAnimation, undefined);
if (this.duration > 0) {
this.durationTimeout = setTimeout(
() => this.dismiss(),
this.duration + 10
);
}
}
/**
* Dismiss the loading overlay after it has been presented.
*
* @param data Any data to emit in the dismiss events.
* @param role The role of the element that is dismissing the loading.
* This can be useful in a button handler for determining which button was
* clicked to dismiss the loading.
* Some examples include: ``"cancel"`, `"destructive"`, "selected"`, and `"backdrop"`.
*/
@Method()
dismiss(data?: any, role?: string): Promise<boolean> {
if (this.durationTimeout) {
clearTimeout(this.durationTimeout);
}
return dismiss(this, data, role, 'loadingLeave', iosLeaveAnimation, mdLeaveAnimation);
}
/**
* Returns a promise that resolves when the loading did dismiss.
*/
@Method()
onDidDismiss(): Promise<OverlayEventDetail> {
return eventMethod(this.el, 'ionLoadingDidDismiss');
}
/**
* Returns a promise that resolves when the loading will dismiss.
*/
@Method()
onWillDismiss(): Promise<OverlayEventDetail> {
return eventMethod(this.el, 'ionLoadingWillDismiss');
}
private onBackdropTap = () => {
this.dismiss(undefined, BACKDROP);
}
render() {
const { message, spinner } = this;
const mode = getIonMode(this);
return (
<Host
onIonBackdropTap={this.onBackdropTap}
style={{
zIndex: `${40000 + this.overlayIndex}`
}}
class={{
...getClassMap(this.cssClass),
[mode]: true,
'loading-translucent': this.translucent
}}
>
<ion-backdrop visible={this.showBackdrop} tappable={this.backdropDismiss} />
<div class="loading-wrapper" role="dialog">
{spinner && (
<div class="loading-spinner">
<ion-spinner name={spinner} />
</div>
)}
{message && <div class="loading-content" innerHTML={sanitizeDOMString(message)}></div>}
</div>
</Host>
);
}
}