@spectrum-web-components/overlay 0.16.0 → 0.16.3-slim.2

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 (12) hide show
  1. package/custom-elements.json +0 -936
  2. package/package.json +6 -6
  3. package/src/ActiveOverlay.js +31 -6
  4. package/src/ActiveOverlay.js.map +1 -1
  5. package/src/OverlayTrigger.js +3 -1
  6. package/src/OverlayTrigger.js.map +1 -1
  7. package/stories/overlay.stories.js +9 -2
  8. package/stories/overlay.stories.js.map +1 -1
  9. package/test/overlay-trigger-hover.test.js +8 -7
  10. package/test/overlay-trigger-hover.test.js.map +1 -1
  11. package/test/overlay.test.js +37 -1
  12. package/test/overlay.test.js.map +1 -1
package/custom-elements.json CHANGED
@@ -2,42 +2,6 @@
2
2
  "schemaVersion": "1.0.0",
3
3
  "readme": "",
4
4
  "modules": [
5
- {
6
- "kind": "javascript-module",
7
- "path": "active-overlay.ts",
8
- "declarations": [],
9
- "exports": [
10
- {
11
- "kind": "custom-element-definition",
12
- "name": "active-overlay",
13
- "declaration": {
14
- "name": "ActiveOverlay",
15
- "module": "/src/ActiveOverlay.js"
16
- }
17
- }
18
- ]
19
- },
20
- {
21
- "kind": "javascript-module",
22
- "path": "overlay-trigger.ts",
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.ts",
38
- "declarations": [],
39
- "exports": []
40
- },
41
5
  {
42
6
  "kind": "javascript-module",
43
7
  "path": "src/ActiveOverlay.ts",
@@ -1173,906 +1137,6 @@
1173
1137
  }
1174
1138
  }
1175
1139
  ]
