forked from sweetalert2/sweetalert2
-
Notifications
You must be signed in to change notification settings - Fork 0
/
sweetalert2.d.ts
1183 lines (1040 loc) · 30.4 KB
/
sweetalert2.d.ts
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
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
declare module 'sweetalert2' {
/**
* A namespace inside the default function, containing utility function for controlling the currently-displayed popup.
*
* Example:
* ```
* Swal.fire('Hey user!', 'You are the rockstar!', 'info');
*
* Swal.update({
* icon: 'success'
* })
* ```
*/
namespace Swal {
/**
* Function to display a SweetAlert2 popup, with an object of options, all being optional.
* See the `SweetAlertOptions` interface for the list of accepted fields and values.
*
* Example:
* ```
* Swal.fire({
* title: 'Auto close alert!',
* text: 'I will close in 2 seconds.',
* timer: 2000
* })
* ```
*/
function fire<T = any>(options: SweetAlertOptions<T>): Promise<SweetAlertResult<Awaited<T>>>
/**
* Function to display a simple SweetAlert2 popup.
*
* Example:
* ```
* Swal.fire('The Internet?', 'That thing is still around?', 'question');
* ```
*/
function fire<T = any>(title?: string, html?: string, icon?: SweetAlertIcon): Promise<SweetAlertResult<Awaited<T>>>
/**
* Reuse configuration by creating a `Swal` instance.
*
* Example:
* ```
* const Toast = Swal.mixin({
* toast: true,
* position: 'top-end',
* timer: 3000,
* timerProgressBar: true
* })
* Toast.fire('Something interesting happened', '', 'info')
* ```
*
* @param options the default options to set for this instance.
*/
function mixin(options: SweetAlertOptions): typeof Swal
/**
* Determines if a popup is shown.
*/
function isVisible(): boolean
/**
* Updates popup options.
* See the `SweetAlertOptions` interface for the list of accepted fields and values.
*
* Example:
* ```
* Swal.update({
* icon: 'error'
* })
* ```
*/
function update(options: Pick<SweetAlertOptions, SweetAlertUpdatableParameters>): void
/**
* Closes the currently open SweetAlert2 popup programmatically.
*
* @param result The promise originally returned by `Swal.fire()` will be resolved with this value.
* If no object is given, the promise is resolved with an empty `SweetAlertResult` object.
*/
function close(result?: SweetAlertResult): void
/**
* Gets the popup container which contains the backdrop and the popup itself.
*/
function getContainer(): HTMLElement | null
/**
* Gets the popup.
*/
function getPopup(): HTMLElement | null
/**
* Gets the popup title.
*/
function getTitle(): HTMLElement | null
/**
* Gets progress steps.
*/
function getProgressSteps(): HTMLElement | null
/**
* Gets the DOM element where the `html`/`text` parameter is rendered to.
*/
function getHtmlContainer(): HTMLElement | null
/**
* Gets the image.
*/
function getImage(): HTMLElement | null
/**
* Gets the close button.
*/
function getCloseButton(): HTMLButtonElement | null
/**
* Gets the icon.
*/
function getIcon(): HTMLElement | null
/**
* Gets the "Confirm" button.
*/
function getConfirmButton(): HTMLButtonElement | null
/**
* Gets the "Deny" button.
*/
function getDenyButton(): HTMLButtonElement | null
/**
* Gets the "Cancel" button.
*/
function getCancelButton(): HTMLButtonElement | null
/**
* Gets actions (buttons) wrapper.
*/
function getActions(): HTMLElement | null
/**
* Gets the popup footer.
*/
function getFooter(): HTMLElement | null
/**
* Gets the timer progress bar (see the `timerProgressBar` param).
*/
function getTimerProgressBar(): HTMLElement | null
/**
* Gets all focusable elements in the popup.
*/
function getFocusableElements(): readonly HTMLElement[]
/**
* Enables "Confirm" and "Cancel" buttons.
*/
function enableButtons(): void
/**
* Disables "Confirm" and "Cancel" buttons.
*/
function disableButtons(): void
/**
* Shows loader (spinner), this is useful with AJAX requests.
*
* By default the loader be shown instead of the "Confirm" button, but if you want
* another button to be replaced with a loader, just pass it like this:
* ```
* Swal.showLoading(Swal.getDenyButton())
* ```
*/
function showLoading(buttonToReplace?: HTMLButtonElement): void
/**
* Hides loader and shows back the button which was hidden by .showLoading()
*/
function hideLoading(): void
/**
* Determines if popup is in the loading state.
*/
function isLoading(): boolean
/**
* Clicks the "Confirm" button programmatically.
*/
function clickConfirm(): void
/**
* Clicks the "Deny" button programmatically.
*/
function clickDeny(): void
/**
* Clicks the "Cancel" button programmatically.
*/
function clickCancel(): void
/**
* Shows a validation message.
*
* @param validationMessage The validation message.
*/
function showValidationMessage(validationMessage: string): void
/**
* Hides validation message.
*/
function resetValidationMessage(): void
/**
* Gets the input DOM node, this method works with input parameter.
*/
function getInput(): HTMLInputElement | null
/**
* Disables the popup input. A disabled input element is unusable and un-clickable.
*/
function disableInput(): void
/**
* Enables the popup input.
*/
function enableInput(): void
/**
* Gets the validation message container.
*/
function getValidationMessage(): HTMLElement | null
/**
* If `timer` parameter is set, returns number of milliseconds of timer remained.
* Otherwise, returns undefined.
*/
function getTimerLeft(): number | undefined
/**
* Stop timer. Returns number of milliseconds of timer remained.
* If `timer` parameter isn't set, returns `undefined`.
*/
function stopTimer(): number | undefined
/**
* Resume timer. Returns number of milliseconds of timer remained.
* If `timer` parameter isn't set, returns `undefined`.
*/
function resumeTimer(): number | undefined
/**
* Toggle timer. Returns number of milliseconds of timer remained.
* If `timer` parameter isn't set, returns `undefined`.
*/
function toggleTimer(): number | undefined
/**
* Check if timer is running. Returns true if timer is running,
* and false is timer is paused / stopped.
* If `timer` parameter isn't set, returns `undefined`.
*/
function isTimerRunning(): boolean | undefined
/**
* Increase timer. Returns number of milliseconds of an updated timer.
* If `timer` parameter isn't set, returns `undefined`.
*
* @param n The number of milliseconds to add to the currect timer
*/
function increaseTimer(n: number): number | undefined
/**
* Determines if a given parameter name is valid.
*
* @param paramName The parameter to check
*/
function isValidParameter(paramName: string): paramName is keyof SweetAlertOptions
/**
* Determines if a given parameter name is valid for `Swal.update()` method.
*
* @param paramName The parameter to check
*/
function isUpdatableParameter(paramName: string): paramName is SweetAlertUpdatableParameters
/**
* Normalizes the arguments you can give to Swal.fire() in an object of type SweetAlertOptions.
*
* Example:
* ```
* Swal.argsToParams(['title', 'text']); //=> { title: 'title', text: 'text' }
* Swal.argsToParams([{ title: 'title', text: 'text' }]); //=> { title: 'title', text: 'text' }
* ```
*
* @param params The array of arguments to normalize.
*/
function argsToParams<T>(params: SweetAlertArrayOptions | readonly [SweetAlertOptions<T>]): SweetAlertOptions<T>
/**
* An enum of possible reasons that can explain an alert dismissal.
*/
enum DismissReason {
cancel,
backdrop,
close,
esc,
timer,
}
/**
* SweetAlert2's version
*/
const version: string
}
interface SweetAlertHideShowClass {
backdrop?: string | readonly string[]
icon?: string | readonly string[]
popup?: string | readonly string[]
}
type Awaited<T> = T extends Promise<infer U> ? U : T
type SyncOrAsync<T> = T | Promise<T> | { toPromise: () => T }
type ValueOrThunk<T> = T | (() => T)
export type SweetAlertArrayOptions = readonly [string?, string?, SweetAlertIcon?]
export type SweetAlertGrow = 'row' | 'column' | 'fullscreen' | false
export type SweetAlertHideClass = SweetAlertHideShowClass
export type SweetAlertShowClass = Readonly<SweetAlertHideShowClass>
export type SweetAlertIcon = 'success' | 'error' | 'warning' | 'info' | 'question'
export type SweetAlertInput =
| 'text'
| 'email'
| 'password'
| 'number'
| 'tel'
| 'range'
| 'textarea'
| 'select'
| 'radio'
| 'checkbox'
| 'file'
| 'url'
export type SweetAlertPosition =
| 'top'
| 'top-start'
| 'top-end'
| 'top-left'
| 'top-right'
| 'center'
| 'center-start'
| 'center-end'
| 'center-left'
| 'center-right'
| 'bottom'
| 'bottom-start'
| 'bottom-end'
| 'bottom-left'
| 'bottom-right'
export type SweetAlertUpdatableParameters =
| 'allowEscapeKey'
| 'allowOutsideClick'
| 'background'
| 'buttonsStyling'
| 'cancelButtonAriaLabel'
| 'cancelButtonColor'
| 'cancelButtonText'
| 'closeButtonAriaLabel'
| 'closeButtonHtml'
| 'confirmButtonAriaLabel'
| 'confirmButtonColor'
| 'confirmButtonText'
| 'currentProgressStep'
| 'customClass'
| 'denyButtonAriaLabel'
| 'denyButtonColor'
| 'denyButtonText'
| 'didClose'
| 'didDestroy'
| 'footer'
| 'hideClass'
| 'html'
| 'icon'
| 'iconColor'
| 'imageAlt'
| 'imageHeight'
| 'imageUrl'
| 'imageWidth'
| 'preConfirm'
| 'preDeny'
| 'progressSteps'
| 'reverseButtons'
| 'showCancelButton'
| 'showCloseButton'
| 'showConfirmButton'
| 'showDenyButton'
| 'text'
| 'title'
| 'titleText'
| 'willClose'
export interface SweetAlertCustomClass {
container?: string | readonly string[]
popup?: string | readonly string[]
title?: string | readonly string[]
closeButton?: string | readonly string[]
icon?: string | readonly string[]
image?: string | readonly string[]
htmlContainer?: string | readonly string[]
input?: string | readonly string[]
validationMessage?: string | readonly string[]
actions?: string | readonly string[]
confirmButton?: string | readonly string[]
denyButton?: string | readonly string[]
cancelButton?: string | readonly string[]
loader?: string | readonly string[]
footer?: string | readonly string[]
timerProgressBar?: string | readonly string[]
}
export interface SweetAlertResult<T = any> {
readonly isConfirmed: boolean
readonly isDenied: boolean
readonly isDismissed: boolean
readonly value?: T
readonly dismiss?: Swal.DismissReason
}
export interface SweetAlertOptions<PreConfirmResult = any, PreConfirmCallbackValue = any> {
/**
* The title of the popup, as HTML.
* It can either be added to the object under the key `title` or passed as the first parameter of `Swal.fire()`.
*
* @default ''
*/
title?: string | HTMLElement | JQuery
/**
* The title of the popup, as text. Useful to avoid HTML injection.
*
* @default ''
*/
titleText?: string
/**
* A description for the popup.
* If `text` and `html` parameters are provided in the same time, `html` will be used.
*
* @default ''
*/
text?: string
/**
* A HTML description for the popup.
* If `text` and `html` parameters are provided in the same time, `html` will be used.
*
* [Security] SweetAlert2 does NOT sanitize this parameter. It is the developer's responsibility
* to escape any user input when using the `html` option, so XSS attacks would be prevented.
*
* @default ''
*/
html?: string | HTMLElement | JQuery
/**
* The icon of the popup.
* SweetAlert2 comes with 5 built-in icons which will show a corresponding icon animation:
* `'warning'`, `'error'`, `'success'`, `'info'` and `'question'`.
* It can either be put to the object under the key `icon` or passed as the third parameter of `Swal.fire()`.
*
* @default undefined
*/
icon?: SweetAlertIcon
/**
* Use this to change the color of the icon.
*
* @default undefined
*/
iconColor?: string
/**
* The custom HTML content for an icon.
*
* Example:
* ```
* Swal.fire({
* icon: 'error',
* iconHtml: '<i class="fas fa-bug"></i>'
* })
* ```
*
* @default undefined
*/
iconHtml?: string
/**
* The footer of the popup, as HTML.
*
* @default ''
*/
footer?: string | HTMLElement | JQuery
/**
* The declarative <template> of the popup. All API prams can be set via
* `<swal-param name="..." value="..."></swal-param>`, e.g.
* `<swal-param name="toast" value="true"></swal-param>`
*
* Additionally, there are specialized elements for specific params:
* - `<swal-title>`
* - `<swal-html>`
* - `<swal-icon>`
* - `<swal-image>`
* - `<swal-input>`
* - `<swal-input-option>`
* - `<swal-button>`
* - `<swal-footer>`
*
* Example:
* ```html
* <template id="my-template">
* <swal-title>Are you sure?</swal-title>
* <swal-html>You won't be able to revert this!</swal-html>
*
* <swal-icon type="success"></swal-icon>
* <swal-image src="..." width="..." height="..." alt="..."></swal-image>
*
* <swal-input type="select" placeholder="..." label="..." value="...">
* <swal-input-option value="...">...</swal-input-option>
* </swal-input>
* <swal-param name="inputAttributes" value='{ "multiple": true }'></swal-param>
*
* <swal-button type="confirm" color="..." aria-label="...">Yes</swal-button>
* <swal-button type="cancel" color="..." aria-label="...">No</swal-button>
*
* <swal-footer>read more here</swal-footer>
* </template>
* ```
*
* ```
* Swal.fire({
* template: '#my-template'
* })
* ```
*
* @default undefined
*/
template?: string | HTMLTemplateElement
/**
* Whether or not SweetAlert2 should show a full screen click-to-dismiss backdrop.
* Either a boolean value or a css background value (hex, rgb, rgba, url, etc.)
*
* @default true
*/
backdrop?: boolean | string
/**
* Whether or not an alert should be treated as a toast notification.
* This option is normally coupled with the `position` and `timer` parameters.
* Toasts are NEVER autofocused.
*
* @default false
*/
toast?: boolean
/**
* The container element for adding popup into (query selector only).
*
* @default 'body'
*/
target?: string | HTMLElement
/**
* Input field type, can be `'text'`, `'email'`, `'password'`, `'number'`, `'tel'`, `'range'`, `'textarea'`,
* `'select'`, `'radio'`, `'checkbox'`, `'file'` and `'url'`.
*
* @default undefined
*/
input?: SweetAlertInput
/**
* Popup width, including paddings (`box-sizing: border-box`).
*
* @default undefined
*/
width?: number | string
/**
* Popup padding.
*
* @default undefined
*/
padding?: number | string
/**
* Color for title, content and footer (CSS `color` property). The default color is `#545454`.
*
* @default undefined
*/
color?: string
/**
* Popup background (CSS `background` property). The default background is `#fff`.
*
* @default undefined
*/
background?: string
/**
* Popup position
*
* @default 'center'
*/
position?: SweetAlertPosition
/**
* Popup grow direction
*
* @default false
*/
grow?: SweetAlertGrow
/**
* CSS classes for animations when showing a popup (fade in)
* @default { popup: 'swal2-show', backdrop: 'swal2-backdrop-show', icon: 'swal2-icon-show' }
*/
showClass?: SweetAlertShowClass
/**
* CSS classes for animations when hiding a popup (fade out)
* @default { popup: 'swal2-hide', backdrop: 'swal2-backdrop-hide', icon: 'swal2-icon-hide' }
*/
hideClass?: SweetAlertHideClass
/**
* A custom CSS class for the popup.
* If a string value is provided, the classname will be applied to the popup.
* If an object is provided, the classnames will be applied to the corresponding fields:
*
* Example:
* ```
* Swal.fire({
* customClass: {
* container: '...',
* popup: '...',
* title: '...',
* closeButton: '...',
* icon: '...',
* image: '...',
* input: '...',
* inputLabel: '...',
* validationMessage: '...',
* actions: '...',
* confirmButton: '...',
* denyButton: '...',
* cancelButton: '...',
* loader: '...',
* footer: '...',
* timerProgressBar: '...',
* }
* })
* ```
*
* @default {}
*/
customClass?: SweetAlertCustomClass
/**
* Auto close timer of the popup. Set in ms (milliseconds).
*
* @default undefined
*/
timer?: number
/**
* If set to `true`, the timer will have a progress bar at the bottom of a popup.
* Mostly, this feature is useful with toasts.
*
* @default false
*/
timerProgressBar?: boolean
/**
* By default, SweetAlert2 sets html's and body's CSS `height` to `auto !important`.
* If this behavior isn't compatible with your project's layout, set `heightAuto` to `false`.
*
* @default true
*/
heightAuto?: boolean
/**
* If set to `false`, the user can't dismiss the popup by clicking outside it.
* You can also pass a custom function returning a boolean value, e.g. if you want
* to disable outside clicks for the loading state of a popup.
*
* @default true
*/
allowOutsideClick?: ValueOrThunk<boolean>
/**
* If set to `false`, the user can't dismiss the popup by pressing the Escape key.
* You can also pass a custom function returning a boolean value, e.g. if you want
* to disable the escape key for the loading state of a popup.
*
* @default true
*/
allowEscapeKey?: ValueOrThunk<boolean>
/**
* If set to `false`, the user can't confirm the popup by pressing the Enter or Space keys,
* unless they manually focus the confirm button.
* You can also pass a custom function returning a boolean value.
*
* @default true
*/
allowEnterKey?: ValueOrThunk<boolean>
/**
* If set to `false`, SweetAlert2 will allow keydown events propagation to the document.
*
* @default true
*/
stopKeydownPropagation?: boolean
/**
* Useful for those who are using SweetAlert2 along with Bootstrap modals.
* By default keydownListenerCapture is `false` which means when a user hits `Esc`,
* both SweetAlert2 and Bootstrap modals will be closed.
* Set `keydownListenerCapture` to `true` to fix that behavior.
*
* @default false
*/
keydownListenerCapture?: boolean
/**
* If set to `false`, the "Confirm" button will not be shown.
* It can be useful when you're using custom HTML description.
*
* @default true
*/
showConfirmButton?: boolean
/**
* If set to `true`, the "Deny" button will be shown, which the user can click on to deny the popup.
*
* @default false
*/
showDenyButton?: boolean
/**
* If set to `true`, the "Cancel" button will be shown, which the user can click on to dismiss the popup.
*
* @default false
*/
showCancelButton?: boolean
/**
* Use this to change the text on the "Confirm" button.
*
* @default 'OK'
*/
confirmButtonText?: string
/**
* Use this to change the text on the "Confirm" button.
*
* @default 'No'
*/
denyButtonText?: string
/**
* Use this to change the text on the "Cancel" button.
*
* @default 'Cancel'
*/
cancelButtonText?: string
/**
* Use this to change the background color of the "Confirm" button.
*
* @default undefined
*/
confirmButtonColor?: string
/**
* Use this to change the background color of the "Deny" button.
*
* @default undefined
*/
denyButtonColor?: string
/**
* Use this to change the background color of the "Cancel" button.
*
* @default undefined
*/
cancelButtonColor?: string
/**
* Use this to change the `aria-label` for the "Confirm" button.
*
* @default ''
*/
confirmButtonAriaLabel?: string
/**
* Use this to change the `aria-label` for the "Deny" button.
*
* @default ''
*/
denyButtonAriaLabel?: string
/**
* Use this to change the `aria-label` for the "Cancel" button.
*
* @default ''
*/
cancelButtonAriaLabel?: string
/**
* Whether to apply the default SweetAlert2 styling to buttons.
* If you want to use your own classes (e.g. Bootstrap classes) set this parameter to `false`.
*
* @default true
*/
buttonsStyling?: boolean
/**
* Set to `true` if you want to invert default buttons positions.
*
* @default false
*/
reverseButtons?: boolean
/**
* Set to `false` if you want to focus the first element in tab order instead of the "Confirm" button by default.
*
* @default true
*/
focusConfirm?: boolean
/**
* Set to `true` if you want to focus the "Deny" button by default.
*
* @default false
*/
focusDeny?: boolean
/**
* Set to `true` if you want to focus the "Cancel" button by default.
*
* @default false
*/
focusCancel?: boolean
/**
* Set to `false` if you don't want to return the focus to the element that invoked the modal
* after the modal is closed.
*
* @default true
*/
returnFocus?: boolean
/**
* Set to `true` to show close button.
*
* @default false
*/
showCloseButton?: boolean
/**
* Use this to change the HTML content of the close button.
*
* @default '×'
*/
closeButtonHtml?: string
/**
* Use this to change the `aria-label` for the close button.
*
* @default 'Close this dialog'
*/
closeButtonAriaLabel?: string
/**
* Use this to change the HTML content of the loader.
*
* @default ''
*/
loaderHtml?: string
/**
* Set to `true` to disable buttons and show the loader instead of the Confirm button.
* Use it in combination with the `preConfirm` parameter.
*
* @default false
*/
showLoaderOnConfirm?: boolean
/**
* Set to `true` to disable buttons and show the loader instead of the Deny button.
* Use it in combination with the `preDeny` parameter.
*
* @default false
*/
showLoaderOnDeny?: boolean
/**
* Function to execute before confirming, may be async (Promise-returning) or sync.
* Returned (or resolved) value can be:
* - `false` to prevent a popup from closing
* - anything else to pass that value as the `result.value` of `Swal.fire()`
* - `undefined` to keep the default `result.value`
*
* Example:
* ```
* Swal.fire({
* title: 'Multiple inputs',
* html:
* '<input id="swal-input1" class="swal2-input">' +
* '<input id="swal-input2" class="swal2-input">',
* focusConfirm: false,
* preConfirm: () => [
* document.querySelector('#swal-input1').value,
* document.querySelector('#swal-input2').value
* ]
* }).then(result => Swal.fire(JSON.stringify(result));
* ```
*
* @default undefined
*/
preConfirm?(inputValue: PreConfirmCallbackValue): PreConfirmResult
/**
* Function to execute before denying, may be async (Promise-returning) or sync.
* Returned (or resolved) value can be:
* - `false` to prevent a popup from closing
* - anything else to pass that value as the `result.value` of `Swal.fire()`
* - `undefined` to keep the default `result.value`
*
* @default undefined
*/
preDeny?(value: any): SyncOrAsync<any | void>
/**
* Add an image to the popup. Should contain a string with the path or URL to the image.
*
* @default undefined
*/
imageUrl?: string
/**
* If imageUrl is set, you can specify imageWidth to describes image width.
*
* @default undefined
*/
imageWidth?: number | string
/**
* If imageUrl is set, you can specify imageHeight to describes image height.
*
* @default undefined
*/
imageHeight?: number | string
/**
* An alternative text for the custom image icon.
*
* @default ''
*/
imageAlt?: string
/**
* Input field label.
*
* @default ''
*/
inputLabel?: string
/**
* Input field placeholder.
*
* @default ''
*/
inputPlaceholder?: string
/**