@genesislcap/foundation-ui 14.352.0 → 14.353.1

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.
@@ -1265,7 +1265,158 @@
1265
1265
  },
1266
1266
  {
1267
1267
  "kind": "javascript-module",
1268
- "path": "src/_config/index.ts",
1268
+ "path": "src/accordion/accordion.styles.ts",
1269
+ "declarations": [
1270
+ {
1271
+ "kind": "function",
1272
+ "name": "foundationAccordionStyles",
1273
+ "return": {
1274
+ "type": {
1275
+ "text": "ElementStyles"
1276
+ }
1277
+ },
1278
+ "parameters": [
1279
+ {
1280
+ "name": "context",
1281
+ "type": {
1282
+ "text": "ElementDefinitionContext"
1283
+ }
1284
+ },
1285
+ {
1286
+ "name": "definition",
1287
+ "type": {
1288
+ "text": "FoundationElementDefinition"
1289
+ }
1290
+ }
1291
+ ]
1292
+ }
1293
+ ],
1294
+ "exports": [
1295
+ {
1296
+ "kind": "js",
1297
+ "name": "foundationAccordionStyles",
1298
+ "declaration": {
1299
+ "name": "foundationAccordionStyles",
1300
+ "module": "src/accordion/accordion.styles.ts"
1301
+ }
1302
+ }
1303
+ ]
1304
+ },
1305
+ {
1306
+ "kind": "javascript-module",
1307
+ "path": "src/accordion/accordion.template.ts",
1308
+ "declarations": [
1309
+ {
1310
+ "kind": "function",
1311
+ "name": "foundationAccordionTemplate",
1312
+ "return": {
1313
+ "type": {
1314
+ "text": "ViewTemplate<Accordion>"
1315
+ }
1316
+ },
1317
+ "parameters": [
1318
+ {
1319
+ "name": "context",
1320
+ "type": {
1321
+ "text": "ElementDefinitionContext"
1322
+ }
1323
+ },
1324
+ {
1325
+ "name": "definition",
1326
+ "type": {
1327
+ "text": "FoundationElementDefinition"
1328
+ }
1329
+ }
1330
+ ]
1331
+ }
1332
+ ],
1333
+ "exports": [
1334
+ {
1335
+ "kind": "js",
1336
+ "name": "foundationAccordionTemplate",
1337
+ "declaration": {
1338
+ "name": "foundationAccordionTemplate",
1339
+ "module": "src/accordion/accordion.template.ts"
1340
+ }
1341
+ }
1342
+ ]
1343
+ },
1344
+ {
1345
+ "kind": "javascript-module",
1346
+ "path": "src/accordion/accordion.ts",
1347
+ "declarations": [
1348
+ {
1349
+ "kind": "class",
1350
+ "description": "",
1351
+ "name": "Accordion",
1352
+ "superclass": {
1353
+ "name": "FASTAccordion",
1354
+ "package": "@microsoft/fast-foundation"
1355
+ },
1356
+ "tagName": "%%prefix%%-accordion",
1357
+ "customElement": true
1358
+ },
1359
+ {
1360
+ "kind": "variable",
1361
+ "name": "foundationAccordionShadowOptions",
1362
+ "type": {
1363
+ "text": "ShadowRootInit"
1364
+ },
1365
+ "default": "{\n delegatesFocus: true,\n mode: 'open',\n}"
1366
+ },
1367
+ {
1368
+ "kind": "variable",
1369
+ "name": "defaultAccordionConfig",
1370
+ "type": {
1371
+ "text": "object"
1372
+ },
1373
+ "default": "{}"
1374
+ },
1375
+ {
1376
+ "kind": "variable",
1377
+ "name": "foundationAccordion",
1378
+ "description": "The Foundation Accordion",
1379
+ "privacy": "public"
1380
+ }
1381
+ ],
1382
+ "exports": [
1383
+ {
1384
+ "kind": "js",
1385
+ "name": "Accordion",
1386
+ "declaration": {
1387
+ "name": "Accordion",
1388
+ "module": "src/accordion/accordion.ts"
1389
+ }
1390
+ },
1391
+ {
1392
+ "kind": "js",
1393
+ "name": "foundationAccordionShadowOptions",
1394
+ "declaration": {
1395
+ "name": "foundationAccordionShadowOptions",
1396
+ "module": "src/accordion/accordion.ts"
1397
+ }
1398
+ },
1399
+ {
1400
+ "kind": "js",
1401
+ "name": "defaultAccordionConfig",
1402
+ "declaration": {
1403
+ "name": "defaultAccordionConfig",
1404
+ "module": "src/accordion/accordion.ts"
1405
+ }
1406
+ },
1407
+ {
1408
+ "kind": "js",
1409
+ "name": "foundationAccordion",
1410
+ "declaration": {
1411
+ "name": "foundationAccordion",
1412
+ "module": "src/accordion/accordion.ts"
1413
+ }
1414
+ }
1415
+ ]
1416
+ },
1417
+ {
1418
+ "kind": "javascript-module",
1419
+ "path": "src/accordion/index.ts",
1269
1420
  "declarations": [],
1270
1421
  "exports": [
1271
1422
  {
@@ -1273,7 +1424,7 @@
1273
1424
  "name": "*",
1274
1425
  "declaration": {
1275
1426
  "name": "*",
1276
- "package": "./styles"
1427
+ "package": "./accordion.template"
1277
1428
  }
1278
1429
  },
1279
1430
  {
@@ -1281,7 +1432,7 @@
1281
1432
  "name": "*",
1282
1433
  "declaration": {
1283
1434
  "name": "*",
1284
- "package": "./tokens"
1435
+ "package": "./accordion.styles"
1285
1436
  }
1286
1437
  },
1287
1438
  {
@@ -1289,7 +1440,7 @@
1289
1440
  "name": "*",
1290
1441
  "declaration": {
1291
1442
  "name": "*",
1292
- "package": "./values"
1443
+ "package": "./accordion"
1293
1444
  }
1294
1445
  }
1295
1446
  ]
@@ -1690,14 +1841,45 @@
1690
1841
  },
