@spectrum-web-components/dialog 0.35.1-rc.34 → 0.35.1-rc.41

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