@spectrum-web-components/overlay 0.47.2 → 0.48.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 +7 -7
  2. package/custom-elements.json +0 -3345
package/custom-elements.json DELETED
@@ -1,3345 +0,0 @@
1
- {
2
- "schemaVersion": "1.0.0",
3
- "readme": "",
4
- "modules": [
5
- {
6
- "kind": "javascript-module",
7
- "path": "sp-overlay.js",
8
- "declarations": [],
9
- "exports": [
10
- {
11
- "kind": "custom-element-definition",
12
- "name": "sp-overlay",
13
- "declaration": {
14
- "name": "Overlay",
15
- "module": "/src/Overlay.js"
16
- }
17
- }
18
- ]
19
- },
20
- {
21
- "kind": "javascript-module",
22
- "path": "overlay-trigger.js",
23
- "declarations": [],
24
- "exports": [
25
- {
26
- "kind": "custom-element-definition",
27
- "name": "overlay-trigger",
28
- "declaration": {
29
- "name": "OverlayTrigger",
30
- "module": "/src/OverlayTrigger.js"
31
- }
32
- }
33
- ]
34
- },
35
- {
36
- "kind": "javascript-module",
37
- "path": "sync/overlay-trigger.js",
38
- "declarations": [],
39
- "exports": [
40
- {
41
- "kind": "js",
42
- "name": "OverlayTrigger",
43
- "declaration": {
44
- "name": "OverlayTrigger",
45
- "module": "sync/overlay-trigger.js"
46
- }
47
- },
48
- {
49
- "kind": "js",
50
- "name": "OverlayOptionsV1",
51
- "declaration": {
52
- "name": "OverlayOptionsV1",
53
- "module": "sync/overlay-trigger.js"
54
- }
55
- },
56
- {
57
- "kind": "js",
58
- "name": "TriggerInteractions",
59
- "declaration": {
60
- "name": "TriggerInteractions",
61
- "module": "sync/overlay-trigger.js"
62
- }
63
- }
64
- ]
65
- },
66
- {
67
- "kind": "javascript-module",
68
- "path": "src/AbstractOverlay.js",
69
- "declarations": [
70
- {
71
- "kind": "variable",
72
- "name": "overlayTimer",
73
- "default": "new OverlayTimer()"
74
- },
75
- {
76
- "kind": "function",
77
- "name": "noop",
78
- "return": {
79
- "type": {
80
- "text": "void"
81
- }
82
- }
83
- },
84
- {
85
- "kind": "function",
86
- "name": "guaranteedAllTransitionend",
87
- "return": {
88
- "type": {
89
- "text": "void"
90
- }
91
- },
92
- "parameters": [
93
- {
94
- "name": "el",
95
- "type": {
96
- "text": "HTMLElement"
97
- },
98
- "description": "Target of the \"transition\" listeners."
99
- },
100
- {
101
- "name": "action",
102
- "type": {
103
- "text": "Function"
104
- },
105
- "description": "Method to trigger the \"transition\"."
106
- },
107
- {
108
- "name": "cb",
109
- "type": {
110
- "text": "Function"
111
- },
112
- "description": "Callback to trigger when the \"transition\" has ended."
113
- }
114
- ],
115
- "description": "Apply a \"transitionend\" listener to an element that may not transition but\nguarantee the callback will be fired either way."
116
- },
117
- {
118
- "kind": "function",
119
- "name": "nextFrame",
120
- "return": {
121
- "type": {
122
- "text": "Promise<void>"
123
- }
124
- }
125
- },
126
- {
127
- "kind": "class",
128
- "description": "Abstract Overlay base class so that property tyings and imperative API\ninterfaces can be held separate from the actual class definition.",
129
- "name": "AbstractOverlay",
130
- "members": [
131
- {
132
- "kind": "method",
133
- "name": "applyFocus",
134
- "privacy": "protected",
135
- "return": {
136
- "type": {
137
- "text": "Promise<void>"
138
- }
139
- },
140
- "parameters": [
141
- {
142
- "name": "_targetOpenState",
143
- "type": {
144
- "text": "boolean"
145
- }
146
- },
147
- {
148
- "name": "_focusEl",
149
- "type": {
150
- "text": "HTMLElement | null"
151
- }
152
- }
153
- ]
154
- },
155
- {
156
- "kind": "field",
157
- "name": "delayed",
158
- "type": {
159
- "text": "boolean"
160
- }
161
- },
162
- {
163
- "kind": "field",
164
- "name": "dialogEl",
165
- "type": {
166
- "text": "HTMLDialogElement & {\n showPopover(): void;\n hidePopover(): void;\n }"
167
- }
168
- },
169
- {
170
- "kind": "field",
171
- "name": "disabled",
172
- "type": {
173
- "text": "boolean"
174
- }
175
- },
176
- {
177
- "kind": "field",
178
- "name": "dispose",
179
- "default": "noop"
180
- },
181
- {
182
- "kind": "field",
183
- "name": "elementResolver",
184
- "type": {
185
- "text": "ElementResolutionController"
186
- },
187
- "privacy": "protected"
188
- },
189
- {
190
- "kind": "field",
191
- "name": "_elementResolver",
192
- "type": {
193
- "text": "ElementResolutionController"
194
- },
195
- "privacy": "protected"
196
- },
197
- {
198
- "kind": "method",
199
- "name": "ensureOnDOM",
200
- "privacy": "protected",
201
- "return": {
202
- "type": {
203
- "text": "Promise<void>"
204
- }
205
- },
206
- "parameters": [
207
- {
208
- "name": "_targetOpenState",
209
- "type": {
210
- "text": "boolean"
211
- }
212
- }
213
- ]
214
- },
215
- {
216
- "kind": "field",
217
- "name": "elements",
218
- "type": {
219
- "text": "OpenableElement[]"
220
- }
221
- },
222
- {
223
- "kind": "method",
224
- "name": "makeTransition",
225
- "privacy": "protected",
226
- "return": {
227
- "type": {
228
- "text": "Promise<HTMLElement | null>"
229
- }
230
- },
231
- "parameters": [
232
- {
233
- "name": "_targetOpenState",
234
- "type": {
235
- "text": "boolean"
236
- }
237
- }
238
- ]
239
- },
240
- {
241
- "kind": "method",
242
- "name": "manageDelay",
243
- "privacy": "protected",
244
- "return": {
245
- "type": {
246
- "text": "Promise<void>"
247
- }
248
- },
249
- "parameters": [
250
- {
251
- "name": "_targetOpenState",
252
- "type": {
253
- "text": "boolean"
254
- }
255
- }
256
- ]
257
- },
258
- {
259
- "kind": "method",
260
- "name": "manageDialogOpen",
261
- "privacy": "protected",
262
- "return": {
263
- "type": {
264
- "text": "Promise<void>"
265
- }
266
- }
267
- },
268
- {
269
- "kind": "method",
270
- "name": "managePopoverOpen",
271
- "privacy": "protected",
272
- "return": {
273
- "type": {
274
- "text": "Promise<void>"
275
- }
276
- }
277
- },
278
- {
279
- "kind": "method",
280
- "name": "managePosition",
281
- "privacy": "protected",
282
- "return": {
283
- "type": {
284
- "text": "void"
285
- }
286
- }
287
- },
288
- {
289
- "kind": "field",
290
- "name": "offset",
291
- "type": {
292
- "text": "number | [number, number]"
293
- },
294
- "privacy": "protected",
295
- "default": "0"
296
- },
297
- {
298
- "kind": "field",
299
- "name": "open",
300
- "type": {
301
- "text": "boolean"
302
- }
303
- },
304
- {
305
- "kind": "field",
306
- "name": "placement",
307
- "type": {
308
- "text": "Placement | undefined"
309
- }
310
- },
311
- {
312
- "kind": "field",
313
- "name": "placementController",
314
- "type": {
315
- "text": "PlacementController"
316
- },
317
- "privacy": "protected"
318
- },
319
- {
320
- "kind": "field",
321
- "name": "_placementController",
322
- "type": {
323
- "text": "PlacementController"
324
- },
325
- "privacy": "protected"
326
- },
327
- {
328
- "kind": "field",
329
- "name": "receivesFocus",
330
- "type": {
331
- "text": "'true' | 'false' | 'auto'"
332
- }
333
- },
334
- {
335
- "kind": "method",
336
- "name": "requestSlottable",
337
- "privacy": "protected",
338
- "return": {
339
- "type": {
340
- "text": "void"
341
- }
342
- }
343
- },
344
- {
345
- "kind": "method",
346
- "name": "returnFocus",
347
- "privacy": "protected",
348
- "return": {
349
- "type": {
350
- "text": "void"
351
- }
352
- }
353
- },
354
- {
355
- "kind": "field",
356
- "name": "state",
357
- "type": {
358
- "text": "OverlayState"
359
- }
360
- },
361
- {
362
- "kind": "field",
363
- "name": "_state",
364
- "type": {
365
- "text": "OverlayState"
366
- },
367
- "privacy": "protected"
368
- },
369
- {
370
- "kind": "field",
371
- "name": "triggerElement",
372
- "type": {
373
- "text": "HTMLElement | VirtualTrigger | null"
374
- }
375
- },
376
- {
377
- "kind": "field",
378
- "name": "type",
379
- "type": {
380
- "text": "OverlayTypes"
381
- }
382
- },
383
- {
384
- "kind": "field",
385
- "name": "willPreventClose",
386
- "type": {
387
- "text": "boolean"
388
- },
389
- "default": "false"
390
- },
391
- {
392
- "kind": "method",
393
- "name": "manuallyKeepOpen",
394
- "privacy": "public",
395
- "return": {
396
- "type": {
397
- "text": "void"
398
- }
399
- }
400
- },
401
- {
402
- "kind": "method",
403
- "name": "open",
404
- "privacy": "public",
405
- "static": true,
406
- "return": {
407
- "type": {
408
- "text": "Promise<() => void>"
409
- }
410
- },
411
- "parameters": [
412
- {
413
- "name": "trigger",
414
- "type": {
415
- "text": "HTMLElement"
416
- }
417
- },
418
- {
419
- "name": "interaction",
420
- "type": {
421
- "text": "TriggerInteractionsV1"
422
- }
423
- },
424
- {
425
- "name": "content",
426
- "type": {
427
- "text": "HTMLElement"
428
- }
429
- },
430
- {
431
- "name": "optionsV1",
432
- "type": {
433
- "text": "OverlayOptionsV1"
434
- }
435
- }
436
- ],
437
- "description": "Overloaded imperative API entry point that allows for both the pre-0.37.0\nargument signature as well as the post-0.37.0 signature. This allows for\nconsumers to continue to leverage it as they had been in previous releases\nwhile also surfacing the more feature-rich API that has been made available."
438
- },
439
- {
440
- "kind": "method",
441
- "name": "open",
442
- "privacy": "public",
443
- "static": true,
444
- "return": {
445
- "type": {
446
- "text": "Promise<Overlay>"
447
- }
448
- },
449
- "parameters": [
450
- {
451
- "name": "content",
452
- "type": {
453
- "text": "HTMLElement"
454
- }
455
- },
456
- {
457
- "name": "options",
458
- "optional": true,
459
- "type": {
460
- "text": "OverlayOptions"
461
- }
462
- }
463
- ]
464
- },
465
- {
466
- "kind": "method",
467
- "name": "open",
468
- "privacy": "public",
469
- "static": true,
470
- "return": {
471
- "type": {
472
- "text": "Promise<Overlay | (() => void)>"
473
- }
474
- },
475
- "parameters": [
476
- {
477
- "name": "triggerOrContent",
478
- "type": {
479
- "text": "HTMLElement"
480
- }
481
- },
482
- {
483
- "name": "interactionOrOptions",
484
- "type": {
485
- "text": "| TriggerInteractionsV1\n | OverlayOptions\n | undefined"
486
- }
487
- },
488
- {
489
- "name": "content",
490
- "optional": true,
491
- "type": {
492
- "text": "HTMLElement"
493
- }
494
- },
495
- {
496
- "name": "optionsV1",
497
- "optional": true,
498
- "type": {
499
- "text": "OverlayOptionsV1"
500
- }
501
- }
502
- ]
503
- },
504
- {
505
- "kind": "method",
506
- "name": "applyOptions",
507
- "static": true,
508
- "return": {
509
- "type": {
510
- "text": "void"
511
- }
512
- },
513
- "parameters": [
514
- {
515
- "name": "overlay",
516
- "type": {
517
- "text": "AbstractOverlay"
518
- }
519
- },
520
- {
521
- "name": "options",
522
- "type": {
523
- "text": "OverlayOptions"
524
- }
525
- }
526
- ]
527
- }
528
- ],
529
- "superclass": {
530
- "name": "SpectrumElement",
531
- "package": "@spectrum-web-components/base"
532
- }
533
- }
534
- ],
535
- "exports": [
536
- {
537
- "kind": "js",
538
- "name": "overlayTimer",
539
- "declaration": {
540
- "name": "overlayTimer",
541
- "module": "src/AbstractOverlay.js"
542
- }
543
- },
544
- {
545
- "kind": "js",
546
- "name": "noop",
547
- "declaration": {
548
- "name": "noop",
549
- "module": "src/AbstractOverlay.js"
550
- }
551
- },
552
- {
553
- "kind": "js",
554
- "name": "guaranteedAllTransitionend",
555
- "declaration": {
556
- "name": "guaranteedAllTransitionend",
557
- "module": "src/AbstractOverlay.js"
558
- }
559
- },
560
- {
561
- "kind": "js",
562
- "name": "nextFrame",
563
- "declaration": {
564
- "name": "nextFrame",
565
- "module": "src/AbstractOverlay.js"
566
- }
567
- },
568
- {
569
- "kind": "js",
570
- "name": "AbstractOverlay",
571
- "declaration": {
572
- "name": "AbstractOverlay",
573
- "module": "src/AbstractOverlay.js"
574
- }
575
- }
576
- ]
577
- },
578
- {
579
- "kind": "javascript-module",
580
- "path": "src/ClickController.js",
581
- "declarations": [
582
- {
583
- "kind": "class",
584
- "description": "",
585
- "name": "ClickController",
586
- "members": [
587
- {
588
- "kind": "field",
589
- "name": "type",
590
- "type": {
591
- "text": "InteractionTypes"
592
- },
593
- "inheritedFrom": {
594
- "name": "InteractionController",
595
- "module": "src/InteractionController.js"
596
- }
597
- },
598
- {
599
- "kind": "field",
600
- "name": "preventNextToggle",
601
- "type": {
602
- "text": "boolean"
603
- },
604
- "privacy": "private",
605
- "default": "false",
606
- "description": "An overlay with a `click` interaction should not close on click `triggerElement`.\nWhen a click is initiated (`pointerdown`), apply `preventNextToggle` when the\noverlay is `open` to prevent from toggling the overlay when the click event\npropagates later in the interaction."
607
- },
608
- {
609
- "kind": "method",
610
- "name": "handleClick",
611
- "return": {
612
- "type": {
613
- "text": "void"
614
- }
615
- }
616
- },
617
- {
618
- "kind": "method",
619
- "name": "handlePointerdown",
620
- "return": {
621
- "type": {
622
- "text": "void"
623
- }
624
- }
625
- },
626
- {
627
- "kind": "method",
628
- "name": "init",
629
- "return": {
630
- "type": {
631
- "text": "void"
632
- }
633
- },
634
- "inheritedFrom": {
635
- "name": "InteractionController",
636
- "module": "src/InteractionController.js"
637
- }
638
- },
639
- {
640
- "kind": "field",
641
- "name": "abortController",
642
- "type": {
643
- "text": "AbortController"
644
- },
645
- "inheritedFrom": {
646
- "name": "InteractionController",
647
- "module": "src/InteractionController.js"
648
- }
649
- },
650
- {
651
- "kind": "field",
652
- "name": "activelyOpening",
653
- "type": {
654
- "text": "boolean"
655
- },
656
- "readonly": true,
657
- "inheritedFrom": {
658
- "name": "InteractionController",
659
- "module": "src/InteractionController.js"
660
- }
661
- },
662
- {
663
- "kind": "field",
664
- "name": "handleOverlayReady",
665
- "type": {
666
- "text": "(overlay: AbstractOverlay) => void | undefined"
667
- },
668
- "privacy": "private",
669
- "default": "handleOverlayReady",
670
- "inheritedFrom": {
671
- "name": "InteractionController",
672
- "module": "src/InteractionController.js"
673
- }
674
- },
675
- {
676
- "kind": "field",
677
- "name": "isLazilyOpen",
678
- "type": {
679
- "text": "boolean"
680
- },
681
- "privacy": "private",
682
- "default": "false",
683
- "inheritedFrom": {
684
- "name": "InteractionController",
685
- "module": "src/InteractionController.js"
686
- }
687
- },
688
- {
689
- "kind": "field",
690
- "name": "open",
691
- "type": {
692
- "text": "boolean"
693
- },
694
- "privacy": "public",
695
- "description": "Set `open` against the associated Overlay lazily.",
696
- "inheritedFrom": {
697
- "name": "InteractionController",
698
- "module": "src/InteractionController.js"
699
- }
700
- },
701
- {
702
- "kind": "field",
703
- "name": "overlay",
704
- "type": {
705
- "text": "AbstractOverlay"
706
- },
707
- "privacy": "public",
708
- "default": "overlay",
709
- "inheritedFrom": {
710
- "name": "InteractionController",
711
- "module": "src/InteractionController.js"
712
- }
713
- },
714
- {
715
- "kind": "field",
716
- "name": "_overlay",
717
- "type": {
718
- "text": "AbstractOverlay"
719
- },
720
- "privacy": "private",
721
- "inheritedFrom": {
722
- "name": "InteractionController",
723
- "module": "src/InteractionController.js"
724
- }
725
- },
726
- {
727
- "kind": "field",
728
- "name": "isPersistent",
729
- "type": {
730
- "text": "boolean"
731
- },
732
- "privacy": "protected",
733
- "default": "!!isPersistent",
734
- "inheritedFrom": {
735
- "name": "InteractionController",
736
- "module": "src/InteractionController.js"
737
- }
738
- },
739
- {
740
- "kind": "method",
741
- "name": "prepareDescription",
742
- "return": {
743
- "type": {
744
- "text": "void"
745
- }
746
- },
747
- "parameters": [
748
- {
749
- "name": "_",
750
- "type": {
751
- "text": "HTMLElement"
752
- }
753
- }
754
- ],
755
- "inheritedFrom": {
756
- "name": "InteractionController",
757
- "module": "src/InteractionController.js"
758
- }
759
- },
760
- {
761
- "kind": "method",
762
- "name": "releaseDescription",
763
- "return": {
764
- "type": {
765
- "text": "void"
766
- }
767
- },
768
- "inheritedFrom": {
769
- "name": "InteractionController",
770
- "module": "src/InteractionController.js"
771
- }
772
- },
773
- {
774
- "kind": "method",
775
- "name": "shouldCompleteOpen",
776
- "return": {
777
- "type": {
778
- "text": "void"
779
- }
780
- },
781
- "inheritedFrom": {
782
- "name": "InteractionController",
783
- "module": "src/InteractionController.js"
784
- }
785
- },
786
- {
787
- "kind": "method",
788
- "name": "initOverlay",
789
- "return": {
790
- "type": {
791
- "text": "void"
792
- }
793
- },
794
- "inheritedFrom": {
795
- "name": "InteractionController",
796
- "module": "src/InteractionController.js"
797
- }
798
- },
799
- {
800
- "kind": "method",
801
- "name": "abort",
802
- "return": {
803
- "type": {
804
- "text": "void"
805
- }
806
- },
807
- "inheritedFrom": {
808
- "name": "InteractionController",
809
- "module": "src/InteractionController.js"
810
- }
811
- },
812
- {
813
- "kind": "method",
814
- "name": "hostConnected",
815
- "return": {
816
- "type": {
817
- "text": "void"
818
- }
819
- },
820
- "inheritedFrom": {
821
- "name": "InteractionController",
822
- "module": "src/InteractionController.js"
823
- }
824
- },
825
- {
826
- "kind": "method",
827
- "name": "hostDisconnected",
828
- "return": {
829
- "type": {
830
- "text": "void"
831
- }
832
- },
833
- "inheritedFrom": {
834
- "name": "InteractionController",
835
- "module": "src/InteractionController.js"
836
- }
837
- }
838
- ],
839
- "superclass": {
840
- "name": "InteractionController",
841
- "module": "/src/InteractionController.js"
842
- }
843
- }
844
- ],
845
- "exports": [
846
- {
847
- "kind": "js",
848
- "name": "ClickController",
849
- "declaration": {
850
- "name": "ClickController",
851
- "module": "src/ClickController.js"
852
- }
853
- }
854
- ]
855
- },
856
- {
857
- "kind": "javascript-module",
858
- "path": "src/HoverController.js",
859
- "declarations": [
860
- {
861
- "kind": "class",
862
- "description": "",
863
- "name": "HoverController",
864
- "members": [
865
- {
866
- "kind": "field",
867
- "name": "type",
868
- "type": {
869
- "text": "InteractionTypes"
870
- },
871
- "inheritedFrom": {
872
- "name": "InteractionController",
873
- "module": "src/InteractionController.js"
874
- }
875
- },
876
- {
877
- "kind": "field",
878
- "name": "elementIds",
879
- "type": {
880
- "text": "string[]"
881
- },
882
- "privacy": "private",
883
- "default": "[]"
884
- },
885
- {
886
- "kind": "field",
887
- "name": "focusedin",
888
- "type": {
889
- "text": "boolean"
890
- },
891
- "default": "false"
892
- },
893
- {
894
- "kind": "field",
895
- "name": "hoverTimeout",
896
- "type": {
897
- "text": "ReturnType<typeof setTimeout> | undefined"
898
- },
899
- "privacy": "private"
900
- },
901
- {
902
- "kind": "field",
903
- "name": "pointerentered",
904
- "type": {
905
- "text": "boolean"
906
- },
907
- "default": "false"
908
- },
909
- {
910
- "kind": "method",
911
- "name": "handleTargetFocusin",
912
- "return": {
913
- "type": {
914
- "text": "void"
915
- }
916
- }
917
- },
918
- {
919
- "kind": "method",
920
- "name": "handleTargetFocusout",
921
- "return": {
922
- "type": {
923
- "text": "void"
924
- }
925
- }
926
- },
927
- {
928
- "kind": "method",
929
- "name": "handleTargetPointerenter",
930
- "return": {
931
- "type": {
932
- "text": "void"
933
- }
934
- }
935
- },
936
- {
937
- "kind": "method",
938
- "name": "handleTargetPointerleave",
939
- "return": {
940
- "type": {
941
- "text": "void"
942
- }
943
- }
944
- },
945
- {
946
- "kind": "method",
947
- "name": "handleHostPointerenter",
948
- "return": {
949
- "type": {
950
- "text": "void"
951
- }
952
- }
953
- },
954
- {
955
- "kind": "method",
956
- "name": "handleHostPointerleave",
957
- "return": {
958
- "type": {
959
- "text": "void"
960
- }
961
- }
962
- },
963
- {
964
- "kind": "method",
965
- "name": "prepareDescription",
966
- "return": {
967
- "type": {
968
- "text": "void"
969
- }
970
- },
971
- "parameters": [
972
- {
973
- "name": "_",
974
- "type": {
975
- "text": "HTMLElement"
976
- }
977
- }
978
- ],
979
- "inheritedFrom": {
980
- "name": "InteractionController",
981
- "module": "src/InteractionController.js"
982
- }
983
- },
984
- {
985
- "kind": "method",
986
- "name": "prepareOverlayRelativeDescription",
987
- "privacy": "private",
988
- "return": {
989
- "type": {
990
- "text": "void"
991
- }
992
- }
993
- },
994
- {
995
- "kind": "method",
996
- "name": "prepareContentRelativeDescription",
997
- "privacy": "private",
998
- "return": {
999
- "type": {
1000
- "text": "void"
1001
- }
1002
- }
1003
- },
1004
- {
1005
- "kind": "method",
1006
- "name": "doPointerleave",
1007
- "privacy": "protected",
1008
- "return": {
1009
- "type": {
1010
- "text": "void"
1011
- }
1012
- }
1013
- },
1014
- {
1015
- "kind": "method",
1016
- "name": "init",
1017
- "return": {
1018
- "type": {
1019
- "text": "void"
1020
- }
1021
- },
1022
- "inheritedFrom": {
1023
- "name": "InteractionController",
1024
- "module": "src/InteractionController.js"
1025
- }
1026
- },
1027
- {
1028
- "kind": "method",
1029
- "name": "initOverlay",
1030
- "return": {
1031
- "type": {
1032
- "text": "void"
1033
- }
1034
- },
1035
- "inheritedFrom": {
1036
- "name": "InteractionController",
1037
- "module": "src/InteractionController.js"
1038
- }
1039
- },
1040
- {
1041
- "kind": "field",
1042
- "name": "abortController",
1043
- "type": {
1044
- "text": "AbortController"
1045
- },
1046
- "inheritedFrom": {
1047
- "name": "InteractionController",
1048
- "module": "src/InteractionController.js"
1049
- }
1050
- },
1051
- {
1052
- "kind": "field",
1053
- "name": "activelyOpening",
1054
- "type": {
1055
- "text": "boolean"
1056
- },
1057
- "readonly": true,
1058
- "inheritedFrom": {
1059
- "name": "InteractionController",
1060
- "module": "src/InteractionController.js"
1061
- }
1062
- },
1063
- {
1064
- "kind": "field",
1065
- "name": "handleOverlayReady",
1066
- "type": {
1067
- "text": "(overlay: AbstractOverlay) => void | undefined"
1068
- },
1069
- "privacy": "private",
1070
- "default": "handleOverlayReady",
1071
- "inheritedFrom": {
1072
- "name": "InteractionController",
1073
- "module": "src/InteractionController.js"
1074
- }
1075
- },
1076
- {
1077
- "kind": "field",
1078
- "name": "isLazilyOpen",
1079
- "type": {
1080
- "text": "boolean"
1081
- },
1082
- "privacy": "private",
1083
- "default": "false",
1084
- "inheritedFrom": {
1085
- "name": "InteractionController",
1086
- "module": "src/InteractionController.js"
1087
- }
1088
- },
1089
- {
1090
- "kind": "field",
1091
- "name": "open",
1092
- "type": {
1093
- "text": "boolean"
1094
- },
1095
- "privacy": "public",
1096
- "description": "Set `open` against the associated Overlay lazily.",
1097
- "inheritedFrom": {
1098
- "name": "InteractionController",
1099
- "module": "src/InteractionController.js"
1100
- }
1101
- },
1102
- {
1103
- "kind": "field",
1104
- "name": "overlay",
1105
- "type": {
1106
- "text": "AbstractOverlay"
1107
- },
1108
- "privacy": "public",
1109
- "default": "overlay",
1110
- "inheritedFrom": {
1111
- "name": "InteractionController",
1112
- "module": "src/InteractionController.js"
1113
- }
1114
- },
1115
- {
1116
- "kind": "field",
1117
- "name": "_overlay",
1118
- "type": {
1119
- "text": "AbstractOverlay"
1120
- },
1121
- "privacy": "private",
1122
- "inheritedFrom": {
1123
- "name": "InteractionController",
1124
- "module": "src/InteractionController.js"
1125
- }
1126
- },
1127
- {
1128
- "kind": "field",
1129
- "name": "isPersistent",
1130
- "type": {
1131
- "text": "boolean"
1132
- },
1133
- "privacy": "protected",
1134
- "default": "!!isPersistent",
1135
- "inheritedFrom": {
1136
- "name": "InteractionController",
1137
- "module": "src/InteractionController.js"
1138
- }
1139
- },
1140
- {
1141
- "kind": "method",
1142
- "name": "releaseDescription",
1143
- "return": {
1144
- "type": {
1145
- "text": "void"
1146
- }
1147
- },
1148
- "inheritedFrom": {
1149
- "name": "InteractionController",
1150
- "module": "src/InteractionController.js"
1151
- }
1152
- },
1153
- {
1154
- "kind": "method",
1155
- "name": "shouldCompleteOpen",
1156
- "return": {
1157
- "type": {
1158
- "text": "void"
1159
- }
1160
- },
1161
- "inheritedFrom": {
1162
- "name": "InteractionController",
1163
- "module": "src/InteractionController.js"
1164
- }
1165
- },
1166
- {
1167
- "kind": "method",
1168
- "name": "abort",
1169
- "return": {
1170
- "type": {
1171
- "text": "void"
1172
- }
1173
- },
1174
- "inheritedFrom": {
1175
- "name": "InteractionController",
1176
- "module": "src/InteractionController.js"
1177
- }
1178
- },
1179
- {
1180
- "kind": "method",
1181
- "name": "hostConnected",
1182
- "return": {
1183
- "type": {
1184
- "text": "void"
1185
- }
1186
- },
1187
- "inheritedFrom": {
1188
- "name": "InteractionController",
1189
- "module": "src/InteractionController.js"
1190
- }
1191
- },
1192
- {
1193
- "kind": "method",
1194
- "name": "hostDisconnected",
1195
- "return": {
1196
- "type": {
1197
- "text": "void"
1198
- }
1199
- },
1200
- "inheritedFrom": {
1201
- "name": "InteractionController",
1202
- "module": "src/InteractionController.js"
1203
- }
1204
- }
1205
- ],
1206
- "superclass": {
1207
- "name": "InteractionController",
1208
- "module": "/src/InteractionController.js"
1209
- }
1210
- }
1211
- ],
1212
- "exports": [
1213
- {
1214
- "kind": "js",
1215
- "name": "HoverController",
1216
- "declaration": {
1217
- "name": "HoverController",
1218
- "module": "src/HoverController.js"
1219
- }
1220
- }
1221
- ]
1222
- },
1223
- {
1224
- "kind": "javascript-module",
1225
- "path": "src/InteractionController.js",
1226
- "declarations": [
1227
- {
1228
- "kind": "class",
1229
- "description": "",
1230
- "name": "InteractionController",
1231
- "members": [
1232
- {
1233
- "kind": "field",
1234
- "name": "abortController",
1235
- "type": {
1236
- "text": "AbortController"
1237
- }
1238
- },
1239
- {
1240
- "kind": "field",
1241
- "name": "activelyOpening",
1242
- "type": {
1243
- "text": "boolean"
1244
- },
1245
- "readonly": true
1246
- },
1247
- {
1248
- "kind": "field",
1249
- "name": "handleOverlayReady",
1250
- "type": {
1251
- "text": "(overlay: AbstractOverlay) => void | undefined"
1252
- },
1253
- "privacy": "private",
1254
- "default": "handleOverlayReady"
1255
- },
1256
- {
1257
- "kind": "field",
1258
- "name": "isLazilyOpen",
1259
- "type": {
1260
- "text": "boolean"
1261
- },
1262
- "privacy": "private",
1263
- "default": "false"
1264
- },
1265
- {
1266
- "kind": "field",
1267
- "name": "open",
1268
- "type": {
1269
- "text": "boolean"
1270
- },
1271
- "privacy": "public",
1272
- "description": "Set `open` against the associated Overlay lazily."
1273
- },
1274
- {
1275
- "kind": "field",
1276
- "name": "overlay",
1277
- "type": {
1278
- "text": "AbstractOverlay"
1279
- },
1280
- "privacy": "public",
1281
- "default": "overlay"
1282
- },
1283
- {
1284
- "kind": "field",
1285
- "name": "_overlay",
1286
- "type": {
1287
- "text": "AbstractOverlay"
1288
- },
1289
- "privacy": "private"
1290
- },
1291
- {
1292
- "kind": "field",
1293
- "name": "isPersistent",
1294
- "type": {
1295
- "text": "boolean"
1296
- },
1297
- "privacy": "protected",
1298
- "default": "!!isPersistent"
1299
- },
1300
- {
1301
- "kind": "field",
1302
- "name": "type",
1303
- "type": {
1304
- "text": "InteractionTypes"
1305
- }
1306
- },
1307
- {
1308
- "kind": "method",
1309
- "name": "prepareDescription",
1310
- "return": {
1311
- "type": {
1312
- "text": "void"
1313
- }
1314
- },
1315
- "parameters": [
1316
- {
1317
- "name": "_",
1318
- "type": {
1319
- "text": "HTMLElement"
1320
- }
1321
- }
1322
- ]
1323
- },
1324
- {
1325
- "kind": "method",
1326
- "name": "releaseDescription",
1327
- "return": {
1328
- "type": {
1329
- "text": "void"
1330
- }
1331
- }
1332
- },
1333
- {
1334
- "kind": "method",
1335
- "name": "shouldCompleteOpen",
1336
- "return": {
1337
- "type": {
1338
- "text": "void"
1339
- }
1340
- }
1341
- },
1342
- {
1343
- "kind": "method",
1344
- "name": "init",
1345
- "return": {
1346
- "type": {
1347
- "text": "void"
1348
- }
1349
- }
1350
- },
1351
- {
1352
- "kind": "method",
1353
- "name": "initOverlay",
1354
- "return": {
1355
- "type": {
1356
- "text": "void"
1357
- }
1358
- }
1359
- },
1360
- {
1361
- "kind": "method",
1362
- "name": "abort",
1363
- "return": {
1364
- "type": {
1365
- "text": "void"
1366
- }
1367
- }
1368
- },
1369
- {
1370
- "kind": "method",
1371
- "name": "hostConnected",
1372
- "return": {
1373
- "type": {
1374
- "text": "void"
1375
- }
1376
- }
1377
- },
1378
- {
1379
- "kind": "method",
1380
- "name": "hostDisconnected",
1381
- "return": {
1382
- "type": {
1383
- "text": "void"
1384
- }
1385
- }
1386
- }
1387
- ]
1388
- }
1389
- ],
1390
- "exports": [
1391
- {
1392
- "kind": "js",
1393
- "name": "InteractionController",
1394
- "declaration": {
1395
- "name": "InteractionController",
1396
- "module": "src/InteractionController.js"
1397
- }
1398
- }
1399
- ]
1400
- },
1401
- {
1402
- "kind": "javascript-module",
1403
- "path": "src/LongpressController.js",
1404
- "declarations": [
1405
- {
1406
- "kind": "variable",
1407
- "name": "LONGPRESS_INSTRUCTIONS",
1408
- "type": {
1409
- "text": "object"
1410
- },
1411
- "default": "{\n touch: 'Double tap and long press for additional options',\n keyboard: 'Press Space or Alt+Down Arrow for additional options',\n mouse: 'Click and hold for additional options',\n}"
1412
- },
1413
- {
1414
- "kind": "class",
1415
- "description": "",
1416
- "name": "LongpressController",
1417
- "members": [
1418
- {
1419
- "kind": "field",
1420
- "name": "type",
1421
- "type": {
1422
- "text": "InteractionTypes"
1423
- },
1424
- "inheritedFrom": {
1425
- "name": "InteractionController",
1426
- "module": "src/InteractionController.js"
1427
- }
1428
- },
1429
- {
1430
- "kind": "field",
1431
- "name": "activelyOpening",
1432
- "type": {
1433
- "text": "boolean"
1434
- },
1435
- "readonly": true,
1436
- "inheritedFrom": {
1437
- "name": "InteractionController",
1438
- "module": "src/InteractionController.js"
1439
- }
1440
- },
1441
- {
1442
- "kind": "field",
1443
- "name": "longpressState",
1444
- "type": {
1445
- "text": "null | 'potential' | 'opening' | 'pressed'"
1446
- },
1447
- "privacy": "protected",
1448
- "default": "null"
1449
- },
1450
- {
1451
- "kind": "field",
1452
- "name": "releaseDescription",
1453
- "return": {
1454
- "type": {
1455
- "text": "void"
1456
- }
1457
- },
1458
- "default": "noop",
1459
- "inheritedFrom": {
1460
- "name": "InteractionController",
1461
- "module": "src/InteractionController.js"
1462
- }
1463
- },
1464
- {
1465
- "kind": "field",
1466
- "name": "timeout",
1467
- "type": {
1468
- "text": "ReturnType<typeof setTimeout>"
1469
- },
1470
- "privacy": "private"
1471
- },
1472
- {
1473
- "kind": "method",
1474
- "name": "handleLongpress",
1475
- "return": {
1476
- "type": {
1477
- "text": "void"
1478
- }
1479
- }
1480
- },
1481
- {
1482
- "kind": "method",
1483
- "name": "handlePointerdown",
1484
- "return": {
1485
- "type": {
1486
- "text": "void"
1487
- }
1488
- },
1489
- "parameters": [
1490
- {
1491
- "name": "event",
1492
- "type": {
1493
- "text": "PointerEvent"
1494
- }
1495
- }
1496
- ]
1497
- },
1498
- {
1499
- "kind": "field",
1500
- "name": "handlePointerup",
1501
- "privacy": "private"
1502
- },
1503
- {
1504
- "kind": "method",
1505
- "name": "handleKeydown",
1506
- "privacy": "private",
1507
- "return": {
1508
- "type": {
1509
- "text": "void"
1510
- }
1511
- },
1512
- "parameters": [
1513
- {
1514
- "name": "event",
1515
- "type": {
1516
- "text": "KeyboardEvent"
1517
- }
1518
- }
1519
- ]
1520
- },
1521
- {
1522
- "kind": "method",
1523
- "name": "handleKeyup",
1524
- "privacy": "private",
1525
- "return": {
1526
- "type": {
1527
- "text": "void"
1528
- }
1529
- },
1530
- "parameters": [
1531
- {
1532
- "name": "event",
1533
- "type": {
1534
- "text": "KeyboardEvent"
1535
- }
1536
- }
1537
- ]
1538
- },
1539
- {
1540
- "kind": "method",
1541
- "name": "prepareDescription",
1542
- "return": {
1543
- "type": {
1544
- "text": "void"
1545
- }
1546
- },
1547
- "parameters": [
1548
- {
1549
- "name": "trigger",
1550
- "type": {
1551
- "text": "HTMLElement"
1552
- }
1553
- }
1554
- ],
1555
- "inheritedFrom": {
1556
- "name": "InteractionController",
1557
- "module": "src/InteractionController.js"
1558
- }
1559
- },
1560
- {
1561
- "kind": "method",
1562
- "name": "shouldCompleteOpen",
1563
- "return": {
1564
- "type": {
1565
- "text": "void"
1566
- }
1567
- },
1568
- "inheritedFrom": {
1569
- "name": "InteractionController",
1570
- "module": "src/InteractionController.js"
1571
- }
1572
- },
1573
- {
1574
- "kind": "method",
1575
- "name": "init",
1576
- "return": {
1577
- "type": {
1578
- "text": "void"
1579
- }
1580
- },
1581
- "inheritedFrom": {
1582
- "name": "InteractionController",
1583
- "module": "src/InteractionController.js"
1584
- }
1585
- },
1586
- {
1587
- "kind": "field",
1588
- "name": "abortController",
1589
- "type": {
1590
- "text": "AbortController"
1591
- },
1592
- "inheritedFrom": {
1593
- "name": "InteractionController",
1594
- "module": "src/InteractionController.js"
1595
- }
1596
- },
1597
- {
1598
- "kind": "field",
1599
- "name": "handleOverlayReady",
1600
- "type": {
1601
- "text": "(overlay: AbstractOverlay) => void | undefined"
1602
- },
1603
- "privacy": "private",
1604
- "default": "handleOverlayReady",
1605
- "inheritedFrom": {
1606
- "name": "InteractionController",
1607
- "module": "src/InteractionController.js"
1608
- }
1609
- },
1610
- {
1611
- "kind": "field",
1612
- "name": "isLazilyOpen",
1613
- "type": {
1614
- "text": "boolean"
1615
- },
1616
- "privacy": "private",
1617
- "default": "false",
1618
- "inheritedFrom": {
1619
- "name": "InteractionController",
1620
- "module": "src/InteractionController.js"
1621
- }
1622
- },
1623
- {
1624
- "kind": "field",
1625
- "name": "open",
1626
- "type": {
1627
- "text": "boolean"
1628
- },
1629
- "privacy": "public",
1630
- "description": "Set `open` against the associated Overlay lazily.",
1631
- "inheritedFrom": {
1632
- "name": "InteractionController",
1633
- "module": "src/InteractionController.js"
1634
- }
1635
- },
1636
- {
1637
- "kind": "field",
1638
- "name": "overlay",
1639
- "type": {
1640
- "text": "AbstractOverlay"
1641
- },
1642
- "privacy": "public",
1643
- "default": "overlay",
1644
- "inheritedFrom": {
1645
- "name": "InteractionController",
1646
- "module": "src/InteractionController.js"
1647
- }
1648
- },
1649
- {
1650
- "kind": "field",
1651
- "name": "_overlay",
1652
- "type": {
1653
- "text": "AbstractOverlay"
1654
- },
1655
- "privacy": "private",
1656
- "inheritedFrom": {
1657
- "name": "InteractionController",
1658
- "module": "src/InteractionController.js"
1659
- }
1660
- },
1661
- {
1662
- "kind": "field",
1663
- "name": "isPersistent",
1664
- "type": {
1665
- "text": "boolean"
1666
- },
1667
- "privacy": "protected",
1668
- "default": "!!isPersistent",
1669
- "inheritedFrom": {
1670
- "name": "InteractionController",
1671
- "module": "src/InteractionController.js"
1672
- }
1673
- },
1674
- {
1675
- "kind": "method",
1676
- "name": "initOverlay",
1677
- "return": {
1678
- "type": {
1679
- "text": "void"
1680
- }
1681
- },
1682
- "inheritedFrom": {
1683
- "name": "InteractionController",
1684
- "module": "src/InteractionController.js"
1685
- }
1686
- },
1687
- {
1688
- "kind": "method",
1689
- "name": "abort",
1690
- "return": {
1691
- "type": {
1692
- "text": "void"
1693
- }
1694
- },
1695
- "inheritedFrom": {
1696
- "name": "InteractionController",
1697
- "module": "src/InteractionController.js"
1698
- }
1699
- },
1700
- {
1701
- "kind": "method",
1702
- "name": "hostConnected",
1703
- "return": {
1704
- "type": {
1705
- "text": "void"
1706
- }
1707
- },
1708
- "inheritedFrom": {
1709
- "name": "InteractionController",
1710
- "module": "src/InteractionController.js"
1711
- }
1712
- },
1713
- {
1714
- "kind": "method",
1715
- "name": "hostDisconnected",
1716
- "return": {
1717
- "type": {
1718
- "text": "void"
1719
- }
1720
- },
1721
- "inheritedFrom": {
1722
- "name": "InteractionController",
1723
- "module": "src/InteractionController.js"
1724
- }
1725
- }
1726
- ],
1727
- "superclass": {
1728
- "name": "InteractionController",
1729
- "module": "/src/InteractionController.js"
1730
- }
1731
- }
1732
- ],
1733
- "exports": [
1734
- {
1735
- "kind": "js",
1736
- "name": "LONGPRESS_INSTRUCTIONS",
1737
- "declaration": {
1738
- "name": "LONGPRESS_INSTRUCTIONS",
1739
- "module": "src/LongpressController.js"
1740
- }
1741
- },
1742
- {
1743
- "kind": "js",
1744
- "name": "LongpressController",
1745
- "declaration": {
1746
- "name": "LongpressController",
1747
- "module": "src/LongpressController.js"
1748
- }
1749
- }
1750
- ]
1751
- },
1752
- {
1753
- "kind": "javascript-module",
1754
- "path": "src/Overlay.js",
1755
- "declarations": [
1756
- {
1757
- "kind": "class",
1758
- "description": "",
1759
- "name": "Overlay",
1760
- "members": [
1761
- {
1762
- "kind": "field",
1763
- "name": "delayed",
1764
- "type": {
1765
- "text": "boolean"
1766
- },
1767
- "description": "An Overlay that is `delayed` will wait until a warm-up period of 1000ms\nhas completed before opening. Once the warmup period has completed, all\nsubsequent Overlays will open immediately. When no Overlays are opened,\na cooldown period of 1000ms will begin. Once the cooldown has completed,\nthe next Overlay to be opened will be subject to the warm-up period if\nprovided that option.",
1768
- "attribute": "delayed"
1769
- },
1770
- {
1771
- "kind": "field",
1772
- "name": "_delayed",
1773
- "type": {
1774
- "text": "boolean"
1775
- },
1776
- "privacy": "private",
1777
- "default": "false"
1778
- },
1779
- {
1780
- "kind": "field",
1781
- "name": "dialogEl",
1782
- "type": {
1783
- "text": "HTMLDialogElement & {\n showPopover(): void;\n hidePopover(): void;\n }"
1784
- }
1785
- },
1786
- {
1787
- "kind": "field",
1788
- "name": "disabled",
1789
- "type": {
1790
- "text": "boolean"
1791
- },
1792
- "description": "Whether the overlay is currently functional or not",
1793
- "attribute": "disabled"
1794
- },
1795
- {
1796
- "kind": "field",
1797
- "name": "_disabled",
1798
- "type": {
1799
- "text": "boolean"
1800
- },
1801
- "privacy": "private",
1802
- "default": "false"
1803
- },
1804
- {
1805
- "kind": "field",
1806
- "name": "elements",
1807
- "type": {
1808
- "text": "OpenableElement[]"
1809
- }
1810
- },
1811
- {
1812
- "kind": "field",
1813
- "name": "parentOverlayToForceClose",
1814
- "type": {
1815
- "text": "Overlay | undefined"
1816
- },
1817
- "privacy": "public"
1818
- },
1819
- {
1820
- "kind": "field",
1821
- "name": "hasNonVirtualTrigger",
1822
- "type": {
1823
- "text": "boolean"
1824
- },
1825
- "privacy": "private",
1826
- "readonly": true
1827
- },
1828
- {
1829
- "kind": "field",
1830
- "name": "offset",
1831
- "type": {
1832
- "text": "number | [number, number]"
1833
- },
1834
- "default": "0",
1835
- "description": "The `offset` property accepts either a single number, to\ndefine the offset of the Overlay along the main axis from\nthe trigger, or 2-tuple, to define the offset along the\nmain axis and the cross axis. This option has no effect\nwhen there is no trigger element.",
1836
- "attribute": "offset"
1837
- },
1838
- {
1839
- "kind": "field",
1840
- "name": "placementController",
1841
- "type": {
1842
- "text": "PlacementController"
1843
- },
1844
- "privacy": "protected",
1845
- "readonly": true
1846
- },
1847
- {
1848
- "kind": "field",
1849
- "name": "open",
1850
- "type": {
1851
- "text": "boolean"
1852
- },
1853
- "description": "Whether the Overlay is projected onto the \"top layer\" or not.",
1854
- "attribute": "open",
1855
- "reflects": true
1856
- },
1857
- {
1858
- "kind": "field",
1859
- "name": "_open",
1860
- "type": {
1861
- "text": "boolean"
1862
- },
1863
- "privacy": "private",
1864
- "default": "false"
1865
- },
1866
- {
1867
- "kind": "field",
1868
- "name": "openCount",
1869
- "type": {
1870
- "text": "number"
1871
- },
1872
- "static": true,
1873
- "default": "1"
1874
- },
1875
- {
1876
- "kind": "field",
1877
- "name": "placement",
1878
- "type": {
1879
- "text": "\"top\" | \"top-start\" | \"top-end\" | \"right\" | \"right-start\" | \"right-end\" | \"bottom\" | \"bottom-start\" | \"bottom-end\" | \"left\" | \"left-start\" | \"left-end\""
1880
- },
1881
- "description": "Instruct the Overlay where to place itself in\nrelationship to the trigger element.",
1882
- "attribute": "placement"
1883
- },
1884
- {
1885
- "kind": "field",
1886
- "name": "lastRequestSlottableState",
1887
- "type": {
1888
- "text": "boolean"
1889
- },
1890
- "privacy": "private",
1891
- "default": "false",
1892
- "description": "The state in which the last `request-slottable` event was dispatched.\nDo not allow overlays from dispatching the same state twice in a row."
1893
- },
1894
- {
1895
- "kind": "field",
1896
- "name": "receivesFocus",
1897
- "type": {
1898
- "text": "'true' | 'false' | 'auto'"
1899
- },
1900
- "default": "'auto'",
1901
- "description": "Whether to pass focus to the overlay once opened, or\nto the appropriate value based on the \"type\" of the overlay\nwhen set to `\"auto\"`.",
1902
- "attribute": "receives-focus"
1903
- },
1904
- {
1905
- "kind": "field",
1906
- "name": "slotEl",
1907
- "type": {
1908
- "text": "HTMLSlotElement"
1909
- }
1910
- },
1911
- {
1912
- "kind": "field",
1913
- "name": "state",
1914
- "type": {
1915
- "text": "OverlayState"
1916
- }
1917
- },
1918
- {
1919
- "kind": "field",
1920
- "name": "_state",
1921
- "type": {
1922
- "text": "OverlayState"
1923
- },
1924
- "default": "'closed'"
1925
- },
1926
- {
1927
- "kind": "field",
1928
- "name": "strategy",
1929
- "type": {
1930
- "text": "ClickController | HoverController | LongpressController | undefined"
1931
- },
1932
- "privacy": "public"
1933
- },
1934
- {
1935
- "kind": "field",
1936
- "name": "tipPadding",
1937
- "type": {
1938
- "text": "number | undefined"
1939
- },
1940
- "attribute": "tip-padding"
1941
- },
1942
- {
1943
- "kind": "field",
1944
- "name": "trigger",
1945
- "type": {
1946
- "text": "string | undefined"
1947
- },
1948
- "description": "An optional ID reference for the trigger element combined with the optional\ninteraction (click | hover | longpress) by which the overlay shold open\nthe overlay with an `@`: e.g. `trigger@click` opens the overlay when an\nelement with the ID \"trigger\" is clicked.",
1949
- "attribute": "trigger"
1950
- },
1951
- {
1952
- "kind": "field",
1953
- "name": "triggerElement",
1954
- "type": {
1955
- "text": "HTMLElement | VirtualTrigger | null"
1956
- },
1957
- "default": "null",
1958
- "description": "An element reference for the trigger element that the overlay should relate to."
1959
- },
1960
- {
1961
- "kind": "field",
1962
- "name": "triggerInteraction",
1963
- "type": {
1964
- "text": "TriggerInteraction | undefined"
1965
- },
1966
- "description": "The specific interaction to listen for on the `triggerElement` to open the overlay."
1967
- },
1968
- {
1969
- "kind": "field",
1970
- "name": "type",
1971
- "type": {
1972
- "text": "\"auto\" | \"hint\" | \"manual\" | \"modal\" | \"page\""
1973
- },
1974
- "default": "'auto'",
1975
- "description": "Configures the open/close heuristics of the Overlay.",
1976
- "attribute": "type"
1977
- },
1978
- {
1979
- "kind": "field",
1980
- "name": "wasOpen",
1981
- "type": {
1982
- "text": "boolean"
1983
- },
1984
- "privacy": "protected",
1985
- "default": "false"
1986
- },
1987
- {
1988
- "kind": "field",
1989
- "name": "elementResolver",
1990
- "type": {
1991
- "text": "ElementResolutionController"
1992
- },
1993
- "privacy": "protected",
1994
- "readonly": true
1995
- },
1996
- {
1997
- "kind": "field",
1998
- "name": "usesDialog",
1999
- "type": {
2000
- "text": "boolean"
2001
- },
2002
- "privacy": "private",
2003
- "readonly": true
2004
- },
2005
- {
2006
- "kind": "field",
2007
- "name": "popoverValue",
2008
- "type": {
2009
- "text": "'auto' | 'manual' | undefined"
2010
- },
2011
- "privacy": "private",
2012
- "readonly": true
2013
- },
2014
- {
2015
- "kind": "field",
2016
- "name": "requiresPosition",
2017
- "type": {
2018
- "text": "boolean"
2019
- },
2020
- "privacy": "protected",
2021
- "readonly": true
2022
- },
2023
- {
2024
- "kind": "method",
2025
- "name": "managePosition",
2026
- "privacy": "protected",
2027
- "return": {
2028
- "type": {
2029
- "text": "void"
2030
- }
2031
- }
2032
- },
2033
- {
2034
- "kind": "method",
2035
- "name": "managePopoverOpen",
2036
- "privacy": "protected",
2037
- "return": {
2038
- "type": {
2039
- "text": "Promise<void>"
2040
- }
2041
- }
2042
- },
2043
- {
2044
- "kind": "method",
2045
- "name": "applyFocus",
2046
- "privacy": "protected",
2047
- "return": {
2048
- "type": {
2049
- "text": "Promise<void>"
2050
- }
2051
- },
2052
- "parameters": [
2053
- {
2054
- "name": "targetOpenState",
2055
- "type": {
2056
- "text": "boolean"
2057
- }
2058
- },
2059
- {
2060
- "name": "focusEl",
2061
- "type": {
2062
- "text": "HTMLElement | null"
2063
- }
2064
- }
2065
- ]
2066
- },
2067
- {
2068
- "kind": "method",
2069
- "name": "returnFocus",
2070
- "privacy": "protected",
2071
- "return": {
2072
- "type": {
2073
- "text": "void"
2074
- }
2075
- }
2076
- },
2077
- {
2078
- "kind": "field",
2079
- "name": "closeOnFocusOut",
2080
- "privacy": "private"
2081
- },
2082
- {
2083
- "kind": "method",
2084
- "name": "manageOpen",
2085
- "privacy": "protected",
2086
- "return": {
2087
- "type": {
2088
- "text": "Promise<void>"
2089
- }
2090
- },
2091
- "parameters": [
2092
- {
2093
- "name": "oldOpen",
2094
- "type": {
2095
- "text": "boolean"
2096
- }
2097
- }
2098
- ]
2099
- },
2100
- {
2101
- "kind": "method",
2102
- "name": "bindEvents",
2103
- "privacy": "protected",
2104
- "return": {
2105
- "type": {
2106
- "text": "void"
2107
- }
2108
- }
2109
- },
2110
- {
2111
- "kind": "method",
2112
- "name": "handleBeforetoggle",
2113
- "privacy": "protected",
2114
- "return": {
2115
- "type": {
2116
- "text": "void"
2117
- }
2118
- },
2119
- "parameters": [
2120
- {
2121
- "name": "event",
2122
- "type": {
2123
- "text": "Event & { newState: string }"
2124
- }
2125
- }
2126
- ]
2127
- },
2128
- {
2129
- "kind": "method",
2130
- "name": "handleBrowserClose",
2131
- "privacy": "protected",
2132
- "return": {
2133
- "type": {
2134
- "text": "void"
2135
- }
2136
- }
2137
- },
2138
- {
2139
- "kind": "method",
2140
- "name": "manuallyKeepOpen",
2141
- "privacy": "public",
2142
- "return": {
2143
- "type": {
2144
- "text": "void"
2145
- }
2146
- }
2147
- },
2148
- {
2149
- "kind": "method",
2150
- "name": "handleSlotchange",
2151
- "privacy": "protected",
2152
- "return": {
2153
- "type": {
2154
- "text": "void"
2155
- }
2156
- }
2157
- },
2158
- {
2159
- "kind": "method",
2160
- "name": "shouldPreventClose",
2161
- "privacy": "public",
2162
- "return": {
2163
- "type": {
2164
- "text": "boolean"
2165
- }
2166
- }
2167
- },
2168
- {
2169
- "kind": "method",
2170
- "name": "requestSlottable",
2171
- "privacy": "protected",
2172
- "return": {
2173
- "type": {
2174
- "text": "void"
2175
- }
2176
- }
2177
- },
2178
- {
2179
- "kind": "method",
2180
- "name": "renderContent",
2181
- "privacy": "protected",
2182
- "return": {
2183
- "type": {
2184
- "text": "TemplateResult"
2185
- }
2186
- }
2187
- },
2188
- {
2189
- "kind": "field",
2190
- "name": "dialogStyleMap",
2191
- "type": {
2192
- "text": "StyleInfo"
2193
- },
2194
- "privacy": "private",
2195
- "readonly": true
2196
- },
2197
- {
2198
- "kind": "method",
2199
- "name": "renderDialog",
2200
- "privacy": "protected",
2201
- "return": {
2202
- "type": {
2203
- "text": "TemplateResult"
2204
- }
2205
- }
2206
- },
2207
- {
2208
- "kind": "method",
2209
- "name": "renderPopover",
2210
- "privacy": "protected",
2211
- "return": {
2212
- "type": {
2213
- "text": "TemplateResult"
2214
- }
2215
- }
2216
- }
2217
- ],
2218
- "events": [
2219
- {
2220
- "description": "announces that an overlay has completed any entry animations",
2221
- "name": "sp-opened"
2222
- },
2223
- {
2224
- "description": "announce that an overlay has compelted any exit animations",
2225
- "name": "sp-closed"
2226
- },
2227
- {
2228
- "description": "requests to add or remove slottable content",
2229
- "name": "slottable-request"
2230
- }
2231
- ],
2232
- "attributes": [
2233
- {
2234
- "name": "delayed",
2235
- "type": {
2236
- "text": "boolean"
2237
- },
2238
- "description": "An Overlay that is `delayed` will wait until a warm-up period of 1000ms\nhas completed before opening. Once the warmup period has completed, all\nsubsequent Overlays will open immediately. When no Overlays are opened,\na cooldown period of 1000ms will begin. Once the cooldown has completed,\nthe next Overlay to be opened will be subject to the warm-up period if\nprovided that option.",
2239
- "fieldName": "delayed"
2240
- },
2241
- {
2242
- "name": "disabled",
2243
- "type": {
2244
- "text": "boolean"
2245
- },
2246
- "description": "Whether the overlay is currently functional or not",
2247
- "fieldName": "disabled"
2248
- },
2249
- {
2250
- "name": "offset",
2251
- "type": {
2252
- "text": "number | [number, number]"
2253
- },
2254
- "default": "0",
2255
- "description": "The `offset` property accepts either a single number, to\ndefine the offset of the Overlay along the main axis from\nthe trigger, or 2-tuple, to define the offset along the\nmain axis and the cross axis. This option has no effect\nwhen there is no trigger element.",
2256
- "fieldName": "offset"
2257
- },
2258
- {
2259
- "name": "open",
2260
- "type": {
2261
- "text": "boolean"
2262
- },
2263
- "description": "Whether the Overlay is projected onto the \"top layer\" or not.",
2264
- "fieldName": "open"
2265
- },
2266
- {
2267
- "name": "placement",
2268
- "type": {
2269
- "text": "\"top\" | \"top-start\" | \"top-end\" | \"right\" | \"right-start\" | \"right-end\" | \"bottom\" | \"bottom-start\" | \"bottom-end\" | \"left\" | \"left-start\" | \"left-end\""
2270
- },
2271
- "description": "Instruct the Overlay where to place itself in\nrelationship to the trigger element.",
2272
- "fieldName": "placement"
2273
- },
2274
- {
2275
- "name": "receives-focus",
2276
- "type": {
2277
- "text": "'true' | 'false' | 'auto'"
2278
- },
2279
- "default": "'auto'",
2280
- "description": "Whether to pass focus to the overlay once opened, or\nto the appropriate value based on the \"type\" of the overlay\nwhen set to `\"auto\"`.",
2281
- "fieldName": "receivesFocus"
2282
- },
2283
- {
2284
- "name": "tip-padding",
2285
- "type": {
2286
- "text": "number | undefined"
2287
- },
2288
- "fieldName": "tipPadding"
2289
- },
2290
- {
2291
- "name": "trigger",
2292
- "type": {
2293
- "text": "string | undefined"
2294
- },
2295
- "description": "An optional ID reference for the trigger element combined with the optional\ninteraction (click | hover | longpress) by which the overlay shold open\nthe overlay with an `@`: e.g. `trigger@click` opens the overlay when an\nelement with the ID \"trigger\" is clicked.",
2296
- "fieldName": "trigger"
2297
- },
2298
- {
2299
- "name": "type",
2300
- "type": {
2301
- "text": "\"auto\" | \"hint\" | \"manual\" | \"modal\" | \"page\""
2302
- },
2303
- "default": "'auto'",
2304
- "description": "Configures the open/close heuristics of the Overlay.",
2305
- "fieldName": "type"
2306
- }
2307
- ],
2308
- "superclass": {
2309
- "name": "OverlayFeatures",
2310
- "module": "src/Overlay.ts"
2311
- },
2312
- "tagName": "sp-overlay",
2313
- "customElement": true
2314
- }
2315
- ],
2316
- "exports": [
2317
- {
2318
- "kind": "js",
2319
- "name": "LONGPRESS_INSTRUCTIONS",
2320
- "declaration": {
2321
- "name": "LONGPRESS_INSTRUCTIONS",
2322
- "module": "./LongpressController.js"
2323
- }
2324
- },
2325
- {
2326
- "kind": "js",
2327
- "name": "Overlay",
2328
- "declaration": {
2329
- "name": "Overlay",
2330
- "module": "src/Overlay.js"
2331
- }
2332
- }
2333
- ]
2334
- },
2335
- {
2336
- "kind": "javascript-module",
2337
- "path": "src/OverlayDialog.js",
2338
- "declarations": [
2339
- {
2340
- "kind": "mixin",
2341
- "description": "",
2342
- "name": "OverlayDialog",
2343
- "members": [
2344
- {
2345
- "kind": "method",
2346
- "name": "manageDialogOpen",
2347
- "privacy": "protected",
2348
- "return": {
2349
- "type": {
2350
- "text": "Promise<void>"
2351
- }
2352
- }
2353
- },
2354
- {
2355
- "kind": "method",
2356
- "name": "dialogMakeTransition",
2357
- "privacy": "protected",
2358
- "return": {
2359
- "type": {
2360
- "text": "Promise<HTMLElement | null>"
2361
- }
2362
- },
2363
- "parameters": [
2364
- {
2365
- "name": "targetOpenState",
2366
- "type": {
2367
- "text": "boolean"
2368
- }
2369
- }
2370
- ]
2371
- },
2372
- {
2373
- "kind": "method",
2374
- "name": "dialogApplyFocus",
2375
- "privacy": "protected",
2376
- "return": {
2377
- "type": {
2378
- "text": "Promise<void>"
2379
- }
2380
- },
2381
- "parameters": [
2382
- {
2383
- "name": "targetOpenState",
2384
- "type": {
2385
- "text": "boolean"
2386
- }
2387
- },
2388
- {
2389
- "name": "focusEl",
2390
- "type": {
2391
- "text": "HTMLElement | null"
2392
- }
2393
- }
2394
- ]
2395
- }
2396
- ],
2397
- "events": [
2398
- {
2399
- "type": {
2400
- "text": "event"
2401
- }
2402
- },
2403
- {
2404
- "name": "eventName",
2405
- "type": {
2406
- "text": "OverlayStateEvent"
2407
- }
2408
- }
2409
- ],
2410
- "parameters": [
2411
- {
2412
- "name": "constructor",
2413
- "type": {
2414
- "text": "T"
2415
- }
2416
- }
2417
- ]
2418
- }
2419
- ],
2420
- "exports": [
2421
- {
2422
- "kind": "js",
2423
- "name": "OverlayDialog",
2424
- "declaration": {
2425
- "name": "OverlayDialog",
2426
- "module": "src/OverlayDialog.js"
2427
- }
2428
- }
2429
- ]
2430
- },
2431
- {
2432
- "kind": "javascript-module",
2433
- "path": "src/OverlayNoPopover.js",
2434
- "declarations": [
2435
- {
2436
- "kind": "mixin",
2437
- "description": "",
2438
- "name": "OverlayNoPopover",
2439
- "members": [
2440
- {
2441
- "kind": "method",
2442
- "name": "managePopoverOpen",
2443
- "privacy": "protected",
2444
- "return": {
2445
- "type": {
2446
- "text": "Promise<void>"
2447
- }
2448
- }
2449
- },
2450
- {
2451
- "kind": "method",
2452
- "name": "manageDelay",
2453
- "privacy": "protected",
2454
- "return": {
2455
- "type": {
2456
- "text": "Promise<void>"
2457
- }
2458
- },
2459
- "parameters": [
2460
- {
2461
- "name": "targetOpenState",
2462
- "type": {
2463
- "text": "boolean"
2464
- }
2465
- }
2466
- ]
2467
- },
2468
- {
2469
- "kind": "method",
2470
- "name": "ensureOnDOM",
2471
- "privacy": "protected",
2472
- "return": {
2473
- "type": {
2474
- "text": "Promise<void>"
2475
- }
2476
- },
2477
- "parameters": [
2478
- {
2479
- "name": "_targetOpenState",
2480
- "type": {
2481
- "text": "boolean"
2482
- }
2483
- }
2484
- ]
2485
- },
2486
- {
2487
- "kind": "method",
2488
- "name": "makeTransition",
2489
- "privacy": "protected",
2490
- "return": {
2491
- "type": {
2492
- "text": "Promise<HTMLElement | null>"
2493
- }
2494
- },
2495
- "parameters": [
2496
- {
2497
- "name": "targetOpenState",
2498
- "type": {
2499
- "text": "boolean"
2500
- }
2501
- }
2502
- ]
2503
- }
2504
- ],
2505
- "events": [
2506
- {
2507
- "type": {
2508
- "text": "event"
2509
- }
2510
- },
2511
- {
2512
- "name": "eventName",
2513
- "type": {
2514
- "text": "OverlayStateEvent"
2515
- }
2516
- }
2517
- ],
2518
- "parameters": [
2519
- {
2520
- "name": "constructor",
2521
- "type": {
2522
- "text": "T"
2523
- }
2524
- }
2525
- ]
2526
- }
2527
- ],
2528
- "exports": [
2529
- {
2530
- "kind": "js",
2531
- "name": "OverlayNoPopover",
2532
- "declaration": {
2533
- "name": "OverlayNoPopover",
2534
- "module": "src/OverlayNoPopover.js"
2535
- }
2536
- }
2537
- ]
2538
- },
2539
- {
2540
- "kind": "javascript-module",
2541
- "path": "src/OverlayPopover.js",
2542
- "declarations": [
2543
- {
2544
- "kind": "mixin",
2545
- "description": "",
2546
- "name": "OverlayPopover",
2547
- "members": [
2548
- {
2549
- "kind": "method",
2550
- "name": "manageDelay",
2551
- "privacy": "protected",
2552
- "return": {
2553
- "type": {
2554
- "text": "Promise<void>"
2555
- }
2556
- },
2557
- "parameters": [
2558
- {
2559
- "name": "targetOpenState",
2560
- "type": {
2561
- "text": "boolean"
2562
- }
2563
- }
2564
- ]
2565
- },
2566
- {
2567
- "kind": "method",
2568
- "name": "shouldHidePopover",
2569
- "privacy": "private",
2570
- "return": {
2571
- "type": {
2572
- "text": "Promise<void>"
2573
- }
2574
- },
2575
- "parameters": [
2576
- {
2577
- "name": "targetOpenState",
2578
- "type": {
2579
- "text": "boolean"
2580
- }
2581
- }
2582
- ],
2583
- "description": "A popover should be hidden _after_ it is no longer on top-layer because\nthe position metrics will have changed from when it was originally positioned."
2584
- },
2585
- {
2586
- "kind": "method",
2587
- "name": "shouldShowPopover",
2588
- "privacy": "private",
2589
- "return": {
2590
- "type": {
2591
- "text": "Promise<void>"
2592
- }
2593
- },
2594
- "parameters": [
2595
- {
2596
- "name": "targetOpenState",
2597
- "type": {
2598
- "text": "boolean"
2599
- }
2600
- }
2601
- ]
2602
- },
2603
- {
2604
- "kind": "method",
2605
- "name": "ensureOnDOM",
2606
- "privacy": "protected",
2607
- "return": {
2608
- "type": {
2609
- "text": "Promise<void>"
2610
- }
2611
- },
2612
- "parameters": [
2613
- {
2614
- "name": "targetOpenState",
2615
- "type": {
2616
- "text": "boolean"
2617
- }
2618
- }
2619
- ]
2620
- },
2621
- {
2622
- "kind": "method",
2623
- "name": "makeTransition",
2624
- "privacy": "protected",
2625
- "return": {
2626
- "type": {
2627
- "text": "Promise<HTMLElement | null>"
2628
- }
2629
- },
2630
- "parameters": [
2631
- {
2632
- "name": "targetOpenState",
2633
- "type": {
2634
- "text": "boolean"
2635
- }
2636
- }
2637
- ]
2638
- }
2639
- ],
2640
- "events": [
2641
- {
2642
- "type": {
2643
- "text": "event"
2644
- }
2645
- },
2646
- {
2647
- "name": "eventName",
2648
- "type": {
2649
- "text": "OverlayStateEvent"
2650
- }
2651
- }
2652
- ],
2653
- "parameters": [
2654
- {
2655
- "name": "constructor",
2656
- "type": {
2657
- "text": "T"
2658
- }
2659
- }
2660
- ]
2661
- }
2662
- ],
2663
- "exports": [
2664
- {
2665
- "kind": "js",
2666
- "name": "OverlayPopover",
2667
- "declaration": {
2668
- "name": "OverlayPopover",
2669
- "module": "src/OverlayPopover.js"
2670
- }
2671
- }
2672
- ]
2673
- },
2674
- {
2675
- "kind": "javascript-module",
2676
- "path": "src/OverlayStack.js",
2677
- "declarations": [
2678
- {
2679
- "kind": "variable",
2680
- "name": "overlayStack",
2681
- "default": "new OverlayStack()"
2682
- }
2683
- ],
2684
- "exports": [
2685
- {
2686
- "kind": "js",
2687
- "name": "overlayStack",
2688
- "declaration": {
2689
- "name": "overlayStack",
2690
- "module": "src/OverlayStack.js"
2691
- }
2692
- }
2693
- ]
2694
- },
2695
- {
2696
- "kind": "javascript-module",
2697
- "path": "src/OverlayTrigger.js",
2698
- "declarations": [
2699
- {
2700
- "kind": "class",
2701
- "description": "",
2702
- "name": "OverlayTrigger",
2703
- "slots": [
2704
- {
2705
- "description": "The content that will trigger the various overlays",
2706
- "name": "trigger"
2707
- },
2708
- {
2709
- "description": "The content that will be displayed on hover",
2710
- "name": "hover-content"
2711
- },
2712
- {
2713
- "description": "The content that will be displayed on click",
2714
- "name": "click-content"
2715
- },
2716
- {
2717
- "description": "The content that will be displayed on click",
2718
- "name": "longpress-content"
2719
- }
2720
- ],
2721
- "members": [
2722
- {
2723
- "kind": "field",
2724
- "name": "content",
2725
- "type": {
2726
- "text": "string"
2727
- },
2728
- "default": "'click hover longpress'",
2729
- "attribute": "content"
2730
- },
2731
- {
2732
- "kind": "field",
2733
- "name": "placement",
2734
- "type": {
2735
- "text": "\"top\" | \"top-start\" | \"top-end\" | \"right\" | \"right-start\" | \"right-end\" | \"bottom\" | \"bottom-start\" | \"bottom-end\" | \"left\" | \"left-start\" | \"left-end\""
2736
- },
2737
- "privacy": "public",
2738
- "attribute": "placement",
2739
- "reflects": true
2740
- },
2741
- {
2742
- "kind": "field",
2743
- "name": "type",
2744
- "type": {
2745
- "text": "OverlayTriggerInteractions | undefined"
2746
- },
2747
- "privacy": "public",
2748
- "attribute": "type"
2749
- },
2750
- {
2751
- "kind": "field",
2752
- "name": "offset",
2753
- "type": {
2754
- "text": "number"
2755
- },
2756
- "privacy": "public",
2757
- "default": "6",
2758
- "attribute": "offset"
2759
- },
2760
- {
2761
- "kind": "field",
2762
- "name": "open",
2763
- "type": {
2764
- "text": "OverlayContentTypes | undefined"
2765
- },
2766
- "privacy": "public",
2767
- "attribute": "open",
2768
- "reflects": true
2769
- },
2770
- {
2771
- "kind": "field",
2772
- "name": "disabled",
2773
- "type": {
2774
- "text": "boolean"
2775
- },
2776
- "privacy": "public",
2777
- "default": "false",
2778
- "attribute": "disabled",
2779
- "reflects": true
2780
- },
2781
- {
2782
- "kind": "field",
2783
- "name": "receivesFocus",
2784
- "type": {
2785
- "text": "'true' | 'false' | 'auto'"
2786
- },
2787
- "privacy": "public",
2788
- "default": "'auto'",
2789
- "attribute": "receives-focus"
2790
- },
2791
- {
2792
- "kind": "field",
2793
- "name": "clickContent",
2794
- "type": {
2795
- "text": "HTMLElement[]"
2796
- },
2797
- "privacy": "private",
2798
- "default": "[]"
2799
- },
2800
- {
2801
- "kind": "field",
2802
- "name": "clickPlacement",
2803
- "type": {
2804
- "text": "Placement | undefined"
2805
- },
2806
- "privacy": "private"
2807
- },
2808
- {
2809
- "kind": "field",
2810
- "name": "longpressContent",
2811
- "type": {
2812
- "text": "HTMLElement[]"
2813
- },
2814
- "privacy": "private",
2815
- "default": "[]"
2816
- },
2817
- {
2818
- "kind": "field",
2819
- "name": "longpressPlacement",
2820
- "type": {
2821
- "text": "Placement | undefined"
2822
- },
2823
- "privacy": "private"
2824
- },
2825
- {
2826
- "kind": "field",
2827
- "name": "hoverContent",
2828
- "type": {
2829
- "text": "HTMLElement[]"
2830
- },
2831
- "privacy": "private",
2832
- "default": "[]"
2833
- },
2834
- {
2835
- "kind": "field",
2836
- "name": "hoverPlacement",
2837
- "type": {
2838
- "text": "Placement | undefined"
2839
- },
2840
- "privacy": "private"
2841
- },
2842
- {
2843
- "kind": "field",
2844
- "name": "targetContent",
2845
- "type": {
2846
- "text": "HTMLElement[]"
2847
- },
2848
- "privacy": "private",
2849
- "default": "[]"
2850
- },
2851
- {
2852
- "kind": "field",
2853
- "name": "clickOverlayElement",
2854
- "type": {
2855
- "text": "Overlay"
2856
- }
2857
- },
2858
- {
2859
- "kind": "field",
2860
- "name": "longpressOverlayElement",
2861
- "type": {
2862
- "text": "Overlay"
2863
- }
2864
- },
2865
- {
2866
- "kind": "field",
2867
- "name": "hoverOverlayElement",
2868
- "type": {
2869
- "text": "Overlay"
2870
- }
2871
- },
2872
- {
2873
- "kind": "method",
2874
- "name": "getAssignedElementsFromSlot",
2875
- "privacy": "private",
2876
- "return": {
2877
- "type": {
2878
- "text": "HTMLElement[]"
2879
- }
2880
- },
2881
- "parameters": [
2882
- {
2883
- "name": "slot",
2884
- "type": {
2885
- "text": "HTMLSlotElement"
2886
- }
2887
- }
2888
- ]
2889
- },
2890
- {
2891
- "kind": "method",
2892
- "name": "handleTriggerContent",
2893
- "privacy": "private",
2894
- "return": {
2895
- "type": {
2896
- "text": "void"
2897
- }
2898
- },
2899
- "parameters": [
2900
- {
2901
- "name": "event",
2902
- "type": {
2903
- "text": "Event & { target: HTMLSlotElement }"
2904
- }
2905
- }
2906
- ]
2907
- },
2908
- {
2909
- "kind": "method",
2910
- "name": "handleSlotContent",
2911
- "privacy": "private",
2912
- "return": {
2913
- "type": {
2914
- "text": "void"
2915
- }
2916
- },
2917
- "parameters": [
2918
- {
2919
- "name": "event",
2920
- "type": {
2921
- "text": "Event & { target: HTMLSlotElement }"
2922
- }
2923
- }
2924
- ]
2925
- },
2926
- {
2927
- "kind": "method",
2928
- "name": "handleBeforetoggle",
2929
- "privacy": "private",
2930
- "return": {
2931
- "type": {
2932
- "text": "void"
2933
- }
2934
- },
2935
- "parameters": [
2936
- {
2937
- "name": "event",
2938
- "type": {
2939
- "text": "BeforetoggleOpenEvent"
2940
- }
2941
- }
2942
- ]
2943
- },
2944
- {
2945
- "kind": "method",
2946
- "name": "renderSlot",
2947
- "privacy": "protected",
2948
- "return": {
2949
- "type": {
2950
- "text": "TemplateResult"
2951
- }
2952
- },
2953
- "parameters": [
2954
- {
2955
- "name": "name",
2956
- "type": {
2957
- "text": "string"
2958
- }
2959
- }
2960
- ]
2961
- },
2962
- {
2963
- "kind": "method",
2964
- "name": "renderClickOverlay",
2965
- "privacy": "protected",
2966
- "return": {
2967
- "type": {
2968
- "text": "TemplateResult"
2969
- }
2970
- }
2971
- },
2972
- {
2973
- "kind": "method",
2974
- "name": "renderHoverOverlay",
2975
- "privacy": "protected",
2976
- "return": {
2977
- "type": {
2978
- "text": "TemplateResult"
2979
- }
2980
- }
2981
- },
2982
- {
2983
- "kind": "method",
2984
- "name": "renderLongpressOverlay",
2985
- "privacy": "protected",
2986
- "return": {
2987
- "type": {
2988
- "text": "TemplateResult"
2989
- }
2990
- }
2991
- },
2992
- {
2993
- "kind": "method",
2994
- "name": "getUpdateComplete",
2995
- "privacy": "protected",
2996
- "return": {
2997
- "type": {
2998
- "text": "Promise<boolean>"
2999
- }
3000
- }
3001
- }
3002
- ],
3003
- "events": [
3004
- {
3005
- "description": "Announces that the overlay has been opened",
3006
- "name": "sp-opened"
3007
- },
3008
- {
3009
- "description": "Announces that the overlay has been closed",
3010
- "name": "sp-closed"
3011
- }
3012
- ],
3013
- "attributes": [
3014
- {
3015
- "name": "placement",
3016
- "type": {
3017
- "text": "\"top\" | \"top-start\" | \"top-end\" | \"right\" | \"right-start\" | \"right-end\" | \"bottom\" | \"bottom-start\" | \"bottom-end\" | \"left\" | \"left-start\" | \"left-end\""
3018
- },
3019
- "fieldName": "placement",
3020
- "attribute": "placement"
3021
- },
3022
- {
3023
- "name": "content",
3024
- "type": {
3025
- "text": "string"
3026
- },
3027
- "default": "'click hover longpress'",
3028
- "fieldName": "content"
3029
- },
3030
- {
3031
- "name": "type",
3032
- "type": {
3033
- "text": "OverlayTriggerInteractions | undefined"
3034
- },
3035
- "fieldName": "type"
3036
- },
3037
- {
3038
- "name": "offset",
3039
- "type": {
3040
- "text": "number"
3041
- },
3042
- "default": "6",
3043
- "fieldName": "offset"
3044
- },
3045
- {
3046
- "name": "open",
3047
- "type": {
3048
- "text": "OverlayContentTypes | undefined"
3049
- },
3050
- "fieldName": "open"
3051
- },
3052
- {
3053
- "name": "disabled",
3054
- "type": {
3055
- "text": "boolean"
3056
- },
3057
- "default": "false",
3058
- "fieldName": "disabled"
3059
- },
3060
- {
3061
- "name": "receives-focus",
3062
- "type": {
3063
- "text": "'true' | 'false' | 'auto'"
3064
- },
3065
- "default": "'auto'",
3066
- "fieldName": "receivesFocus"
3067
- }
3068
- ],
3069
- "superclass": {
3070
- "name": "SpectrumElement",
3071
- "package": "@spectrum-web-components/base"
3072
- },
3073
- "tagName": "overlay-trigger",
3074
- "customElement": true
3075
- }
3076
- ],
3077
- "exports": [
3078
- {
3079
- "kind": "js",
3080
- "name": "OverlayTrigger",
3081
- "declaration": {
3082
- "name": "OverlayTrigger",
3083
- "module": "src/OverlayTrigger.js"
3084
- }
3085
- }
3086
- ]
3087
- },
3088
- {
3089
- "kind": "javascript-module",
3090
- "path": "src/PlacementController.js",
3091
- "declarations": [
3092
- {
3093
- "kind": "variable",
3094
- "name": "placementUpdatedSymbol"
3095
- },
3096
- {
3097
- "kind": "class",
3098
- "description": "",
3099
- "name": "PlacementController",
3100
- "members": [
3101
- {
3102
- "kind": "field",
3103
- "name": "cleanup",
3104
- "type": {
3105
- "text": "() => void | undefined"
3106
- },
3107
- "privacy": "private"
3108
- },
3109
- {
3110
- "kind": "field",
3111
- "name": "initialHeight",
3112
- "type": {
3113
- "text": "number | undefined"
3114
- }
3115
- },
3116
- {
3117
- "kind": "field",
3118
- "name": "isConstrained",
3119
- "type": {
3120
- "text": "boolean | undefined"
3121
- }
3122
- },
3123
- {
3124
- "kind": "field",
3125
- "name": "host",
3126
- "type": {
3127
- "text": "ReactiveElement & { elements: OpenableElement[] }"
3128
- },
3129
- "privacy": "private",
3130
- "default": "host"
3131
- },
3132
- {
3133
- "kind": "field",
3134
- "name": "options",
3135
- "type": {
3136
- "text": "OverlayOptionsV1"
3137
- },
3138
- "privacy": "private"
3139
- },
3140
- {
3141
- "kind": "field",
3142
- "name": "originalPlacements",
3143
- "privacy": "private",
3144
- "default": "new WeakMap<HTMLElement, Placement>()"
3145
- },
3146
- {
3147
- "kind": "field",
3148
- "name": "target",
3149
- "type": {
3150
- "text": "HTMLElement"
3151
- },
3152
- "privacy": "private"
3153
- },
3154
- {
3155
- "kind": "method",
3156
- "name": "placeOverlay",
3157
- "privacy": "public",
3158
- "return": {
3159
- "type": {
3160
- "text": "Promise<void>"
3161
- }
3162
- },
3163
- "parameters": [
3164
- {
3165
- "name": "target",
3166
- "default": "this.target",
3167
- "type": {
3168
- "text": "HTMLElement"
3169
- }
3170
- },
3171
- {
3172
- "name": "options",
3173
- "default": "this.options",
3174
- "type": {
3175
- "text": "OverlayOptionsV1"
3176
- }
3177
- }
3178
- ]
3179
- },
3180
- {
3181
- "kind": "field",
3182
- "name": "allowPlacementUpdate",
3183
- "type": {
3184
- "text": "boolean"
3185
- },
3186
- "default": "false"
3187
- },
3188
- {
3189
- "kind": "field",
3190
- "name": "closeForAncestorUpdate"
3191
- },
3192
- {
3193
- "kind": "field",
3194
- "name": "updatePlacement"
3195
- },
3196
- {
3197
- "kind": "method",
3198
- "name": "computePlacement",
3199
- "return": {
3200
- "type": {
3201
- "text": "Promise<void>"
3202
- }
3203
- }
3204
- },
3205
- {
3206
- "kind": "method",
3207
- "name": "clearOverlayPosition",
3208
- "privacy": "public",
3209
- "return": {
3210
- "type": {
3211
- "text": "void"
3212
- }
3213
- }
3214
- },
3215
- {
3216
- "kind": "field",
3217
- "name": "resetOverlayPosition",
3218
- "privacy": "public"
3219
- },
3220
- {
3221
- "kind": "method",
3222
- "name": "hostConnected",
3223
- "return": {
3224
- "type": {
3225
- "text": "void"
3226
- }
3227
- }
3228
- },
3229
- {
3230
- "kind": "method",
3231
- "name": "hostUpdated",
3232
- "return": {
3233
- "type": {
3234
- "text": "void"
3235
- }
3236
- }
3237
- },
3238
- {
3239
- "kind": "method",
3240
- "name": "hostDisconnected",
3241
- "return": {
3242
- "type": {
3243
- "text": "void"
3244
- }
3245
- }
3246
- }
3247
- ]
3248
- }
3249
- ],
3250
- "exports": [
3251
- {
3252
- "kind": "js",
3253
- "name": "placementUpdatedSymbol",
3254
- "declaration": {
3255
- "name": "placementUpdatedSymbol",
3256
- "module": "src/PlacementController.js"
3257
- }
3258
- },
3259
- {
3260
- "kind": "js",
3261
- "name": "PlacementController",
3262
- "declaration": {
3263
- "name": "PlacementController",
3264
- "module": "src/PlacementController.js"
3265
- }
3266
- }
3267
- ]
3268
- },
3269
- {
3270
- "kind": "javascript-module",
3271
- "path": "src/VirtualTrigger.js",
3272
- "declarations": [
3273
- {
3274
- "kind": "class",
3275
- "description": "",
3276
- "name": "VirtualTrigger",
3277
- "members": [
3278
- {
3279
- "kind": "field",
3280
- "name": "x",
3281
- "type": {
3282
- "text": "number"
3283
- },
3284
- "privacy": "private",
3285
- "default": "x"
3286
- },
3287
- {
3288
- "kind": "field",
3289
- "name": "y",
3290
- "type": {
3291
- "text": "number"
3292
- },
3293
- "privacy": "private",
3294
- "default": "y"
3295
- },
3296
- {
3297
- "kind": "method",
3298
- "name": "updateBoundingClientRect",
3299
- "privacy": "public",
3300
- "return": {
3301
- "type": {
3302
- "text": "void"
3303
- }
3304
- },
3305
- "parameters": [
3306
- {
3307
- "name": "x",
3308
- "type": {
3309
- "text": "number"
3310
- }
3311
- },
3312
- {
3313
- "name": "y",
3314
- "type": {
3315
- "text": "number"
3316
- }
3317
- }
3318
- ]
3319
- },
3320
- {
3321
- "kind": "method",
3322
- "name": "getBoundingClientRect",
3323
- "privacy": "public",
3324
- "return": {
3325
- "type": {
3326
- "text": "DOMRect"
3327
- }
3328
- }
3329
- }
3330
- ]
3331
- }
3332
- ],
3333
- "exports": [
3334
- {
3335
- "kind": "js",
3336
- "name": "VirtualTrigger",
3337
- "declaration": {
3338
- "name": "VirtualTrigger",
3339
- "module": "src/VirtualTrigger.js"
3340
- }
3341
- }
3342
- ]
3343
- }
3344
- ]
3345
- }