1691
1842
  {
1692
1843
  "kind": "javascript-module",
1693
- "path": "src/actions-menu/actions-menu.styles.ts",
1844
+ "path": "src/_config/index.ts",
1845
+ "declarations": [],
1846
+ "exports": [
1847
+ {
1848
+ "kind": "js",
1849
+ "name": "*",
1850
+ "declaration": {
1851
+ "name": "*",
1852
+ "package": "./styles"
1853
+ }
1854
+ },
1855
+ {
1856
+ "kind": "js",
1857
+ "name": "*",
1858
+ "declaration": {
1859
+ "name": "*",
1860
+ "package": "./tokens"
1861
+ }
1862
+ },
1863
+ {
1864
+ "kind": "js",
1865
+ "name": "*",
1866
+ "declaration": {
1867
+ "name": "*",
1868
+ "package": "./values"
1869
+ }
1870
+ }
1871
+ ]
1872
+ },
1873
+ {
1874
+ "kind": "javascript-module",
1875
+ "path": "src/anchored-region/anchor-region.template.ts",
1694
1876
  "declarations": [
1695
1877
  {
1696
1878
  "kind": "function",
1697
- "name": "actionsMenuBaseStyles",
1879
+ "name": "foundationAnchoredRegionTemplate",
1698
1880
  "return": {
1699
1881
  "type": {
1700
- "text": "ElementStyles"
1882
+ "text": "ViewTemplate<AnchoredRegion>"
1701
1883
  }
1702
1884
  },
1703
1885
  "parameters": [
@@ -1714,10 +1896,26 @@
1714
1896
  }
1715
1897
  }
1716
1898
  ]
1717
- },
1899
+ }
1900
+ ],
1901
+ "exports": [
1902
+ {
1903
+ "kind": "js",
1904
+ "name": "foundationAnchoredRegionTemplate",
1905
+ "declaration": {
1906
+ "name": "foundationAnchoredRegionTemplate",
1907
+ "module": "src/anchored-region/anchor-region.template.ts"
1908
+ }
1909
+ }
1910
+ ]
1911
+ },
1912
+ {
1913
+ "kind": "javascript-module",
1914
+ "path": "src/anchored-region/anchored-region.styles.ts",
1915
+ "declarations": [
1718
1916
  {
1719
1917
  "kind": "function",
1720
- "name": "foundationActionsMenuStyles",
1918
+ "name": "foundationAnchoredRegionStyles",
1721
1919
  "return": {
1722
1920
  "type": {
1723
1921
  "text": "ElementStyles"
@@ -1742,1523 +1940,1001 @@
1742
1940
  "exports": [
1743
1941
  {
1744
1942
  "kind": "js",
1745
- "name": "actionsMenuBaseStyles",
1746
- "declaration": {
1747
- "name": "actionsMenuBaseStyles",
1748
- "module": "src/actions-menu/actions-menu.styles.ts"
1749
- }
1750
- },
1751
- {
1752
- "kind": "js",
1753
- "name": "foundationActionsMenuStyles",
1943
+ "name": "foundationAnchoredRegionStyles",
1754
1944
  "declaration": {
1755
- "name": "foundationActionsMenuStyles",
1756
- "module": "src/actions-menu/actions-menu.styles.ts"
1945
+ "name": "foundationAnchoredRegionStyles",
1946
+ "module": "src/anchored-region/anchored-region.styles.ts"
1757
1947
  }
1758
1948
  }
1759
1949
  ]
1760
1950
  },
1761
1951
  {
1762
1952
  "kind": "javascript-module",
1763
- "path": "src/actions-menu/actions-menu.template.ts",
1953
+ "path": "src/anchored-region/anchored-region.ts",
1764
1954
  "declarations": [
1765
1955
  {
1766
- "kind": "function",
1767
- "name": "menuTemplate",
1768
- "parameters": [
1956
+ "kind": "class",
1957
+ "description": "",
1958
+ "name": "AnchoredRegion",
1959
+ "superclass": {
1960
+ "name": "FASTAnchoredRegion",
1961
+ "package": "@microsoft/fast-components"
1962
+ },
1963
+ "tagName": "%%prefix%%-anchored-region",
1964
+ "customElement": true,
1965
+ "attributes": [
1769
1966
  {
1770
- "name": "prefix",
1967
+ "name": "anchor",
1771
1968
  "type": {
1772
1969
  "text": "string"
1970
+ },
1971
+ "default": "\"\"",
1972
+ "description": "The HTML ID of the anchor element this region is positioned relative to",
1973
+ "fieldName": "anchor",
1974
+ "inheritedFrom": {
1975
+ "name": "AnchoredRegion",
1976
+ "module": "src/anchored-region/anchored-region.ts"
1773
1977
  }
1774
- }
1775
- ]
1776
- },
1777
- {
1778
- "kind": "function",
1779
- "name": "singleOptionTemplate",
1780
- "parameters": [
1978
+ },
1781
1979
  {
1782
- "name": "prefix",
1980
+ "name": "viewport",
1783
1981
  "type": {
1784
1982
  "text": "string"
1983
+ },
1984
+ "default": "\"\"",
1985
+ "description": "The HTML ID of the viewport element this region is positioned relative to",
1986
+ "fieldName": "viewport",
1987
+ "inheritedFrom": {
1988
+ "name": "AnchoredRegion",
1989
+ "module": "src/anchored-region/anchored-region.ts"
1785
1990
  }
1786
- }
1787
- ]
1788
- },
1789
- {
1790
- "kind": "variable",
1791
- "name": "foundationActionsMenuTemplate",
1792
- "type": {
1793
- "text": "ViewTemplate<ActionsMenu>"
1794
- },
1795
- "default": "html`\n <div\n class=\"actions-container${(x) => (x.isVertical ? ' actions-vertical' : '')}\"\n part=\"actions-container\"\n >\n ${(x) => x.getTemplate(getPrefix(x))}\n </div>\n`"
1796
- }
1797
- ],
1798
- "exports": [
1799
- {
1800
- "kind": "js",
1801
- "name": "menuTemplate",
1802
- "declaration": {
1803
- "name": "menuTemplate",
1804
- "module": "src/actions-menu/actions-menu.template.ts"
1805
- }
1806
- },
1807
- {
1808
- "kind": "js",
1809
- "name": "singleOptionTemplate",
1810
- "declaration": {
1811
- "name": "singleOptionTemplate",
1812
- "module": "src/actions-menu/actions-menu.template.ts"
1813
- }
1814
- },
1815
- {
1816
- "kind": "js",
1817
- "name": "foundationActionsMenuTemplate",
1818
- "declaration": {
1819
- "name": "foundationActionsMenuTemplate",
1820
- "module": "src/actions-menu/actions-menu.template.ts"
1821
- }
1822
- }
1823
- ]
1824
- },
1825
- {
1826
- "kind": "javascript-module",
1827
- "path": "src/actions-menu/actions-menu.ts",
1828
- "declarations": [
1829
- {
1830
- "kind": "class",
1831
- "description": "",
1832
- "name": "ActionsMenu",
1833
- "members": [
1991
+ },
1834
1992
  {
1835
- "kind": "field",
1836
- "name": "actions",
1993
+ "name": "horizontal-positioning-mode",
1837
1994
  "type": {
1838
- "text": "ActionMenuItem[]"
1995
+ "text": "AxisPositioningMode"
1996
+ },
1997
+ "default": "\"uncontrolled\"",
1998
+ "description": "Sets what logic the component uses to determine horizontal placement.\n'locktodefault' forces the default position\n'dynamic' decides placement based on available space\n'uncontrolled' does not control placement on the horizontal axis",
1999
+ "fieldName": "horizontalPositioningMode",
2000
+ "inheritedFrom": {
2001
+ "name": "AnchoredRegion",
2002
+ "module": "src/anchored-region/anchored-region.ts"
1839
2003
  }
1840
2004
  },
1841
2005
  {
1842
- "kind": "field",
1843
- "name": "isVertical",
2006
+ "name": "horizontal-default-position",
1844
2007
  "type": {
1845
- "text": "boolean"
2008
+ "text": "HorizontalPosition"
1846
2009
  },
1847
- "default": "false"
2010
+ "default": "\"unset\"",
2011
+ "description": "The default horizontal position of the region relative to the anchor element",
2012
+ "fieldName": "horizontalDefaultPosition",
2013
+ "inheritedFrom": {
2014
+ "name": "AnchoredRegion",
2015
+ "module": "src/anchored-region/anchored-region.ts"
2016
+ }
1848
2017
  },
1849
2018
  {
1850
- "kind": "field",
1851
- "name": "addDefaultActions",
2019
+ "name": "horizontal-viewport-lock",
1852
2020
  "type": {
1853
2021
  "text": "boolean"
1854
2022
  },
1855
- "default": "true"
2023
+ "default": "false",
2024
+ "description": "Whether the region remains in the viewport (ie. detaches from the anchor) on the horizontal axis",
2025
+ "fieldName": "horizontalViewportLock",
2026
+ "inheritedFrom": {
2027
+ "name": "AnchoredRegion",
2028
+ "module": "src/anchored-region/anchored-region.ts"
2029
+ }
1856
2030
  },
1857
2031
  {
1858
- "kind": "field",
1859
- "name": "autoCloseOnAction",
2032
+ "name": "horizontal-inset",
1860
2033
  "type": {
1861
2034
  "text": "boolean"
1862
2035
  },
1863
- "default": "true"
2036
+ "default": "false",
2037
+ "description": "Whether the region overlaps the anchor on the horizontal axis",
2038
+ "fieldName": "horizontalInset",
2039
+ "inheritedFrom": {
2040
+ "name": "AnchoredRegion",
2041
+ "module": "src/anchored-region/anchored-region.ts"
2042
+ }
1864
2043
  },
1865
2044
  {
1866
- "kind": "field",
1867
- "name": "classNames",
2045
+ "name": "horizontal-threshold",
1868
2046
  "type": {
1869
- "text": "string"
2047
+ "text": "number"
2048
+ },
2049
+ "description": "How narrow the space allocated to the default position has to be before the widest area\nis selected for layout",
2050
+ "fieldName": "horizontalThreshold",
2051
+ "inheritedFrom": {
2052
+ "name": "AnchoredRegion",
2053
+ "module": "src/anchored-region/anchored-region.ts"
1870
2054
  }
1871
2055
  },
1872
2056
  {
1873
- "kind": "field",
1874
- "name": "definition",
2057
+ "name": "horizontal-scaling",
1875
2058
  "type": {
1876
- "text": "any"
2059
+ "text": "AxisScalingMode"
2060
+ },
2061
+ "default": "\"content\"",
2062
+ "description": "Defines how the width of the region is calculated",
2063
+ "fieldName": "horizontalScaling",
2064
+ "inheritedFrom": {
2065
+ "name": "AnchoredRegion",
2066
+ "module": "src/anchored-region/anchored-region.ts"
1877
2067
  }
1878
2068
  },
1879
2069
  {
1880
- "kind": "field",
1881
- "name": "name",
2070
+ "name": "vertical-positioning-mode",
1882
2071
  "type": {
1883
- "text": "string"
2072
+ "text": "AxisPositioningMode"
1884
2073
  },
1885
- "default": "'Actions'"
2074
+ "default": "\"uncontrolled\"",
2075
+ "description": "Sets what logic the component uses to determine vertical placement.\n'locktodefault' forces the default position\n'dynamic' decides placement based on available space\n'uncontrolled' does not control placement on the vertical axis",
2076
+ "fieldName": "verticalPositioningMode",
2077
+ "inheritedFrom": {
2078
+ "name": "AnchoredRegion",
2079
+ "module": "src/anchored-region/anchored-region.ts"
2080
+ }
1886
2081
  },
1887
2082
  {
1888
- "kind": "field",
1889
- "name": "open",
2083
+ "name": "vertical-default-position",
1890
2084
  "type": {
1891
- "text": "boolean"
2085
+ "text": "VerticalPosition"
1892
2086
  },
1893
- "default": "false"
2087
+ "default": "\"unset\"",
2088
+ "description": "The default vertical position of the region relative to the anchor element",
2089
+ "fieldName": "verticalDefaultPosition",
2090
+ "inheritedFrom": {
2091
+ "name": "AnchoredRegion",
2092
+ "module": "src/anchored-region/anchored-region.ts"
2093
+ }
1894
2094
  },
1895
2095
  {
1896
- "kind": "field",
1897
- "name": "buttonAppearance",
2096
+ "name": "vertical-viewport-lock",
1898
2097
  "type": {
1899
- "text": "string"
2098
+ "text": "boolean"
2099
+ },
2100
+ "default": "false",
2101
+ "description": "Whether the region remains in the viewport (ie. detaches from the anchor) on the vertical axis",
2102
+ "fieldName": "verticalViewportLock",
2103
+ "inheritedFrom": {
2104
+ "name": "AnchoredRegion",
2105
+ "module": "src/anchored-region/anchored-region.ts"
1900
2106
  }
1901
2107
  },
1902
2108
  {
1903
- "kind": "field",
1904
- "name": "hideDisabled",
2109
+ "name": "vertical-inset",
1905
2110
  "type": {
1906
2111
  "text": "boolean"
1907
2112
  },
1908
- "default": "false"
2113
+ "default": "false",
2114
+ "description": "Whether the region overlaps the anchor on the vertical axis",
2115
+ "fieldName": "verticalInset",
2116
+ "inheritedFrom": {
2117
+ "name": "AnchoredRegion",
2118
+ "module": "src/anchored-region/anchored-region.ts"
2119
+ }
1909
2120
  },
1910
2121
  {
1911
- "kind": "field",
1912
- "name": "hideMenuSingleOption",
2122
+ "name": "vertical-threshold",
1913
2123
  "type": {
1914
- "text": "boolean"
2124
+ "text": "number"
1915
2125
  },
1916
- "default": "false"
2126
+ "description": "How short the space allocated to the default position has to be before the tallest area\nis selected for layout",
2127
+ "fieldName": "verticalThreshold",
2128
+ "inheritedFrom": {
2129
+ "name": "AnchoredRegion",
2130
+ "module": "src/anchored-region/anchored-region.ts"
2131
+ }
1917
2132
  },
1918
2133
  {
1919
- "kind": "field",
1920
- "name": "singleOption",
2134
+ "name": "vertical-scaling",
1921
2135
  "type": {
1922
- "text": "ActionMenuItem"
2136
+ "text": "AxisScalingMode"
2137
+ },
2138
+ "default": "\"content\"",
2139
+ "description": "Defines how the height of the region is calculated",
2140
+ "fieldName": "verticalScaling",
2141
+ "inheritedFrom": {
2142
+ "name": "AnchoredRegion",
2143
+ "module": "src/anchored-region/anchored-region.ts"
2144
+ }
2145
+ },
2146
+ {
2147
+ "name": "fixed-placement",
2148
+ "type": {
2149
+ "text": "boolean"
2150
+ },
2151
+ "default": "false",
2152
+ "description": "Whether the region is positioned using css \"position: fixed\".\nOtherwise the region uses \"position: absolute\".\nFixed placement allows the region to break out of parent containers,",
2153
+ "fieldName": "fixedPlacement",
2154
+ "inheritedFrom": {
2155
+ "name": "AnchoredRegion",
2156
+ "module": "src/anchored-region/anchored-region.ts"
1923
2157
  }
1924
2158
  },
2159
+ {
2160
+ "name": "auto-update-mode",
2161
+ "type": {
2162
+ "text": "AutoUpdateMode"
2163
+ },
2164
+ "default": "\"anchor\"",
2165
+ "description": "Defines what triggers the anchored region to revaluate positioning",
2166
+ "fieldName": "autoUpdateMode",
2167
+ "inheritedFrom": {
2168
+ "name": "AnchoredRegion",
2169
+ "module": "src/anchored-region/anchored-region.ts"
2170
+ }
2171
+ }
2172
+ ],
2173
+ "members": [
1925
2174
  {
1926
2175
  "kind": "field",
1927
- "name": "actionsMenu",
2176
+ "name": "anchor",
1928
2177
  "type": {
1929
- "text": "HTMLElement"
2178
+ "text": "string"
2179
+ },
2180
+ "privacy": "public",
2181
+ "default": "\"\"",
2182
+ "description": "The HTML ID of the anchor element this region is positioned relative to",
2183
+ "inheritedFrom": {
2184
+ "name": "AnchoredRegion",
2185
+ "module": "src/anchored-region/anchored-region.ts"
1930
2186
  }
1931
2187
  },
1932
2188
  {
1933
2189
  "kind": "method",
1934
- "name": "definitionChanged",
1935
- "privacy": "protected",
1936
- "parameters": [
1937
- {
1938
- "name": "oldValue",
1939
- "type": {
1940
- "text": "any"
1941
- }
1942
- },
1943
- {
1944
- "name": "newValue",
1945
- "type": {
1946
- "text": "any"
1947
- }
2190
+ "name": "anchorChanged",
2191
+ "privacy": "private",
2192
+ "return": {
2193
+ "type": {
2194
+ "text": "void"
1948
2195
  }
1949
- ]
1950
- },
1951
- {
1952
- "kind": "method",
1953
- "name": "openChanged",
1954
- "privacy": "protected"
2196
+ },
2197
+ "inheritedFrom": {
2198
+ "name": "AnchoredRegion",
2199
+ "module": "src/anchored-region/anchored-region.ts"
2200
+ }
1955
2201
  },
1956
2202
  {
1957
- "kind": "method",
1958
- "name": "toggleActionsMenuVisibility"
2203
+ "kind": "field",
2204
+ "name": "viewport",
2205
+ "type": {
2206
+ "text": "string"
2207
+ },
2208
+ "privacy": "public",
2209
+ "default": "\"\"",
2210
+ "description": "The HTML ID of the viewport element this region is positioned relative to",
2211
+ "inheritedFrom": {
2212
+ "name": "AnchoredRegion",
2213
+ "module": "src/anchored-region/anchored-region.ts"
2214
+ }
1959
2215
  },
1960
2216
  {
1961
2217
  "kind": "method",
1962
- "name": "onActionMenuItemClick",
1963
- "parameters": [
1964
- {
1965
- "name": "callback",
1966
- "type": {
1967
- "text": "(rowData) => void | any"
1968
- }
2218
+ "name": "viewportChanged",
2219
+ "privacy": "private",
2220
+ "return": {
2221
+ "type": {
2222
+ "text": "void"
1969
2223
  }
1970
- ]
2224
+ },
2225
+ "inheritedFrom": {
2226
+ "name": "AnchoredRegion",
2227
+ "module": "src/anchored-region/anchored-region.ts"
2228
+ }
1971
2229
  },
1972
2230
  {
1973
2231
  "kind": "field",
1974
- "name": "allActions",
2232
+ "name": "horizontalPositioningMode",
1975
2233
  "type": {
1976
- "text": "ActionMenuItem[]"
2234
+ "text": "AxisPositioningMode"
1977
2235
  },
1978
- "readonly": true
1979
- },
1980
- {
1981
- "kind": "field",
1982
- "name": "rowData",
1983
- "readonly": true
1984
- },
1985
- {
1986
- "kind": "method",
1987
- "name": "getLabel",
1988
- "parameters": [
1989
- {
1990
- "name": "name",
1991
- "type": {
1992
- "text": "string | ((rowData: any) => string)"
1993
- }
1994
- }
1995
- ]
2236
+ "privacy": "public",
2237
+ "default": "\"uncontrolled\"",
2238
+ "description": "Sets what logic the component uses to determine horizontal placement.\n'locktodefault' forces the default position\n'dynamic' decides placement based on available space\n'uncontrolled' does not control placement on the horizontal axis",
2239
+ "inheritedFrom": {
2240
+ "name": "AnchoredRegion",
2241
+ "module": "src/anchored-region/anchored-region.ts"
2242
+ }
1996
2243
  },
1997
2244
  {
1998
2245
  "kind": "method",
1999
- "name": "getTemplate",
2000
- "parameters": [
2001
- {
2002
- "name": "prefix",
2003
- "type": {
2004
- "text": "string"
2005
- }
2246
+ "name": "horizontalPositioningModeChanged",
2247
+ "privacy": "private",
2248
+ "return": {
2249
+ "type": {
2250
+ "text": "void"
2006
2251
  }
2007
- ]
2252
+ },
2253
+ "inheritedFrom": {
2254
+ "name": "AnchoredRegion",
2255
+ "module": "src/anchored-region/anchored-region.ts"
2256
+ }
2008
2257
  },
2009
2258
  {
2010
2259
  "kind": "field",
2011
- "name": "_presentation",
2260
+ "name": "horizontalDefaultPosition",
2012
2261
  "type": {
2013
- "text": "ComponentPresentation | null | undefined"
2262
+ "text": "HorizontalPosition"
2014
2263
  },
2015
- "privacy": "private",
2016
- "default": "void 0",
2264
+ "privacy": "public",
2265
+ "default": "\"unset\"",
2266
+ "description": "The default horizontal position of the region relative to the anchor element",
2017
2267
  "inheritedFrom": {
2018
- "name": "FoundationElement",
2019
- "module": "src/foundation-element/foundation-element.ts"
2268
+ "name": "AnchoredRegion",
2269
+ "module": "src/anchored-region/anchored-region.ts"
2020
2270
  }
2021
2271
  },
2022
2272
  {
2023
- "kind": "field",
2024
- "name": "$presentation",
2025
- "type": {
2026
- "text": "ComponentPresentation | null"
2273
+ "kind": "method",
2274
+ "name": "horizontalDefaultPositionChanged",
2275
+ "privacy": "private",
2276
+ "return": {
2277
+ "type": {
2278
+ "text": "void"
2279
+ }
2027
2280
  },
2028
- "privacy": "public",
2029
- "description": "A property which resolves the ComponentPresentation instance\nfor the current component.",
2030
2281
  "inheritedFrom": {
2031
- "name": "FoundationElement",
2032
- "module": "src/foundation-element/foundation-element.ts"
2282
+ "name": "AnchoredRegion",
2283
+ "module": "src/anchored-region/anchored-region.ts"
2033
2284
  }
2034
2285
  },
2035
2286
  {
2036
2287
  "kind": "field",
2037
- "name": "template",
2288
+ "name": "horizontalViewportLock",
2038
2289
  "type": {
2039
- "text": "ElementViewTemplate | void | null"
2290
+ "text": "boolean"
2040
2291
  },
2041
2292
  "privacy": "public",
2042
- "description": "Sets the template of the element instance. When undefined,\nthe element will attempt to resolve the template from\nthe associated presentation or custom element definition.",
2293
+ "default": "false",
2294
+ "description": "Whether the region remains in the viewport (ie. detaches from the anchor) on the horizontal axis",
2043
2295
  "inheritedFrom": {
2044
- "name": "FoundationElement",
2045
- "module": "src/foundation-element/foundation-element.ts"
2296
+ "name": "AnchoredRegion",
2297
+ "module": "src/anchored-region/anchored-region.ts"
2046
2298
  }
2047
2299
  },
2048
2300
  {
2049
2301
  "kind": "method",
2050
- "name": "templateChanged",
2051
- "privacy": "protected",
2302
+ "name": "horizontalViewportLockChanged",
2303
+ "privacy": "private",
2052
2304
  "return": {
2053
2305
  "type": {
2054
2306
  "text": "void"
2055
2307
  }
2056
2308
  },
2057
2309
  "inheritedFrom": {
2058
- "name": "FoundationElement",
2059
- "module": "src/foundation-element/foundation-element.ts"
2310
+ "name": "AnchoredRegion",
2311
+ "module": "src/anchored-region/anchored-region.ts"
2060
2312
  }
2061
2313
  },
2062
2314
  {
2063
2315
  "kind": "field",
2064
- "name": "styles",
2316
+ "name": "horizontalInset",
2065
2317
  "type": {
2066
- "text": "ElementStyles | void | null"
2318
+ "text": "boolean"
2067
2319
  },
2068
2320
  "privacy": "public",
2069
- "description": "Sets the default styles for the element instance. When undefined,\nthe element will attempt to resolve default styles from\nthe associated presentation or custom element definition.",
2321
+ "default": "false",
2322
+ "description": "Whether the region overlaps the anchor on the horizontal axis",
2070
2323
  "inheritedFrom": {
2071
- "name": "FoundationElement",
2072
- "module": "src/foundation-element/foundation-element.ts"
2324
+ "name": "AnchoredRegion",
2325
+ "module": "src/anchored-region/anchored-region.ts"
2073
2326
  }
2074
2327
  },
2075
2328
  {
2076
2329
  "kind": "method",
2077
- "name": "stylesChanged",
2078
- "privacy": "protected",
2330
+ "name": "horizontalInsetChanged",
2331
+ "privacy": "private",
2079
2332
  "return": {
2080
2333
  "type": {
2081
2334
  "text": "void"
2082
2335
  }
2083
2336
  },
2084
2337
  "inheritedFrom": {
2085
- "name": "FoundationElement",
2086
- "module": "src/foundation-element/foundation-element.ts"
2338
+ "name": "AnchoredRegion",
2339
+ "module": "src/anchored-region/anchored-region.ts"
2087
2340
  }
2088
2341
  },
2089
2342
  {
2090
- "kind": "method",
2091
- "name": "compose",
2343
+ "kind": "field",
2344
+ "name": "horizontalThreshold",
2345
+ "type": {
2346
+ "text": "number"
2347
+ },
2092
2348
  "privacy": "public",
2093
- "static": true,
2349
+ "description": "How narrow the space allocated to the default position has to be before the widest area\nis selected for layout",
2350
+ "inheritedFrom": {
2351
+ "name": "AnchoredRegion",
2352
+ "module": "src/anchored-region/anchored-region.ts"
2353
+ }
2354
+ },
2355
+ {
2356
+ "kind": "method",
2357
+ "name": "horizontalThresholdChanged",
2358
+ "privacy": "private",
2094
2359
  "return": {
2095
2360
  "type": {
2096
- "text": "(\n overrideDefinition?: OverrideFoundationElementDefinition<T>\n ) => FoundationElementRegistry<T, K>"
2361
+ "text": "void"
2097
2362
  }
2098
2363
  },
2099
- "parameters": [
2100
- {
2101
- "name": "this",
2102
- "type": {
2103
- "text": "K"
2104
- }
2105
- },
2106
- {
2107
- "name": "elementDefinition",
2108
- "type": {
2109
- "text": "T"
2110
- },
2111
- "description": "The definition of the element to create the registry\nfunction for."
2112
- }
2113
- ],
2114
- "description": "Defines an element registry function with a set of element definition defaults.",
2115
2364
  "inheritedFrom": {
2116
- "name": "FoundationElement",
2117
- "module": "src/foundation-element/foundation-element.ts"
2365
+ "name": "AnchoredRegion",
2366
+ "module": "src/anchored-region/anchored-region.ts"
2118
2367
  }
2119
- }
2120
- ],
2121
- "attributes": [
2368
+ },
2122
2369
  {
2123
- "name": "is-vertical",
2370
+ "kind": "field",
2371
+ "name": "horizontalScaling",
2124
2372
  "type": {
2125
- "text": "boolean"
2373
+ "text": "AxisScalingMode"
2126
2374
  },
2127
- "default": "false",
2128
- "fieldName": "isVertical"
2375
+ "privacy": "public",
2376
+ "default": "\"content\"",
2377
+ "description": "Defines how the width of the region is calculated",
2378
+ "inheritedFrom": {
2379
+ "name": "AnchoredRegion",
2380
+ "module": "src/anchored-region/anchored-region.ts"
2381
+ }
2129
2382
  },
2130
2383
  {
2131
- "name": "add-default-actions",
2132
- "type": {
2133
- "text": "boolean"
2384
+ "kind": "method",
2385
+ "name": "horizontalScalingChanged",
2386
+ "privacy": "private",
2387
+ "return": {
2388
+ "type": {
2389
+ "text": "void"
2390
+ }
2134
2391
  },
2135
- "default": "true",
2136
- "fieldName": "addDefaultActions"
2392
+ "inheritedFrom": {
2393
+ "name": "AnchoredRegion",
2394
+ "module": "src/anchored-region/anchored-region.ts"
2395
+ }
2137
2396
  },
2138
2397
  {
2139
- "name": "auto-close-on-action",
2398
+ "kind": "field",
2399
+ "name": "verticalPositioningMode",
2140
2400
  "type": {
2141
- "text": "boolean"
2401
+ "text": "AxisPositioningMode"
2142
2402
  },
2143
- "default": "true",
2144
- "fieldName": "autoCloseOnAction"
2403
+ "privacy": "public",
2404
+ "default": "\"uncontrolled\"",
2405
+ "description": "Sets what logic the component uses to determine vertical placement.\n'locktodefault' forces the default position\n'dynamic' decides placement based on available space\n'uncontrolled' does not control placement on the vertical axis",
2406
+ "inheritedFrom": {
2407
+ "name": "AnchoredRegion",
2408
+ "module": "src/anchored-region/anchored-region.ts"
2409
+ }
2145
2410
  },
2146
2411
  {
2147
- "name": "name",
2148
- "type": {
2149
- "text": "string"
2150
- },
2151
- "default": "'Actions'",
2152
- "fieldName": "name"
2153
- },
2154
- {
2155
- "name": "open",
2156
- "type": {
2157
- "text": "boolean"
2158
- },
2159
- "default": "false",
2160
- "fieldName": "open"
2161
- },
2162
- {
2163
- "name": "buttonAppearance",
2164
- "type": {
2165
- "text": "string"
2166
- },
2167
- "fieldName": "buttonAppearance"
2168
- },
2169
- {
2170
- "name": "hide-disabled",
2171
- "type": {
2172
- "text": "boolean"
2173
- },
2174
- "default": "false",
2175
- "fieldName": "hideDisabled"
2176
- },
2177
- {
2178
- "name": "hide-menu-single-option",
2179
- "type": {
2180
- "text": "boolean"
2181
- },
2182
- "default": "false",
2183
- "fieldName": "hideMenuSingleOption"
2184
- }
2185
- ],
2186
- "superclass": {
2187
- "name": "FoundationElement",
2188
- "package": "@microsoft/fast-foundation"
2189
- },
2190
- "tagName": "%%prefix%%-actions-menu",
2191
- "customElement": true
2192
- },
2193
- {
2194
- "kind": "variable",
2195
- "name": "foundationActionsMenu",
2196
- "description": "The Foundation Actions Menu",
2197
- "privacy": "public"
2198
- }
2199
- ],
2200
- "exports": [
2201
- {
2202
- "kind": "js",
2203
- "name": "ActionsMenu",
2204
- "declaration": {
2205
- "name": "ActionsMenu",
2206
- "module": "src/actions-menu/actions-menu.ts"
2207
- }
2208
- },
2209
- {
2210
- "kind": "js",
2211
- "name": "foundationActionsMenu",
2212
- "declaration": {
2213
- "name": "foundationActionsMenu",
2214
- "module": "src/actions-menu/actions-menu.ts"
2215
- }
2216
- }
2217
- ]
2218
- },
2219
- {
2220
- "kind": "javascript-module",
2221
- "path": "src/actions-menu/index.ts",
2222
- "declarations": [],
2223
- "exports": [
2224
- {
2225
- "kind": "js",
2226
- "name": "*",
2227
- "declaration": {
2228
- "name": "*",
2229
- "package": "./actions-menu.styles"
2230
- }
2231
- },
2232
- {
2233
- "kind": "js",
2234
- "name": "*",
2235
- "declaration": {
2236
- "name": "*",
2237
- "package": "./actions-menu.template"
2238
- }
2239
- },
2240
- {
2241
- "kind": "js",
2242
- "name": "*",
2243
- "declaration": {
2244
- "name": "*",
2245
- "package": "./actions-menu"
2246
- }
2247
- }
2248
- ]
2249
- },
2250
- {
2251
- "kind": "javascript-module",
2252
- "path": "src/accordion/accordion.styles.ts",
2253
- "declarations": [
2254
- {
2255
- "kind": "function",
2256
- "name": "foundationAccordionStyles",
2257
- "return": {
2258
- "type": {
2259
- "text": "ElementStyles"
2260
- }
2261
- },
2262
- "parameters": [
2263
- {
2264
- "name": "context",
2265
- "type": {
2266
- "text": "ElementDefinitionContext"
2267
- }
2268
- },
2269
- {
2270
- "name": "definition",
2271
- "type": {
2272
- "text": "FoundationElementDefinition"
2273
- }
2274
- }
2275
- ]
2276
- }
2277
- ],
2278
- "exports": [
2279
- {
2280
- "kind": "js",
2281
- "name": "foundationAccordionStyles",
2282
- "declaration": {
2283
- "name": "foundationAccordionStyles",
2284
- "module": "src/accordion/accordion.styles.ts"
2285
- }
2286
- }
2287
- ]
2288
- },
2289
- {
2290
- "kind": "javascript-module",
2291
- "path": "src/accordion/accordion.template.ts",
2292
- "declarations": [
2293
- {
2294
- "kind": "function",
2295
- "name": "foundationAccordionTemplate",
2296
- "return": {
2297
- "type": {
2298
- "text": "ViewTemplate<Accordion>"
2299
- }
2300
- },
2301
- "parameters": [
2302
- {
2303
- "name": "context",
2304
- "type": {
2305
- "text": "ElementDefinitionContext"
2306
- }
2307
- },
2308
- {
2309
- "name": "definition",
2310
- "type": {
2311
- "text": "FoundationElementDefinition"
2312
- }
2313
- }
2314
- ]
2315
- }
2316
- ],
2317
- "exports": [
2318
- {
2319
- "kind": "js",
2320
- "name": "foundationAccordionTemplate",
2321
- "declaration": {
2322
- "name": "foundationAccordionTemplate",
2323
- "module": "src/accordion/accordion.template.ts"
2324
- }
2325
- }
2326
- ]
2327
- },
2328
- {
2329
- "kind": "javascript-module",
2330
- "path": "src/accordion/accordion.ts",
2331
- "declarations": [
2332
- {
2333
- "kind": "class",
2334
- "description": "",
2335
- "name": "Accordion",
2336
- "superclass": {
2337
- "name": "FASTAccordion",
2338
- "package": "@microsoft/fast-foundation"
2339
- },
2340
- "tagName": "%%prefix%%-accordion",
2341
- "customElement": true
2342
- },
2343
- {
2344
- "kind": "variable",
2345
- "name": "foundationAccordionShadowOptions",
2346
- "type": {
2347
- "text": "ShadowRootInit"
2348
- },
2349
- "default": "{\n delegatesFocus: true,\n mode: 'open',\n}"
2350
- },
2351
- {
2352
- "kind": "variable",
2353
- "name": "defaultAccordionConfig",
2354
- "type": {
2355
- "text": "object"
2356
- },
2357
- "default": "{}"
2358
- },
2359
- {
2360
- "kind": "variable",
2361
- "name": "foundationAccordion",
2362
- "description": "The Foundation Accordion",
2363
- "privacy": "public"
2364
- }
2365
- ],
2366
- "exports": [
2367
- {
2368
- "kind": "js",
2369
- "name": "Accordion",
2370
- "declaration": {
2371
- "name": "Accordion",
2372
- "module": "src/accordion/accordion.ts"
2373
- }
2374
- },
2375
- {
2376
- "kind": "js",
2377
- "name": "foundationAccordionShadowOptions",
2378
- "declaration": {
2379
- "name": "foundationAccordionShadowOptions",
2380
- "module": "src/accordion/accordion.ts"
2381
- }
2382
- },
2383
- {
2384
- "kind": "js",
2385
- "name": "defaultAccordionConfig",
2386
- "declaration": {
2387
- "name": "defaultAccordionConfig",
2388
- "module": "src/accordion/accordion.ts"
2389
- }
2390
- },
2391
- {
2392
- "kind": "js",
2393
- "name": "foundationAccordion",
2394
- "declaration": {
2395
- "name": "foundationAccordion",
2396
- "module": "src/accordion/accordion.ts"
2397
- }
2398
- }
2399
- ]
2400
- },
2401
- {
2402
- "kind": "javascript-module",
2403
- "path": "src/accordion/index.ts",
2404
- "declarations": [],
2405
- "exports": [
2406
- {
2407
- "kind": "js",
2408
- "name": "*",
2409
- "declaration": {
2410
- "name": "*",
2411
- "package": "./accordion.template"
2412
- }
2413
- },
2414
- {
2415
- "kind": "js",
2416
- "name": "*",
2417
- "declaration": {
2418
- "name": "*",
2419
- "package": "./accordion.styles"
2420
- }
2421
- },
2422
- {
2423
- "kind": "js",
2424
- "name": "*",
2425
- "declaration": {
2426
- "name": "*",
2427
- "package": "./accordion"
2428
- }
2429
- }
2430
- ]
2431
- },
2432
- {
2433
- "kind": "javascript-module",
2434
- "path": "src/anchor/anchor.styles.ts",
2435
- "declarations": [
2436
- {
2437
- "kind": "function",
2438
- "name": "foundationAnchorStyles",
2439
- "return": {
2440
- "type": {
2441
- "text": "ElementStyles"
2442
- }
2443
- },
2444
- "parameters": [
2445
- {
2446
- "name": "context",
2447
- "type": {
2448
- "text": "ElementDefinitionContext"
2449
- }
2450
- },
2451
- {
2452
- "name": "definition",
2453
- "type": {
2454
- "text": "FoundationElementDefinition"
2455
- }
2456
- }
2457
- ]
2458
- }
2459
- ],
2460
- "exports": [
2461
- {
2462
- "kind": "js",
2463
- "name": "foundationAnchorStyles",
2464
- "declaration": {
2465
- "name": "foundationAnchorStyles",
2466
- "module": "src/anchor/anchor.styles.ts"
2467
- }
2468
- }
2469
- ]
2470
- },
2471
- {
2472
- "kind": "javascript-module",
2473
- "path": "src/anchor/anchor.template.ts",
2474
- "declarations": [
2475
- {
2476
- "kind": "function",
2477
- "name": "foundationAnchorTemplate",
2478
- "return": {
2479
- "type": {
2480
- "text": "ViewTemplate<Anchor>"
2481
- }
2482
- },
2483
- "parameters": [
2484
- {
2485
- "name": "context",
2486
- "type": {
2487
- "text": "ElementDefinitionContext"
2488
- }
2489
- },
2490
- {
2491
- "name": "definition",
2492
- "type": {
2493
- "text": "FoundationElementDefinition"
2494
- }
2495
- }
2496
- ]
2497
- }
2498
- ],
2499
- "exports": [
2500
- {
2501
- "kind": "js",
2502
- "name": "foundationAnchorTemplate",
2503
- "declaration": {
2504
- "name": "foundationAnchorTemplate",
2505
- "module": "src/anchor/anchor.template.ts"
2506
- }
2507
- }
2508
- ]
2509
- },
2510
- {
2511
- "kind": "javascript-module",
2512
- "path": "src/anchor/anchor.ts",
2513
- "declarations": [
2514
- {
2515
- "kind": "class",
2516
- "description": "",
2517
- "name": "Anchor",
2518
- "superclass": {
2519
- "name": "FASTAnchor",
2520
- "package": "@microsoft/fast-components"
2521
- },
2522
- "tagName": "%%prefix%%-anchor",
2523
- "customElement": true,
2524
- "attributes": [
2525
- {
2526
- "name": "download",
2527
- "type": {
2528
- "text": "string"
2529
- },
2530
- "description": "Prompts the user to save the linked URL. See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a | <a> element for more information.",
2531
- "fieldName": "download",
2532
- "inheritedFrom": {
2533
- "name": "Anchor",
2534
- "module": "src/anchor/anchor.ts"
2535
- }
2536
- },
2537
- {
2538
- "name": "href",
2539
- "type": {
2540
- "text": "string"
2541
- },
2542
- "description": "The URL the hyperlink references. See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a | <a> element for more information.",
2543
- "fieldName": "href",
2544
- "inheritedFrom": {
2545
- "name": "Anchor",
2546
- "module": "src/anchor/anchor.ts"
2547
- }
2548
- },
2549
- {
2550
- "name": "hreflang",
2551
- "type": {
2552
- "text": "string"
2553
- },
2554
- "description": "Hints at the language of the referenced resource. See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a | <a> element for more information.",
2555
- "fieldName": "hreflang",
2556
- "inheritedFrom": {
2557
- "name": "Anchor",
2558
- "module": "src/anchor/anchor.ts"
2559
- }
2560
- },
2561
- {
2562
- "name": "ping",
2563
- "type": {
2564
- "text": "string"
2565
- },
2566
- "description": "See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a | <a> element for more information.",
2567
- "fieldName": "ping",
2568
- "inheritedFrom": {
2569
- "name": "Anchor",
2570
- "module": "src/anchor/anchor.ts"
2571
- }
2572
- },
2573
- {
2574
- "name": "referrerpolicy",
2575
- "type": {
2576
- "text": "string"
2577
- },
2578
- "description": "See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a | <a> element for more information.",
2579
- "fieldName": "referrerpolicy",
2580
- "inheritedFrom": {
2581
- "name": "Anchor",
2582
- "module": "src/anchor/anchor.ts"
2583
- }
2584
- },
2585
- {
2586
- "name": "rel",
2587
- "type": {
2588
- "text": "string"
2589
- },
2590
- "description": "See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a | <a> element for more information.",
2591
- "fieldName": "rel",
2592
- "inheritedFrom": {
2593
- "name": "Anchor",
2594
- "module": "src/anchor/anchor.ts"
2595
- }
2596
- },
2597
- {
2598
- "name": "target",
2599
- "type": {
2600
- "text": "\"_self\" | \"_blank\" | \"_parent\" | \"_top\""
2601
- },
2602
- "description": "See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a | <a> element for more information.",
2603
- "fieldName": "target",
2604
- "inheritedFrom": {
2605
- "name": "Anchor",
2606
- "module": "src/anchor/anchor.ts"
2607
- }
2608
- },
2609
- {
2610
- "name": "type",
2611
- "type": {
2612
- "text": "string"
2613
- },
2614
- "description": "See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a | <a> element for more information.",
2615
- "fieldName": "type",
2616
- "inheritedFrom": {
2617
- "name": "Anchor",
2618
- "module": "src/anchor/anchor.ts"
2619
- }
2620
- }
2621
- ],
2622
- "members": [
2623
- {
2624
- "kind": "field",
2625
- "name": "download",
2626
- "type": {
2627
- "text": "string"
2628
- },
2629
- "privacy": "public",
2630
- "description": "Prompts the user to save the linked URL. See {@link https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a | <a> element } for more information.",
2631
- "inheritedFrom": {
2632
- "name": "Anchor",
2633
- "module": "src/anchor/anchor.ts"
2634
- }
2635
- },
2636
- {
2637
- "kind": "field",
2638
- "name": "href",
2639
- "type": {
2640
- "text": "string"
2412
+ "kind": "method",
2413
+ "name": "verticalPositioningModeChanged",
2414
+ "privacy": "private",
2415
+ "return": {
2416
+ "type": {
2417
+ "text": "void"
2418
+ }
2641
2419
  },
2642
- "privacy": "public",
2643
- "description": "The URL the hyperlink references. See {@link https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a | <a> element } for more information.",
2644
2420
  "inheritedFrom": {
2645
- "name": "Anchor",
2646
- "module": "src/anchor/anchor.ts"
2421
+ "name": "AnchoredRegion",
2422
+ "module": "src/anchored-region/anchored-region.ts"
2647
2423
  }
2648
2424
  },
2649
2425
  {
2650
2426
  "kind": "field",
2651
- "name": "hreflang",
2427
+ "name": "verticalDefaultPosition",
2652
2428
  "type": {
2653
- "text": "string"
2429
+ "text": "VerticalPosition"
2654
2430
  },
2655
2431
  "privacy": "public",
2656
- "description": "Hints at the language of the referenced resource. See {@link https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a | <a> element } for more information.",
2432
+ "default": "\"unset\"",
2433
+ "description": "The default vertical position of the region relative to the anchor element",
2657
2434
  "inheritedFrom": {
2658
- "name": "Anchor",
2659
- "module": "src/anchor/anchor.ts"
2435
+ "name": "AnchoredRegion",
2436
+ "module": "src/anchored-region/anchored-region.ts"
2660
2437
  }
2661
2438
  },
2662
2439
  {
2663
- "kind": "field",
2664
- "name": "ping",
2665
- "type": {
2666
- "text": "string"
2440
+ "kind": "method",
2441
+ "name": "verticalDefaultPositionChanged",
2442
+ "privacy": "private",
2443
+ "return": {
2444
+ "type": {
2445
+ "text": "void"
2446
+ }
2667
2447
  },
2668
- "privacy": "public",
2669
- "description": "See {@link https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a | <a> element } for more information.",
2670
2448
  "inheritedFrom": {
2671
- "name": "Anchor",
2672
- "module": "src/anchor/anchor.ts"
2449
+ "name": "AnchoredRegion",
2450
+ "module": "src/anchored-region/anchored-region.ts"
2673
2451
  }
2674
2452
  },
2675
2453
  {
2676
2454
  "kind": "field",
2677
- "name": "referrerpolicy",
2455
+ "name": "verticalViewportLock",
2678
2456
  "type": {
2679
- "text": "string"
2457
+ "text": "boolean"
2680
2458
  },
2681
2459
  "privacy": "public",
2682
- "description": "See {@link https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a | <a> element } for more information.",
2460
+ "default": "false",
2461
+ "description": "Whether the region remains in the viewport (ie. detaches from the anchor) on the vertical axis",
2683
2462
  "inheritedFrom": {
2684
- "name": "Anchor",
2685
- "module": "src/anchor/anchor.ts"
2463
+ "name": "AnchoredRegion",
2464
+ "module": "src/anchored-region/anchored-region.ts"
2686
2465
  }
2687
2466
  },
2688
2467
  {
2689
- "kind": "field",
2690
- "name": "rel",
2691
- "type": {
2692
- "text": "string"
2468
+ "kind": "method",
2469
+ "name": "verticalViewportLockChanged",
2470
+ "privacy": "private",
2471
+ "return": {
2472
+ "type": {
2473
+ "text": "void"
2474
+ }
2693
2475
  },
2694
- "privacy": "public",
2695
- "description": "See {@link https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a | <a> element } for more information.",
2696
2476
  "inheritedFrom": {
2697
- "name": "Anchor",
2698
- "module": "src/anchor/anchor.ts"
2477
+ "name": "AnchoredRegion",
2478
+ "module": "src/anchored-region/anchored-region.ts"
2699
2479
  }
2700
2480
  },
2701
2481
  {
2702
2482
  "kind": "field",
2703
- "name": "target",
2483
+ "name": "verticalInset",
2704
2484
  "type": {
2705
- "text": "\"_self\" | \"_blank\" | \"_parent\" | \"_top\""
2485
+ "text": "boolean"
2706
2486
  },
2707
2487
  "privacy": "public",
2708
- "description": "See {@link https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a | <a> element } for more information.",
2488
+ "default": "false",
2489
+ "description": "Whether the region overlaps the anchor on the vertical axis",
2709
2490
  "inheritedFrom": {
2710
- "name": "Anchor",
2711
- "module": "src/anchor/anchor.ts"
2491
+ "name": "AnchoredRegion",
2492
+ "module": "src/anchored-region/anchored-region.ts"
2712
2493
  }
2713
2494
  },
2714
2495
  {
2715
- "kind": "field",
2716
- "name": "type",
2717
- "type": {
2718
- "text": "string"
2496
+ "kind": "method",
2497
+ "name": "verticalInsetChanged",
2498
+ "privacy": "private",
2499
+ "return": {
2500
+ "type": {
2501
+ "text": "void"
2502
+ }
2719
2503
  },
2720
- "privacy": "public",
2721
- "description": "See {@link https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a | <a> element } for more information.",
2722
2504
  "inheritedFrom": {
2723
- "name": "Anchor",
2724
- "module": "src/anchor/anchor.ts"
2505
+ "name": "AnchoredRegion",
2506
+ "module": "src/anchored-region/anchored-region.ts"
2725
2507
  }
2726
2508
  },
2727
2509
  {
2728
2510
  "kind": "field",
2729
- "name": "control",
2511
+ "name": "verticalThreshold",
2730
2512
  "type": {
2731
- "text": "HTMLAnchorElement | undefined"
2513
+ "text": "number"
2732
2514
  },
2733
2515
  "privacy": "public",
2734
- "description": "References the root element",
2735
- "inheritedFrom": {
2736
- "name": "Anchor",
2737
- "module": "src/anchor/anchor.ts"
2738
- }
2739
- },
2740
- {
2741
- "kind": "field",
2742
- "name": "handleUnsupportedDelegatesFocus",
2743
- "privacy": "private",
2744
- "description": "Overrides the focus call for where delegatesFocus is unsupported.\nThis check works for Chrome, Edge Chromium, FireFox, and Safari\nRelevant PR on the Firefox browser: https://phabricator.services.mozilla.com/D123858",
2516
+ "description": "How short the space allocated to the default position has to be before the tallest area\nis selected for layout",
2745
2517
  "inheritedFrom": {
2746
- "name": "Anchor",
2747
- "module": "src/anchor/anchor.ts"
2518
+ "name": "AnchoredRegion",
2519
+ "module": "src/anchored-region/anchored-region.ts"
2748
2520
  }
2749
2521
  },
2750
2522
  {
2751
- "kind": "field",
2752
- "name": "_presentation",
2753
- "type": {
2754
- "text": "ComponentPresentation | null | undefined"
2755
- },
2523
+ "kind": "method",
2524
+ "name": "verticalThresholdChanged",
2756
2525
  "privacy": "private",
2757
- "default": "void 0",
2758
- "inheritedFrom": {
2759
- "name": "FoundationElement",
2760
- "module": "src/foundation-element/foundation-element.ts"
2761
- }
2762
- },
2763
- {
2764
- "kind": "field",
2765
- "name": "$presentation",
2766
- "type": {
2767
- "text": "ComponentPresentation | null"
2526
+ "return": {
2527
+ "type": {
2528
+ "text": "void"
2529
+ }
2768
2530
  },
2769
- "privacy": "public",
2770
- "description": "A property which resolves the ComponentPresentation instance\nfor the current component.",
2771
2531
  "inheritedFrom": {
2772
- "name": "FoundationElement",
2773
- "module": "src/foundation-element/foundation-element.ts"
2532
+ "name": "AnchoredRegion",
2533
+ "module": "src/anchored-region/anchored-region.ts"
2774
2534
  }
2775
2535
  },
2776
2536
  {
2777
2537
  "kind": "field",
2778
- "name": "template",
2538
+ "name": "verticalScaling",
2779
2539
  "type": {
2780
- "text": "ElementViewTemplate | void | null"
2540
+ "text": "AxisScalingMode"
2781
2541
  },
2782
2542
  "privacy": "public",
2783
- "description": "Sets the template of the element instance. When undefined,\nthe element will attempt to resolve the template from\nthe associated presentation or custom element definition.",
2543
+ "default": "\"content\"",
2544
+ "description": "Defines how the height of the region is calculated",
2784
2545
  "inheritedFrom": {
2785
- "name": "FoundationElement",
2786
- "module": "src/foundation-element/foundation-element.ts"
2546
+ "name": "AnchoredRegion",
2547
+ "module": "src/anchored-region/anchored-region.ts"
2787
2548
  }
2788
2549
  },
2789
2550
  {
2790
2551
  "kind": "method",
2791
- "name": "templateChanged",
2792
- "privacy": "protected",
2552
+ "name": "verticalScalingChanged",
2553
+ "privacy": "private",
2793
2554
  "return": {
2794
2555
  "type": {
2795
2556
  "text": "void"
2796
2557
  }
2797
2558
  },
2798
2559
  "inheritedFrom": {
2799
- "name": "FoundationElement",
2800
- "module": "src/foundation-element/foundation-element.ts"
2560
+ "name": "AnchoredRegion",
2561
+ "module": "src/anchored-region/anchored-region.ts"
2801
2562
  }
2802
2563
  },
2803
2564
  {
2804
2565
  "kind": "field",
2805
- "name": "styles",
2566
+ "name": "fixedPlacement",
2806
2567
  "type": {
2807
- "text": "ElementStyles | void | null"
2568
+ "text": "boolean"
2808
2569
  },
2809
2570
  "privacy": "public",
2810
- "description": "Sets the default styles for the element instance. When undefined,\nthe element will attempt to resolve default styles from\nthe associated presentation or custom element definition.",
2571
+ "default": "false",
2572
+ "description": "Whether the region is positioned using css \"position: fixed\".\nOtherwise the region uses \"position: absolute\".\nFixed placement allows the region to break out of parent containers,",
2811
2573
  "inheritedFrom": {
2812
- "name": "FoundationElement",
2813
- "module": "src/foundation-element/foundation-element.ts"
2574
+ "name": "AnchoredRegion",
2575
+ "module": "src/anchored-region/anchored-region.ts"
2814
2576
  }
2815
2577
  },
2816
2578
  {
2817
2579
  "kind": "method",
2818
- "name": "stylesChanged",
2819
- "privacy": "protected",
2580
+ "name": "fixedPlacementChanged",
2581
+ "privacy": "private",
2820
2582
  "return": {
2821
2583
  "type": {
2822
2584
  "text": "void"
2823
2585
  }
2824
2586
  },
2825
2587
  "inheritedFrom": {
2826
- "name": "FoundationElement",
2827
- "module": "src/foundation-element/foundation-element.ts"
2588
+ "name": "AnchoredRegion",
2589
+ "module": "src/anchored-region/anchored-region.ts"
2828
2590
  }
2829
2591
  },
2830
2592
  {
2831
- "kind": "method",
2832
- "name": "compose",
2593
+ "kind": "field",
2594
+ "name": "autoUpdateMode",
2595
+ "type": {
2596
+ "text": "AutoUpdateMode"
2597
+ },
2833
2598
  "privacy": "public",
2834
- "static": true,
2599
+ "default": "\"anchor\"",
2600
+ "description": "Defines what triggers the anchored region to revaluate positioning",
2601
+ "inheritedFrom": {
2602
+ "name": "AnchoredRegion",
2603
+ "module": "src/anchored-region/anchored-region.ts"
2604
+ }
2605
+ },
2606
+ {
2607
+ "kind": "method",
2608
+ "name": "autoUpdateModeChanged",
2609
+ "privacy": "private",
2835
2610
  "return": {
2836
2611
  "type": {
2837
- "text": "(\n overrideDefinition?: OverrideFoundationElementDefinition<T>\n ) => FoundationElementRegistry<T, K>"
2612
+ "text": "void"
2838
2613
  }
2839
2614
  },
2840
2615
  "parameters": [
2841
2616
  {
2842
- "name": "this",
2617
+ "name": "prevMode",
2843
2618
  "type": {
2844
- "text": "K"
2619
+ "text": "AutoUpdateMode"
2845
2620
  }
2846
2621
  },
2847
2622
  {
2848
- "name": "elementDefinition",
2623
+ "name": "newMode",
2849
2624
  "type": {
2850
- "text": "T"
2851
- },
2852
- "description": "The definition of the element to create the registry\nfunction for."
2625
+ "text": "AutoUpdateMode"
2626
+ }
2853
2627
  }
2854
2628
  ],
2855
- "description": "Defines an element registry function with a set of element definition defaults.",
2856
2629
  "inheritedFrom": {
2857
- "name": "FoundationElement",
2858
- "module": "src/foundation-element/foundation-element.ts"
2630
+ "name": "AnchoredRegion",
2631
+ "module": "src/anchored-region/anchored-region.ts"
2859
2632
  }
2860
- }
2861
- ]
2862
- },
2863
- {
2864
- "kind": "variable",
2865
- "name": "foundationAnchorShadowOptions",
2866
- "type": {
2867
- "text": "ShadowRootInit"
2868
- },
2869
- "default": "{\n delegatesFocus: true,\n mode: 'open',\n}"
2870
- },
2871
- {
2872
- "kind": "variable",
2873
- "name": "defaultAnchorConfig",
2874
- "type": {
2875
- "text": "object"
2876
- },
2877
- "default": "{}"
2878
- },
2879
- {
2880
- "kind": "variable",
2881
- "name": "foundationAnchor",
2882
- "description": "The Foundation Anchor",
2883
- "privacy": "public"
2884
- }
2885
- ],
2886
- "exports": [
2887
- {
2888
- "kind": "js",
2889
- "name": "Anchor",
2890
- "declaration": {
2891
- "name": "Anchor",
2892
- "module": "src/anchor/anchor.ts"
2893
- }
2894
- },
2895
- {
2896
- "kind": "js",
2897
- "name": "foundationAnchorShadowOptions",
2898
- "declaration": {
2899
- "name": "foundationAnchorShadowOptions",
2900
- "module": "src/anchor/anchor.ts"
2901
- }
2902
- },
2903
- {
2904
- "kind": "js",
2905
- "name": "defaultAnchorConfig",
2906
- "declaration": {
2907
- "name": "defaultAnchorConfig",
2908
- "module": "src/anchor/anchor.ts"
2909
- }
2910
- },
2911
- {
2912
- "kind": "js",
2913
- "name": "foundationAnchor",
2914
- "declaration": {
2915
- "name": "foundationAnchor",
2916
- "module": "src/anchor/anchor.ts"
2917
- }
2918
- }
2919
- ]
2920
- },
2921
- {
2922
- "kind": "javascript-module",
2923
- "path": "src/anchor/index.ts",
2924
- "declarations": [],
2925
- "exports": [
2926
- {
2927
- "kind": "js",
2928
- "name": "*",
2929
- "declaration": {
2930
- "name": "*",
2931
- "package": "./anchor.template"
2932
- }
2933
- },
2934
- {
2935
- "kind": "js",
2936
- "name": "*",
2937
- "declaration": {
2938
- "name": "*",
2939
- "package": "./anchor.styles"
2940
- }
2941
- },
2942
- {
2943
- "kind": "js",
2944
- "name": "*",
2945
- "declaration": {
2946
- "name": "*",
2947
- "package": "./anchor"
2948
- }
2949
- }
2950
- ]
2951
- },
2952
- {
2953
- "kind": "javascript-module",
2954
- "path": "src/anchored-region/anchor-region.template.ts",
2955
- "declarations": [
2956
- {
2957
- "kind": "function",
2958
- "name": "foundationAnchoredRegionTemplate",
2959
- "return": {
2960
- "type": {
2961
- "text": "ViewTemplate<AnchoredRegion>"
2962
- }
2963
- },
2964
- "parameters": [
2633
+ },
2965
2634
  {
2966
- "name": "context",
2635
+ "kind": "field",
2636
+ "name": "anchorElement",
2967
2637
  "type": {
2968
- "text": "ElementDefinitionContext"
2638
+ "text": "HTMLElement | null"
2639
+ },
2640
+ "privacy": "public",
2641
+ "default": "null",
2642
+ "description": "The HTML element being used as the anchor",
2643
+ "inheritedFrom": {
2644
+ "name": "AnchoredRegion",
2645
+ "module": "src/anchored-region/anchored-region.ts"
2969
2646
  }
2970
2647
  },
2971
2648
  {
2972
- "name": "definition",
2649
+ "kind": "method",
2650
+ "name": "anchorElementChanged",
2651
+ "privacy": "private",
2652
+ "return": {
2653
+ "type": {
2654
+ "text": "void"
2655
+ }
2656
+ },
2657
+ "inheritedFrom": {
2658
+ "name": "AnchoredRegion",
2659
+ "module": "src/anchored-region/anchored-region.ts"
2660
+ }
2661
+ },
2662
+ {
2663
+ "kind": "field",
2664
+ "name": "viewportElement",
2973
2665
  "type": {
2974
- "text": "FoundationElementDefinition"
2666
+ "text": "HTMLElement | null"
2667
+ },
2668
+ "privacy": "public",
2669
+ "default": "null",
2670
+ "description": "The HTML element being used as the viewport",
2671
+ "inheritedFrom": {
2672
+ "name": "AnchoredRegion",
2673
+ "module": "src/anchored-region/anchored-region.ts"
2975
2674
  }
2976
- }
2977
- ]
2978
- }
2979
- ],
2980
- "exports": [
2981
- {
2982
- "kind": "js",
2983
- "name": "foundationAnchoredRegionTemplate",
2984
- "declaration": {
2985
- "name": "foundationAnchoredRegionTemplate",
2986
- "module": "src/anchored-region/anchor-region.template.ts"
2987
- }
2988
- }
2989
- ]
2990
- },
2991
- {
2992
- "kind": "javascript-module",
2993
- "path": "src/anchored-region/anchored-region.styles.ts",
2994
- "declarations": [
2995
- {
2996
- "kind": "function",
2997
- "name": "foundationAnchoredRegionStyles",
2998
- "return": {
2999
- "type": {
3000
- "text": "ElementStyles"
3001
- }
3002
- },
3003
- "parameters": [
2675
+ },
2676
+ {
2677
+ "kind": "method",
2678
+ "name": "viewportElementChanged",
2679
+ "privacy": "private",
2680
+ "return": {
2681
+ "type": {
2682
+ "text": "void"
2683
+ }
2684
+ },
2685
+ "inheritedFrom": {
2686
+ "name": "AnchoredRegion",
2687
+ "module": "src/anchored-region/anchored-region.ts"
2688
+ }
2689
+ },
3004
2690
  {
3005
- "name": "context",
2691
+ "kind": "field",
2692
+ "name": "verticalPosition",
3006
2693
  "type": {
3007
- "text": "ElementDefinitionContext"
2694
+ "text": "AnchoredRegionPositionLabel | undefined"
2695
+ },
2696
+ "privacy": "public",
2697
+ "description": "indicates the current horizontal position of the region",
2698
+ "inheritedFrom": {
2699
+ "name": "AnchoredRegion",
2700
+ "module": "src/anchored-region/anchored-region.ts"
3008
2701
  }
3009
2702
  },
3010
2703
  {
3011
- "name": "definition",
2704
+ "kind": "field",
2705
+ "name": "horizontalPosition",
3012
2706
  "type": {
3013
- "text": "FoundationElementDefinition"
2707
+ "text": "AnchoredRegionPositionLabel | undefined"
2708
+ },
2709
+ "privacy": "public",
2710
+ "description": "indicates the current vertical position of the region",
2711
+ "inheritedFrom": {
2712
+ "name": "AnchoredRegion",
2713
+ "module": "src/anchored-region/anchored-region.ts"
3014
2714
  }
3015
- }
3016
- ]
3017
- }
3018
- ],
3019
- "exports": [
3020
- {
3021
- "kind": "js",
3022
- "name": "foundationAnchoredRegionStyles",
3023
- "declaration": {
3024
- "name": "foundationAnchoredRegionStyles",
3025
- "module": "src/anchored-region/anchored-region.styles.ts"
3026
- }
3027
- }
3028
- ]
3029
- },
3030
- {
3031
- "kind": "javascript-module",
3032
- "path": "src/anchored-region/anchored-region.ts",
3033
- "declarations": [
3034
- {
3035
- "kind": "class",
3036
- "description": "",
3037
- "name": "AnchoredRegion",
3038
- "superclass": {
3039
- "name": "FASTAnchoredRegion",
3040
- "package": "@microsoft/fast-components"
3041
- },
3042
- "tagName": "%%prefix%%-anchored-region",
3043
- "customElement": true,
3044
- "attributes": [
2715
+ },
3045
2716
  {
3046
- "name": "anchor",
2717
+ "kind": "field",
2718
+ "name": "translateX",
3047
2719
  "type": {
3048
- "text": "string"
2720
+ "text": "number"
3049
2721
  },
3050
- "default": "\"\"",
3051
- "description": "The HTML ID of the anchor element this region is positioned relative to",
3052
- "fieldName": "anchor",
2722
+ "privacy": "private",
2723
+ "description": "values to be applied to the component's transform on render",
3053
2724
  "inheritedFrom": {
3054
2725
  "name": "AnchoredRegion",
3055
2726
  "module": "src/anchored-region/anchored-region.ts"
3056
2727
  }
3057
2728
  },
3058
2729
  {
3059
- "name": "viewport",
2730
+ "kind": "field",
2731
+ "name": "translateY",
3060
2732
  "type": {
3061
- "text": "string"
2733
+ "text": "number"
3062
2734
  },
3063
- "default": "\"\"",
3064
- "description": "The HTML ID of the viewport element this region is positioned relative to",
3065
- "fieldName": "viewport",
2735
+ "privacy": "private",
3066
2736
  "inheritedFrom": {
3067
2737
  "name": "AnchoredRegion",
3068
2738
  "module": "src/anchored-region/anchored-region.ts"
3069
2739
  }
3070
2740
  },
3071
2741
  {
3072
- "name": "horizontal-positioning-mode",
2742
+ "kind": "field",
2743
+ "name": "regionWidth",
3073
2744
  "type": {
3074
- "text": "AxisPositioningMode"
2745
+ "text": "string"
3075
2746
  },
3076
- "default": "\"uncontrolled\"",
3077
- "description": "Sets what logic the component uses to determine horizontal placement.\n'locktodefault' forces the default position\n'dynamic' decides placement based on available space\n'uncontrolled' does not control placement on the horizontal axis",
3078
- "fieldName": "horizontalPositioningMode",
2747
+ "privacy": "private",
2748
+ "description": "the span to be applied to the region on each axis",
3079
2749
  "inheritedFrom": {
3080
2750
  "name": "AnchoredRegion",
3081
2751
  "module": "src/anchored-region/anchored-region.ts"
3082
2752
  }
3083
2753
  },
3084
2754
  {
3085
- "name": "horizontal-default-position",
2755
+ "kind": "field",
2756
+ "name": "regionHeight",
3086
2757
  "type": {
3087
- "text": "HorizontalPosition"
2758
+ "text": "string"
3088
2759
  },
3089
- "default": "\"unset\"",
3090
- "description": "The default horizontal position of the region relative to the anchor element",
3091
- "fieldName": "horizontalDefaultPosition",
2760
+ "privacy": "private",
3092
2761
  "inheritedFrom": {
3093
2762
  "name": "AnchoredRegion",
3094
2763
  "module": "src/anchored-region/anchored-region.ts"
3095
2764
  }
3096
2765
  },
3097
2766
  {
3098
- "name": "horizontal-viewport-lock",
2767
+ "kind": "field",
2768
+ "name": "resizeDetector",
3099
2769
  "type": {
3100
- "text": "boolean"
2770
+ "text": "ResizeObserverClassDefinition | null"
3101
2771
  },
3102
- "default": "false",
3103
- "description": "Whether the region remains in the viewport (ie. detaches from the anchor) on the horizontal axis",
3104
- "fieldName": "horizontalViewportLock",
2772
+ "privacy": "private",
2773
+ "default": "null",
3105
2774
  "inheritedFrom": {
3106
2775
  "name": "AnchoredRegion",
3107
2776
  "module": "src/anchored-region/anchored-region.ts"
3108
2777
  }
3109
2778
  },
3110
2779
  {
3111
- "name": "horizontal-inset",
2780
+ "kind": "field",
2781
+ "name": "viewportRect",
3112
2782
  "type": {
3113
- "text": "boolean"
2783
+ "text": "ClientRect | DOMRect | undefined"
3114
2784
  },
3115
- "default": "false",
3116
- "description": "Whether the region overlaps the anchor on the horizontal axis",
3117
- "fieldName": "horizontalInset",
2785
+ "privacy": "private",
3118
2786
  "inheritedFrom": {
3119
2787
  "name": "AnchoredRegion",
3120
2788
  "module": "src/anchored-region/anchored-region.ts"
3121
2789
  }
3122
2790
  },
3123
2791
  {
3124
- "name": "horizontal-threshold",
2792
+ "kind": "field",
2793
+ "name": "anchorRect",
3125
2794
  "type": {
3126
- "text": "number"
2795
+ "text": "ClientRect | DOMRect | undefined"
3127
2796
  },
3128
- "description": "How narrow the space allocated to the default position has to be before the widest area\nis selected for layout",
3129
- "fieldName": "horizontalThreshold",
2797
+ "privacy": "private",
3130
2798
  "inheritedFrom": {
3131
2799
  "name": "AnchoredRegion",
3132
2800
  "module": "src/anchored-region/anchored-region.ts"
3133
2801
  }
3134
2802
  },
3135
2803
  {
3136
- "name": "horizontal-scaling",
2804
+ "kind": "field",
2805
+ "name": "regionRect",
3137
2806
  "type": {
3138
- "text": "AxisScalingMode"
2807
+ "text": "ClientRect | DOMRect | undefined"
3139
2808
  },
3140
- "default": "\"content\"",
3141
- "description": "Defines how the width of the region is calculated",
3142
- "fieldName": "horizontalScaling",
2809
+ "privacy": "private",
3143
2810
  "inheritedFrom": {
3144
2811
  "name": "AnchoredRegion",
3145
2812
  "module": "src/anchored-region/anchored-region.ts"
3146
2813
  }
3147
2814
  },
3148
2815
  {
3149
- "name": "vertical-positioning-mode",
2816
+ "kind": "field",
2817
+ "name": "baseHorizontalOffset",
3150
2818
  "type": {
3151
- "text": "AxisPositioningMode"
2819
+ "text": "number"
3152
2820
  },
3153
- "default": "\"uncontrolled\"",
3154
- "description": "Sets what logic the component uses to determine vertical placement.\n'locktodefault' forces the default position\n'dynamic' decides placement based on available space\n'uncontrolled' does not control placement on the vertical axis",
3155
- "fieldName": "verticalPositioningMode",
2821
+ "privacy": "private",
2822
+ "default": "0",
2823
+ "description": "base offsets between the positioner's base position and the anchor's",
3156
2824
  "inheritedFrom": {
3157
2825
  "name": "AnchoredRegion",
3158
2826
  "module": "src/anchored-region/anchored-region.ts"
3159
2827
  }
3160
2828
  },
3161
2829
  {
3162
- "name": "vertical-default-position",
2830
+ "kind": "field",
2831
+ "name": "baseVerticalOffset",
3163
2832
  "type": {
3164
- "text": "VerticalPosition"
2833
+ "text": "number"
3165
2834
  },
3166
- "default": "\"unset\"",
3167
- "description": "The default vertical position of the region relative to the anchor element",
3168
- "fieldName": "verticalDefaultPosition",
2835
+ "privacy": "private",
2836
+ "default": "0",
3169
2837
  "inheritedFrom": {
3170
2838
  "name": "AnchoredRegion",
3171
2839
  "module": "src/anchored-region/anchored-region.ts"
3172
2840
  }
3173
2841
  },
3174
2842
  {
3175
- "name": "vertical-viewport-lock",
2843
+ "kind": "field",
2844
+ "name": "pendingPositioningUpdate",
3176
2845
  "type": {
3177
2846
  "text": "boolean"
3178
2847
  },
2848
+ "privacy": "private",
3179
2849
  "default": "false",
3180
- "description": "Whether the region remains in the viewport (ie. detaches from the anchor) on the vertical axis",
3181
- "fieldName": "verticalViewportLock",
3182
2850
  "inheritedFrom": {
3183
2851
  "name": "AnchoredRegion",
3184
2852
  "module": "src/anchored-region/anchored-region.ts"
3185
2853
  }
3186
2854
  },
3187
2855
  {
3188
- "name": "vertical-inset",
2856
+ "kind": "field",
2857
+ "name": "pendingReset",
3189
2858
  "type": {
3190
2859
  "text": "boolean"
3191
2860
  },
2861
+ "privacy": "private",
3192
2862
  "default": "false",
3193
- "description": "Whether the region overlaps the anchor on the vertical axis",
3194
- "fieldName": "verticalInset",
3195
2863
  "inheritedFrom": {
3196
2864
  "name": "AnchoredRegion",
3197
2865
  "module": "src/anchored-region/anchored-region.ts"
3198
2866
  }
3199
2867
  },
3200
2868
  {
3201
- "name": "vertical-threshold",
2869
+ "kind": "field",
2870
+ "name": "currentDirection",
3202
2871
  "type": {
3203
- "text": "number"
2872
+ "text": "Direction"
3204
2873
  },
3205
- "description": "How short the space allocated to the default position has to be before the tallest area\nis selected for layout",
3206
- "fieldName": "verticalThreshold",
2874
+ "privacy": "private",
3207
2875
  "inheritedFrom": {
3208
2876
  "name": "AnchoredRegion",
3209
2877
  "module": "src/anchored-region/anchored-region.ts"
3210
2878
  }
3211
2879
  },
3212
2880
  {
3213
- "name": "vertical-scaling",
2881
+ "kind": "field",
2882
+ "name": "regionVisible",
3214
2883
  "type": {
3215
- "text": "AxisScalingMode"
2884
+ "text": "boolean"
3216
2885
  },
3217
- "default": "\"content\"",
3218
- "description": "Defines how the height of the region is calculated",
3219
- "fieldName": "verticalScaling",
2886
+ "privacy": "private",
2887
+ "default": "false",
3220
2888
  "inheritedFrom": {
3221
2889
  "name": "AnchoredRegion",
3222
2890
  "module": "src/anchored-region/anchored-region.ts"
3223
2891
  }
3224
2892
  },
3225
2893
  {
3226
- "name": "fixed-placement",
2894
+ "kind": "field",
2895
+ "name": "forceUpdate",
3227
2896
  "type": {
3228
2897
  "text": "boolean"
3229
2898
  },
2899
+ "privacy": "private",
3230
2900
  "default": "false",
3231
- "description": "Whether the region is positioned using css \"position: fixed\".\nOtherwise the region uses \"position: absolute\".\nFixed placement allows the region to break out of parent containers,",
3232
- "fieldName": "fixedPlacement",
3233
2901
  "inheritedFrom": {
3234
2902
  "name": "AnchoredRegion",
3235
2903
  "module": "src/anchored-region/anchored-region.ts"
3236
2904
  }
3237
2905
  },
3238
2906
  {
3239
- "name": "auto-update-mode",
2907
+ "kind": "field",
2908
+ "name": "updateThreshold",
3240
2909
  "type": {
3241
- "text": "AutoUpdateMode"
2910
+ "text": "number"
3242
2911
  },
3243
- "default": "\"anchor\"",
3244
- "description": "Defines what triggers the anchored region to revaluate positioning",
3245
- "fieldName": "autoUpdateMode",
2912
+ "privacy": "private",
2913
+ "default": "0.5",
3246
2914
  "inheritedFrom": {
3247
2915
  "name": "AnchoredRegion",
3248
2916
  "module": "src/anchored-region/anchored-region.ts"
3249
2917
  }
3250
- }
3251
- ],
3252
- "members": [
2918
+ },
3253
2919
  {
3254
2920
  "kind": "field",
3255
- "name": "anchor",
2921
+ "name": "intersectionService",
3256
2922
  "type": {
3257
- "text": "string"
2923
+ "text": "IntersectionService"
3258
2924
  },
2925
+ "privacy": "private",
2926
+ "static": true,
2927
+ "default": "new IntersectionService()",
2928
+ "inheritedFrom": {
2929
+ "name": "AnchoredRegion",
2930
+ "module": "src/anchored-region/anchored-region.ts"
2931
+ }
2932
+ },
2933
+ {
2934
+ "kind": "field",
2935
+ "name": "update",
3259
2936
  "privacy": "public",
3260
- "default": "\"\"",
3261
- "description": "The HTML ID of the anchor element this region is positioned relative to",
2937
+ "description": "update position",
3262
2938
  "inheritedFrom": {
3263
2939
  "name": "AnchoredRegion",
3264
2940
  "module": "src/anchored-region/anchored-region.ts"
@@ -3266,27 +2942,29 @@
3266
2942
  },
3267
2943
  {
3268
2944
  "kind": "method",
3269
- "name": "anchorChanged",
2945
+ "name": "disconnectResizeDetector",
3270
2946
  "privacy": "private",
3271
2947
  "return": {
3272
2948
  "type": {
3273
2949
  "text": "void"
3274
2950
  }
3275
2951
  },
2952
+ "description": "destroys the instance's resize observer",
3276
2953
  "inheritedFrom": {
3277
2954
  "name": "AnchoredRegion",
3278
2955
  "module": "src/anchored-region/anchored-region.ts"
3279
2956
  }
3280
2957
  },
3281
2958
  {
3282
- "kind": "field",
3283
- "name": "viewport",
3284
- "type": {
3285
- "text": "string"
2959
+ "kind": "method",
2960
+ "name": "initializeResizeDetector",
2961
+ "privacy": "private",
2962
+ "return": {
2963
+ "type": {
2964
+ "text": "void"
2965
+ }
3286
2966
  },
3287
- "privacy": "public",
3288
- "default": "\"\"",
3289
- "description": "The HTML ID of the viewport element this region is positioned relative to",
2967
+ "description": "initializes the instance's resize observer",
3290
2968
  "inheritedFrom": {
3291
2969
  "name": "AnchoredRegion",
3292
2970
  "module": "src/anchored-region/anchored-region.ts"
@@ -3294,27 +2972,44 @@
3294
2972
  },
3295
2973
  {
3296
2974
  "kind": "method",
3297
- "name": "viewportChanged",
2975
+ "name": "updateForAttributeChange",
3298
2976
  "privacy": "private",
3299
2977
  "return": {
3300
2978
  "type": {
3301
2979
  "text": "void"
3302
2980
  }
3303
2981
  },
2982
+ "description": "react to attribute changes that don't require a reset",
3304
2983
  "inheritedFrom": {
3305
2984
  "name": "AnchoredRegion",
3306
2985
  "module": "src/anchored-region/anchored-region.ts"
3307
2986
  }
3308
2987
  },
3309
2988
  {
3310
- "kind": "field",
3311
- "name": "horizontalPositioningMode",
3312
- "type": {
3313
- "text": "AxisPositioningMode"
2989
+ "kind": "method",
2990
+ "name": "initialize",
2991
+ "privacy": "private",
2992
+ "return": {
2993
+ "type": {
2994
+ "text": "void"
2995
+ }
2996
+ },
2997
+ "description": "fully initializes the component",
2998
+ "inheritedFrom": {
2999
+ "name": "AnchoredRegion",
3000
+ "module": "src/anchored-region/anchored-region.ts"
3001
+ }
3002
+ },
3003
+ {
3004
+ "kind": "method",
3005
+ "name": "requestReset",
3006
+ "privacy": "private",
3007
+ "return": {
3008
+ "type": {
3009
+ "text": "void"
3010
+ }
3314
3011
  },
3315
- "privacy": "public",
3316
- "default": "\"uncontrolled\"",
3317
- "description": "Sets what logic the component uses to determine horizontal placement.\n'locktodefault' forces the default position\n'dynamic' decides placement based on available space\n'uncontrolled' does not control placement on the horizontal axis",
3012
+ "description": "Request a reset if there are currently no open requests",
3318
3013
  "inheritedFrom": {
3319
3014
  "name": "AnchoredRegion",
3320
3015
  "module": "src/anchored-region/anchored-region.ts"
@@ -3322,13 +3017,14 @@
3322
3017
  },
3323
3018
  {
3324
3019
  "kind": "method",
3325
- "name": "horizontalPositioningModeChanged",
3020
+ "name": "setInitialState",
3326
3021
  "privacy": "private",
3327
3022
  "return": {
3328
3023
  "type": {
3329
3024
  "text": "void"
3330
3025
  }
3331
3026
  },
3027
+ "description": "sets the starting configuration for component internal values",
3332
3028
  "inheritedFrom": {
3333
3029
  "name": "AnchoredRegion",
3334
3030
  "module": "src/anchored-region/anchored-region.ts"
@@ -3336,27 +3032,19 @@
3336
3032
  },
3337
3033
  {
3338
3034
  "kind": "field",
3339
- "name": "horizontalDefaultPosition",
3340
- "type": {
3341
- "text": "HorizontalPosition"
3342
- },
3343
- "privacy": "public",
3344
- "default": "\"unset\"",
3345
- "description": "The default horizontal position of the region relative to the anchor element",
3035
+ "name": "startObservers",
3036
+ "privacy": "private",
3037
+ "description": "starts observers",
3346
3038
  "inheritedFrom": {
3347
3039
  "name": "AnchoredRegion",
3348
3040
  "module": "src/anchored-region/anchored-region.ts"
3349
3041
  }
3350
3042
  },
3351
3043
  {
3352
- "kind": "method",
3353
- "name": "horizontalDefaultPositionChanged",
3044
+ "kind": "field",
3045
+ "name": "requestPositionUpdates",
3354
3046
  "privacy": "private",
3355
- "return": {
3356
- "type": {
3357
- "text": "void"
3358
- }
3359
- },
3047
+ "description": "get position updates",
3360
3048
  "inheritedFrom": {
3361
3049
  "name": "AnchoredRegion",
3362
3050
  "module": "src/anchored-region/anchored-region.ts"
@@ -3364,27 +3052,19 @@
3364
3052
  },
3365
3053
  {
3366
3054
  "kind": "field",
3367
- "name": "horizontalViewportLock",
3368
- "type": {
3369
- "text": "boolean"
3370
- },
3371
- "privacy": "public",
3372
- "default": "false",
3373
- "description": "Whether the region remains in the viewport (ie. detaches from the anchor) on the horizontal axis",
3055
+ "name": "stopObservers",
3056
+ "privacy": "private",
3057
+ "description": "stops observers",
3374
3058
  "inheritedFrom": {
3375
3059
  "name": "AnchoredRegion",
3376
3060
  "module": "src/anchored-region/anchored-region.ts"
3377
3061
  }
3378
3062
  },
3379
3063
  {
3380
- "kind": "method",
3381
- "name": "horizontalViewportLockChanged",
3064
+ "kind": "field",
3065
+ "name": "getViewport",
3382
3066
  "privacy": "private",
3383
- "return": {
3384
- "type": {
3385
- "text": "void"
3386
- }
3387
- },
3067
+ "description": "Gets the viewport element by id, or defaults to document root",
3388
3068
  "inheritedFrom": {
3389
3069
  "name": "AnchoredRegion",
3390
3070
  "module": "src/anchored-region/anchored-region.ts"
@@ -3392,27 +3072,19 @@
3392
3072
  },
3393
3073
  {
3394
3074
  "kind": "field",
3395
- "name": "horizontalInset",
3396
- "type": {
3397
- "text": "boolean"
3398
- },
3399
- "privacy": "public",
3400
- "default": "false",
3401
- "description": "Whether the region overlaps the anchor on the horizontal axis",
3075
+ "name": "getAnchor",
3076
+ "privacy": "private",
3077
+ "description": "Gets the anchor element by id",
3402
3078
  "inheritedFrom": {
3403
3079
  "name": "AnchoredRegion",
3404
3080
  "module": "src/anchored-region/anchored-region.ts"
3405
3081
  }
3406
3082
  },
3407
3083
  {
3408
- "kind": "method",
3409
- "name": "horizontalInsetChanged",
3084
+ "kind": "field",
3085
+ "name": "handleIntersection",
3410
3086
  "privacy": "private",
3411
- "return": {
3412
- "type": {
3413
- "text": "void"
3414
- }
3415
- },
3087
+ "description": "Handle intersections",
3416
3088
  "inheritedFrom": {
3417
3089
  "name": "AnchoredRegion",
3418
3090
  "module": "src/anchored-region/anchored-region.ts"
@@ -3420,26 +3092,19 @@
3420
3092
  },
3421
3093
  {
3422
3094
  "kind": "field",
3423
- "name": "horizontalThreshold",
3424
- "type": {
3425
- "text": "number"
3426
- },
3427
- "privacy": "public",
3428
- "description": "How narrow the space allocated to the default position has to be before the widest area\nis selected for layout",
3095
+ "name": "applyIntersectionEntries",
3096
+ "privacy": "private",
3097
+ "description": "iterate through intersection entries and apply data",
3429
3098
  "inheritedFrom": {
3430
3099
  "name": "AnchoredRegion",
3431
3100
  "module": "src/anchored-region/anchored-region.ts"
3432
3101
  }
3433
3102
  },
3434
3103
  {
3435
- "kind": "method",
3436
- "name": "horizontalThresholdChanged",
3104
+ "kind": "field",
3105
+ "name": "updateRegionOffset",
3437
3106
  "privacy": "private",
3438
- "return": {
3439
- "type": {
3440
- "text": "void"
3441
- }
3442
- },
3107
+ "description": "Update the offset values",
3443
3108
  "inheritedFrom": {
3444
3109
  "name": "AnchoredRegion",
3445
3110
  "module": "src/anchored-region/anchored-region.ts"
@@ -3447,27 +3112,19 @@
3447
3112
  },
3448
3113
  {
3449
3114
  "kind": "field",
3450
- "name": "horizontalScaling",
3451
- "type": {
3452
- "text": "AxisScalingMode"
3453
- },
3454
- "privacy": "public",
3455
- "default": "\"content\"",
3456
- "description": "Defines how the width of the region is calculated",
3115
+ "name": "isRectDifferent",
3116
+ "privacy": "private",
3117
+ "description": "compare rects to see if there is enough change to justify a DOM update",
3457
3118
  "inheritedFrom": {
3458
3119
  "name": "AnchoredRegion",
3459
3120
  "module": "src/anchored-region/anchored-region.ts"
3460
3121
  }
3461
3122
  },
3462
3123
  {
3463
- "kind": "method",
3464
- "name": "horizontalScalingChanged",
3124
+ "kind": "field",
3125
+ "name": "handleResize",
3465
3126
  "privacy": "private",
3466
- "return": {
3467
- "type": {
3468
- "text": "void"
3469
- }
3470
- },
3127
+ "description": "Handle resize events",
3471
3128
  "inheritedFrom": {
3472
3129
  "name": "AnchoredRegion",
3473
3130
  "module": "src/anchored-region/anchored-region.ts"
@@ -3475,27 +3132,19 @@
3475
3132
  },
3476
3133
  {
3477
3134
  "kind": "field",
3478
- "name": "verticalPositioningMode",
3479
- "type": {
3480
- "text": "AxisPositioningMode"
3481
- },
3482
- "privacy": "public",
3483
- "default": "\"uncontrolled\"",
3484
- "description": "Sets what logic the component uses to determine vertical placement.\n'locktodefault' forces the default position\n'dynamic' decides placement based on available space\n'uncontrolled' does not control placement on the vertical axis",
3135
+ "name": "reset",
3136
+ "privacy": "private",
3137
+ "description": "resets the component",
3485
3138
  "inheritedFrom": {
3486
3139
  "name": "AnchoredRegion",
3487
3140
  "module": "src/anchored-region/anchored-region.ts"
3488
3141
  }
3489
3142
  },
3490
3143
  {
3491
- "kind": "method",
3492
- "name": "verticalPositioningModeChanged",
3144
+ "kind": "field",
3145
+ "name": "updateLayout",
3493
3146
  "privacy": "private",
3494
- "return": {
3495
- "type": {
3496
- "text": "void"
3497
- }
3498
- },
3147
+ "description": "Recalculate layout related state values",
3499
3148
  "inheritedFrom": {
3500
3149
  "name": "AnchoredRegion",
3501
3150
  "module": "src/anchored-region/anchored-region.ts"
@@ -3503,27 +3152,19 @@
3503
3152
  },
3504
3153
  {
3505
3154
  "kind": "field",
3506
- "name": "verticalDefaultPosition",
3507
- "type": {
3508
- "text": "VerticalPosition"
3509
- },
3510
- "privacy": "public",
3511
- "default": "\"unset\"",
3512
- "description": "The default vertical position of the region relative to the anchor element",
3155
+ "name": "updateRegionStyle",
3156
+ "privacy": "private",
3157
+ "description": "Updates the style string applied to the region element as well as the css classes attached\nto the root element",
3513
3158
  "inheritedFrom": {
3514
3159
  "name": "AnchoredRegion",
3515
3160
  "module": "src/anchored-region/anchored-region.ts"
3516
3161
  }
3517
3162
  },
3518
3163
  {
3519
- "kind": "method",
3520
- "name": "verticalDefaultPositionChanged",
3164
+ "kind": "field",
3165
+ "name": "updatePositionClasses",
3521
3166
  "privacy": "private",
3522
- "return": {
3523
- "type": {
3524
- "text": "void"
3525
- }
3526
- },
3167
+ "description": "Updates the css classes that reflect the current position of the element",
3527
3168
  "inheritedFrom": {
3528
3169
  "name": "AnchoredRegion",
3529
3170
  "module": "src/anchored-region/anchored-region.ts"
@@ -3531,27 +3172,19 @@
3531
3172
  },
3532
3173
  {
3533
3174
  "kind": "field",
3534
- "name": "verticalViewportLock",
3535
- "type": {
3536
- "text": "boolean"
3537
- },
3538
- "privacy": "public",
3539
- "default": "false",
3540
- "description": "Whether the region remains in the viewport (ie. detaches from the anchor) on the vertical axis",
3175
+ "name": "setHorizontalPosition",
3176
+ "privacy": "private",
3177
+ "description": "Get horizontal positioning state based on desired position",
3541
3178
  "inheritedFrom": {
3542
3179
  "name": "AnchoredRegion",
3543
3180
  "module": "src/anchored-region/anchored-region.ts"
3544
3181
  }
3545
3182
  },
3546
3183
  {
3547
- "kind": "method",
3548
- "name": "verticalViewportLockChanged",
3184
+ "kind": "field",
3185
+ "name": "setVerticalPosition",
3549
3186
  "privacy": "private",
3550
- "return": {
3551
- "type": {
3552
- "text": "void"
3553
- }
3554
- },
3187
+ "description": "Set vertical positioning state based on desired position",
3555
3188
  "inheritedFrom": {
3556
3189
  "name": "AnchoredRegion",
3557
3190
  "module": "src/anchored-region/anchored-region.ts"
@@ -3559,27 +3192,19 @@
3559
3192
  },
3560
3193
  {
3561
3194
  "kind": "field",
3562
- "name": "verticalInset",
3563
- "type": {
3564
- "text": "boolean"
3565
- },
3566
- "privacy": "public",
3567
- "default": "false",
3568
- "description": "Whether the region overlaps the anchor on the vertical axis",
3195
+ "name": "getPositioningOptions",
3196
+ "privacy": "private",
3197
+ "description": "Get available positions based on positioning mode",
3569
3198
  "inheritedFrom": {
3570
3199
  "name": "AnchoredRegion",
3571
3200
  "module": "src/anchored-region/anchored-region.ts"
3572
3201
  }
3573
3202
  },
3574
3203
  {
3575
- "kind": "method",
3576
- "name": "verticalInsetChanged",
3204
+ "kind": "field",
3205
+ "name": "getAvailableSpace",
3577
3206
  "privacy": "private",
3578
- "return": {
3579
- "type": {
3580
- "text": "void"
3581
- }
3582
- },
3207
+ "description": "Get the space available for a particular relative position",
3583
3208
  "inheritedFrom": {
3584
3209
  "name": "AnchoredRegion",
3585
3210
  "module": "src/anchored-region/anchored-region.ts"
@@ -3587,26 +3212,19 @@
3587
3212
  },
3588
3213
  {
3589
3214
  "kind": "field",
3590
- "name": "verticalThreshold",
3591
- "type": {
3592
- "text": "number"
3593
- },
3594
- "privacy": "public",
3595
- "description": "How short the space allocated to the default position has to be before the tallest area\nis selected for layout",
3215
+ "name": "getNextRegionDimension",
3216
+ "privacy": "private",
3217
+ "description": "Get region dimensions",
3596
3218
  "inheritedFrom": {
3597
3219
  "name": "AnchoredRegion",
3598
3220
  "module": "src/anchored-region/anchored-region.ts"
3599
3221
  }
3600
3222
  },
3601
3223
  {
3602
- "kind": "method",
3603
- "name": "verticalThresholdChanged",
3224
+ "kind": "field",
3225
+ "name": "startAutoUpdateEventListeners",
3604
3226
  "privacy": "private",
3605
- "return": {
3606
- "type": {
3607
- "text": "void"
3608
- }
3609
- },
3227
+ "description": "starts event listeners that can trigger auto updating",
3610
3228
  "inheritedFrom": {
3611
3229
  "name": "AnchoredRegion",
3612
3230
  "module": "src/anchored-region/anchored-region.ts"
@@ -3614,710 +3232,1071 @@
3614
3232
  },
3615
3233
  {
3616
3234
  "kind": "field",
3617
- "name": "verticalScaling",
3618
- "type": {
3619
- "text": "AxisScalingMode"
3620
- },
3621
- "privacy": "public",
3622
- "default": "\"content\"",
3623
- "description": "Defines how the height of the region is calculated",
3235
+ "name": "stopAutoUpdateEventListeners",
3236
+ "privacy": "private",
3237
+ "description": "stops event listeners that can trigger auto updating",
3624
3238
  "inheritedFrom": {
3625
3239
  "name": "AnchoredRegion",
3626
3240
  "module": "src/anchored-region/anchored-region.ts"
3627
3241
  }
3628
3242
  },
3629
3243
  {
3630
- "kind": "method",
3631
- "name": "verticalScalingChanged",
3244
+ "kind": "field",
3245
+ "name": "_presentation",
3246
+ "type": {
3247
+ "text": "ComponentPresentation | null | undefined"
3248
+ },
3632
3249
  "privacy": "private",
3633
- "return": {
3634
- "type": {
3635
- "text": "void"
3636
- }
3250
+ "default": "void 0",
3251
+ "inheritedFrom": {
3252
+ "name": "FoundationElement",
3253
+ "module": "src/foundation-element/foundation-element.ts"
3254
+ }
3255
+ },
3256
+ {
3257
+ "kind": "field",
3258
+ "name": "$presentation",
3259
+ "type": {
3260
+ "text": "ComponentPresentation | null"
3637
3261
  },
3262
+ "privacy": "public",
3263
+ "description": "A property which resolves the ComponentPresentation instance\nfor the current component.",
3638
3264
  "inheritedFrom": {
3639
- "name": "AnchoredRegion",
3640
- "module": "src/anchored-region/anchored-region.ts"
3265
+ "name": "FoundationElement",
3266
+ "module": "src/foundation-element/foundation-element.ts"
3641
3267
  }
3642
3268
  },
3643
3269
  {
3644
3270
  "kind": "field",
3645
- "name": "fixedPlacement",
3271
+ "name": "template",
3646
3272
  "type": {
3647
- "text": "boolean"
3273
+ "text": "ElementViewTemplate | void | null"
3648
3274
  },
3649
3275
  "privacy": "public",
3650
- "default": "false",
3651
- "description": "Whether the region is positioned using css \"position: fixed\".\nOtherwise the region uses \"position: absolute\".\nFixed placement allows the region to break out of parent containers,",
3276
+ "description": "Sets the template of the element instance. When undefined,\nthe element will attempt to resolve the template from\nthe associated presentation or custom element definition.",
3652
3277
  "inheritedFrom": {
3653
- "name": "AnchoredRegion",
3654
- "module": "src/anchored-region/anchored-region.ts"
3278
+ "name": "FoundationElement",
3279
+ "module": "src/foundation-element/foundation-element.ts"
3655
3280
  }
3656
3281
  },
3657
3282
  {
3658
3283
  "kind": "method",
3659
- "name": "fixedPlacementChanged",
3660
- "privacy": "private",
3284
+ "name": "templateChanged",
3285
+ "privacy": "protected",
3661
3286
  "return": {
3662
3287
  "type": {
3663
3288
  "text": "void"
3664
3289
  }
3665
3290
  },
3666
3291
  "inheritedFrom": {
3667
- "name": "AnchoredRegion",
3668
- "module": "src/anchored-region/anchored-region.ts"
3292
+ "name": "FoundationElement",
3293
+ "module": "src/foundation-element/foundation-element.ts"
3669
3294
  }
3670
3295
  },
3671
3296
  {
3672
3297
  "kind": "field",
3673
- "name": "autoUpdateMode",
3298
+ "name": "styles",
3674
3299
  "type": {
3675
- "text": "AutoUpdateMode"
3300
+ "text": "ElementStyles | void | null"
3676
3301
  },
3677
3302
  "privacy": "public",
3678
- "default": "\"anchor\"",
3679
- "description": "Defines what triggers the anchored region to revaluate positioning",
3303
+ "description": "Sets the default styles for the element instance. When undefined,\nthe element will attempt to resolve default styles from\nthe associated presentation or custom element definition.",
3680
3304
  "inheritedFrom": {
3681
- "name": "AnchoredRegion",
3682
- "module": "src/anchored-region/anchored-region.ts"
3305
+ "name": "FoundationElement",
3306
+ "module": "src/foundation-element/foundation-element.ts"
3683
3307
  }
3684
3308
  },
3685
3309
  {
3686
3310
  "kind": "method",
3687
- "name": "autoUpdateModeChanged",
3688
- "privacy": "private",
3311
+ "name": "stylesChanged",
3312
+ "privacy": "protected",
3689
3313
  "return": {
3690
3314
  "type": {
3691
3315
  "text": "void"
3692
3316
  }
3693
3317
  },
3318
+ "inheritedFrom": {
3319
+ "name": "FoundationElement",
3320
+ "module": "src/foundation-element/foundation-element.ts"
3321
+ }
3322
+ },
3323
+ {
3324
+ "kind": "method",
3325
+ "name": "compose",
3326
+ "privacy": "public",
3327
+ "static": true,
3328
+ "return": {
3329
+ "type": {
3330
+ "text": "(\n overrideDefinition?: OverrideFoundationElementDefinition<T>\n ) => FoundationElementRegistry<T, K>"
3331
+ }
3332
+ },
3694
3333
  "parameters": [
3695
3334
  {
3696
- "name": "prevMode",
3335
+ "name": "this",
3697
3336
  "type": {
3698
- "text": "AutoUpdateMode"
3337
+ "text": "K"
3699
3338
  }
3700
3339
  },
3701
3340
  {
3702
- "name": "newMode",
3341
+ "name": "elementDefinition",
3703
3342
  "type": {
3704
- "text": "AutoUpdateMode"
3705
- }
3343
+ "text": "T"
3344
+ },
3345
+ "description": "The definition of the element to create the registry\nfunction for."
3706
3346
  }
3707
3347
  ],
3348
+ "description": "Defines an element registry function with a set of element definition defaults.",
3708
3349
  "inheritedFrom": {
3709
- "name": "AnchoredRegion",
3710
- "module": "src/anchored-region/anchored-region.ts"
3350
+ "name": "FoundationElement",
3351
+ "module": "src/foundation-element/foundation-element.ts"
3711
3352
  }
3712
- },
3353
+ }
3354
+ ],
3355
+ "events": [
3713
3356
  {
3714
- "kind": "field",
3715
- "name": "anchorElement",
3716
- "type": {
3717
- "text": "HTMLElement | null"
3718
- },
3719
- "privacy": "public",
3720
- "default": "null",
3721
- "description": "The HTML element being used as the anchor",
3357
+ "description": "Fires a custom 'loaded' event when the region is loaded and visible",
3358
+ "name": "loaded",
3722
3359
  "inheritedFrom": {
3723
3360
  "name": "AnchoredRegion",
3724
3361
  "module": "src/anchored-region/anchored-region.ts"
3725
3362
  }
3726
3363
  },
3727
3364
  {
3728
- "kind": "method",
3729
- "name": "anchorElementChanged",
3730
- "privacy": "private",
3731
- "return": {
3732
- "type": {
3733
- "text": "void"
3734
- }
3735
- },
3365
+ "description": "Fires a custom 'positionchange' event when the position has changed",
3366
+ "name": "positionchange",
3736
3367
  "inheritedFrom": {
3737
3368
  "name": "AnchoredRegion",
3738
3369
  "module": "src/anchored-region/anchored-region.ts"
3739
3370
  }
3371
+ }
3372
+ ]
3373
+ },
3374
+ {
3375
+ "kind": "variable",
3376
+ "name": "foundationAnchoredRegionShadowOptions",
3377
+ "type": {
3378
+ "text": "ShadowRootInit"
3379
+ },
3380
+ "default": "{\n delegatesFocus: true,\n mode: 'open',\n}"
3381
+ },
3382
+ {
3383
+ "kind": "variable",
3384
+ "name": "defaultAnchoredRegionConfig",
3385
+ "type": {
3386
+ "text": "object"
3387
+ },
3388
+ "default": "{}"
3389
+ },
3390
+ {
3391
+ "kind": "variable",
3392
+ "name": "foundationAnchoredRegion",
3393
+ "description": "The Foundation Anchored Region",
3394
+ "privacy": "public"
3395
+ }
3396
+ ],
3397
+ "exports": [
3398
+ {
3399
+ "kind": "js",
3400
+ "name": "AnchoredRegion",
3401
+ "declaration": {
3402
+ "name": "AnchoredRegion",
3403
+ "module": "src/anchored-region/anchored-region.ts"
3404
+ }
3405
+ },
3406
+ {
3407
+ "kind": "js",
3408
+ "name": "foundationAnchoredRegionShadowOptions",
3409
+ "declaration": {
3410
+ "name": "foundationAnchoredRegionShadowOptions",
3411
+ "module": "src/anchored-region/anchored-region.ts"
3412
+ }
3413
+ },
3414
+ {
3415
+ "kind": "js",
3416
+ "name": "defaultAnchoredRegionConfig",
3417
+ "declaration": {
3418
+ "name": "defaultAnchoredRegionConfig",
3419
+ "module": "src/anchored-region/anchored-region.ts"
3420
+ }
3421
+ },
3422
+ {
3423
+ "kind": "js",
3424
+ "name": "foundationAnchoredRegion",
3425
+ "declaration": {
3426
+ "name": "foundationAnchoredRegion",
3427
+ "module": "src/anchored-region/anchored-region.ts"
3428
+ }
3429
+ }
3430
+ ]
3431
+ },
3432
+ {
3433
+ "kind": "javascript-module",
3434
+ "path": "src/anchored-region/index.ts",
3435
+ "declarations": [],
3436
+ "exports": [
3437
+ {
3438
+ "kind": "js",
3439
+ "name": "*",
3440
+ "declaration": {
3441
+ "name": "*",
3442
+ "package": "./anchor-region.template"
3443
+ }
3444
+ },
3445
+ {
3446
+ "kind": "js",
3447
+ "name": "*",
3448
+ "declaration": {
3449
+ "name": "*",
3450
+ "package": "./anchored-region.styles"
3451
+ }
3452
+ },
3453
+ {
3454
+ "kind": "js",
3455
+ "name": "*",
3456
+ "declaration": {
3457
+ "name": "*",
3458
+ "package": "./anchored-region"
3459
+ }
3460
+ }
3461
+ ]
3462
+ },
3463
+ {
3464
+ "kind": "javascript-module",
3465
+ "path": "src/anchor/anchor.styles.ts",
3466
+ "declarations": [
3467
+ {
3468
+ "kind": "function",
3469
+ "name": "foundationAnchorStyles",
3470
+ "return": {
3471
+ "type": {
3472
+ "text": "ElementStyles"
3473
+ }
3474
+ },
3475
+ "parameters": [
3476
+ {
3477
+ "name": "context",
3478
+ "type": {
3479
+ "text": "ElementDefinitionContext"
3480
+ }
3481
+ },
3482
+ {
3483
+ "name": "definition",
3484
+ "type": {
3485
+ "text": "FoundationElementDefinition"
3486
+ }
3487
+ }
3488
+ ]
3489
+ }
3490
+ ],
3491
+ "exports": [
3492
+ {
3493
+ "kind": "js",
3494
+ "name": "foundationAnchorStyles",
3495
+ "declaration": {
3496
+ "name": "foundationAnchorStyles",
3497
+ "module": "src/anchor/anchor.styles.ts"
3498
+ }
3499
+ }
3500
+ ]
3501
+ },
3502
+ {
3503
+ "kind": "javascript-module",
3504
+ "path": "src/anchor/anchor.template.ts",
3505
+ "declarations": [
3506
+ {
3507
+ "kind": "function",
3508
+ "name": "foundationAnchorTemplate",
3509
+ "return": {
3510
+ "type": {
3511
+ "text": "ViewTemplate<Anchor>"
3512
+ }
3513
+ },
3514
+ "parameters": [
3515
+ {
3516
+ "name": "context",
3517
+ "type": {
3518
+ "text": "ElementDefinitionContext"
3519
+ }
3740
3520
  },
3741
3521
  {
3742
- "kind": "field",
3743
- "name": "viewportElement",
3522
+ "name": "definition",
3523
+ "type": {
3524
+ "text": "FoundationElementDefinition"
3525
+ }
3526
+ }
3527
+ ]
3528
+ }
3529
+ ],
3530
+ "exports": [
3531
+ {
3532
+ "kind": "js",
3533
+ "name": "foundationAnchorTemplate",
3534
+ "declaration": {
3535
+ "name": "foundationAnchorTemplate",
3536
+ "module": "src/anchor/anchor.template.ts"
3537
+ }
3538
+ }
3539
+ ]
3540
+ },
3541
+ {
3542
+ "kind": "javascript-module",
3543
+ "path": "src/anchor/anchor.ts",
3544
+ "declarations": [
3545
+ {
3546
+ "kind": "class",
3547
+ "description": "",
3548
+ "name": "Anchor",
3549
+ "superclass": {
3550
+ "name": "FASTAnchor",
3551
+ "package": "@microsoft/fast-components"
3552
+ },
3553
+ "tagName": "%%prefix%%-anchor",
3554
+ "customElement": true,
3555
+ "attributes": [
3556
+ {
3557
+ "name": "download",
3744
3558
  "type": {
3745
- "text": "HTMLElement | null"
3746
- },
3747
- "privacy": "public",
3748
- "default": "null",
3749
- "description": "The HTML element being used as the viewport",
3750
- "inheritedFrom": {
3751
- "name": "AnchoredRegion",
3752
- "module": "src/anchored-region/anchored-region.ts"
3753
- }
3754
- },
3755
- {
3756
- "kind": "method",
3757
- "name": "viewportElementChanged",
3758
- "privacy": "private",
3759
- "return": {
3760
- "type": {
3761
- "text": "void"
3762
- }
3559
+ "text": "string"
3763
3560
  },
3561
+ "description": "Prompts the user to save the linked URL. See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a | <a> element for more information.",
3562
+ "fieldName": "download",
3764
3563
  "inheritedFrom": {
3765
- "name": "AnchoredRegion",
3766
- "module": "src/anchored-region/anchored-region.ts"
3564
+ "name": "Anchor",
3565
+ "module": "src/anchor/anchor.ts"
3767
3566
  }
3768
3567
  },
3769
3568
  {
3770
- "kind": "field",
3771
- "name": "verticalPosition",
3569
+ "name": "href",
3772
3570
  "type": {
3773
- "text": "AnchoredRegionPositionLabel | undefined"
3571
+ "text": "string"
3774
3572
  },
3775
- "privacy": "public",
3776
- "description": "indicates the current horizontal position of the region",
3573
+ "description": "The URL the hyperlink references. See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a | <a> element for more information.",
3574
+ "fieldName": "href",
3777
3575
  "inheritedFrom": {
3778
- "name": "AnchoredRegion",
3779
- "module": "src/anchored-region/anchored-region.ts"
3576
+ "name": "Anchor",
3577
+ "module": "src/anchor/anchor.ts"
3780
3578
  }
3781
3579
  },
3782
3580
  {
3783
- "kind": "field",
3784
- "name": "horizontalPosition",
3581
+ "name": "hreflang",
3785
3582
  "type": {
3786
- "text": "AnchoredRegionPositionLabel | undefined"
3583
+ "text": "string"
3787
3584
  },
3788
- "privacy": "public",
3789
- "description": "indicates the current vertical position of the region",
3585
+ "description": "Hints at the language of the referenced resource. See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a | <a> element for more information.",
3586
+ "fieldName": "hreflang",
3790
3587
  "inheritedFrom": {
3791
- "name": "AnchoredRegion",
3792
- "module": "src/anchored-region/anchored-region.ts"
3588
+ "name": "Anchor",
3589
+ "module": "src/anchor/anchor.ts"
3793
3590
  }
3794
3591
  },
3795
3592
  {
3796
- "kind": "field",
3797
- "name": "translateX",
3593
+ "name": "ping",
3798
3594
  "type": {
3799
- "text": "number"
3595
+ "text": "string"
3800
3596
  },
3801
- "privacy": "private",
3802
- "description": "values to be applied to the component's transform on render",
3597
+ "description": "See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a | <a> element for more information.",
3598
+ "fieldName": "ping",
3803
3599
  "inheritedFrom": {
3804
- "name": "AnchoredRegion",
3805
- "module": "src/anchored-region/anchored-region.ts"
3600
+ "name": "Anchor",
3601
+ "module": "src/anchor/anchor.ts"
3806
3602
  }
3807
3603
  },
3808
3604
  {
3809
- "kind": "field",
3810
- "name": "translateY",
3605
+ "name": "referrerpolicy",
3811
3606
  "type": {
3812
- "text": "number"
3607
+ "text": "string"
3813
3608
  },
3814
- "privacy": "private",
3609
+ "description": "See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a | <a> element for more information.",
3610
+ "fieldName": "referrerpolicy",
3815
3611
  "inheritedFrom": {
3816
- "name": "AnchoredRegion",
3817
- "module": "src/anchored-region/anchored-region.ts"
3612
+ "name": "Anchor",
3613
+ "module": "src/anchor/anchor.ts"
3818
3614
  }
3819
3615
  },
3820
3616
  {
3821
- "kind": "field",
3822
- "name": "regionWidth",
3617
+ "name": "rel",
3823
3618
  "type": {
3824
3619
  "text": "string"
3825
3620
  },
3826
- "privacy": "private",
3827
- "description": "the span to be applied to the region on each axis",
3621
+ "description": "See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a | <a> element for more information.",
3622
+ "fieldName": "rel",
3828
3623
  "inheritedFrom": {
3829
- "name": "AnchoredRegion",
3830
- "module": "src/anchored-region/anchored-region.ts"
3624
+ "name": "Anchor",
3625
+ "module": "src/anchor/anchor.ts"
3831
3626
  }
3832
3627
  },
3833
3628
  {
3834
- "kind": "field",
3835
- "name": "regionHeight",
3629
+ "name": "target",
3836
3630
  "type": {
3837
- "text": "string"
3631
+ "text": "\"_self\" | \"_blank\" | \"_parent\" | \"_top\""
3838
3632
  },
3839
- "privacy": "private",
3633
+ "description": "See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a | <a> element for more information.",
3634
+ "fieldName": "target",
3840
3635
  "inheritedFrom": {
3841
- "name": "AnchoredRegion",
3842
- "module": "src/anchored-region/anchored-region.ts"
3636
+ "name": "Anchor",
3637
+ "module": "src/anchor/anchor.ts"
3843
3638
  }
3844
3639
  },
3845
3640
  {
3846
- "kind": "field",
3847
- "name": "resizeDetector",
3641
+ "name": "type",
3848
3642
  "type": {
3849
- "text": "ResizeObserverClassDefinition | null"
3643
+ "text": "string"
3850
3644
  },
3851
- "privacy": "private",
3852
- "default": "null",
3645
+ "description": "See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a | <a> element for more information.",
3646
+ "fieldName": "type",
3853
3647
  "inheritedFrom": {
3854
- "name": "AnchoredRegion",
3855
- "module": "src/anchored-region/anchored-region.ts"
3648
+ "name": "Anchor",
3649
+ "module": "src/anchor/anchor.ts"
3856
3650
  }
3857
- },
3651
+ }
3652
+ ],
3653
+ "members": [
3858
3654
  {
3859
3655
  "kind": "field",
3860
- "name": "viewportRect",
3656
+ "name": "download",
3861
3657
  "type": {
3862
- "text": "ClientRect | DOMRect | undefined"
3658
+ "text": "string"
3863
3659
  },
3864
- "privacy": "private",
3660
+ "privacy": "public",
3661
+ "description": "Prompts the user to save the linked URL. See {@link https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a | <a> element } for more information.",
3865
3662
  "inheritedFrom": {
3866
- "name": "AnchoredRegion",
3867
- "module": "src/anchored-region/anchored-region.ts"
3663
+ "name": "Anchor",
3664
+ "module": "src/anchor/anchor.ts"
3868
3665
  }
3869
3666
  },
3870
3667
  {
3871
3668
  "kind": "field",
3872
- "name": "anchorRect",
3669
+ "name": "href",
3873
3670
  "type": {
3874
- "text": "ClientRect | DOMRect | undefined"
3671
+ "text": "string"
3875
3672
  },
3876
- "privacy": "private",
3673
+ "privacy": "public",
3674
+ "description": "The URL the hyperlink references. See {@link https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a | <a> element } for more information.",
3877
3675
  "inheritedFrom": {
3878
- "name": "AnchoredRegion",
3879
- "module": "src/anchored-region/anchored-region.ts"
3676
+ "name": "Anchor",
3677
+ "module": "src/anchor/anchor.ts"
3880
3678
  }
3881
3679
  },
3882
3680
  {
3883
3681
  "kind": "field",
3884
- "name": "regionRect",
3682
+ "name": "hreflang",
3885
3683
  "type": {
3886
- "text": "ClientRect | DOMRect | undefined"
3684
+ "text": "string"
3887
3685
  },
3888
- "privacy": "private",
3686
+ "privacy": "public",
3687
+ "description": "Hints at the language of the referenced resource. See {@link https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a | <a> element } for more information.",
3889
3688
  "inheritedFrom": {
3890
- "name": "AnchoredRegion",
3891
- "module": "src/anchored-region/anchored-region.ts"
3689
+ "name": "Anchor",
3690
+ "module": "src/anchor/anchor.ts"
3892
3691
  }
3893
3692
  },
3894
3693
  {
3895
3694
  "kind": "field",
3896
- "name": "baseHorizontalOffset",
3695
+ "name": "ping",
3897
3696
  "type": {
3898
- "text": "number"
3697
+ "text": "string"
3899
3698
  },
3900
- "privacy": "private",
3901
- "default": "0",
3902
- "description": "base offsets between the positioner's base position and the anchor's",
3699
+ "privacy": "public",
3700
+ "description": "See {@link https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a | <a> element } for more information.",
3903
3701
  "inheritedFrom": {
3904
- "name": "AnchoredRegion",
3905
- "module": "src/anchored-region/anchored-region.ts"
3702
+ "name": "Anchor",
3703
+ "module": "src/anchor/anchor.ts"
3906
3704
  }
3907
3705
  },
3908
3706
  {
3909
3707
  "kind": "field",
3910
- "name": "baseVerticalOffset",
3708
+ "name": "referrerpolicy",
3911
3709
  "type": {
3912
- "text": "number"
3710
+ "text": "string"
3913
3711
  },
3914
- "privacy": "private",
3915
- "default": "0",
3712
+ "privacy": "public",
3713
+ "description": "See {@link https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a | <a> element } for more information.",
3916
3714
  "inheritedFrom": {
3917
- "name": "AnchoredRegion",
3918
- "module": "src/anchored-region/anchored-region.ts"
3715
+ "name": "Anchor",
3716
+ "module": "src/anchor/anchor.ts"
3919
3717
  }
3920
3718
  },
3921
3719
  {
3922
3720
  "kind": "field",
3923
- "name": "pendingPositioningUpdate",
3721
+ "name": "rel",
3924
3722
  "type": {
3925
- "text": "boolean"
3723
+ "text": "string"
3926
3724
  },
3927
- "privacy": "private",
3928
- "default": "false",
3725
+ "privacy": "public",
3726
+ "description": "See {@link https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a | <a> element } for more information.",
3929
3727
  "inheritedFrom": {
3930
- "name": "AnchoredRegion",
3931
- "module": "src/anchored-region/anchored-region.ts"
3728
+ "name": "Anchor",
3729
+ "module": "src/anchor/anchor.ts"
3932
3730
  }
3933
3731
  },
3934
3732
  {
3935
3733
  "kind": "field",
3936
- "name": "pendingReset",
3734
+ "name": "target",
3937
3735
  "type": {
3938
- "text": "boolean"
3736
+ "text": "\"_self\" | \"_blank\" | \"_parent\" | \"_top\""
3939
3737
  },
3940
- "privacy": "private",
3941
- "default": "false",
3738
+ "privacy": "public",
3739
+ "description": "See {@link https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a | <a> element } for more information.",
3942
3740
  "inheritedFrom": {
3943
- "name": "AnchoredRegion",
3944
- "module": "src/anchored-region/anchored-region.ts"
3741
+ "name": "Anchor",
3742
+ "module": "src/anchor/anchor.ts"
3945
3743
  }
3946
3744
  },
3947
3745
  {
3948
3746
  "kind": "field",
3949
- "name": "currentDirection",
3747
+ "name": "type",
3950
3748
  "type": {
3951
- "text": "Direction"
3749
+ "text": "string"
3952
3750
  },
3953
- "privacy": "private",
3751
+ "privacy": "public",
3752
+ "description": "See {@link https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a | <a> element } for more information.",
3954
3753
  "inheritedFrom": {
3955
- "name": "AnchoredRegion",
3956
- "module": "src/anchored-region/anchored-region.ts"
3754
+ "name": "Anchor",
3755
+ "module": "src/anchor/anchor.ts"
3957
3756
  }
3958
3757
  },
3959
3758
  {
3960
3759
  "kind": "field",
3961
- "name": "regionVisible",
3760
+ "name": "control",
3962
3761
  "type": {
3963
- "text": "boolean"
3762
+ "text": "HTMLAnchorElement | undefined"
3964
3763
  },
3965
- "privacy": "private",
3966
- "default": "false",
3764
+ "privacy": "public",
3765
+ "description": "References the root element",
3967
3766
  "inheritedFrom": {
3968
- "name": "AnchoredRegion",
3969
- "module": "src/anchored-region/anchored-region.ts"
3767
+ "name": "Anchor",
3768
+ "module": "src/anchor/anchor.ts"
3970
3769
  }
3971
3770
  },
3972
3771
  {
3973
3772
  "kind": "field",
3974
- "name": "forceUpdate",
3975
- "type": {
3976
- "text": "boolean"
3977
- },
3773
+ "name": "handleUnsupportedDelegatesFocus",
3978
3774
  "privacy": "private",
3979
- "default": "false",
3775
+ "description": "Overrides the focus call for where delegatesFocus is unsupported.\nThis check works for Chrome, Edge Chromium, FireFox, and Safari\nRelevant PR on the Firefox browser: https://phabricator.services.mozilla.com/D123858",
3980
3776
  "inheritedFrom": {
3981
- "name": "AnchoredRegion",
3982
- "module": "src/anchored-region/anchored-region.ts"
3777
+ "name": "Anchor",
3778
+ "module": "src/anchor/anchor.ts"
3983
3779
  }
3984
3780
  },
3985
3781
  {
3986
3782
  "kind": "field",
3987
- "name": "updateThreshold",
3783
+ "name": "_presentation",
3988
3784
  "type": {
3989
- "text": "number"
3785
+ "text": "ComponentPresentation | null | undefined"
3990
3786
  },
3991
3787
  "privacy": "private",
3992
- "default": "0.5",
3788
+ "default": "void 0",
3993
3789
  "inheritedFrom": {
3994
- "name": "AnchoredRegion",
3995
- "module": "src/anchored-region/anchored-region.ts"
3790
+ "name": "FoundationElement",
3791
+ "module": "src/foundation-element/foundation-element.ts"
3996
3792
  }
3997
3793
  },
3998
3794
  {
3999
3795
  "kind": "field",
4000
- "name": "intersectionService",
3796
+ "name": "$presentation",
4001
3797
  "type": {
4002
- "text": "IntersectionService"
3798
+ "text": "ComponentPresentation | null"
4003
3799
  },
4004
- "privacy": "private",
4005
- "static": true,
4006
- "default": "new IntersectionService()",
3800
+ "privacy": "public",
3801
+ "description": "A property which resolves the ComponentPresentation instance\nfor the current component.",
4007
3802
  "inheritedFrom": {
4008
- "name": "AnchoredRegion",
4009
- "module": "src/anchored-region/anchored-region.ts"
3803
+ "name": "FoundationElement",
3804
+ "module": "src/foundation-element/foundation-element.ts"
4010
3805
  }
4011
3806
  },
4012
3807
  {
4013
3808
  "kind": "field",
4014
- "name": "update",
3809
+ "name": "template",
3810
+ "type": {
3811
+ "text": "ElementViewTemplate | void | null"
3812
+ },
4015
3813
  "privacy": "public",
4016
- "description": "update position",
3814
+ "description": "Sets the template of the element instance. When undefined,\nthe element will attempt to resolve the template from\nthe associated presentation or custom element definition.",
4017
3815
  "inheritedFrom": {
4018
- "name": "AnchoredRegion",
4019
- "module": "src/anchored-region/anchored-region.ts"
3816
+ "name": "FoundationElement",
3817
+ "module": "src/foundation-element/foundation-element.ts"
4020
3818
  }
4021
3819
  },
4022
3820
  {
4023
3821
  "kind": "method",
4024
- "name": "disconnectResizeDetector",
4025
- "privacy": "private",
3822
+ "name": "templateChanged",
3823
+ "privacy": "protected",
4026
3824
  "return": {
4027
3825
  "type": {
4028
3826
  "text": "void"
4029
3827
  }
4030
3828
  },
4031
- "description": "destroys the instance's resize observer",
4032
3829
  "inheritedFrom": {
4033
- "name": "AnchoredRegion",
4034
- "module": "src/anchored-region/anchored-region.ts"
3830
+ "name": "FoundationElement",
3831
+ "module": "src/foundation-element/foundation-element.ts"
4035
3832
  }
4036
3833
  },
4037
3834
  {
4038
- "kind": "method",
4039
- "name": "initializeResizeDetector",
4040
- "privacy": "private",
4041
- "return": {
4042
- "type": {
4043
- "text": "void"
4044
- }
3835
+ "kind": "field",
3836
+ "name": "styles",
3837
+ "type": {
3838
+ "text": "ElementStyles | void | null"
4045
3839
  },
4046
- "description": "initializes the instance's resize observer",
3840
+ "privacy": "public",
3841
+ "description": "Sets the default styles for the element instance. When undefined,\nthe element will attempt to resolve default styles from\nthe associated presentation or custom element definition.",
4047
3842
  "inheritedFrom": {
4048
- "name": "AnchoredRegion",
4049
- "module": "src/anchored-region/anchored-region.ts"
3843
+ "name": "FoundationElement",
3844
+ "module": "src/foundation-element/foundation-element.ts"
4050
3845
  }
4051
3846
  },
4052
3847
  {
4053
3848
  "kind": "method",
4054
- "name": "updateForAttributeChange",
4055
- "privacy": "private",
3849
+ "name": "stylesChanged",
3850
+ "privacy": "protected",
4056
3851
  "return": {
4057
3852
  "type": {
4058
3853
  "text": "void"
4059
3854
  }
4060
3855
  },
4061
- "description": "react to attribute changes that don't require a reset",
4062
3856
  "inheritedFrom": {
4063
- "name": "AnchoredRegion",
4064
- "module": "src/anchored-region/anchored-region.ts"
3857
+ "name": "FoundationElement",
3858
+ "module": "src/foundation-element/foundation-element.ts"
4065
3859
  }
4066
3860
  },
4067
3861
  {
4068
3862
  "kind": "method",
4069
- "name": "initialize",
4070
- "privacy": "private",
3863
+ "name": "compose",
3864
+ "privacy": "public",
3865
+ "static": true,
4071
3866
  "return": {
4072
3867
  "type": {
4073
- "text": "void"
3868
+ "text": "(\n overrideDefinition?: OverrideFoundationElementDefinition<T>\n ) => FoundationElementRegistry<T, K>"
4074
3869
  }
4075
3870
  },
4076
- "description": "fully initializes the component",
3871
+ "parameters": [
3872
+ {
3873
+ "name": "this",
3874
+ "type": {
3875
+ "text": "K"
3876
+ }
3877
+ },
3878
+ {
3879
+ "name": "elementDefinition",
3880
+ "type": {
3881
+ "text": "T"
3882
+ },
3883
+ "description": "The definition of the element to create the registry\nfunction for."
3884
+ }
3885
+ ],
3886
+ "description": "Defines an element registry function with a set of element definition defaults.",
4077
3887
  "inheritedFrom": {
4078
- "name": "AnchoredRegion",
4079
- "module": "src/anchored-region/anchored-region.ts"
3888
+ "name": "FoundationElement",
3889
+ "module": "src/foundation-element/foundation-element.ts"
3890
+ }
3891
+ }
3892
+ ]
3893
+ },
3894
+ {
3895
+ "kind": "variable",
3896
+ "name": "foundationAnchorShadowOptions",
3897
+ "type": {
3898
+ "text": "ShadowRootInit"
3899
+ },
3900
+ "default": "{\n delegatesFocus: true,\n mode: 'open',\n}"
3901
+ },
3902
+ {
3903
+ "kind": "variable",
3904
+ "name": "defaultAnchorConfig",
3905
+ "type": {
3906
+ "text": "object"
3907
+ },
3908
+ "default": "{}"
3909
+ },
3910
+ {
3911
+ "kind": "variable",
3912
+ "name": "foundationAnchor",
3913
+ "description": "The Foundation Anchor",
3914
+ "privacy": "public"
3915
+ }
3916
+ ],
3917
+ "exports": [
3918
+ {
3919
+ "kind": "js",
3920
+ "name": "Anchor",
3921
+ "declaration": {
3922
+ "name": "Anchor",
3923
+ "module": "src/anchor/anchor.ts"
3924
+ }
3925
+ },
3926
+ {
3927
+ "kind": "js",
3928
+ "name": "foundationAnchorShadowOptions",
3929
+ "declaration": {
3930
+ "name": "foundationAnchorShadowOptions",
3931
+ "module": "src/anchor/anchor.ts"
3932
+ }
3933
+ },
3934
+ {
3935
+ "kind": "js",
3936
+ "name": "defaultAnchorConfig",
3937
+ "declaration": {
3938
+ "name": "defaultAnchorConfig",
3939
+ "module": "src/anchor/anchor.ts"
3940
+ }
3941
+ },
3942
+ {
3943
+ "kind": "js",
3944
+ "name": "foundationAnchor",
3945
+ "declaration": {
3946
+ "name": "foundationAnchor",
3947
+ "module": "src/anchor/anchor.ts"
3948
+ }
3949
+ }
3950
+ ]
3951
+ },
3952
+ {
3953
+ "kind": "javascript-module",
3954
+ "path": "src/anchor/index.ts",
3955
+ "declarations": [],
3956
+ "exports": [
3957
+ {
3958
+ "kind": "js",
3959
+ "name": "*",
3960
+ "declaration": {
3961
+ "name": "*",
3962
+ "package": "./anchor.template"
3963
+ }
3964
+ },
3965
+ {
3966
+ "kind": "js",
3967
+ "name": "*",
3968
+ "declaration": {
3969
+ "name": "*",
3970
+ "package": "./anchor.styles"
3971
+ }
3972
+ },
3973
+ {
3974
+ "kind": "js",
3975
+ "name": "*",
3976
+ "declaration": {
3977
+ "name": "*",
3978
+ "package": "./anchor"
3979
+ }
3980
+ }
3981
+ ]
3982
+ },
3983
+ {
3984
+ "kind": "javascript-module",
3985
+ "path": "src/actions-menu/actions-menu.styles.ts",
3986
+ "declarations": [
3987
+ {
3988
+ "kind": "function",
3989
+ "name": "actionsMenuBaseStyles",
3990
+ "return": {
3991
+ "type": {
3992
+ "text": "ElementStyles"
3993
+ }
3994
+ },
3995
+ "parameters": [
3996
+ {
3997
+ "name": "context",
3998
+ "type": {
3999
+ "text": "ElementDefinitionContext"
4080
4000
  }
4081
4001
  },
4082
4002
  {
4083
- "kind": "method",
4084
- "name": "requestReset",
4085
- "privacy": "private",
4086
- "return": {
4087
- "type": {
4088
- "text": "void"
4089
- }
4090
- },
4091
- "description": "Request a reset if there are currently no open requests",
4092
- "inheritedFrom": {
4093
- "name": "AnchoredRegion",
4094
- "module": "src/anchored-region/anchored-region.ts"
4003
+ "name": "definition",
4004
+ "type": {
4005
+ "text": "FoundationElementDefinition"
4006
+ }
4007
+ }
4008
+ ]
4009
+ },
4010
+ {
4011
+ "kind": "function",
4012
+ "name": "foundationActionsMenuStyles",
4013
+ "return": {
4014
+ "type": {
4015
+ "text": "ElementStyles"
4016
+ }
4017
+ },
4018
+ "parameters": [
4019
+ {
4020
+ "name": "context",
4021
+ "type": {
4022
+ "text": "ElementDefinitionContext"
4095
4023
  }
4096
4024
  },
4097
4025
  {
4098
- "kind": "method",
4099
- "name": "setInitialState",
4100
- "privacy": "private",
4101
- "return": {
4102
- "type": {
4103
- "text": "void"
4104
- }
4105
- },
4106
- "description": "sets the starting configuration for component internal values",
4107
- "inheritedFrom": {
4108
- "name": "AnchoredRegion",
4109
- "module": "src/anchored-region/anchored-region.ts"
4026
+ "name": "definition",
4027
+ "type": {
4028
+ "text": "FoundationElementDefinition"
4029
+ }
4030
+ }
4031
+ ]
4032
+ }
4033
+ ],
4034
+ "exports": [
4035
+ {
4036
+ "kind": "js",
4037
+ "name": "actionsMenuBaseStyles",
4038
+ "declaration": {
4039
+ "name": "actionsMenuBaseStyles",
4040
+ "module": "src/actions-menu/actions-menu.styles.ts"
4041
+ }
4042
+ },
4043
+ {
4044
+ "kind": "js",
4045
+ "name": "foundationActionsMenuStyles",
4046
+ "declaration": {
4047
+ "name": "foundationActionsMenuStyles",
4048
+ "module": "src/actions-menu/actions-menu.styles.ts"
4049
+ }
4050
+ }
4051
+ ]
4052
+ },
4053
+ {
4054
+ "kind": "javascript-module",
4055
+ "path": "src/actions-menu/actions-menu.template.ts",
4056
+ "declarations": [
4057
+ {
4058
+ "kind": "function",
4059
+ "name": "menuTemplate",
4060
+ "parameters": [
4061
+ {
4062
+ "name": "prefix",
4063
+ "type": {
4064
+ "text": "string"
4110
4065
  }
4111
- },
4066
+ }
4067
+ ]
4068
+ },
4069
+ {
4070
+ "kind": "function",
4071
+ "name": "singleOptionTemplate",
4072
+ "parameters": [
4112
4073
  {
4113
- "kind": "field",
4114
- "name": "startObservers",
4115
- "privacy": "private",
4116
- "description": "starts observers",
4117
- "inheritedFrom": {
4118
- "name": "AnchoredRegion",
4119
- "module": "src/anchored-region/anchored-region.ts"
4074
+ "name": "prefix",
4075
+ "type": {
4076
+ "text": "string"
4120
4077
  }
4121
- },
4078
+ }
4079
+ ]
4080
+ },
4081
+ {
4082
+ "kind": "variable",
4083
+ "name": "foundationActionsMenuTemplate",
4084
+ "type": {
4085
+ "text": "ViewTemplate<ActionsMenu>"
4086
+ },
4087
+ "default": "html`\n <div\n class=\"actions-container${(x) => (x.isVertical ? ' actions-vertical' : '')}\"\n part=\"actions-container\"\n >\n ${(x) => x.getTemplate(getPrefix(x))}\n </div>\n`"
4088
+ }
4089
+ ],
4090
+ "exports": [
4091
+ {
4092
+ "kind": "js",
4093
+ "name": "menuTemplate",
4094
+ "declaration": {
4095
+ "name": "menuTemplate",
4096
+ "module": "src/actions-menu/actions-menu.template.ts"
4097
+ }
4098
+ },
4099
+ {
4100
+ "kind": "js",
4101
+ "name": "singleOptionTemplate",
4102
+ "declaration": {
4103
+ "name": "singleOptionTemplate",
4104
+ "module": "src/actions-menu/actions-menu.template.ts"
4105
+ }
4106
+ },
4107
+ {
4108
+ "kind": "js",
4109
+ "name": "foundationActionsMenuTemplate",
4110
+ "declaration": {
4111
+ "name": "foundationActionsMenuTemplate",
4112
+ "module": "src/actions-menu/actions-menu.template.ts"
4113
+ }
4114
+ }
4115
+ ]
4116
+ },
4117
+ {
4118
+ "kind": "javascript-module",
4119
+ "path": "src/actions-menu/actions-menu.ts",
4120
+ "declarations": [
4121
+ {
4122
+ "kind": "class",
4123
+ "description": "",
4124
+ "name": "ActionsMenu",
4125
+ "members": [
4122
4126
  {
4123
4127
  "kind": "field",
4124
- "name": "requestPositionUpdates",
4125
- "privacy": "private",
4126
- "description": "get position updates",
4127
- "inheritedFrom": {
4128
- "name": "AnchoredRegion",
4129
- "module": "src/anchored-region/anchored-region.ts"
4128
+ "name": "actions",
4129
+ "type": {
4130
+ "text": "ActionMenuItem[]"
4130
4131
  }
4131
4132
  },
4132
4133
  {
4133
4134
  "kind": "field",
4134
- "name": "stopObservers",
4135
- "privacy": "private",
4136
- "description": "stops observers",
4137
- "inheritedFrom": {
4138
- "name": "AnchoredRegion",
4139
- "module": "src/anchored-region/anchored-region.ts"
4140
- }
4135
+ "name": "isVertical",
4136
+ "type": {
4137
+ "text": "boolean"
4138
+ },
4139
+ "default": "false"
4141
4140
  },
4142
4141
  {
4143
4142
  "kind": "field",
4144
- "name": "getViewport",
4145
- "privacy": "private",
4146
- "description": "Gets the viewport element by id, or defaults to document root",
4147
- "inheritedFrom": {
4148
- "name": "AnchoredRegion",
4149
- "module": "src/anchored-region/anchored-region.ts"
4150
- }
4143
+ "name": "addDefaultActions",
4144
+ "type": {
4145
+ "text": "boolean"
4146
+ },
4147
+ "default": "true"
4151
4148
  },
4152
4149
  {
4153
4150
  "kind": "field",
4154
- "name": "getAnchor",
4155
- "privacy": "private",
4156
- "description": "Gets the anchor element by id",
4157
- "inheritedFrom": {
4158
- "name": "AnchoredRegion",
4159
- "module": "src/anchored-region/anchored-region.ts"
4160
- }
4151
+ "name": "autoCloseOnAction",
4152
+ "type": {
4153
+ "text": "boolean"
4154
+ },
4155
+ "default": "true"
4161
4156
  },
4162
4157
  {
4163
4158
  "kind": "field",
4164
- "name": "handleIntersection",
4165
- "privacy": "private",
4166
- "description": "Handle intersections",
4167
- "inheritedFrom": {
4168
- "name": "AnchoredRegion",
4169
- "module": "src/anchored-region/anchored-region.ts"
4159
+ "name": "classNames",
4160
+ "type": {
4161
+ "text": "string"
4170
4162
  }
4171
4163
  },
4172
4164
  {
4173
4165
  "kind": "field",
4174
- "name": "applyIntersectionEntries",
4175
- "privacy": "private",
4176
- "description": "iterate through intersection entries and apply data",
4177
- "inheritedFrom": {
4178
- "name": "AnchoredRegion",
4179
- "module": "src/anchored-region/anchored-region.ts"
4166
+ "name": "definition",
4167
+ "type": {
4168
+ "text": "any"
4180
4169
  }
4181
4170
  },
4182
4171
  {
4183
4172
  "kind": "field",
4184
- "name": "updateRegionOffset",
4185
- "privacy": "private",
4186
- "description": "Update the offset values",
4187
- "inheritedFrom": {
4188
- "name": "AnchoredRegion",
4189
- "module": "src/anchored-region/anchored-region.ts"
4190
- }
4173
+ "name": "name",
4174
+ "type": {
4175
+ "text": "string"
4176
+ },
4177
+ "default": "'Actions'"
4191
4178
  },
4192
4179
  {
4193
4180
  "kind": "field",
4194
- "name": "isRectDifferent",
4195
- "privacy": "private",
4196
- "description": "compare rects to see if there is enough change to justify a DOM update",
4197
- "inheritedFrom": {
4198
- "name": "AnchoredRegion",
4199
- "module": "src/anchored-region/anchored-region.ts"
4200
- }
4181
+ "name": "open",
4182
+ "type": {
4183
+ "text": "boolean"
4184
+ },
4185
+ "default": "false"
4201
4186
  },
4202
4187
  {
4203
4188
  "kind": "field",
4204
- "name": "handleResize",
4205
- "privacy": "private",
4206
- "description": "Handle resize events",
4207
- "inheritedFrom": {
4208
- "name": "AnchoredRegion",
4209
- "module": "src/anchored-region/anchored-region.ts"
4189
+ "name": "buttonAppearance",
4190
+ "type": {
4191
+ "text": "string"
4210
4192
  }
4211
4193
  },
4212
4194
  {
4213
4195
  "kind": "field",
4214
- "name": "reset",
4215
- "privacy": "private",
4216
- "description": "resets the component",
4217
- "inheritedFrom": {
4218
- "name": "AnchoredRegion",
4219
- "module": "src/anchored-region/anchored-region.ts"
4220
- }
4196
+ "name": "hideDisabled",
4197
+ "type": {
4198
+ "text": "boolean"
4199
+ },
4200
+ "default": "false"
4221
4201
  },
4222
4202
  {
4223
4203
  "kind": "field",
4224
- "name": "updateLayout",
4225
- "privacy": "private",
4226
- "description": "Recalculate layout related state values",
4227
- "inheritedFrom": {
4228
- "name": "AnchoredRegion",
4229
- "module": "src/anchored-region/anchored-region.ts"
4230
- }
4204
+ "name": "hideMenuSingleOption",
4205
+ "type": {
4206
+ "text": "boolean"
4207
+ },
4208
+ "default": "false"
4231
4209
  },
4232
4210
  {
4233
4211
  "kind": "field",
4234
- "name": "updateRegionStyle",
4235
- "privacy": "private",
4236
- "description": "Updates the style string applied to the region element as well as the css classes attached\nto the root element",
4237
- "inheritedFrom": {
4238
- "name": "AnchoredRegion",
4239
- "module": "src/anchored-region/anchored-region.ts"
4212
+ "name": "singleOption",
4213
+ "type": {
4214
+ "text": "ActionMenuItem"
4240
4215
  }
4241
4216
  },
4242
4217
  {
4243
4218
  "kind": "field",
4244
- "name": "updatePositionClasses",
4245
- "privacy": "private",
4246
- "description": "Updates the css classes that reflect the current position of the element",
4247
- "inheritedFrom": {
4248
- "name": "AnchoredRegion",
4249
- "module": "src/anchored-region/anchored-region.ts"
4219
+ "name": "actionsMenu",
4220
+ "type": {
4221
+ "text": "HTMLElement"
4250
4222
  }
4251
4223
  },
4252
4224
  {
4253
- "kind": "field",
4254
- "name": "setHorizontalPosition",
4255
- "privacy": "private",
4256
- "description": "Get horizontal positioning state based on desired position",
4257
- "inheritedFrom": {
4258
- "name": "AnchoredRegion",
4259
- "module": "src/anchored-region/anchored-region.ts"
4260
- }
4225
+ "kind": "method",
4226
+ "name": "definitionChanged",
4227
+ "privacy": "protected",
4228
+ "parameters": [
4229
+ {
4230
+ "name": "oldValue",
4231
+ "type": {
4232
+ "text": "any"
4233
+ }
4234
+ },
4235
+ {
4236
+ "name": "newValue",
4237
+ "type": {
4238
+ "text": "any"
4239
+ }
4240
+ }
4241
+ ]
4242
+ },
4243
+ {
4244
+ "kind": "method",
4245
+ "name": "openChanged",
4246
+ "privacy": "protected"
4261
4247
  },
4262
4248
  {
4263
- "kind": "field",
4264
- "name": "setVerticalPosition",
4265
- "privacy": "private",
4266
- "description": "Set vertical positioning state based on desired position",
4267
- "inheritedFrom": {
4268
- "name": "AnchoredRegion",
4269
- "module": "src/anchored-region/anchored-region.ts"
4270
- }
4249
+ "kind": "method",
4250
+ "name": "toggleActionsMenuVisibility"
4271
4251
  },
4272
4252
  {
4273
- "kind": "field",
4274
- "name": "getPositioningOptions",
4275
- "privacy": "private",
4276
- "description": "Get available positions based on positioning mode",
4277
- "inheritedFrom": {
4278
- "name": "AnchoredRegion",
4279
- "module": "src/anchored-region/anchored-region.ts"
4280
- }
4253
+ "kind": "method",
4254
+ "name": "onActionMenuItemClick",
4255
+ "parameters": [
4256
+ {
4257
+ "name": "callback",
4258
+ "type": {
4259
+ "text": "(rowData) => void | any"
4260
+ }
4261
+ }
4262
+ ]
4281
4263
  },
4282
4264
  {
4283
4265
  "kind": "field",
4284
- "name": "getAvailableSpace",
4285
- "privacy": "private",
4286
- "description": "Get the space available for a particular relative position",
4287
- "inheritedFrom": {
4288
- "name": "AnchoredRegion",
4289
- "module": "src/anchored-region/anchored-region.ts"
4290
- }
4266
+ "name": "allActions",
4267
+ "type": {
4268
+ "text": "ActionMenuItem[]"
4269
+ },
4270
+ "readonly": true
4291
4271
  },
4292
4272
  {
4293
4273
  "kind": "field",
4294
- "name": "getNextRegionDimension",
4295
- "privacy": "private",
4296
- "description": "Get region dimensions",
4297
- "inheritedFrom": {
4298
- "name": "AnchoredRegion",
4299
- "module": "src/anchored-region/anchored-region.ts"
4300
- }
4274
+ "name": "rowData",
4275
+ "readonly": true
4301
4276
  },
4302
4277
  {
4303
- "kind": "field",
4304
- "name": "startAutoUpdateEventListeners",
4305
- "privacy": "private",
4306
- "description": "starts event listeners that can trigger auto updating",
4307
- "inheritedFrom": {
4308
- "name": "AnchoredRegion",
4309
- "module": "src/anchored-region/anchored-region.ts"
4310
- }
4278
+ "kind": "method",
4279
+ "name": "getLabel",
4280
+ "parameters": [
4281
+ {
4282
+ "name": "name",
4283
+ "type": {
4284
+ "text": "string | ((rowData: any) => string)"
4285
+ }
4286
+ }
4287
+ ]
4311
4288
  },
4312
4289
  {
4313
- "kind": "field",
4314
- "name": "stopAutoUpdateEventListeners",
4315
- "privacy": "private",
4316
- "description": "stops event listeners that can trigger auto updating",
4317
- "inheritedFrom": {
4318
- "name": "AnchoredRegion",
4319
- "module": "src/anchored-region/anchored-region.ts"
4320
- }
4290
+ "kind": "method",
4291
+ "name": "getTemplate",
4292
+ "parameters": [
4293
+ {
4294
+ "name": "prefix",
4295
+ "type": {
4296
+ "text": "string"
4297
+ }
4298
+ }
4299
+ ]
4321
4300
  },
4322
4301
  {
4323
4302
  "kind": "field",
@@ -4431,86 +4410,107 @@
4431
4410
  }
4432
4411
  }
4433
4412
  ],
4434
- "events": [
4413
+ "attributes": [
4435
4414
  {
4436
- "description": "Fires a custom 'loaded' event when the region is loaded and visible",
4437
- "name": "loaded",
4438
- "inheritedFrom": {
4439
- "name": "AnchoredRegion",
4440
- "module": "src/anchored-region/anchored-region.ts"
4441
- }
4415
+ "name": "is-vertical",
4416
+ "type": {
4417
+ "text": "boolean"
4418
+ },
4419
+ "default": "false",
4420
+ "fieldName": "isVertical"
4442
4421
  },
4443
4422
  {
4444
- "description": "Fires a custom 'positionchange' event when the position has changed",
4445
- "name": "positionchange",
4446
- "inheritedFrom": {
4447
- "name": "AnchoredRegion",
4448
- "module": "src/anchored-region/anchored-region.ts"
4449
- }
4423
+ "name": "add-default-actions",
4424
+ "type": {
4425
+ "text": "boolean"
4426
+ },
4427
+ "default": "true",
4428
+ "fieldName": "addDefaultActions"
4429
+ },
4430
+ {
4431
+ "name": "auto-close-on-action",
4432
+ "type": {
4433
+ "text": "boolean"
4434
+ },
4435
+ "default": "true",
4436
+ "fieldName": "autoCloseOnAction"
4437
+ },
4438
+ {
4439
+ "name": "name",
4440
+ "type": {
4441
+ "text": "string"
4442
+ },
4443
+ "default": "'Actions'",
4444
+ "fieldName": "name"
4445
+ },
4446
+ {
4447
+ "name": "open",
4448
+ "type": {
4449
+ "text": "boolean"
4450
+ },
4451
+ "default": "false",
4452
+ "fieldName": "open"
4453
+ },
4454
+ {
4455
+ "name": "buttonAppearance",
4456
+ "type": {
4457
+ "text": "string"
4458
+ },
4459
+ "fieldName": "buttonAppearance"
4460
+ },
4461
+ {
4462
+ "name": "hide-disabled",
4463
+ "type": {
4464
+ "text": "boolean"
4465
+ },
4466
+ "default": "false",
4467
+ "fieldName": "hideDisabled"
4468
+ },
4469
+ {
4470
+ "name": "hide-menu-single-option",
4471
+ "type": {
4472
+ "text": "boolean"
4473
+ },
4474
+ "default": "false",
4475
+ "fieldName": "hideMenuSingleOption"
4450
4476
  }
4451
- ]
4452
- },
4453
- {
4454
- "kind": "variable",
4455
- "name": "foundationAnchoredRegionShadowOptions",
4456
- "type": {
4457
- "text": "ShadowRootInit"
4458
- },
4459
- "default": "{\n delegatesFocus: true,\n mode: 'open',\n}"
4460
- },
4461
- {
4462
- "kind": "variable",
4463
- "name": "defaultAnchoredRegionConfig",
4464
- "type": {
4465
- "text": "object"
4477
+ ],
4478
+ "superclass": {
4479
+ "name": "FoundationElement",
4480
+ "package": "@microsoft/fast-foundation"
4466
4481
  },
4467
- "default": "{}"
4482
+ "tagName": "%%prefix%%-actions-menu",
4483
+ "customElement": true
4468
4484
  },
4469
4485
  {
4470
4486
  "kind": "variable",
4471
- "name": "foundationAnchoredRegion",
4472
- "description": "The Foundation Anchored Region",
4487
+ "name": "foundationActionsMenu",
4488
+ "description": "The Foundation Actions Menu",
4473
4489
  "privacy": "public"
4474
4490
  }
4475
4491
  ],
4476
4492
  "exports": [
4477
4493
  {
4478
4494
  "kind": "js",
4479
- "name": "AnchoredRegion",
4480
- "declaration": {
4481
- "name": "AnchoredRegion",
4482
- "module": "src/anchored-region/anchored-region.ts"
4483
- }
4484
- },
4485
- {
4486
- "kind": "js",
4487
- "name": "foundationAnchoredRegionShadowOptions",
4488
- "declaration": {
4489
- "name": "foundationAnchoredRegionShadowOptions",
4490
- "module": "src/anchored-region/anchored-region.ts"
4491
- }
4492
- },
4493
- {
4494
- "kind": "js",
4495
- "name": "defaultAnchoredRegionConfig",
4495
+ "name": "ActionsMenu",
4496
4496
  "declaration": {
4497
- "name": "defaultAnchoredRegionConfig",
4498
- "module": "src/anchored-region/anchored-region.ts"
4497
+ "name": "ActionsMenu",
4498
+ "module": "src/actions-menu/actions-menu.ts"
4499
4499
  }
4500
4500
  },
4501
4501
  {
4502
4502
  "kind": "js",
4503
- "name": "foundationAnchoredRegion",
4503
+ "name": "foundationActionsMenu",
4504
4504
  "declaration": {
4505
- "name": "foundationAnchoredRegion",
4506
- "module": "src/anchored-region/anchored-region.ts"
4505
+ "name": "foundationActionsMenu",
4506
+ "module": "src/actions-menu/actions-menu.ts"
4507
4507
  }
4508
4508
  }
4509
4509
  ]
4510
4510
  },
4511
4511
  {
4512
4512
  "kind": "javascript-module",
4513
- "path": "src/anchored-region/index.ts",
4513
+ "path": "src/actions-menu/index.ts",
4514
4514
  "declarations": [],
4515
4515
  "exports": [
4516
4516
  {
@@ -4518,7 +4518,7 @@
4518
4518
  "name": "*",
4519
4519
  "declaration": {
4520
4520
  "name": "*",
4521
- "package": "./anchor-region.template"
4521
+ "package": "./actions-menu.styles"
4522
4522
  }
4523
4523
  },
4524
4524
  {
@@ -4526,7 +4526,7 @@
4526
4526
  "name": "*",
4527
4527
  "declaration": {
4528
4528
  "name": "*",
4529
- "package": "./anchored-region.styles"
4529
+ "package": "./actions-menu.template"
4530
4530
  }
4531
4531
  },
4532
4532
  {
@@ -4534,7 +4534,7 @@
4534
4534
  "name": "*",
4535
4535
  "declaration": {
4536
4536
  "name": "*",
4537
- "package": "./anchored-region"
4537
+ "package": "./actions-menu"
4538
4538
  }
4539
4539
  }
4540
4540
  ]
@@ -14370,6 +14370,40 @@
14370
14370
  }
14371
14371
  ]
14372
14372
  },
14373
+ {
14374
+ "kind": "function",
14375
+ "name": "applyCustomTokens",
14376
+ "return": {
14377
+ "type": {
14378
+ "text": "void"
14379
+ }
14380
+ },
14381
+ "parameters": [
14382
+ {
14383
+ "name": "provider",
14384
+ "type": {
14385
+ "text": "HTMLElement"
14386
+ },
14387
+ "description": "The HTML element to set CSS variables on"
14388
+ },
14389
+ {
14390
+ "name": "customTokens",
14391
+ "type": {
14392
+ "text": "CustomTokensConfig"
14393
+ },
14394
+ "description": "The custom tokens object to process"
14395
+ },
14396
+ {
14397
+ "name": "prefix",
14398
+ "default": "''",
14399
+ "type": {
14400
+ "text": "string"
14401
+ },
14402
+ "description": "Internal prefix for nested keys (used during recursion)"
14403
+ }
14404
+ ],
14405
+ "description": "Converts custom tokens to CSS custom properties and sets them on the provider element.\nSupports nested token groups which are flattened into kebab-case CSS variable names.\n\nExample:\n Input: { spacing: { padding: { small: { $value: \"8px\" } } } }\n Output: --spacing-padding-small: 8px"
14406
+ },
14373
14407
  {
14374
14408
  "kind": "function",
14375
14409
  "name": "getDefaultConfig",
@@ -14465,6 +14499,14 @@
14465
14499
  "module": "src/design-system-provider/design-system-provider.utils.ts"
14466
14500
  }
14467
14501
  },
14502
+ {
14503
+ "kind": "js",
14504
+ "name": "applyCustomTokens",
14505
+ "declaration": {
14506
+ "name": "applyCustomTokens",
14507
+ "module": "src/design-system-provider/design-system-provider.utils.ts"
14508
+ }
14509
+ },
14468
14510
  {
14469
14511
  "kind": "js",
14470
14512
  "name": "getDefaultConfig",