@spectrum-web-components/dialog 1.0.0 → 1.1.0-beta.0

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