1176
- },
1177
- {
1178
- "kind": "javascript-module",
1179
- "path": "src/active-overlay.css.ts",
1180
- "declarations": [
1181
- {
1182
- "kind": "variable",
1183
- "name": "styles",
1184
- "default": "css`\n@keyframes sp-overlay-fade-in{0%{opacity:0;transform:var(--sp-overlay-from)}to{opacity:1;transform:translate(0)}}@keyframes sp-overlay-fade-out{0%{opacity:1;transform:translate(0)}to{opacity:0;transform:var(--sp-overlay-from)}}:host{display:inline-block;left:-9999em;pointer-events:none;position:absolute;top:-9999em;z-index:1000}:host(:focus){outline:none}:host([placement=none]){height:100vh;height:-webkit-fill-available;height:fill-available;left:0;max-height:var(--swc-visual-viewport-height);position:fixed;top:0}#contents,sp-theme{height:100%}#contents{--swc-overlay-animation-distance:var(\n--spectrum-picker-m-texticon-popover-offset-y,var(--spectrum-global-dimension-size-75)\n);animation-duration:var(\n--swc-test-duration,var(--spectrum-global-animation-duration-200,.16s)\n);animation-timing-function:var(\n--spectrum-global-animation-ease-out,ease-out\n);box-sizing:border-box;display:inline-block;opacity:1;pointer-events:none;visibility:visible}:host([actual-placement*=top]) #contents{--sp-overlay-from:translateY(var(--spectrum-global-dimension-size-75));align-items:flex-end;display:inline-flex;padding-top:var(--swc-overlay-animation-distance)}:host([actual-placement*=right]) #contents{--sp-overlay-from:translateX(calc(var(--spectrum-global-dimension-size-75)*-1));padding-right:var(--swc-overlay-animation-distance)}:host([actual-placement*=bottom]) #contents{--sp-overlay-from:translateY(calc(var(--spectrum-global-dimension-size-75)*-1));padding-bottom:var(--swc-overlay-animation-distance)}:host([actual-placement*=left]) #contents{--sp-overlay-from:translateX(var(--spectrum-global-dimension-size-75));padding-left:var(--swc-overlay-animation-distance)}:host([animating]) ::slotted(*){pointer-events:none}:host(:not([animating])) ::slotted(*){pointer-events:auto}#contents ::slotted(*){position:relative}\n`"
1185
- }
1186
- ],
1187
- "exports": [
1188
- {
1189
- "kind": "js",
1190
- "name": "default",
1191
- "declaration": {
1192
- "name": "styles",
1193
- "module": "src/active-overlay.css.ts"
1194
- }
1195
- }
1196
- ]
1197
- },
1198
- {
1199
- "kind": "javascript-module",
1200
- "path": "src/index.ts",
1201
- "declarations": [],
1202
- "exports": [
1203
- {
1204
- "kind": "js",
1205
- "name": "*",
1206
- "declaration": {
1207
- "name": "*",
1208
- "package": "./overlay.js"
1209
- }
1210
- },
1211
- {
1212
- "kind": "js",
1213
- "name": "*",
1214
- "declaration": {
1215
- "name": "*",
1216
- "package": "./OverlayTrigger.js"
1217
- }
1218
- },
1219
- {
1220
- "kind": "js",
1221
- "name": "*",
1222
- "declaration": {
1223
- "name": "*",
1224
- "package": "./overlay-types.js"
1225
- }
1226
- },
1227
- {
1228
- "kind": "js",
1229
- "name": "*",
1230
- "declaration": {
1231
- "name": "*",
1232
- "package": "./ActiveOverlay.js"
1233
- }
1234
- },
1235
- {
1236
- "kind": "js",
1237
- "name": "*",
1238
- "declaration": {
1239
- "name": "*",
1240
- "package": "./loader.js"
1241
- }
1242
- },
1243
- {
1244
- "kind": "js",
1245
- "name": "*",
1246
- "declaration": {
1247
- "name": "*",
1248
- "package": "./VirtualTrigger.js"
1249
- }
1250
- }
1251
- ]
1252
- },
1253
- {
1254
- "kind": "javascript-module",
1255
- "path": "src/loader.ts",
1256
- "declarations": [
1257
- {
1258
- "kind": "function",
1259
- "name": "openOverlay",
1260
- "return": {
1261
- "type": {
1262
- "text": "Promise<() => void>"
1263
- }
1264
- },
1265
- "parameters": [
1266
- {
1267
- "name": "target",
1268
- "type": {
1269
- "text": "HTMLElement"
1270
- }
1271
- },
1272
- {
1273
- "name": "interaction",
1274
- "type": {
1275
- "text": "TriggerInteractions"
1276
- }
1277
- },
1278
- {
1279
- "name": "content",
1280
- "type": {
1281
- "text": "HTMLElement"
1282
- }
1283
- },
1284
- {
1285
- "name": "options",
1286
- "type": {
1287
- "text": "OverlayOptions"
1288
- }
1289
- }
1290
- ]
1291
- }
1292
- ],
1293
- "exports": [
1294
- {
1295
- "kind": "js",
1296
- "name": "openOverlay",
1297
- "declaration": {
1298
- "name": "openOverlay",
1299
- "module": "src/loader.ts"
1300
- }
1301
- }
1302
- ]
1303
- },
1304
- {
1305
- "kind": "javascript-module",
1306
- "path": "src/overlay-stack.ts",
1307
- "declarations": [
1308
- {
1309
- "kind": "class",
1310
- "description": "",
1311
- "name": "OverlayStack",
1312
- "members": [
1313
- {
1314
- "kind": "field",
1315
- "name": "overlays",
1316
- "type": {
1317
- "text": "ActiveOverlay[]"
1318
- },
1319
- "privacy": "public",
1320
- "default": "[]"
1321
- },
1322
- {
1323
- "kind": "field",
1324
- "name": "preventMouseRootClose",
1325
- "type": {
1326
- "text": "boolean"
1327
- },
1328
- "privacy": "private",
1329
- "default": "false"
1330
- },
1331
- {
1332
- "kind": "field",
1333
- "name": "root",
1334
- "type": {
1335
- "text": "HTMLElement"
1336
- },
1337
- "privacy": "private"
1338
- },
1339
- {
1340
- "kind": "field",
1341
- "name": "handlingResize",
1342
- "type": {
1343
- "text": "boolean"
1344
- },
1345
- "privacy": "private",
1346
- "default": "false"
1347
- },
1348
- {
1349
- "kind": "field",
1350
- "name": "overlayTimer",
1351
- "privacy": "private",
1352
- "default": "new OverlayTimer()"
1353
- },
1354
- {
1355
- "kind": "field",
1356
- "name": "canTabTrap",
1357
- "type": {
1358
- "text": "boolean"
1359
- },
1360
- "privacy": "private",
1361
- "default": "true"
1362
- },
1363
- {
1364
- "kind": "field",
1365
- "name": "trappingInited",
1366
- "type": {
1367
- "text": "boolean"
1368
- },
1369
- "privacy": "private",
1370
- "default": "false"
1371
- },
1372
- {
1373
- "kind": "field",
1374
- "name": "tabTrapper",
1375
- "type": {
1376
- "text": "HTMLElement"
1377
- },
1378
- "privacy": "private"
1379
- },
1380
- {
1381
- "kind": "field",
1382
- "name": "overlayHolder",
1383
- "type": {
1384
- "text": "HTMLElement"
1385
- },
1386
- "privacy": "private"
1387
- },
1388
- {
1389
- "kind": "field",
1390
- "name": "_eventsAreBound",
1391
- "type": {
1392
- "text": "boolean"
1393
- },
1394
- "privacy": "private",
1395
- "default": "false"
1396
- },
1397
- {
1398
- "kind": "method",
1399
- "name": "initTabTrapping",
1400
- "privacy": "private",
1401
- "return": {
1402
- "type": {
1403
- "text": "void"
1404
- }
1405
- }
1406
- },
1407
- {
1408
- "kind": "field",
1409
- "name": "_bodyMarginsApplied",
1410
- "type": {
1411
- "text": "boolean"
1412
- },
1413
- "privacy": "private",
1414
- "default": "false"
1415
- },
1416
- {
1417
- "kind": "method",
1418
- "name": "applyBodyMargins",
1419
- "privacy": "private",
1420
- "return": {
1421
- "type": {
1422
- "text": "void"
1423
- }
1424
- }
1425
- },
1426
- {
1427
- "kind": "method",
1428
- "name": "startTabTrapping",
1429
- "privacy": "private",
1430
- "return": {
1431
- "type": {
1432
- "text": "void"
1433
- }
1434
- }
1435
- },
1436
- {
1437
- "kind": "method",
1438
- "name": "stopTabTrapping",
1439
- "privacy": "private",
1440
- "return": {
1441
- "type": {
1442
- "text": "void"
1443
- }
1444
- }
1445
- },
1446
- {
1447
- "kind": "field",
1448
- "name": "forwardContextmenuEvent",
1449
- "privacy": "private"
1450
- },
1451
- {
1452
- "kind": "field",
1453
- "name": "document",
1454
- "type": {
1455
- "text": "Document"
1456
- },
1457
- "privacy": "private"
1458
- },
1459
- {
1460
- "kind": "field",
1461
- "name": "topOverlay",
1462
- "type": {
1463
- "text": "ActiveOverlay | undefined"
1464
- },
1465
- "privacy": "private"
1466
- },
1467
- {
1468
- "kind": "method",
1469
- "name": "findOverlayForContent",
1470
- "privacy": "private",
1471
- "return": {
1472
- "type": {
1473
- "text": "ActiveOverlay | undefined"
1474
- }
1475
- },
1476
- "parameters": [
1477
- {
1478
- "name": "overlayContent",
1479
- "type": {
1480
- "text": "HTMLElement"
1481
- }
1482
- }
1483
- ]
1484
- },
1485
- {
1486
- "kind": "method",
1487
- "name": "addEventListeners",
1488
- "privacy": "private",
1489
- "return": {
1490
- "type": {
1491
- "text": "void"
1492
- }
1493
- }
1494
- },
1495
- {
1496
- "kind": "method",
1497
- "name": "isClickOverlayActiveForTrigger",
1498
- "privacy": "private",
1499
- "return": {
1500
- "type": {
1501
- "text": "boolean"
1502
- }
1503
- },
1504
- "parameters": [
1505
- {
1506
- "name": "trigger",
1507
- "type": {
1508
- "text": "HTMLElement"
1509
- }
1510
- }
1511
- ]
1512
- },
1513
- {
1514
- "kind": "method",
1515
- "name": "openOverlay",
1516
- "privacy": "public",
1517
- "return": {
1518
- "type": {
1519
- "text": "Promise<boolean>"
1520
- }
1521
- },
1522
- "parameters": [
1523
- {
1524
- "name": "details",
1525
- "type": {
1526
- "text": "OverlayOpenDetail"
1527
- }
1528
- }
1529
- ]
1530
- },
1531
- {
1532
- "kind": "method",
1533
- "name": "addOverlayEventListeners",
1534
- "privacy": "public",
1535
- "return": {
1536
- "type": {
1537
- "text": "void"
1538
- }
1539
- },
1540
- "parameters": [
1541
- {
1542
- "name": "activeOverlay",
1543
- "type": {
1544
- "text": "ActiveOverlay"
1545
- }
1546
- }
1547
- ]
1548
- },
1549
- {
1550
- "kind": "method",
1551
- "name": "addReplaceOverlayEventListeners",
1552
- "privacy": "public",
1553
- "return": {
1554
- "type": {
1555
- "text": "void"
1556
- }
1557
- },
1558
- "parameters": [
1559
- {
1560
- "name": "activeOverlay",
1561
- "type": {
1562
- "text": "ActiveOverlay"
1563
- }
1564
- }
1565
- ]
1566
- },
1567
- {
1568
- "kind": "method",
1569
- "name": "addInlineOverlayEventListeners",
1570
- "privacy": "public",
1571
- "return": {
1572
- "type": {
1573
- "text": "void"
1574
- }
1575
- },
1576
- "parameters": [
1577
- {
1578
- "name": "activeOverlay",
1579
- "type": {
1580
- "text": "ActiveOverlay"
1581
- }
1582
- }
1583
- ]
1584
- },
1585
- {
1586
- "kind": "method",
1587
- "name": "closeOverlay",
1588
- "privacy": "public",
1589
- "return": {
1590
- "type": {
1591
- "text": "void"
1592
- }
1593
- },
1594
- "parameters": [
1595
- {
1596
- "name": "content",
1597
- "type": {
1598
- "text": "HTMLElement"
1599
- }
1600
- }
1601
- ]
1602
- },
1603
- {
1604
- "kind": "field",
1605
- "name": "handleMouseCapture",
1606
- "privacy": "private"
1607
- },
1608
- {
1609
- "kind": "method",
1610
- "name": "closeAllHoverOverlays",
1611
- "privacy": "private",
1612
- "return": {
1613
- "type": {
1614
- "text": "void"
1615
- }
1616
- }
1617
- },
1618
- {
1619
- "kind": "method",
1620
- "name": "manageFocusAfterCloseWhenOverlaysRemain",
1621
- "privacy": "private",
1622
- "return": {
1623
- "type": {
1624
- "text": "Promise<void>"
1625
- }
1626
- }
1627
- },
1628
- {
1629
- "kind": "method",
1630
- "name": "manageFocusAfterCloseWhenLastOverlay",
1631
- "privacy": "private",
1632
- "return": {
1633
- "type": {
1634
- "text": "void"
1635
- }
1636
- },
1637
- "parameters": [
1638
- {
1639
- "name": "overlay",
1640
- "type": {
1641
- "text": "ActiveOverlay"
1642
- }
1643
- }
1644
- ]
1645
- },
1646
- {
1647
- "kind": "method",
1648
- "name": "hideAndCloseOverlay",
1649
- "privacy": "private",
1650
- "return": {
1651
- "type": {
1652
- "text": "Promise<void>"
1653
- }
1654
- },
1655
- "parameters": [
1656
- {
1657
- "name": "overlay",
1658
- "optional": true,
1659
- "type": {
1660
- "text": "ActiveOverlay"
1661
- }
1662
- },
1663
- {
1664
- "name": "animated",
1665
- "optional": true,
1666
- "type": {
1667
- "text": "boolean"
1668
- }
1669
- },
1670
- {
1671
- "name": "clickAway",
1672
- "optional": true,
1673
- "type": {
1674
- "text": "boolean"
1675
- }
1676
- }
1677
- ]
1678
- },
1679
- {
1680
- "kind": "method",
1681
- "name": "closeTopOverlay",
1682
- "privacy": "private",
1683
- "return": {
1684
- "type": {
1685
- "text": "Promise<void>"
1686
- }
1687
- },
1688
- "parameters": [
1689
- {
1690
- "name": "clickAway",
1691
- "optional": true,
1692
- "type": {
1693
- "text": "boolean"
1694
- }
1695
- }
1696
- ]
1697
- },
1698
- {
1699
- "kind": "field",
1700
- "name": "_doesNotCloseOnFirstClick",
1701
- "type": {
1702
- "text": "boolean"
1703
- },
1704
- "privacy": "private",
1705
- "default": "false",
1706
- "description": "A \"longpress\" occurs before the \"click\" that creates it has occured.\nIn that way the first click will still be part of the \"longpress\" and\nnot part of closing the overlay."
1707
- },
1708
- {
1709
- "kind": "field",
1710
- "name": "handleMouse",
1711
- "privacy": "private"
1712
- },
1713
- {
1714
- "kind": "field",
1715
- "name": "handleKeyUp",
1716
- "privacy": "private"
1717
- },
1718
- {
1719
- "kind": "field",
1720
- "name": "handleResize",
1721
- "privacy": "private"
1722
- }
1723
- ]
1724
- }
1725
- ],
1726
- "exports": [
1727
- {
1728
- "kind": "js",
1729
- "name": "OverlayStack",
1730
- "declaration": {
1731
- "name": "OverlayStack",
1732
- "module": "src/overlay-stack.ts"
1733
- }
1734
- }
1735
- ]
1736
- },
1737
- {
1738
- "kind": "javascript-module",
1739
- "path": "src/overlay-timer.ts",
1740
- "declarations": [
1741
- {
1742
- "kind": "class",
1743
- "description": "A timer to help with implementation of warnup/cooldown behavior as described here:\nhttps://spectrum.adobe.com/page/tooltip/#Immediate-or-delayed-appearance",
1744
- "name": "OverlayTimer",
1745
- "members": [
1746
- {
1747
- "kind": "field",
1748
- "name": "warmUpDelay",
1749
- "privacy": "private",
1750
- "default": "1000",
1751
- "type": {
1752
- "text": "number"
1753
- }
1754
- },
1755
- {
1756
- "kind": "field",
1757
- "name": "coolDownDelay",
1758
- "privacy": "private",
1759
- "default": "1000",
1760
- "type": {
1761
- "text": "number"
1762
- }
1763
- },
1764
- {
1765
- "kind": "field",
1766
- "name": "isWarm",
1767
- "type": {
1768
- "text": "boolean"
1769
- },
1770
- "privacy": "private",
1771
- "default": "false"
1772
- },
1773
- {
1774
- "kind": "field",
1775
- "name": "cooldownTimeout",
1776
- "type": {
1777
- "text": "number | undefined"
1778
- },
1779
- "privacy": "private"
1780
- },
1781
- {
1782
- "kind": "field",
1783
- "name": "component",
1784
- "type": {
1785
- "text": "HTMLElement | undefined"
1786
- },
1787
- "privacy": "private"
1788
- },
1789
- {
1790
- "kind": "field",
1791
- "name": "timeout",
1792
- "type": {
1793
- "text": "number"
1794
- },
1795
- "privacy": "private",
1796
- "default": "0"
1797
- },
1798
- {
1799
- "kind": "field",
1800
- "name": "promise",
1801
- "type": {
1802
- "text": "Promise<boolean> | undefined"
1803
- },
1804
- "privacy": "private"
1805
- },
1806
- {
1807
- "kind": "field",
1808
- "name": "resolve",
1809
- "type": {
1810
- "text": "(cancelled: boolean) => void | undefined"
1811
- },
1812
- "privacy": "private"
1813
- },
1814
- {
1815
- "kind": "method",
1816
- "name": "openTimer",
1817
- "privacy": "public",
1818
- "return": {
1819
- "type": {
1820
- "text": "Promise<boolean>"
1821
- }
1822
- },
1823
- "parameters": [
1824
- {
1825
- "name": "component",
1826
- "type": {
1827
- "text": "HTMLElement"
1828
- }
1829
- }
1830
- ]
1831
- },
1832
- {
1833
- "kind": "method",
1834
- "name": "close",
1835
- "privacy": "public",
1836
- "return": {
1837
- "type": {
1838
- "text": "void"
1839
- }
1840
- },
1841
- "parameters": [
1842
- {
1843
- "name": "component",
1844
- "type": {
1845
- "text": "HTMLElement"
1846
- }
1847
- }
1848
- ]
1849
- },
1850
- {
1851
- "kind": "method",
1852
- "name": "resetCooldownTimer",
1853
- "privacy": "private",
1854
- "return": {
1855
- "type": {
1856
- "text": "void"
1857
- }
1858
- }
1859
- },
1860
- {
1861
- "kind": "method",
1862
- "name": "cancelCooldownTimer",
1863
- "privacy": "private",
1864
- "return": {
1865
- "type": {
1866
- "text": "void"
1867
- }
1868
- }
1869
- }
1870
- ]
1871
- }
1872
- ],
1873
- "exports": [
1874
- {
1875
- "kind": "js",
1876
- "name": "OverlayTimer",
1877
- "declaration": {
1878
- "name": "OverlayTimer",
1879
- "module": "src/overlay-timer.ts"
1880
- }
1881
- }
1882
- ]
1883
- },
1884
- {
1885
- "kind": "javascript-module",
1886
- "path": "src/overlay-trigger.css.ts",
1887
- "declarations": [
1888
- {
1889
- "kind": "variable",
1890
- "name": "styles",
1891
- "default": "css`\n:host([disabled]) ::slotted([slot=trigger]){pointer-events:none}#overlay-content slot{display:none}\n`"
1892
- }
1893
- ],
1894
- "exports": [
1895
- {
1896
- "kind": "js",
1897
- "name": "default",
1898
- "declaration": {
1899
- "name": "styles",
1900
- "module": "src/overlay-trigger.css.ts"
1901
- }
1902
- }
1903
- ]
1904
- },
1905
- {
1906
- "kind": "javascript-module",
1907
- "path": "src/overlay-types.ts",
1908
- "declarations": [],
1909
- "exports": []
1910
- },
1911
- {
1912
- "kind": "javascript-module",
1913
- "path": "src/overlay.ts",
1914
- "declarations": [
1915
- {
1916
- "kind": "class",
1917
- "description": "This class allows access to the overlay system which allows a client to\nposition an element in the overlay positioned relative to another node.",
1918
- "name": "Overlay",
1919
- "members": [
1920
- {
1921
- "kind": "field",
1922
- "name": "overlayStack",
1923
- "privacy": "private",
1924
- "static": true,
1925
- "default": "new OverlayStack()"
1926
- },
1927
- {
1928
- "kind": "field",
1929
- "name": "isOpen",
1930
- "type": {
1931
- "text": "boolean"
1932
- },
1933
- "privacy": "private",
1934
- "default": "false"
1935
- },
1936
- {
1937
- "kind": "field",
1938
- "name": "overlayElement",
1939
- "type": {
1940
- "text": "HTMLElement"
1941
- },
1942
- "privacy": "private",
1943
- "default": "overlayElement"
1944
- },
1945
- {
1946
- "kind": "field",
1947
- "name": "owner",
1948
- "type": {
1949
- "text": "HTMLElement"
1950
- },
1951
- "privacy": "private",
1952
- "default": "owner"
1953
- },
1954
- {
1955
- "kind": "field",
1956
- "name": "interaction",
1957
- "type": {
1958
- "text": "TriggerInteractions"
1959
- },
1960
- "privacy": "private",
1961
- "default": "interaction"
1962
- },
1963
- {
1964
- "kind": "method",
1965
- "name": "open",
1966
- "privacy": "public",
1967
- "static": true,
1968
- "return": {
1969
- "type": {
1970
- "text": ""
1971
- }
1972
- },
1973
- "parameters": [
1974
- {
1975
- "name": "owner",
1976
- "type": {
1977
- "text": "HTMLElement"
1978
- },
1979
- "description": "the parent element we will use to position the overlay element"
1980
- },
1981
- {
1982
- "name": "interaction",
1983
- "type": {
1984
- "text": "TriggerInteractions"
1985
- },
1986
- "description": "the type of interaction that caused this overlay to be shown"
1987
- },
1988
- {
1989
- "name": "overlayElement",
1990
- "type": {
1991
- "text": "HTMLElement"
1992
- },
1993
- "description": "the item to display as an overlay"
1994
- },
1995
- {
1996
- "name": "options",
1997
- "type": {
1998
- "text": "OverlayOptions"
1999
- },
2000
- "description": "display parameters"
2001
- },
2002
- {
2003
- "description": "if true delay opening of the overlay based on the global warmup/cooldown timer",
2004
- "name": "options.delayed"
2005
- },
2006
- {
2007
- "description": "distance to offset the overlay",
2008
- "name": "options.offset"
2009
- },
2010
- {
2011
- "description": "side on which to position the overlay",
2012
- "name": "options.placement"
2013
- }
2014
- ],
2015
- "description": "Open an overlay"
2016
- },
2017
- {
2018
- "kind": "method",
2019
- "name": "open",
2020
- "privacy": "public",
2021
- "return": {
2022
- "type": {
2023
- "text": ""
2024
- }
2025
- },
2026
- "parameters": [
2027
- {
2028
- "name": "{\n abortPromise,\n delayed,\n offset = 0,\n placement = 'top',\n receivesFocus,\n notImmediatelyClosable,\n virtualTrigger,\n }",
2029
- "type": {
2030
- "text": "OverlayOptions"
2031
- }
2032
- },
2033
- {
2034
- "description": "display parameters",
2035
- "name": "options"
2036
- },
2037
- {
2038
- "description": "delay before opening the overlay",
2039
- "name": "options.delayed"
2040
- },
2041
- {
2042
- "description": "distance to offset the overlay",
2043
- "name": "options.offset"
2044
- },
2045
- {
2046
- "description": "side on which to position the overlay",
2047
- "name": "options.placement"
2048
- }
2049
- ],
2050
- "description": "Open an overlay"
2051
- },
2052
- {
2053
- "kind": "method",
2054
- "name": "close",
2055
- "privacy": "public",
2056
- "return": {
2057
- "type": {
2058
- "text": "void"
2059
- }
2060
- },
2061
- "description": "Close the overlay if it is open"
2062
- }
2063
- ]
2064
- }
2065
- ],
2066
- "exports": [
2067
- {
2068
- "kind": "js",
2069
- "name": "Overlay",
2070
- "declaration": {
2071
- "name": "Overlay",
2072
- "module": "src/overlay.ts"
2073
- }
2074
- }
2075
- ]
2076
1140
  }
2077
1141
  ]
2078
1142
  }