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