@spectrum-web-components/dialog 0.31.1-overlay.29 → 0.31.1-react.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,1294 @@
1
+ {
2
+ "schemaVersion": "1.0.0",
3
+ "readme": "",
4
+ "modules": [
5
+ {
6
+ "kind": "javascript-module",
7
+ "path": "sp-dialog-base.ts",
8
+ "declarations": [],
9
+ "exports": []
10
+ },
11
+ {
12
+ "kind": "javascript-module",
13
+ "path": "sp-dialog-wrapper.ts",
14
+ "declarations": [],
15
+ "exports": []
16
+ },
17
+ {
18
+ "kind": "javascript-module",
19
+ "path": "sp-dialog.ts",
20
+ "declarations": [],
21
+ "exports": []
22
+ },
23
+ {
24
+ "kind": "javascript-module",
25
+ "path": "src/Dialog.ts",
26
+ "declarations": [
27
+ {
28
+ "kind": "class",
29
+ "description": "",
30
+ "name": "Dialog",
31
+ "slots": [
32
+ {
33
+ "description": "Accepts a hero image to display at the top of the dialog",
34
+ "name": "hero"
35
+ },
36
+ {
37
+ "description": "Acts as the heading of the dialog. This should be an actual heading tag `<h1-6 />`",
38
+ "name": "heading"
39
+ },
40
+ {
41
+ "description": "Content not addressed to a specific slot will be interpreted as the main content of the dialog",
42
+ "name": ""
43
+ },
44
+ {
45
+ "description": "Content addressed to the `footer` will be placed below the main content and to the side of any `[slot='button']` content",
46
+ "name": "footer"
47
+ },
48
+ {
49
+ "description": "Button elements addressed to this slot may be placed below the content when not delivered in a fullscreen mode",
50
+ "name": "button"
51
+ }
52
+ ],
53
+ "members": [
54
+ {
55
+ "kind": "field",
56
+ "name": "closeButton",
57
+ "type": {
58
+ "text": "CloseButton | undefined"
59
+ }
60
+ },
61
+ {
62
+ "kind": "field",
63
+ "name": "contentElement",
64
+ "type": {
65
+ "text": "HTMLDivElement"
66
+ },
67
+ "privacy": "private"
68
+ },
69
+ {
70
+ "kind": "field",
71
+ "name": "error",
72
+ "type": {
73
+ "text": "boolean"
74
+ },
75
+ "privacy": "public",
76
+ "default": "false",
77
+ "attribute": "error",
78
+ "reflects": true
79
+ },
80
+ {
81
+ "kind": "field",
82
+ "name": "dismissable",
83
+ "type": {
84
+ "text": "boolean"
85
+ },
86
+ "privacy": "public",
87
+ "default": "false",
88
+ "attribute": "dismissable",
89
+ "reflects": true
90
+ },
91
+ {
92
+ "kind": "field",
93
+ "name": "hasFooter",
94
+ "type": {
95
+ "text": "boolean"
96
+ },
97
+ "privacy": "protected"
98
+ },
99
+ {
100
+ "kind": "field",
101
+ "name": "hasButtons",
102
+ "type": {
103
+ "text": "boolean"
104
+ },
105
+ "privacy": "protected"
106
+ },
107
+ {
108
+ "kind": "field",
109
+ "name": "hasHero",
110
+ "type": {
111
+ "text": "boolean"
112
+ },
113
+ "privacy": "protected"
114
+ },
115
+ {
116
+ "kind": "field",
117
+ "name": "noDivider",
118
+ "type": {
119
+ "text": "boolean"
120
+ },
121
+ "privacy": "public",
122
+ "default": "false",
123
+ "attribute": "no-divider",
124
+ "reflects": true
125
+ },
126
+ {
127
+ "kind": "field",
128
+ "name": "mode",
129
+ "type": {
130
+ "text": "'fullscreen' | 'fullscreenTakeover' | undefined"
131
+ },
132
+ "privacy": "public",
133
+ "attribute": "mode",
134
+ "reflects": true
135
+ },
136
+ {
137
+ "kind": "field",
138
+ "name": "size",
139
+ "type": {
140
+ "text": "'s' | 'm' | 'l' | undefined"
141
+ },
142
+ "privacy": "public",
143
+ "attribute": "size",
144
+ "reflects": true
145
+ },
146
+ {
147
+ "kind": "method",
148
+ "name": "close",
149
+ "privacy": "public",
150
+ "return": {
151
+ "type": {
152
+ "text": "void"
153
+ }
154
+ }
155
+ },
156
+ {
157
+ "kind": "method",
158
+ "name": "renderHero",
159
+ "privacy": "protected",
160
+ "return": {
161
+ "type": {
162
+ "text": "TemplateResult"
163
+ }
164
+ }
165
+ },
166
+ {
167
+ "kind": "method",
168
+ "name": "renderHeading",
169
+ "privacy": "protected",
170
+ "return": {
171
+ "type": {
172
+ "text": "TemplateResult"
173
+ }
174
+ }
175
+ },
176
+ {
177
+ "kind": "method",
178
+ "name": "renderContent",
179
+ "privacy": "protected",
180
+ "return": {
181
+ "type": {
182
+ "text": "TemplateResult"
183
+ }
184
+ }
185
+ },
186
+ {
187
+ "kind": "method",
188
+ "name": "renderFooter",
189
+ "privacy": "protected",
190
+ "return": {
191
+ "type": {
192
+ "text": "TemplateResult"
193
+ }
194
+ }
195
+ },
196
+ {
197
+ "kind": "method",
198
+ "name": "renderButtons",
199
+ "privacy": "protected",
200
+ "return": {
201
+ "type": {
202
+ "text": "TemplateResult"
203
+ }
204
+ }
205
+ },
206
+ {
207
+ "kind": "method",
208
+ "name": "renderDismiss",
209
+ "privacy": "protected",
210
+ "return": {
211
+ "type": {
212
+ "text": "TemplateResult"
213
+ }
214
+ }
215
+ },
216
+ {
217
+ "kind": "field",
218
+ "name": "shouldManageTabOrderForScrolling",
219
+ "privacy": "public"
220
+ },
221
+ {
222
+ "kind": "field",
223
+ "name": "instanceCount",
224
+ "type": {
225
+ "text": "number"
226
+ },
227
+ "static": true,
228
+ "default": "0"
229
+ },
230
+ {
231
+ "kind": "field",
232
+ "name": "labelledbyId",
233
+ "privacy": "private",
234
+ "default": "`sp-dialog-label-${Dialog.instanceCount++}`"
235
+ },
236
+ {
237
+ "kind": "field",
238
+ "name": "conditionLabelledby",
239
+ "type": {
240
+ "text": "() => void | undefined"
241
+ },
242
+ "privacy": "private"
243
+ },
244
+ {
245
+ "kind": "field",
246
+ "name": "conditionDescribedby",
247
+ "type": {
248
+ "text": "() => void | undefined"
249
+ },
250
+ "privacy": "private"
251
+ },
252
+ {
253
+ "kind": "method",
254
+ "name": "onHeadingSlotchange",
255
+ "privacy": "private",
256
+ "return": {
257
+ "type": {
258
+ "text": "void"
259
+ }
260
+ },
261
+ "parameters": [
262
+ {
263
+ "name": "{\n target,\n }",
264
+ "type": {
265
+ "text": "Event & { target: HTMLSlotElement }"
266
+ }
267
+ }
268
+ ]
269
+ },
270
+ {
271
+ "kind": "field",
272
+ "name": "describedbyId",
273
+ "privacy": "private",
274
+ "default": "`sp-dialog-description-${Dialog.instanceCount++}`"
275
+ },
276
+ {
277
+ "kind": "method",
278
+ "name": "onContentSlotChange",
279
+ "privacy": "protected",
280
+ "return": {
281
+ "type": {
282
+ "text": "void"
283
+ }
284
+ },
285
+ "parameters": [
286
+ {
287
+ "name": "{\n target,\n }",
288
+ "type": {
289
+ "text": "Event & { target: HTMLSlotElement }"
290
+ }
291
+ }
292
+ ]
293
+ }
294
+ ],
295
+ "events": [
296
+ {
297
+ "name": "close",
298
+ "type": {
299
+ "text": "Event"
300
+ },
301
+ "description": "Announces that the dialog has been closed."
302
+ }
303
+ ],
304
+ "attributes": [
305
+ {
306
+ "name": "error",
307
+ "type": {
308
+ "text": "boolean"
309
+ },
310
+ "default": "false",
311
+ "fieldName": "error"
312
+ },
313
+ {
314
+ "name": "dismissable",
315
+ "type": {
316
+ "text": "boolean"
317
+ },
318
+ "default": "false",
319
+ "fieldName": "dismissable"
320
+ },
321
+ {
322
+ "name": "no-divider",
323
+ "type": {
324
+ "text": "boolean"
325
+ },
326
+ "default": "false",
327
+ "fieldName": "noDivider"
328
+ },
329
+ {
330
+ "name": "mode",
331
+ "type": {
332
+ "text": "'fullscreen' | 'fullscreenTakeover' | undefined"
333
+ },
334
+ "fieldName": "mode"
335
+ },
336
+ {
337
+ "name": "size",
338
+ "type": {
339
+ "text": "'s' | 'm' | 'l' | undefined"
340
+ },
341
+ "fieldName": "size"
342
+ }
343
+ ],
344
+ "mixins": [
345
+ {
346
+ "name": "FocusVisiblePolyfillMixin",
347
+ "package": "@spectrum-web-components/shared"
348
+ },
349
+ {
350
+ "name": "ObserveSlotPresence",
351
+ "package": "@spectrum-web-components/shared"
352
+ }
353
+ ],
354
+ "superclass": {
355
+ "name": "SpectrumElement",
356
+ "package": "@spectrum-web-components/base"
357
+ },
358
+ "tagName": "sp-dialog",
359
+ "customElement": true
360
+ }
361
+ ],
362
+ "exports": [
363
+ {
364
+ "kind": "js",
365
+ "name": "Dialog",
366
+ "declaration": {
367
+ "name": "Dialog",
368
+ "module": "src/Dialog.ts"
369
+ }
370
+ }
371
+ ]
372
+ },
373
+ {
374
+ "kind": "javascript-module",
375
+ "path": "src/DialogBase.ts",
376
+ "declarations": [
377
+ {
378
+ "kind": "class",
379
+ "description": "",
380
+ "name": "DialogBase",
381
+ "slots": [
382
+ {
383
+ "description": "A Dialog element to display.",
384
+ "name": ""
385
+ }
386
+ ],
387
+ "members": [
388
+ {
389
+ "kind": "field",
390
+ "name": "dismissable",
391
+ "type": {
392
+ "text": "boolean"
393
+ },
394
+ "privacy": "public",
395
+ "default": "false",
396
+ "attribute": "dismissable",
397
+ "reflects": true
398
+ },
399
+ {
400
+ "kind": "field",
401
+ "name": "open",
402
+ "type": {
403
+ "text": "boolean"
404
+ },
405
+ "privacy": "public",
406
+ "default": "false",
407
+ "attribute": "open",
408
+ "reflects": true
409
+ },
410
+ {
411
+ "kind": "field",
412
+ "name": "mode",
413
+ "type": {
414
+ "text": "'fullscreen' | 'fullscreenTakeover' | undefined"
415
+ },
416
+ "privacy": "public",
417
+ "attribute": "mode",
418
+ "reflects": true
419
+ },
420
+ {
421
+ "kind": "field",
422
+ "name": "responsive",
423
+ "type": {
424
+ "text": "boolean"
425
+ },
426
+ "privacy": "public",
427
+ "default": "false",
428
+ "description": "When set to true, fills screens smaller than 350px high and 400px wide with the full dialog.",
429
+ "attribute": "responsive"
430
+ },
431
+ {
432
+ "kind": "field",
433
+ "name": "transitionPromise",
434
+ "privacy": "private"
435
+ },
436
+ {
437
+ "kind": "field",
438
+ "name": "resolveTransitionPromise",
439
+ "privacy": "private"
440
+ },
441
+ {
442
+ "kind": "field",
443
+ "name": "underlay",
444
+ "type": {
445
+ "text": "boolean"
446
+ },
447
+ "privacy": "public",
448
+ "default": "false",
449
+ "attribute": "underlay"
450
+ },
451
+ {
452
+ "kind": "field",
453
+ "name": "dialog",
454
+ "type": {
455
+ "text": "Dialog"
456
+ },
457
+ "privacy": "protected"
458
+ },
459
+ {
460
+ "kind": "method",
461
+ "name": "focus",
462
+ "privacy": "public",
463
+ "return": {
464
+ "type": {
465
+ "text": "Promise<void>"
466
+ }
467
+ }
468
+ },
469
+ {
470
+ "kind": "field",
471
+ "name": "animating",
472
+ "type": {
473
+ "text": "boolean"
474
+ },
475
+ "privacy": "private",
476
+ "default": "false"
477
+ },
478
+ {
479
+ "kind": "method",
480
+ "name": "overlayWillCloseCallback",
481
+ "privacy": "public",
482
+ "return": {
483
+ "type": {
484
+ "text": "boolean"
485
+ }
486
+ }
487
+ },
488
+ {
489
+ "kind": "method",
490
+ "name": "dismiss",
491
+ "privacy": "private",
492
+ "return": {
493
+ "type": {
494
+ "text": "void"
495
+ }
496
+ }
497
+ },
498
+ {
499
+ "kind": "method",
500
+ "name": "handleClose",
501
+ "privacy": "protected",
502
+ "return": {
503
+ "type": {
504
+ "text": "void"
505
+ }
506
+ },
507
+ "parameters": [
508
+ {
509
+ "name": "event",
510
+ "type": {
511
+ "text": "Event"
512
+ }
513
+ }
514
+ ]
515
+ },
516
+ {
517
+ "kind": "method",
518
+ "name": "close",
519
+ "privacy": "public",
520
+ "return": {
521
+ "type": {
522
+ "text": "void"
523
+ }
524
+ }
525
+ },
526
+ {
527
+ "kind": "method",
528
+ "name": "dispatchClosed",
529
+ "privacy": "private",
530
+ "return": {
531
+ "type": {
532
+ "text": "void"
533
+ }
534
+ }
535
+ },
536
+ {
537
+ "kind": "method",
538
+ "name": "handleUnderlayTransitionend",
539
+ "privacy": "protected",
540
+ "return": {
541
+ "type": {
542
+ "text": "void"
543
+ }
544
+ },
545
+ "parameters": [
546
+ {
547
+ "name": "event",
548
+ "type": {
549
+ "text": "TransitionEvent"
550
+ }
551
+ }
552
+ ]
553
+ },
554
+ {
555
+ "kind": "method",
556
+ "name": "handleModalTransitionend",
557
+ "privacy": "protected",
558
+ "return": {
559
+ "type": {
560
+ "text": "void"
561
+ }
562
+ }
563
+ },
564
+ {
565
+ "kind": "method",
566
+ "name": "renderDialog",
567
+ "privacy": "protected",
568
+ "return": {
569
+ "type": {
570
+ "text": "TemplateResult"
571
+ }
572
+ }
573
+ },
574
+ {
575
+ "kind": "method",
576
+ "name": "getUpdateComplete",
577
+ "privacy": "protected",
578
+ "return": {
579
+ "type": {
580
+ "text": "Promise<boolean>"
581
+ }
582
+ },
583
+ "description": "Bind the open/close transition into the update complete lifecycle so\nthat the overlay system can wait for it to be \"visibly ready\" before\nattempting to throw focus into the content contained herein. Not\nwaiting for this can cause small amounts of page scroll to happen\nwhile opening the Tray when focusable content is included: e.g. Menu\nelements whose selected Menu Item is not the first Menu Item."
584
+ }
585
+ ],
586
+ "events": [
587
+ {
588
+ "name": "close",
589
+ "type": {
590
+ "text": "Event"
591
+ },
592
+ "description": "Announces that the dialog has been closed."
593
+ }
594
+ ],
595
+ "attributes": [
596
+ {
597
+ "name": "dismissable",
598
+ "type": {
599
+ "text": "boolean"
600
+ },
601
+ "default": "false",
602
+ "fieldName": "dismissable"
603
+ },
604
+ {
605
+ "name": "open",
606
+ "type": {
607
+ "text": "boolean"
608
+ },
609
+ "default": "false",
610
+ "fieldName": "open"
611
+ },
612
+ {
613
+ "name": "mode",
614
+ "type": {
615
+ "text": "'fullscreen' | 'fullscreenTakeover' | undefined"
616
+ },
617
+ "fieldName": "mode"
618
+ },
619
+ {
620
+ "name": "responsive",
621
+ "type": {
622
+ "text": "boolean"
623
+ },
624
+ "default": "false",
625
+ "description": "When set to true, fills screens smaller than 350px high and 400px wide with the full dialog.",
626
+ "fieldName": "responsive"
627
+ },
628
+ {
629
+ "name": "underlay",
630
+ "type": {
631
+ "text": "boolean"
632
+ },
633
+ "default": "false",
634
+ "fieldName": "underlay"
635
+ }
636
+ ],
637
+ "mixins": [
638
+ {
639
+ "name": "FocusVisiblePolyfillMixin",
640
+ "package": "@spectrum-web-components/shared"
641
+ }
642
+ ],
643
+ "superclass": {
644
+ "name": "SpectrumElement",
645
+ "package": "@spectrum-web-components/base"
646
+ },
647
+ "tagName": "sp-dialog-base",
648
+ "customElement": true
649
+ }
650
+ ],
651
+ "exports": [
652
+ {
653
+ "kind": "js",
654
+ "name": "DialogBase",
655
+ "declaration": {
656
+ "name": "DialogBase",
657
+ "module": "src/DialogBase.ts"
658
+ }
659
+ }
660
+ ]
661
+ },
662
+ {
663
+ "kind": "javascript-module",
664
+ "path": "src/DialogWrapper.ts",
665
+ "declarations": [
666
+ {
667
+ "kind": "class",
668
+ "description": "",
669
+ "name": "DialogWrapper",
670
+ "slots": [
671
+ {
672
+ "description": "content for the dialog",
673
+ "name": ""
674
+ }
675
+ ],
676
+ "members": [
677
+ {
678
+ "kind": "field",
679
+ "name": "error",
680
+ "type": {
681
+ "text": "boolean"
682
+ },
683
+ "privacy": "public",
684
+ "default": "false",
685
+ "attribute": "error",
686
+ "reflects": true
687
+ },
688
+ {
689
+ "kind": "field",
690
+ "name": "cancelLabel",
691
+ "type": {
692
+ "text": "string"
693
+ },
694
+ "privacy": "public",
695
+ "default": "''",
696
+ "attribute": "cancel-label"
697
+ },
698
+ {
699
+ "kind": "field",
700
+ "name": "confirmLabel",
701
+ "type": {
702
+ "text": "string"
703
+ },
704
+ "privacy": "public",
705
+ "default": "''",
706
+ "attribute": "confirm-label"
707
+ },
708
+ {
709
+ "kind": "field",
710
+ "name": "footer",
711
+ "type": {
712
+ "text": "string"
713
+ },
714
+ "privacy": "public",
715
+ "default": "''",
716
+ "attribute": "footer"
717
+ },
718
+ {
719
+ "kind": "field",
720
+ "name": "hero",
721
+ "type": {
722
+ "text": "string"
723
+ },
724
+ "privacy": "public",
725
+ "default": "''",
726
+ "attribute": "hero"
727
+ },
728
+ {
729
+ "kind": "field",
730
+ "name": "heroLabel",
731
+ "type": {
732
+ "text": "string"
733
+ },
734
+ "privacy": "public",
735
+ "default": "''",
736
+ "attribute": "hero-label"
737
+ },
738
+ {
739
+ "kind": "field",
740
+ "name": "noDivider",
741
+ "type": {
742
+ "text": "boolean"
743
+ },
744
+ "privacy": "public",
745
+ "default": "false",
746
+ "attribute": "no-divider",
747
+ "reflects": true
748
+ },
749
+ {
750
+ "kind": "field",
751
+ "name": "size",
752
+ "type": {
753
+ "text": "'s' | 'm' | 'l' | undefined"
754
+ },
755
+ "privacy": "public",
756
+ "attribute": "size",
757
+ "reflects": true
758
+ },
759
+ {
760
+ "kind": "field",
761
+ "name": "secondaryLabel",
762
+ "type": {
763
+ "text": "string"
764
+ },
765
+ "privacy": "public",
766
+ "default": "''",
767
+ "attribute": "secondary-label"
768
+ },
769
+ {
770
+ "kind": "field",
771
+ "name": "headline",
772
+ "type": {
773
+ "text": "string"
774
+ },
775
+ "privacy": "public",
776
+ "default": "''",
777
+ "attribute": "headline"
778
+ },
779
+ {
780
+ "kind": "field",
781
+ "name": "headlineVisibility",
782
+ "type": {
783
+ "text": "'none' | undefined"
784
+ },
785
+ "privacy": "public",
786
+ "attribute": "headline-visibility"
787
+ },
788
+ {
789
+ "kind": "field",
790
+ "name": "dialog",
791
+ "type": {
792
+ "text": "Dialog"
793
+ },
794
+ "privacy": "protected",
795
+ "inheritedFrom": {
796
+ "name": "DialogBase",
797
+ "module": "src/DialogBase.ts"
798
+ }
799
+ },
800
+ {
801
+ "kind": "method",
802
+ "name": "clickSecondary",
803
+ "privacy": "private",
804
+ "return": {
805
+ "type": {
806
+ "text": "void"
807
+ }
808
+ }
809
+ },
810
+ {
811
+ "kind": "method",
812
+ "name": "clickCancel",
813
+ "privacy": "private",
814
+ "return": {
815
+ "type": {
816
+ "text": "void"
817
+ }
818
+ }
819
+ },
820
+ {
821
+ "kind": "method",
822
+ "name": "clickConfirm",
823
+ "privacy": "private",
824
+ "return": {
825
+ "type": {
826
+ "text": "void"
827
+ }
828
+ }
829
+ },
830
+ {
831
+ "kind": "method",
832
+ "name": "renderDialog",
833
+ "privacy": "protected",
834
+ "return": {
835
+ "type": {
836
+ "text": "TemplateResult"
837
+ }
838
+ },
839
+ "inheritedFrom": {
840
+ "name": "DialogBase",
841
+ "module": "src/DialogBase.ts"
842
+ }
843
+ },
844
+ {
845
+ "kind": "field",
846
+ "name": "dismissable",
847
+ "type": {
848
+ "text": "boolean"
849
+ },
850
+ "privacy": "public",
851
+ "default": "false",
852
+ "attribute": "dismissable",
853
+ "reflects": true,
854
+ "inheritedFrom": {
855
+ "name": "DialogBase",
856
+ "module": "src/DialogBase.ts"
857
+ }
858
+ },
859
+ {
860
+ "kind": "field",
861
+ "name": "open",
862
+ "type": {
863
+ "text": "boolean"
864
+ },
865
+ "privacy": "public",
866
+ "default": "false",
867
+ "attribute": "open",
868
+ "reflects": true,
869
+ "inheritedFrom": {
870
+ "name": "DialogBase",
871
+ "module": "src/DialogBase.ts"
872
+ }
873
+ },
874
+ {
875
+ "kind": "field",
876
+ "name": "mode",
877
+ "type": {
878
+ "text": "'fullscreen' | 'fullscreenTakeover' | undefined"
879
+ },
880
+ "privacy": "public",
881
+ "attribute": "mode",
882
+ "reflects": true,
883
+ "inheritedFrom": {
884
+ "name": "DialogBase",
885
+ "module": "src/DialogBase.ts"
886
+ }
887
+ },
888
+ {
889
+ "kind": "field",
890
+ "name": "responsive",
891
+ "type": {
892
+ "text": "boolean"
893
+ },
894
+ "privacy": "public",
895
+ "default": "false",
896
+ "description": "When set to true, fills screens smaller than 350px high and 400px wide with the full dialog.",
897
+ "attribute": "responsive",
898
+ "inheritedFrom": {
899
+ "name": "DialogBase",
900
+ "module": "src/DialogBase.ts"
901
+ }
902
+ },
903
+ {
904
+ "kind": "field",
905
+ "name": "transitionPromise",
906
+ "privacy": "private",
907
+ "inheritedFrom": {
908
+ "name": "DialogBase",
909
+ "module": "src/DialogBase.ts"
910
+ }
911
+ },
912
+ {
913
+ "kind": "field",
914
+ "name": "resolveTransitionPromise",
915
+ "privacy": "private",
916
+ "inheritedFrom": {
917
+ "name": "DialogBase",
918
+ "module": "src/DialogBase.ts"
919
+ }
920
+ },
921
+ {
922
+ "kind": "field",
923
+ "name": "underlay",
924
+ "type": {
925
+ "text": "boolean"
926
+ },
927
+ "privacy": "public",
928
+ "default": "false",
929
+ "attribute": "underlay",
930
+ "inheritedFrom": {
931
+ "name": "DialogBase",
932
+ "module": "src/DialogBase.ts"
933
+ }
934
+ },
935
+ {
936
+ "kind": "method",
937
+ "name": "focus",
938
+ "privacy": "public",
939
+ "return": {
940
+ "type": {
941
+ "text": "Promise<void>"
942
+ }
943
+ },
944
+ "inheritedFrom": {
945
+ "name": "DialogBase",
946
+ "module": "src/DialogBase.ts"
947
+ }
948
+ },
949
+ {
950
+ "kind": "field",
951
+ "name": "animating",
952
+ "type": {
953
+ "text": "boolean"
954
+ },
955
+ "privacy": "private",
956
+ "default": "false",
957
+ "inheritedFrom": {
958
+ "name": "DialogBase",
959
+ "module": "src/DialogBase.ts"
960
+ }
961
+ },
962
+ {
963
+ "kind": "method",
964
+ "name": "overlayWillCloseCallback",
965
+ "privacy": "public",
966
+ "return": {
967
+ "type": {
968
+ "text": "boolean"
969
+ }
970
+ },
971
+ "inheritedFrom": {
972
+ "name": "DialogBase",
973
+ "module": "src/DialogBase.ts"
974
+ }
975
+ },
976
+ {
977
+ "kind": "method",
978
+ "name": "dismiss",
979
+ "privacy": "private",
980
+ "return": {
981
+ "type": {
982
+ "text": "void"
983
+ }
984
+ },
985
+ "inheritedFrom": {
986
+ "name": "DialogBase",
987
+ "module": "src/DialogBase.ts"
988
+ }
989
+ },
990
+ {
991
+ "kind": "method",
992
+ "name": "handleClose",
993
+ "privacy": "protected",
994
+ "return": {
995
+ "type": {
996
+ "text": "void"
997
+ }
998
+ },
999
+ "parameters": [
1000
+ {
1001
+ "name": "event",
1002
+ "type": {
1003
+ "text": "Event"
1004
+ }
1005
+ }
1006
+ ],
1007
+ "inheritedFrom": {
1008
+ "name": "DialogBase",
1009
+ "module": "src/DialogBase.ts"
1010
+ }
1011
+ },
1012
+ {
1013
+ "kind": "method",
1014
+ "name": "close",
1015
+ "privacy": "public",
1016
+ "return": {
1017
+ "type": {
1018
+ "text": "void"
1019
+ }
1020
+ },
1021
+ "inheritedFrom": {
1022
+ "name": "DialogBase",
1023
+ "module": "src/DialogBase.ts"
1024
+ }
1025
+ },
1026
+ {
1027
+ "kind": "method",
1028
+ "name": "dispatchClosed",
1029
+ "privacy": "private",
1030
+ "return": {
1031
+ "type": {
1032
+ "text": "void"
1033
+ }
1034
+ },
1035
+ "inheritedFrom": {
1036
+ "name": "DialogBase",
1037
+ "module": "src/DialogBase.ts"
1038
+ }
1039
+ },
1040
+ {
1041
+ "kind": "method",
1042
+ "name": "handleUnderlayTransitionend",
1043
+ "privacy": "protected",
1044
+ "return": {
1045
+ "type": {
1046
+ "text": "void"
1047
+ }
1048
+ },
1049
+ "parameters": [
1050
+ {
1051
+ "name": "event",
1052
+ "type": {
1053
+ "text": "TransitionEvent"
1054
+ }
1055
+ }
1056
+ ],
1057
+ "inheritedFrom": {
1058
+ "name": "DialogBase",
1059
+ "module": "src/DialogBase.ts"
1060
+ }
1061
+ },
1062
+ {
1063
+ "kind": "method",
1064
+ "name": "handleModalTransitionend",
1065
+ "privacy": "protected",
1066
+ "return": {
1067
+ "type": {
1068
+ "text": "void"
1069
+ }
1070
+ },
1071
+ "inheritedFrom": {
1072
+ "name": "DialogBase",
1073
+ "module": "src/DialogBase.ts"
1074
+ }
1075
+ },
1076
+ {
1077
+ "kind": "method",
1078
+ "name": "getUpdateComplete",
1079
+ "privacy": "protected",
1080
+ "return": {
1081
+ "type": {
1082
+ "text": "Promise<boolean>"
1083
+ }
1084
+ },
1085
+ "description": "Bind the open/close transition into the update complete lifecycle so\nthat the overlay system can wait for it to be \"visibly ready\" before\nattempting to throw focus into the content contained herein. Not\nwaiting for this can cause small amounts of page scroll to happen\nwhile opening the Tray when focusable content is included: e.g. Menu\nelements whose selected Menu Item is not the first Menu Item.",
1086
+ "inheritedFrom": {
1087
+ "name": "DialogBase",
1088
+ "module": "src/DialogBase.ts"
1089
+ }
1090
+ }
1091
+ ],
1092
+ "events": [
1093
+ {
1094
+ "name": "secondary",
1095
+ "type": {
1096
+ "text": "Event"
1097
+ },
1098
+ "description": "Announces that the \"secondary\" button has been clicked."
1099
+ },
1100
+ {
1101
+ "name": "cancel",
1102
+ "type": {
1103
+ "text": "Event"
1104
+ },
1105
+ "description": "Announces that the \"cancel\" button has been clicked."
1106
+ },
1107
+ {
1108
+ "name": "confirm",
1109
+ "type": {
1110
+ "text": "Event"
1111
+ },
1112
+ "description": "Announces that the \"confirm\" button has been clicked."
1113
+ },
1114
+ {
1115
+ "name": "close",
1116
+ "type": {
1117
+ "text": "Event"
1118
+ },
1119
+ "description": "Announces that the dialog has been closed.",
1120
+ "inheritedFrom": {
1121
+ "name": "DialogBase",
1122
+ "module": "src/DialogBase.ts"
1123
+ }
1124
+ }
1125
+ ],
1126
+ "attributes": [
1127
+ {
1128
+ "name": "error",
1129
+ "type": {
1130
+ "text": "boolean"
1131
+ },
1132
+ "default": "false",
1133
+ "fieldName": "error"
1134
+ },
1135
+ {
1136
+ "name": "cancel-label",
1137
+ "type": {
1138
+ "text": "string"
1139
+ },
1140
+ "default": "''",
1141
+ "fieldName": "cancelLabel"
1142
+ },
1143
+ {
1144
+ "name": "confirm-label",
1145
+ "type": {
1146
+ "text": "string"
1147
+ },
1148
+ "default": "''",
1149
+ "fieldName": "confirmLabel"
1150
+ },
1151
+ {
1152
+ "name": "footer",
1153
+ "type": {
1154
+ "text": "string"
1155
+ },
1156
+ "default": "''",
1157
+ "fieldName": "footer"
1158
+ },
1159
+ {
1160
+ "name": "hero",
1161
+ "type": {
1162
+ "text": "string"
1163
+ },
1164
+ "default": "''",
1165
+ "fieldName": "hero"
1166
+ },
1167
+ {
1168
+ "name": "hero-label",
1169
+ "type": {
1170
+ "text": "string"
1171
+ },
1172
+ "default": "''",
1173
+ "fieldName": "heroLabel"
1174
+ },
1175
+ {
1176
+ "name": "no-divider",
1177
+ "type": {
1178
+ "text": "boolean"
1179
+ },
1180
+ "default": "false",
1181
+ "fieldName": "noDivider"
1182
+ },
1183
+ {
1184
+ "name": "size",
1185
+ "type": {
1186
+ "text": "'s' | 'm' | 'l' | undefined"
1187
+ },
1188
+ "fieldName": "size"
1189
+ },
1190
+ {
1191
+ "name": "secondary-label",
1192
+ "type": {
1193
+ "text": "string"
1194
+ },
1195
+ "default": "''",
1196
+ "fieldName": "secondaryLabel"
1197
+ },
1198
+ {
1199
+ "name": "headline",
1200
+ "type": {
1201
+ "text": "string"
1202
+ },
1203
+ "default": "''",
1204
+ "fieldName": "headline"
1205
+ },
1206
+ {
1207
+ "name": "headline-visibility",
1208
+ "type": {
1209
+ "text": "'none' | undefined"
1210
+ },
1211
+ "fieldName": "headlineVisibility"
1212
+ },
1213
+ {
1214
+ "name": "dismissable",
1215
+ "type": {
1216
+ "text": "boolean"
1217
+ },
1218
+ "default": "false",
1219
+ "fieldName": "dismissable",
1220
+ "inheritedFrom": {
1221
+ "name": "DialogBase",
1222
+ "module": "src/DialogBase.ts"
1223
+ }
1224
+ },
1225
+ {
1226
+ "name": "open",
1227
+ "type": {
1228
+ "text": "boolean"
1229
+ },
1230
+ "default": "false",
1231
+ "fieldName": "open",
1232
+ "inheritedFrom": {
1233
+ "name": "DialogBase",
1234
+ "module": "src/DialogBase.ts"
1235
+ }
1236
+ },
1237
+ {
1238
+ "name": "mode",
1239
+ "type": {
1240
+ "text": "'fullscreen' | 'fullscreenTakeover' | undefined"
1241
+ },
1242
+ "fieldName": "mode",
1243
+ "inheritedFrom": {
1244
+ "name": "DialogBase",
1245
+ "module": "src/DialogBase.ts"
1246
+ }
1247
+ },
1248
+ {
1249
+ "name": "responsive",
1250
+ "type": {
1251
+ "text": "boolean"
1252
+ },
1253
+ "default": "false",
1254
+ "description": "When set to true, fills screens smaller than 350px high and 400px wide with the full dialog.",
1255
+ "fieldName": "responsive",
1256
+ "inheritedFrom": {
1257
+ "name": "DialogBase",
1258
+ "module": "src/DialogBase.ts"
1259
+ }
1260
+ },
1261
+ {
1262
+ "name": "underlay",
1263
+ "type": {
1264
+ "text": "boolean"
1265
+ },
1266
+ "default": "false",
1267
+ "fieldName": "underlay",
1268
+ "inheritedFrom": {
1269
+ "name": "DialogBase",
1270
+ "module": "src/DialogBase.ts"
1271
+ }
1272
+ }
1273
+ ],
1274
+ "superclass": {
1275
+ "name": "DialogBase",
1276
+ "module": "/src/DialogBase.js"
1277
+ },
1278
+ "tagName": "sp-dialog-wrapper",
1279
+ "customElement": true
1280
+ }
1281
+ ],
1282
+ "exports": [
1283
+ {
1284
+ "kind": "js",
1285
+ "name": "DialogWrapper",
1286
+ "declaration": {
1287
+ "name": "DialogWrapper",
1288
+ "module": "src/DialogWrapper.ts"
1289
+ }
1290
+ }
1291
+ ]
1292
+ }
1293
+ ]
1294
+ }