@genesislcap/foundation-ui 14.122.2-alpha-8195fd971b3.0 → 14.123.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/dist/custom-elements.json +1000 -1000
  2. package/package.json +10 -10
@@ -777,47 +777,6 @@
777
777
  }
778
778
  ]
779
779
  },
780
- {
781
- "kind": "javascript-module",
782
- "path": "src/_common/icons.ts",
783
- "declarations": [
784
- {
785
- "kind": "function",
786
- "name": "closeIcon",
787
- "parameters": [
788
- {
789
- "name": "slot",
790
- "default": "'start'"
791
- }
792
- ]
793
- }
794
- ],
795
- "exports": [
796
- {
797
- "kind": "js",
798
- "name": "closeIcon",
799
- "declaration": {
800
- "name": "closeIcon",
801
- "module": "src/_common/icons.ts"
802
- }
803
- }
804
- ]
805
- },
806
- {
807
- "kind": "javascript-module",
808
- "path": "src/_common/index.ts",
809
- "declarations": [],
810
- "exports": [
811
- {
812
- "kind": "js",
813
- "name": "*",
814
- "declaration": {
815
- "name": "*",
816
- "package": "./icons"
817
- }
818
- }
819
- ]
820
- },
821
780
  {
822
781
  "kind": "javascript-module",
823
782
  "path": "src/_config/index.ts",
@@ -1425,6 +1384,47 @@
1425
1384
  }
1426
1385
  ]
1427
1386
  },
1387
+ {
1388
+ "kind": "javascript-module",
1389
+ "path": "src/_common/icons.ts",
1390
+ "declarations": [
1391
+ {
1392
+ "kind": "function",
1393
+ "name": "closeIcon",
1394
+ "parameters": [
1395
+ {
1396
+ "name": "slot",
1397
+ "default": "'start'"
1398
+ }
1399
+ ]
1400
+ }
1401
+ ],
1402
+ "exports": [
1403
+ {
1404
+ "kind": "js",
1405
+ "name": "closeIcon",
1406
+ "declaration": {
1407
+ "name": "closeIcon",
1408
+ "module": "src/_common/icons.ts"
1409
+ }
1410
+ }
1411
+ ]
1412
+ },
1413
+ {
1414
+ "kind": "javascript-module",
1415
+ "path": "src/_common/index.ts",
1416
+ "declarations": [],
1417
+ "exports": [
1418
+ {
1419
+ "kind": "js",
1420
+ "name": "*",
1421
+ "declaration": {
1422
+ "name": "*",
1423
+ "package": "./icons"
1424
+ }
1425
+ }
1426
+ ]
1427
+ },
1428
1428
  {
1429
1429
  "kind": "javascript-module",
1430
1430
  "path": "src/actions-menu/actions-menu.styles.ts",
@@ -1986,14 +1986,14 @@
1986
1986
  },
1987
1987
  {
1988
1988
  "kind": "javascript-module",
1989
- "path": "src/anchored-region/anchor-region.template.ts",
1989
+ "path": "src/anchor/anchor.styles.ts",
1990
1990
  "declarations": [
1991
1991
  {
1992
1992
  "kind": "function",
1993
- "name": "foundationAnchoredRegionTemplate",
1993
+ "name": "foundationAnchorStyles",
1994
1994
  "return": {
1995
1995
  "type": {
1996
- "text": "ViewTemplate<AnchoredRegion>"
1996
+ "text": "ElementStyles"
1997
1997
  }
1998
1998
  },
1999
1999
  "parameters": [
@@ -2015,24 +2015,24 @@
2015
2015
  "exports": [
2016
2016
  {
2017
2017
  "kind": "js",
2018
- "name": "foundationAnchoredRegionTemplate",
2018
+ "name": "foundationAnchorStyles",
2019
2019
  "declaration": {
2020
- "name": "foundationAnchoredRegionTemplate",
2021
- "module": "src/anchored-region/anchor-region.template.ts"
2020
+ "name": "foundationAnchorStyles",
2021
+ "module": "src/anchor/anchor.styles.ts"
2022
2022
  }
2023
2023
  }
2024
2024
  ]
2025
2025
  },
2026
2026
  {
2027
2027
  "kind": "javascript-module",
2028
- "path": "src/anchored-region/anchored-region.styles.ts",
2028
+ "path": "src/anchor/anchor.template.ts",
2029
2029
  "declarations": [
2030
2030
  {
2031
2031
  "kind": "function",
2032
- "name": "foundationAnchoredRegionStyles",
2032
+ "name": "foundationAnchorTemplate",
2033
2033
  "return": {
2034
2034
  "type": {
2035
- "text": "ElementStyles"
2035
+ "text": "ViewTemplate<Anchor>"
2036
2036
  }
2037
2037
  },
2038
2038
  "parameters": [
@@ -2054,608 +2054,766 @@
2054
2054
  "exports": [
2055
2055
  {
2056
2056
  "kind": "js",
2057
- "name": "foundationAnchoredRegionStyles",
2057
+ "name": "foundationAnchorTemplate",
2058
2058
  "declaration": {
2059
- "name": "foundationAnchoredRegionStyles",
2060
- "module": "src/anchored-region/anchored-region.styles.ts"
2059
+ "name": "foundationAnchorTemplate",
2060
+ "module": "src/anchor/anchor.template.ts"
2061
2061
  }
2062
2062
  }
2063
2063
  ]
2064
2064
  },
2065
2065
  {
2066
2066
  "kind": "javascript-module",
2067
- "path": "src/anchored-region/anchored-region.ts",
2067
+ "path": "src/anchor/anchor.ts",
2068
2068
  "declarations": [
2069
2069
  {
2070
2070
  "kind": "class",
2071
2071
  "description": "",
2072
- "name": "AnchoredRegion",
2072
+ "name": "Anchor",
2073
2073
  "superclass": {
2074
- "name": "FASTAnchoredRegion",
2074
+ "name": "FASTAnchor",
2075
2075
  "package": "@microsoft/fast-components"
2076
2076
  },
2077
- "tagName": "%%prefix%%-anchored-region",
2077
+ "tagName": "%%prefix%%-anchor",
2078
2078
  "customElement": true,
2079
2079
  "attributes": [
2080
2080
  {
2081
- "name": "anchor",
2081
+ "name": "download",
2082
2082
  "type": {
2083
2083
  "text": "string"
2084
2084
  },
2085
- "default": "\"\"",
2086
- "description": "The HTML ID of the anchor element this region is positioned relative to",
2087
- "fieldName": "anchor",
2085
+ "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.",
2086
+ "fieldName": "download",
2088
2087
  "inheritedFrom": {
2089
- "name": "AnchoredRegion",
2090
- "module": "src/anchored-region/anchored-region.ts"
2088
+ "name": "Anchor",
2089
+ "module": "src/anchor/anchor.ts"
2091
2090
  }
2092
2091
  },
2093
2092
  {
2094
- "name": "viewport",
2093
+ "name": "href",
2095
2094
  "type": {
2096
2095
  "text": "string"
2097
2096
  },
2098
- "default": "\"\"",
2099
- "description": "The HTML ID of the viewport element this region is positioned relative to",
2100
- "fieldName": "viewport",
2097
+ "description": "The URL the hyperlink references. See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a | <a> element for more information.",
2098
+ "fieldName": "href",
2101
2099
  "inheritedFrom": {
2102
- "name": "AnchoredRegion",
2103
- "module": "src/anchored-region/anchored-region.ts"
2100
+ "name": "Anchor",
2101
+ "module": "src/anchor/anchor.ts"
2104
2102
  }
2105
2103
  },
2106
2104
  {
2107
- "name": "horizontal-positioning-mode",
2105
+ "name": "hreflang",
2108
2106
  "type": {
2109
- "text": "AxisPositioningMode"
2107
+ "text": "string"
2110
2108
  },
2111
- "default": "\"uncontrolled\"",
2112
- "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",
2113
- "fieldName": "horizontalPositioningMode",
2109
+ "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.",
2110
+ "fieldName": "hreflang",
2114
2111
  "inheritedFrom": {
2115
- "name": "AnchoredRegion",
2116
- "module": "src/anchored-region/anchored-region.ts"
2112
+ "name": "Anchor",
2113
+ "module": "src/anchor/anchor.ts"
2117
2114
  }
2118
2115
  },
2119
2116
  {
2120
- "name": "horizontal-default-position",
2117
+ "name": "ping",
2121
2118
  "type": {
2122
- "text": "HorizontalPosition"
2119
+ "text": "string"
2123
2120
  },
2124
- "default": "\"unset\"",
2125
- "description": "The default horizontal position of the region relative to the anchor element",
2126
- "fieldName": "horizontalDefaultPosition",
2121
+ "description": "See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a | <a> element for more information.",
2122
+ "fieldName": "ping",
2127
2123
  "inheritedFrom": {
2128
- "name": "AnchoredRegion",
2129
- "module": "src/anchored-region/anchored-region.ts"
2124
+ "name": "Anchor",
2125
+ "module": "src/anchor/anchor.ts"
2130
2126
  }
2131
2127
  },
2132
2128
  {
2133
- "name": "horizontal-viewport-lock",
2129
+ "name": "referrerpolicy",
2134
2130
  "type": {
2135
- "text": "boolean"
2131
+ "text": "string"
2136
2132
  },
2137
- "default": "false",
2138
- "description": "Whether the region remains in the viewport (ie. detaches from the anchor) on the horizontal axis",
2139
- "fieldName": "horizontalViewportLock",
2133
+ "description": "See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a | <a> element for more information.",
2134
+ "fieldName": "referrerpolicy",
2140
2135
  "inheritedFrom": {
2141
- "name": "AnchoredRegion",
2142
- "module": "src/anchored-region/anchored-region.ts"
2136
+ "name": "Anchor",
2137
+ "module": "src/anchor/anchor.ts"
2143
2138
  }
2144
2139
  },
2145
2140
  {
2146
- "name": "horizontal-inset",
2141
+ "name": "rel",
2147
2142
  "type": {
2148
- "text": "boolean"
2143
+ "text": "string"
2149
2144
  },
2150
- "default": "false",
2151
- "description": "Whether the region overlaps the anchor on the horizontal axis",
2152
- "fieldName": "horizontalInset",
2145
+ "description": "See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a | <a> element for more information.",
2146
+ "fieldName": "rel",
2153
2147
  "inheritedFrom": {
2154
- "name": "AnchoredRegion",
2155
- "module": "src/anchored-region/anchored-region.ts"
2148
+ "name": "Anchor",
2149
+ "module": "src/anchor/anchor.ts"
2156
2150
  }
2157
2151
  },
2158
2152
  {
2159
- "name": "horizontal-threshold",
2153
+ "name": "target",
2160
2154
  "type": {
2161
- "text": "number"
2155
+ "text": "\"_self\" | \"_blank\" | \"_parent\" | \"_top\""
2162
2156
  },
2163
- "description": "How narrow the space allocated to the default position has to be before the widest area\nis selected for layout",
2164
- "fieldName": "horizontalThreshold",
2157
+ "description": "See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a | <a> element for more information.",
2158
+ "fieldName": "target",
2165
2159
  "inheritedFrom": {
2166
- "name": "AnchoredRegion",
2167
- "module": "src/anchored-region/anchored-region.ts"
2160
+ "name": "Anchor",
2161
+ "module": "src/anchor/anchor.ts"
2168
2162
  }
2169
2163
  },
2170
2164
  {
2171
- "name": "horizontal-scaling",
2165
+ "name": "type",
2172
2166
  "type": {
2173
- "text": "AxisScalingMode"
2167
+ "text": "string"
2174
2168
  },
2175
- "default": "\"content\"",
2176
- "description": "Defines how the width of the region is calculated",
2177
- "fieldName": "horizontalScaling",
2169
+ "description": "See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a | <a> element for more information.",
2170
+ "fieldName": "type",
2178
2171
  "inheritedFrom": {
2179
- "name": "AnchoredRegion",
2180
- "module": "src/anchored-region/anchored-region.ts"
2172
+ "name": "Anchor",
2173
+ "module": "src/anchor/anchor.ts"
2181
2174
  }
2182
- },
2175
+ }
2176
+ ],
2177
+ "members": [
2183
2178
  {
2184
- "name": "vertical-positioning-mode",
2179
+ "kind": "field",
2180
+ "name": "download",
2185
2181
  "type": {
2186
- "text": "AxisPositioningMode"
2182
+ "text": "string"
2187
2183
  },
2188
- "default": "\"uncontrolled\"",
2189
- "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",
2190
- "fieldName": "verticalPositioningMode",
2184
+ "privacy": "public",
2185
+ "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.",
2191
2186
  "inheritedFrom": {
2192
- "name": "AnchoredRegion",
2193
- "module": "src/anchored-region/anchored-region.ts"
2187
+ "name": "Anchor",
2188
+ "module": "src/anchor/anchor.ts"
2194
2189
  }
2195
2190
  },
2196
2191
  {
2197
- "name": "vertical-default-position",
2192
+ "kind": "field",
2193
+ "name": "href",
2198
2194
  "type": {
2199
- "text": "VerticalPosition"
2195
+ "text": "string"
2200
2196
  },
2201
- "default": "\"unset\"",
2202
- "description": "The default vertical position of the region relative to the anchor element",
2203
- "fieldName": "verticalDefaultPosition",
2197
+ "privacy": "public",
2198
+ "description": "The URL the hyperlink references. See {@link https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a | <a> element } for more information.",
2204
2199
  "inheritedFrom": {
2205
- "name": "AnchoredRegion",
2206
- "module": "src/anchored-region/anchored-region.ts"
2200
+ "name": "Anchor",
2201
+ "module": "src/anchor/anchor.ts"
2207
2202
  }
2208
2203
  },
2209
2204
  {
2210
- "name": "vertical-viewport-lock",
2205
+ "kind": "field",
2206
+ "name": "hreflang",
2211
2207
  "type": {
2212
- "text": "boolean"
2208
+ "text": "string"
2213
2209
  },
2214
- "default": "false",
2215
- "description": "Whether the region remains in the viewport (ie. detaches from the anchor) on the vertical axis",
2216
- "fieldName": "verticalViewportLock",
2210
+ "privacy": "public",
2211
+ "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.",
2217
2212
  "inheritedFrom": {
2218
- "name": "AnchoredRegion",
2219
- "module": "src/anchored-region/anchored-region.ts"
2220
- }
2221
- },
2222
- {
2223
- "name": "vertical-inset",
2224
- "type": {
2225
- "text": "boolean"
2226
- },
2227
- "default": "false",
2228
- "description": "Whether the region overlaps the anchor on the vertical axis",
2229
- "fieldName": "verticalInset",
2230
- "inheritedFrom": {
2231
- "name": "AnchoredRegion",
2232
- "module": "src/anchored-region/anchored-region.ts"
2233
- }
2234
- },
2235
- {
2236
- "name": "vertical-threshold",
2237
- "type": {
2238
- "text": "number"
2239
- },
2240
- "description": "How short the space allocated to the default position has to be before the tallest area\nis selected for layout",
2241
- "fieldName": "verticalThreshold",
2242
- "inheritedFrom": {
2243
- "name": "AnchoredRegion",
2244
- "module": "src/anchored-region/anchored-region.ts"
2213
+ "name": "Anchor",
2214
+ "module": "src/anchor/anchor.ts"
2245
2215
  }
2246
2216
  },
2247
2217
  {
2248
- "name": "vertical-scaling",
2218
+ "kind": "field",
2219
+ "name": "ping",
2249
2220
  "type": {
2250
- "text": "AxisScalingMode"
2221
+ "text": "string"
2251
2222
  },
2252
- "default": "\"content\"",
2253
- "description": "Defines how the height of the region is calculated",
2254
- "fieldName": "verticalScaling",
2223
+ "privacy": "public",
2224
+ "description": "See {@link https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a | <a> element } for more information.",
2255
2225
  "inheritedFrom": {
2256
- "name": "AnchoredRegion",
2257
- "module": "src/anchored-region/anchored-region.ts"
2226
+ "name": "Anchor",
2227
+ "module": "src/anchor/anchor.ts"
2258
2228
  }
2259
2229
  },
2260
2230
  {
2261
- "name": "fixed-placement",
2231
+ "kind": "field",
2232
+ "name": "referrerpolicy",
2262
2233
  "type": {
2263
- "text": "boolean"
2234
+ "text": "string"
2264
2235
  },
2265
- "default": "false",
2266
- "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,",
2267
- "fieldName": "fixedPlacement",
2236
+ "privacy": "public",
2237
+ "description": "See {@link https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a | <a> element } for more information.",
2268
2238
  "inheritedFrom": {
2269
- "name": "AnchoredRegion",
2270
- "module": "src/anchored-region/anchored-region.ts"
2239
+ "name": "Anchor",
2240
+ "module": "src/anchor/anchor.ts"
2271
2241
  }
2272
2242
  },
2273
- {
2274
- "name": "auto-update-mode",
2275
- "type": {
2276
- "text": "AutoUpdateMode"
2277
- },
2278
- "default": "\"anchor\"",
2279
- "description": "Defines what triggers the anchored region to revaluate positioning",
2280
- "fieldName": "autoUpdateMode",
2281
- "inheritedFrom": {
2282
- "name": "AnchoredRegion",
2283
- "module": "src/anchored-region/anchored-region.ts"
2284
- }
2285
- }
2286
- ],
2287
- "members": [
2288
2243
  {
2289
2244
  "kind": "field",
2290
- "name": "anchor",
2245
+ "name": "rel",
2291
2246
  "type": {
2292
2247
  "text": "string"
2293
2248
  },
2294
2249
  "privacy": "public",
2295
- "default": "\"\"",
2296
- "description": "The HTML ID of the anchor element this region is positioned relative to",
2250
+ "description": "See {@link https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a | <a> element } for more information.",
2297
2251
  "inheritedFrom": {
2298
- "name": "AnchoredRegion",
2299
- "module": "src/anchored-region/anchored-region.ts"
2252
+ "name": "Anchor",
2253
+ "module": "src/anchor/anchor.ts"
2300
2254
  }
2301
2255
  },
2302
2256
  {
2303
- "kind": "method",
2304
- "name": "anchorChanged",
2305
- "privacy": "private",
2306
- "return": {
2307
- "type": {
2308
- "text": "void"
2309
- }
2257
+ "kind": "field",
2258
+ "name": "target",
2259
+ "type": {
2260
+ "text": "\"_self\" | \"_blank\" | \"_parent\" | \"_top\""
2310
2261
  },
2262
+ "privacy": "public",
2263
+ "description": "See {@link https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a | <a> element } for more information.",
2311
2264
  "inheritedFrom": {
2312
- "name": "AnchoredRegion",
2313
- "module": "src/anchored-region/anchored-region.ts"
2265
+ "name": "Anchor",
2266
+ "module": "src/anchor/anchor.ts"
2314
2267
  }
2315
2268
  },
2316
2269
  {
2317
2270
  "kind": "field",
2318
- "name": "viewport",
2271
+ "name": "type",
2319
2272
  "type": {
2320
2273
  "text": "string"
2321
2274
  },
2322
2275
  "privacy": "public",
2323
- "default": "\"\"",
2324
- "description": "The HTML ID of the viewport element this region is positioned relative to",
2325
- "inheritedFrom": {
2326
- "name": "AnchoredRegion",
2327
- "module": "src/anchored-region/anchored-region.ts"
2328
- }
2329
- },
2330
- {
2331
- "kind": "method",
2332
- "name": "viewportChanged",
2333
- "privacy": "private",
2334
- "return": {
2335
- "type": {
2336
- "text": "void"
2337
- }
2338
- },
2276
+ "description": "See {@link https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a | <a> element } for more information.",
2339
2277
  "inheritedFrom": {
2340
- "name": "AnchoredRegion",
2341
- "module": "src/anchored-region/anchored-region.ts"
2278
+ "name": "Anchor",
2279
+ "module": "src/anchor/anchor.ts"
2342
2280
  }
2343
2281
  },
2344
2282
  {
2345
2283
  "kind": "field",
2346
- "name": "horizontalPositioningMode",
2284
+ "name": "control",
2347
2285
  "type": {
2348
- "text": "AxisPositioningMode"
2286
+ "text": "HTMLAnchorElement | undefined"
2349
2287
  },
2350
2288
  "privacy": "public",
2351
- "default": "\"uncontrolled\"",
2352
- "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",
2289
+ "description": "References the root element",
2353
2290
  "inheritedFrom": {
2354
- "name": "AnchoredRegion",
2355
- "module": "src/anchored-region/anchored-region.ts"
2291
+ "name": "Anchor",
2292
+ "module": "src/anchor/anchor.ts"
2356
2293
  }
2357
2294
  },
2358
2295
  {
2359
- "kind": "method",
2360
- "name": "horizontalPositioningModeChanged",
2296
+ "kind": "field",
2297
+ "name": "handleUnsupportedDelegatesFocus",
2361
2298
  "privacy": "private",
2362
- "return": {
2363
- "type": {
2364
- "text": "void"
2365
- }
2366
- },
2299
+ "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",
2367
2300
  "inheritedFrom": {
2368
- "name": "AnchoredRegion",
2369
- "module": "src/anchored-region/anchored-region.ts"
2301
+ "name": "Anchor",
2302
+ "module": "src/anchor/anchor.ts"
2370
2303
  }
2371
2304
  },
2372
2305
  {
2373
2306
  "kind": "field",
2374
- "name": "horizontalDefaultPosition",
2307
+ "name": "_presentation",
2375
2308
  "type": {
2376
- "text": "HorizontalPosition"
2309
+ "text": "ComponentPresentation | null | undefined"
2377
2310
  },
2378
- "privacy": "public",
2379
- "default": "\"unset\"",
2380
- "description": "The default horizontal position of the region relative to the anchor element",
2381
- "inheritedFrom": {
2382
- "name": "AnchoredRegion",
2383
- "module": "src/anchored-region/anchored-region.ts"
2384
- }
2385
- },
2386
- {
2387
- "kind": "method",
2388
- "name": "horizontalDefaultPositionChanged",
2389
2311
  "privacy": "private",
2390
- "return": {
2391
- "type": {
2392
- "text": "void"
2393
- }
2394
- },
2312
+ "default": "void 0",
2395
2313
  "inheritedFrom": {
2396
- "name": "AnchoredRegion",
2397
- "module": "src/anchored-region/anchored-region.ts"
2314
+ "name": "FoundationElement",
2315
+ "module": "src/foundation-element/foundation-element.ts"
2398
2316
  }
2399
2317
  },
2400
2318
  {
2401
2319
  "kind": "field",
2402
- "name": "horizontalViewportLock",
2320
+ "name": "$presentation",
2403
2321
  "type": {
2404
- "text": "boolean"
2322
+ "text": "ComponentPresentation | null"
2405
2323
  },
2406
2324
  "privacy": "public",
2407
- "default": "false",
2408
- "description": "Whether the region remains in the viewport (ie. detaches from the anchor) on the horizontal axis",
2409
- "inheritedFrom": {
2410
- "name": "AnchoredRegion",
2411
- "module": "src/anchored-region/anchored-region.ts"
2412
- }
2413
- },
2414
- {
2415
- "kind": "method",
2416
- "name": "horizontalViewportLockChanged",
2417
- "privacy": "private",
2418
- "return": {
2419
- "type": {
2420
- "text": "void"
2421
- }
2422
- },
2325
+ "description": "A property which resolves the ComponentPresentation instance\nfor the current component.",
2423
2326
  "inheritedFrom": {
2424
- "name": "AnchoredRegion",
2425
- "module": "src/anchored-region/anchored-region.ts"
2327
+ "name": "FoundationElement",
2328
+ "module": "src/foundation-element/foundation-element.ts"
2426
2329
  }
2427
2330
  },
2428
2331
  {
2429
2332
  "kind": "field",
2430
- "name": "horizontalInset",
2333
+ "name": "template",
2431
2334
  "type": {
2432
- "text": "boolean"
2335
+ "text": "ElementViewTemplate | void | null"
2433
2336
  },
2434
2337
  "privacy": "public",
2435
- "default": "false",
2436
- "description": "Whether the region overlaps the anchor on the horizontal axis",
2338
+ "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.",
2437
2339
  "inheritedFrom": {
2438
- "name": "AnchoredRegion",
2439
- "module": "src/anchored-region/anchored-region.ts"
2340
+ "name": "FoundationElement",
2341
+ "module": "src/foundation-element/foundation-element.ts"
2440
2342
  }
2441
2343
  },
2442
2344
  {
2443
2345
  "kind": "method",
2444
- "name": "horizontalInsetChanged",
2445
- "privacy": "private",
2346
+ "name": "templateChanged",
2347
+ "privacy": "protected",
2446
2348
  "return": {
2447
2349
  "type": {
2448
2350
  "text": "void"
2449
2351
  }
2450
2352
  },
2451
2353
  "inheritedFrom": {
2452
- "name": "AnchoredRegion",
2453
- "module": "src/anchored-region/anchored-region.ts"
2354
+ "name": "FoundationElement",
2355
+ "module": "src/foundation-element/foundation-element.ts"
2454
2356
  }
2455
2357
  },
2456
2358
  {
2457
2359
  "kind": "field",
2458
- "name": "horizontalThreshold",
2360
+ "name": "styles",
2459
2361
  "type": {
2460
- "text": "number"
2362
+ "text": "ElementStyles | void | null"
2461
2363
  },
2462
2364
  "privacy": "public",
2463
- "description": "How narrow the space allocated to the default position has to be before the widest area\nis selected for layout",
2365
+ "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.",
2464
2366
  "inheritedFrom": {
2465
- "name": "AnchoredRegion",
2466
- "module": "src/anchored-region/anchored-region.ts"
2367
+ "name": "FoundationElement",
2368
+ "module": "src/foundation-element/foundation-element.ts"
2467
2369
  }
2468
2370
  },
2469
2371
  {
2470
2372
  "kind": "method",
2471
- "name": "horizontalThresholdChanged",
2472
- "privacy": "private",
2373
+ "name": "stylesChanged",
2374
+ "privacy": "protected",
2473
2375
  "return": {
2474
2376
  "type": {
2475
2377
  "text": "void"
2476
2378
  }
2477
2379
  },
2478
2380
  "inheritedFrom": {
2479
- "name": "AnchoredRegion",
2480
- "module": "src/anchored-region/anchored-region.ts"
2481
- }
2482
- },
2483
- {
2484
- "kind": "field",
2485
- "name": "horizontalScaling",
2486
- "type": {
2487
- "text": "AxisScalingMode"
2488
- },
2489
- "privacy": "public",
2490
- "default": "\"content\"",
2491
- "description": "Defines how the width of the region is calculated",
2492
- "inheritedFrom": {
2493
- "name": "AnchoredRegion",
2494
- "module": "src/anchored-region/anchored-region.ts"
2381
+ "name": "FoundationElement",
2382
+ "module": "src/foundation-element/foundation-element.ts"
2495
2383
  }
2496
2384
  },
2497
2385
  {
2498
2386
  "kind": "method",
2499
- "name": "horizontalScalingChanged",
2500
- "privacy": "private",
2387
+ "name": "compose",
2388
+ "privacy": "public",
2389
+ "static": true,
2501
2390
  "return": {
2502
2391
  "type": {
2503
- "text": "void"
2392
+ "text": "(\n overrideDefinition?: OverrideFoundationElementDefinition<T>\n ) => FoundationElementRegistry<T, K>"
2504
2393
  }
2505
2394
  },
2506
- "inheritedFrom": {
2507
- "name": "AnchoredRegion",
2508
- "module": "src/anchored-region/anchored-region.ts"
2395
+ "parameters": [
2396
+ {
2397
+ "name": "this",
2398
+ "type": {
2399
+ "text": "K"
2400
+ }
2401
+ },
2402
+ {
2403
+ "name": "elementDefinition",
2404
+ "type": {
2405
+ "text": "T"
2406
+ },
2407
+ "description": "The definition of the element to create the registry\nfunction for."
2408
+ }
2409
+ ],
2410
+ "description": "Defines an element registry function with a set of element definition defaults.",
2411
+ "inheritedFrom": {
2412
+ "name": "FoundationElement",
2413
+ "module": "src/foundation-element/foundation-element.ts"
2414
+ }
2415
+ }
2416
+ ]
2417
+ },
2418
+ {
2419
+ "kind": "variable",
2420
+ "name": "foundationAnchorShadowOptions",
2421
+ "type": {
2422
+ "text": "ShadowRootInit"
2423
+ },
2424
+ "default": "{\n delegatesFocus: true,\n mode: 'open',\n}"
2425
+ },
2426
+ {
2427
+ "kind": "variable",
2428
+ "name": "defaultAnchorConfig",
2429
+ "type": {
2430
+ "text": "object"
2431
+ },
2432
+ "default": "{}"
2433
+ },
2434
+ {
2435
+ "kind": "variable",
2436
+ "name": "foundationAnchor",
2437
+ "description": "The Foundation Anchor",
2438
+ "privacy": "public"
2439
+ }
2440
+ ],
2441
+ "exports": [
2442
+ {
2443
+ "kind": "js",
2444
+ "name": "Anchor",
2445
+ "declaration": {
2446
+ "name": "Anchor",
2447
+ "module": "src/anchor/anchor.ts"
2448
+ }
2449
+ },
2450
+ {
2451
+ "kind": "js",
2452
+ "name": "foundationAnchorShadowOptions",
2453
+ "declaration": {
2454
+ "name": "foundationAnchorShadowOptions",
2455
+ "module": "src/anchor/anchor.ts"
2456
+ }
2457
+ },
2458
+ {
2459
+ "kind": "js",
2460
+ "name": "defaultAnchorConfig",
2461
+ "declaration": {
2462
+ "name": "defaultAnchorConfig",
2463
+ "module": "src/anchor/anchor.ts"
2464
+ }
2465
+ },
2466
+ {
2467
+ "kind": "js",
2468
+ "name": "foundationAnchor",
2469
+ "declaration": {
2470
+ "name": "foundationAnchor",
2471
+ "module": "src/anchor/anchor.ts"
2472
+ }
2473
+ }
2474
+ ]
2475
+ },
2476
+ {
2477
+ "kind": "javascript-module",
2478
+ "path": "src/anchor/index.ts",
2479
+ "declarations": [],
2480
+ "exports": [
2481
+ {
2482
+ "kind": "js",
2483
+ "name": "*",
2484
+ "declaration": {
2485
+ "name": "*",
2486
+ "package": "./anchor.template"
2487
+ }
2488
+ },
2489
+ {
2490
+ "kind": "js",
2491
+ "name": "*",
2492
+ "declaration": {
2493
+ "name": "*",
2494
+ "package": "./anchor.styles"
2495
+ }
2496
+ },
2497
+ {
2498
+ "kind": "js",
2499
+ "name": "*",
2500
+ "declaration": {
2501
+ "name": "*",
2502
+ "package": "./anchor"
2503
+ }
2504
+ }
2505
+ ]
2506
+ },
2507
+ {
2508
+ "kind": "javascript-module",
2509
+ "path": "src/anchored-region/anchor-region.template.ts",
2510
+ "declarations": [
2511
+ {
2512
+ "kind": "function",
2513
+ "name": "foundationAnchoredRegionTemplate",
2514
+ "return": {
2515
+ "type": {
2516
+ "text": "ViewTemplate<AnchoredRegion>"
2517
+ }
2518
+ },
2519
+ "parameters": [
2520
+ {
2521
+ "name": "context",
2522
+ "type": {
2523
+ "text": "ElementDefinitionContext"
2509
2524
  }
2510
2525
  },
2511
2526
  {
2512
- "kind": "field",
2513
- "name": "verticalPositioningMode",
2527
+ "name": "definition",
2514
2528
  "type": {
2515
- "text": "AxisPositioningMode"
2529
+ "text": "FoundationElementDefinition"
2530
+ }
2531
+ }
2532
+ ]
2533
+ }
2534
+ ],
2535
+ "exports": [
2536
+ {
2537
+ "kind": "js",
2538
+ "name": "foundationAnchoredRegionTemplate",
2539
+ "declaration": {
2540
+ "name": "foundationAnchoredRegionTemplate",
2541
+ "module": "src/anchored-region/anchor-region.template.ts"
2542
+ }
2543
+ }
2544
+ ]
2545
+ },
2546
+ {
2547
+ "kind": "javascript-module",
2548
+ "path": "src/anchored-region/anchored-region.styles.ts",
2549
+ "declarations": [
2550
+ {
2551
+ "kind": "function",
2552
+ "name": "foundationAnchoredRegionStyles",
2553
+ "return": {
2554
+ "type": {
2555
+ "text": "ElementStyles"
2556
+ }
2557
+ },
2558
+ "parameters": [
2559
+ {
2560
+ "name": "context",
2561
+ "type": {
2562
+ "text": "ElementDefinitionContext"
2563
+ }
2564
+ },
2565
+ {
2566
+ "name": "definition",
2567
+ "type": {
2568
+ "text": "FoundationElementDefinition"
2569
+ }
2570
+ }
2571
+ ]
2572
+ }
2573
+ ],
2574
+ "exports": [
2575
+ {
2576
+ "kind": "js",
2577
+ "name": "foundationAnchoredRegionStyles",
2578
+ "declaration": {
2579
+ "name": "foundationAnchoredRegionStyles",
2580
+ "module": "src/anchored-region/anchored-region.styles.ts"
2581
+ }
2582
+ }
2583
+ ]
2584
+ },
2585
+ {
2586
+ "kind": "javascript-module",
2587
+ "path": "src/anchored-region/anchored-region.ts",
2588
+ "declarations": [
2589
+ {
2590
+ "kind": "class",
2591
+ "description": "",
2592
+ "name": "AnchoredRegion",
2593
+ "superclass": {
2594
+ "name": "FASTAnchoredRegion",
2595
+ "package": "@microsoft/fast-components"
2596
+ },
2597
+ "tagName": "%%prefix%%-anchored-region",
2598
+ "customElement": true,
2599
+ "attributes": [
2600
+ {
2601
+ "name": "anchor",
2602
+ "type": {
2603
+ "text": "string"
2516
2604
  },
2517
- "privacy": "public",
2518
- "default": "\"uncontrolled\"",
2519
- "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",
2605
+ "default": "\"\"",
2606
+ "description": "The HTML ID of the anchor element this region is positioned relative to",
2607
+ "fieldName": "anchor",
2520
2608
  "inheritedFrom": {
2521
2609
  "name": "AnchoredRegion",
2522
2610
  "module": "src/anchored-region/anchored-region.ts"
2523
2611
  }
2524
2612
  },
2525
2613
  {
2526
- "kind": "method",
2527
- "name": "verticalPositioningModeChanged",
2528
- "privacy": "private",
2529
- "return": {
2530
- "type": {
2531
- "text": "void"
2532
- }
2614
+ "name": "viewport",
2615
+ "type": {
2616
+ "text": "string"
2533
2617
  },
2618
+ "default": "\"\"",
2619
+ "description": "The HTML ID of the viewport element this region is positioned relative to",
2620
+ "fieldName": "viewport",
2534
2621
  "inheritedFrom": {
2535
2622
  "name": "AnchoredRegion",
2536
2623
  "module": "src/anchored-region/anchored-region.ts"
2537
2624
  }
2538
2625
  },
2539
2626
  {
2540
- "kind": "field",
2541
- "name": "verticalDefaultPosition",
2627
+ "name": "horizontal-positioning-mode",
2542
2628
  "type": {
2543
- "text": "VerticalPosition"
2629
+ "text": "AxisPositioningMode"
2544
2630
  },
2545
- "privacy": "public",
2546
- "default": "\"unset\"",
2547
- "description": "The default vertical position of the region relative to the anchor element",
2631
+ "default": "\"uncontrolled\"",
2632
+ "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",
2633
+ "fieldName": "horizontalPositioningMode",
2548
2634
  "inheritedFrom": {
2549
2635
  "name": "AnchoredRegion",
2550
2636
  "module": "src/anchored-region/anchored-region.ts"
2551
2637
  }
2552
2638
  },
2553
2639
  {
2554
- "kind": "method",
2555
- "name": "verticalDefaultPositionChanged",
2556
- "privacy": "private",
2557
- "return": {
2558
- "type": {
2559
- "text": "void"
2560
- }
2640
+ "name": "horizontal-default-position",
2641
+ "type": {
2642
+ "text": "HorizontalPosition"
2561
2643
  },
2644
+ "default": "\"unset\"",
2645
+ "description": "The default horizontal position of the region relative to the anchor element",
2646
+ "fieldName": "horizontalDefaultPosition",
2562
2647
  "inheritedFrom": {
2563
2648
  "name": "AnchoredRegion",
2564
2649
  "module": "src/anchored-region/anchored-region.ts"
2565
2650
  }
2566
2651
  },
2567
2652
  {
2568
- "kind": "field",
2569
- "name": "verticalViewportLock",
2653
+ "name": "horizontal-viewport-lock",
2570
2654
  "type": {
2571
2655
  "text": "boolean"
2572
2656
  },
2573
- "privacy": "public",
2574
2657
  "default": "false",
2575
- "description": "Whether the region remains in the viewport (ie. detaches from the anchor) on the vertical axis",
2658
+ "description": "Whether the region remains in the viewport (ie. detaches from the anchor) on the horizontal axis",
2659
+ "fieldName": "horizontalViewportLock",
2576
2660
  "inheritedFrom": {
2577
2661
  "name": "AnchoredRegion",
2578
2662
  "module": "src/anchored-region/anchored-region.ts"
2579
2663
  }
2580
2664
  },
2581
2665
  {
2582
- "kind": "method",
2583
- "name": "verticalViewportLockChanged",
2584
- "privacy": "private",
2585
- "return": {
2586
- "type": {
2587
- "text": "void"
2588
- }
2666
+ "name": "horizontal-inset",
2667
+ "type": {
2668
+ "text": "boolean"
2589
2669
  },
2670
+ "default": "false",
2671
+ "description": "Whether the region overlaps the anchor on the horizontal axis",
2672
+ "fieldName": "horizontalInset",
2590
2673
  "inheritedFrom": {
2591
2674
  "name": "AnchoredRegion",
2592
2675
  "module": "src/anchored-region/anchored-region.ts"
2593
2676
  }
2594
2677
  },
2595
2678
  {
2596
- "kind": "field",
2597
- "name": "verticalInset",
2679
+ "name": "horizontal-threshold",
2680
+ "type": {
2681
+ "text": "number"
2682
+ },
2683
+ "description": "How narrow the space allocated to the default position has to be before the widest area\nis selected for layout",
2684
+ "fieldName": "horizontalThreshold",
2685
+ "inheritedFrom": {
2686
+ "name": "AnchoredRegion",
2687
+ "module": "src/anchored-region/anchored-region.ts"
2688
+ }
2689
+ },
2690
+ {
2691
+ "name": "horizontal-scaling",
2692
+ "type": {
2693
+ "text": "AxisScalingMode"
2694
+ },
2695
+ "default": "\"content\"",
2696
+ "description": "Defines how the width of the region is calculated",
2697
+ "fieldName": "horizontalScaling",
2698
+ "inheritedFrom": {
2699
+ "name": "AnchoredRegion",
2700
+ "module": "src/anchored-region/anchored-region.ts"
2701
+ }
2702
+ },
2703
+ {
2704
+ "name": "vertical-positioning-mode",
2705
+ "type": {
2706
+ "text": "AxisPositioningMode"
2707
+ },
2708
+ "default": "\"uncontrolled\"",
2709
+ "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",
2710
+ "fieldName": "verticalPositioningMode",
2711
+ "inheritedFrom": {
2712
+ "name": "AnchoredRegion",
2713
+ "module": "src/anchored-region/anchored-region.ts"
2714
+ }
2715
+ },
2716
+ {
2717
+ "name": "vertical-default-position",
2718
+ "type": {
2719
+ "text": "VerticalPosition"
2720
+ },
2721
+ "default": "\"unset\"",
2722
+ "description": "The default vertical position of the region relative to the anchor element",
2723
+ "fieldName": "verticalDefaultPosition",
2724
+ "inheritedFrom": {
2725
+ "name": "AnchoredRegion",
2726
+ "module": "src/anchored-region/anchored-region.ts"
2727
+ }
2728
+ },
2729
+ {
2730
+ "name": "vertical-viewport-lock",
2598
2731
  "type": {
2599
2732
  "text": "boolean"
2600
2733
  },
2601
- "privacy": "public",
2602
2734
  "default": "false",
2603
- "description": "Whether the region overlaps the anchor on the vertical axis",
2735
+ "description": "Whether the region remains in the viewport (ie. detaches from the anchor) on the vertical axis",
2736
+ "fieldName": "verticalViewportLock",
2604
2737
  "inheritedFrom": {
2605
2738
  "name": "AnchoredRegion",
2606
2739
  "module": "src/anchored-region/anchored-region.ts"
2607
2740
  }
2608
2741
  },
2609
2742
  {
2610
- "kind": "method",
2611
- "name": "verticalInsetChanged",
2612
- "privacy": "private",
2613
- "return": {
2614
- "type": {
2615
- "text": "void"
2616
- }
2743
+ "name": "vertical-inset",
2744
+ "type": {
2745
+ "text": "boolean"
2617
2746
  },
2747
+ "default": "false",
2748
+ "description": "Whether the region overlaps the anchor on the vertical axis",
2749
+ "fieldName": "verticalInset",
2618
2750
  "inheritedFrom": {
2619
2751
  "name": "AnchoredRegion",
2620
2752
  "module": "src/anchored-region/anchored-region.ts"
2621
2753
  }
2622
2754
  },
2623
2755
  {
2624
- "kind": "field",
2625
- "name": "verticalThreshold",
2756
+ "name": "vertical-threshold",
2626
2757
  "type": {
2627
2758
  "text": "number"
2628
2759
  },
2629
- "privacy": "public",
2630
2760
  "description": "How short the space allocated to the default position has to be before the tallest area\nis selected for layout",
2761
+ "fieldName": "verticalThreshold",
2631
2762
  "inheritedFrom": {
2632
2763
  "name": "AnchoredRegion",
2633
2764
  "module": "src/anchored-region/anchored-region.ts"
2634
2765
  }
2635
2766
  },
2636
2767
  {
2637
- "kind": "method",
2638
- "name": "verticalThresholdChanged",
2639
- "privacy": "private",
2640
- "return": {
2641
- "type": {
2642
- "text": "void"
2643
- }
2768
+ "name": "vertical-scaling",
2769
+ "type": {
2770
+ "text": "AxisScalingMode"
2771
+ },
2772
+ "default": "\"content\"",
2773
+ "description": "Defines how the height of the region is calculated",
2774
+ "fieldName": "verticalScaling",
2775
+ "inheritedFrom": {
2776
+ "name": "AnchoredRegion",
2777
+ "module": "src/anchored-region/anchored-region.ts"
2778
+ }
2779
+ },
2780
+ {
2781
+ "name": "fixed-placement",
2782
+ "type": {
2783
+ "text": "boolean"
2644
2784
  },
2785
+ "default": "false",
2786
+ "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,",
2787
+ "fieldName": "fixedPlacement",
2645
2788
  "inheritedFrom": {
2646
2789
  "name": "AnchoredRegion",
2647
2790
  "module": "src/anchored-region/anchored-region.ts"
2648
2791
  }
2649
2792
  },
2793
+ {
2794
+ "name": "auto-update-mode",
2795
+ "type": {
2796
+ "text": "AutoUpdateMode"
2797
+ },
2798
+ "default": "\"anchor\"",
2799
+ "description": "Defines what triggers the anchored region to revaluate positioning",
2800
+ "fieldName": "autoUpdateMode",
2801
+ "inheritedFrom": {
2802
+ "name": "AnchoredRegion",
2803
+ "module": "src/anchored-region/anchored-region.ts"
2804
+ }
2805
+ }
2806
+ ],
2807
+ "members": [
2650
2808
  {
2651
2809
  "kind": "field",
2652
- "name": "verticalScaling",
2810
+ "name": "anchor",
2653
2811
  "type": {
2654
- "text": "AxisScalingMode"
2812
+ "text": "string"
2655
2813
  },
2656
2814
  "privacy": "public",
2657
- "default": "\"content\"",
2658
- "description": "Defines how the height of the region is calculated",
2815
+ "default": "\"\"",
2816
+ "description": "The HTML ID of the anchor element this region is positioned relative to",
2659
2817
  "inheritedFrom": {
2660
2818
  "name": "AnchoredRegion",
2661
2819
  "module": "src/anchored-region/anchored-region.ts"
@@ -2663,7 +2821,7 @@
2663
2821
  },
2664
2822
  {
2665
2823
  "kind": "method",
2666
- "name": "verticalScalingChanged",
2824
+ "name": "anchorChanged",
2667
2825
  "privacy": "private",
2668
2826
  "return": {
2669
2827
  "type": {
@@ -2677,13 +2835,13 @@
2677
2835
  },
2678
2836
  {
2679
2837
  "kind": "field",
2680
- "name": "fixedPlacement",
2838
+ "name": "viewport",
2681
2839
  "type": {
2682
- "text": "boolean"
2840
+ "text": "string"
2683
2841
  },
2684
2842
  "privacy": "public",
2685
- "default": "false",
2686
- "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,",
2843
+ "default": "\"\"",
2844
+ "description": "The HTML ID of the viewport element this region is positioned relative to",
2687
2845
  "inheritedFrom": {
2688
2846
  "name": "AnchoredRegion",
2689
2847
  "module": "src/anchored-region/anchored-region.ts"
@@ -2691,7 +2849,7 @@
2691
2849
  },
2692
2850
  {
2693
2851
  "kind": "method",
2694
- "name": "fixedPlacementChanged",
2852
+ "name": "viewportChanged",
2695
2853
  "privacy": "private",
2696
2854
  "return": {
2697
2855
  "type": {
@@ -2705,13 +2863,13 @@
2705
2863
  },
2706
2864
  {
2707
2865
  "kind": "field",
2708
- "name": "autoUpdateMode",
2866
+ "name": "horizontalPositioningMode",
2709
2867
  "type": {
2710
- "text": "AutoUpdateMode"
2868
+ "text": "AxisPositioningMode"
2711
2869
  },
2712
2870
  "privacy": "public",
2713
- "default": "\"anchor\"",
2714
- "description": "Defines what triggers the anchored region to revaluate positioning",
2871
+ "default": "\"uncontrolled\"",
2872
+ "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",
2715
2873
  "inheritedFrom": {
2716
2874
  "name": "AnchoredRegion",
2717
2875
  "module": "src/anchored-region/anchored-region.ts"
@@ -2719,27 +2877,13 @@
2719
2877
  },
2720
2878
  {
2721
2879
  "kind": "method",
2722
- "name": "autoUpdateModeChanged",
2880
+ "name": "horizontalPositioningModeChanged",
2723
2881
  "privacy": "private",
2724
2882
  "return": {
2725
2883
  "type": {
2726
2884
  "text": "void"
2727
2885
  }
2728
2886
  },
2729
- "parameters": [
2730
- {
2731
- "name": "prevMode",
2732
- "type": {
2733
- "text": "AutoUpdateMode"
2734
- }
2735
- },
2736
- {
2737
- "name": "newMode",
2738
- "type": {
2739
- "text": "AutoUpdateMode"
2740
- }
2741
- }
2742
- ],
2743
2887
  "inheritedFrom": {
2744
2888
  "name": "AnchoredRegion",
2745
2889
  "module": "src/anchored-region/anchored-region.ts"
@@ -2747,13 +2891,13 @@
2747
2891
  },
2748
2892
  {
2749
2893
  "kind": "field",
2750
- "name": "anchorElement",
2894
+ "name": "horizontalDefaultPosition",
2751
2895
  "type": {
2752
- "text": "HTMLElement | null"
2896
+ "text": "HorizontalPosition"
2753
2897
  },
2754
2898
  "privacy": "public",
2755
- "default": "null",
2756
- "description": "The HTML element being used as the anchor",
2899
+ "default": "\"unset\"",
2900
+ "description": "The default horizontal position of the region relative to the anchor element",
2757
2901
  "inheritedFrom": {
2758
2902
  "name": "AnchoredRegion",
2759
2903
  "module": "src/anchored-region/anchored-region.ts"
@@ -2761,7 +2905,7 @@
2761
2905
  },
2762
2906
  {
2763
2907
  "kind": "method",
2764
- "name": "anchorElementChanged",
2908
+ "name": "horizontalDefaultPositionChanged",
2765
2909
  "privacy": "private",
2766
2910
  "return": {
2767
2911
  "type": {
@@ -2775,13 +2919,13 @@
2775
2919
  },
2776
2920
  {
2777
2921
  "kind": "field",
2778
- "name": "viewportElement",
2922
+ "name": "horizontalViewportLock",
2779
2923
  "type": {
2780
- "text": "HTMLElement | null"
2924
+ "text": "boolean"
2781
2925
  },
2782
2926
  "privacy": "public",
2783
- "default": "null",
2784
- "description": "The HTML element being used as the viewport",
2927
+ "default": "false",
2928
+ "description": "Whether the region remains in the viewport (ie. detaches from the anchor) on the horizontal axis",
2785
2929
  "inheritedFrom": {
2786
2930
  "name": "AnchoredRegion",
2787
2931
  "module": "src/anchored-region/anchored-region.ts"
@@ -2789,7 +2933,7 @@
2789
2933
  },
2790
2934
  {
2791
2935
  "kind": "method",
2792
- "name": "viewportElementChanged",
2936
+ "name": "horizontalViewportLockChanged",
2793
2937
  "privacy": "private",
2794
2938
  "return": {
2795
2939
  "type": {
@@ -2803,25 +2947,27 @@
2803
2947
  },
2804
2948
  {
2805
2949
  "kind": "field",
2806
- "name": "verticalPosition",
2950
+ "name": "horizontalInset",
2807
2951
  "type": {
2808
- "text": "AnchoredRegionPositionLabel | undefined"
2952
+ "text": "boolean"
2809
2953
  },
2810
2954
  "privacy": "public",
2811
- "description": "indicates the current horizontal position of the region",
2955
+ "default": "false",
2956
+ "description": "Whether the region overlaps the anchor on the horizontal axis",
2812
2957
  "inheritedFrom": {
2813
2958
  "name": "AnchoredRegion",
2814
2959
  "module": "src/anchored-region/anchored-region.ts"
2815
2960
  }
2816
2961
  },
2817
2962
  {
2818
- "kind": "field",
2819
- "name": "horizontalPosition",
2820
- "type": {
2821
- "text": "AnchoredRegionPositionLabel | undefined"
2963
+ "kind": "method",
2964
+ "name": "horizontalInsetChanged",
2965
+ "privacy": "private",
2966
+ "return": {
2967
+ "type": {
2968
+ "text": "void"
2969
+ }
2822
2970
  },
2823
- "privacy": "public",
2824
- "description": "indicates the current vertical position of the region",
2825
2971
  "inheritedFrom": {
2826
2972
  "name": "AnchoredRegion",
2827
2973
  "module": "src/anchored-region/anchored-region.ts"
@@ -2829,24 +2975,26 @@
2829
2975
  },
2830
2976
  {
2831
2977
  "kind": "field",
2832
- "name": "translateX",
2978
+ "name": "horizontalThreshold",
2833
2979
  "type": {
2834
2980
  "text": "number"
2835
2981
  },
2836
- "privacy": "private",
2837
- "description": "values to be applied to the component's transform on render",
2982
+ "privacy": "public",
2983
+ "description": "How narrow the space allocated to the default position has to be before the widest area\nis selected for layout",
2838
2984
  "inheritedFrom": {
2839
2985
  "name": "AnchoredRegion",
2840
2986
  "module": "src/anchored-region/anchored-region.ts"
2841
2987
  }
2842
2988
  },
2843
2989
  {
2844
- "kind": "field",
2845
- "name": "translateY",
2846
- "type": {
2847
- "text": "number"
2848
- },
2990
+ "kind": "method",
2991
+ "name": "horizontalThresholdChanged",
2849
2992
  "privacy": "private",
2993
+ "return": {
2994
+ "type": {
2995
+ "text": "void"
2996
+ }
2997
+ },
2850
2998
  "inheritedFrom": {
2851
2999
  "name": "AnchoredRegion",
2852
3000
  "module": "src/anchored-region/anchored-region.ts"
@@ -2854,24 +3002,27 @@
2854
3002
  },
2855
3003
  {
2856
3004
  "kind": "field",
2857
- "name": "regionWidth",
3005
+ "name": "horizontalScaling",
2858
3006
  "type": {
2859
- "text": "string"
3007
+ "text": "AxisScalingMode"
2860
3008
  },
2861
- "privacy": "private",
2862
- "description": "the span to be applied to the region on each axis",
3009
+ "privacy": "public",
3010
+ "default": "\"content\"",
3011
+ "description": "Defines how the width of the region is calculated",
2863
3012
  "inheritedFrom": {
2864
3013
  "name": "AnchoredRegion",
2865
3014
  "module": "src/anchored-region/anchored-region.ts"
2866
3015
  }
2867
3016
  },
2868
3017
  {
2869
- "kind": "field",
2870
- "name": "regionHeight",
2871
- "type": {
2872
- "text": "string"
2873
- },
3018
+ "kind": "method",
3019
+ "name": "horizontalScalingChanged",
2874
3020
  "privacy": "private",
3021
+ "return": {
3022
+ "type": {
3023
+ "text": "void"
3024
+ }
3025
+ },
2875
3026
  "inheritedFrom": {
2876
3027
  "name": "AnchoredRegion",
2877
3028
  "module": "src/anchored-region/anchored-region.ts"
@@ -2879,24 +3030,27 @@
2879
3030
  },
2880
3031
  {
2881
3032
  "kind": "field",
2882
- "name": "resizeDetector",
3033
+ "name": "verticalPositioningMode",
2883
3034
  "type": {
2884
- "text": "ResizeObserverClassDefinition | null"
3035
+ "text": "AxisPositioningMode"
2885
3036
  },
2886
- "privacy": "private",
2887
- "default": "null",
3037
+ "privacy": "public",
3038
+ "default": "\"uncontrolled\"",
3039
+ "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",
2888
3040
  "inheritedFrom": {
2889
3041
  "name": "AnchoredRegion",
2890
3042
  "module": "src/anchored-region/anchored-region.ts"
2891
3043
  }
2892
3044
  },
2893
3045
  {
2894
- "kind": "field",
2895
- "name": "viewportRect",
2896
- "type": {
2897
- "text": "ClientRect | DOMRect | undefined"
2898
- },
3046
+ "kind": "method",
3047
+ "name": "verticalPositioningModeChanged",
2899
3048
  "privacy": "private",
3049
+ "return": {
3050
+ "type": {
3051
+ "text": "void"
3052
+ }
3053
+ },
2900
3054
  "inheritedFrom": {
2901
3055
  "name": "AnchoredRegion",
2902
3056
  "module": "src/anchored-region/anchored-region.ts"
@@ -2904,23 +3058,27 @@
2904
3058
  },
2905
3059
  {
2906
3060
  "kind": "field",
2907
- "name": "anchorRect",
3061
+ "name": "verticalDefaultPosition",
2908
3062
  "type": {
2909
- "text": "ClientRect | DOMRect | undefined"
3063
+ "text": "VerticalPosition"
2910
3064
  },
2911
- "privacy": "private",
3065
+ "privacy": "public",
3066
+ "default": "\"unset\"",
3067
+ "description": "The default vertical position of the region relative to the anchor element",
2912
3068
  "inheritedFrom": {
2913
3069
  "name": "AnchoredRegion",
2914
3070
  "module": "src/anchored-region/anchored-region.ts"
2915
3071
  }
2916
3072
  },
2917
3073
  {
2918
- "kind": "field",
2919
- "name": "regionRect",
2920
- "type": {
2921
- "text": "ClientRect | DOMRect | undefined"
2922
- },
3074
+ "kind": "method",
3075
+ "name": "verticalDefaultPositionChanged",
2923
3076
  "privacy": "private",
3077
+ "return": {
3078
+ "type": {
3079
+ "text": "void"
3080
+ }
3081
+ },
2924
3082
  "inheritedFrom": {
2925
3083
  "name": "AnchoredRegion",
2926
3084
  "module": "src/anchored-region/anchored-region.ts"
@@ -2928,26 +3086,27 @@
2928
3086
  },
2929
3087
  {
2930
3088
  "kind": "field",
2931
- "name": "baseHorizontalOffset",
3089
+ "name": "verticalViewportLock",
2932
3090
  "type": {
2933
- "text": "number"
3091
+ "text": "boolean"
2934
3092
  },
2935
- "privacy": "private",
2936
- "default": "0",
2937
- "description": "base offsets between the positioner's base position and the anchor's",
3093
+ "privacy": "public",
3094
+ "default": "false",
3095
+ "description": "Whether the region remains in the viewport (ie. detaches from the anchor) on the vertical axis",
2938
3096
  "inheritedFrom": {
2939
3097
  "name": "AnchoredRegion",
2940
3098
  "module": "src/anchored-region/anchored-region.ts"
2941
3099
  }
2942
3100
  },
2943
3101
  {
2944
- "kind": "field",
2945
- "name": "baseVerticalOffset",
2946
- "type": {
2947
- "text": "number"
2948
- },
3102
+ "kind": "method",
3103
+ "name": "verticalViewportLockChanged",
2949
3104
  "privacy": "private",
2950
- "default": "0",
3105
+ "return": {
3106
+ "type": {
3107
+ "text": "void"
3108
+ }
3109
+ },
2951
3110
  "inheritedFrom": {
2952
3111
  "name": "AnchoredRegion",
2953
3112
  "module": "src/anchored-region/anchored-region.ts"
@@ -2955,25 +3114,27 @@
2955
3114
  },
2956
3115
  {
2957
3116
  "kind": "field",
2958
- "name": "pendingPositioningUpdate",
3117
+ "name": "verticalInset",
2959
3118
  "type": {
2960
3119
  "text": "boolean"
2961
3120
  },
2962
- "privacy": "private",
3121
+ "privacy": "public",
2963
3122
  "default": "false",
3123
+ "description": "Whether the region overlaps the anchor on the vertical axis",
2964
3124
  "inheritedFrom": {
2965
3125
  "name": "AnchoredRegion",
2966
3126
  "module": "src/anchored-region/anchored-region.ts"
2967
3127
  }
2968
3128
  },
2969
3129
  {
2970
- "kind": "field",
2971
- "name": "pendingReset",
2972
- "type": {
2973
- "text": "boolean"
2974
- },
3130
+ "kind": "method",
3131
+ "name": "verticalInsetChanged",
2975
3132
  "privacy": "private",
2976
- "default": "false",
3133
+ "return": {
3134
+ "type": {
3135
+ "text": "void"
3136
+ }
3137
+ },
2977
3138
  "inheritedFrom": {
2978
3139
  "name": "AnchoredRegion",
2979
3140
  "module": "src/anchored-region/anchored-region.ts"
@@ -2981,24 +3142,26 @@
2981
3142
  },
2982
3143
  {
2983
3144
  "kind": "field",
2984
- "name": "currentDirection",
3145
+ "name": "verticalThreshold",
2985
3146
  "type": {
2986
- "text": "Direction"
3147
+ "text": "number"
2987
3148
  },
2988
- "privacy": "private",
3149
+ "privacy": "public",
3150
+ "description": "How short the space allocated to the default position has to be before the tallest area\nis selected for layout",
2989
3151
  "inheritedFrom": {
2990
3152
  "name": "AnchoredRegion",
2991
3153
  "module": "src/anchored-region/anchored-region.ts"
2992
3154
  }
2993
3155
  },
2994
3156
  {
2995
- "kind": "field",
2996
- "name": "regionVisible",
2997
- "type": {
2998
- "text": "boolean"
2999
- },
3157
+ "kind": "method",
3158
+ "name": "verticalThresholdChanged",
3000
3159
  "privacy": "private",
3001
- "default": "false",
3160
+ "return": {
3161
+ "type": {
3162
+ "text": "void"
3163
+ }
3164
+ },
3002
3165
  "inheritedFrom": {
3003
3166
  "name": "AnchoredRegion",
3004
3167
  "module": "src/anchored-region/anchored-region.ts"
@@ -3006,25 +3169,27 @@
3006
3169
  },
3007
3170
  {
3008
3171
  "kind": "field",
3009
- "name": "forceUpdate",
3172
+ "name": "verticalScaling",
3010
3173
  "type": {
3011
- "text": "boolean"
3174
+ "text": "AxisScalingMode"
3012
3175
  },
3013
- "privacy": "private",
3014
- "default": "false",
3176
+ "privacy": "public",
3177
+ "default": "\"content\"",
3178
+ "description": "Defines how the height of the region is calculated",
3015
3179
  "inheritedFrom": {
3016
3180
  "name": "AnchoredRegion",
3017
3181
  "module": "src/anchored-region/anchored-region.ts"
3018
3182
  }
3019
3183
  },
3020
3184
  {
3021
- "kind": "field",
3022
- "name": "updateThreshold",
3023
- "type": {
3024
- "text": "number"
3025
- },
3185
+ "kind": "method",
3186
+ "name": "verticalScalingChanged",
3026
3187
  "privacy": "private",
3027
- "default": "0.5",
3188
+ "return": {
3189
+ "type": {
3190
+ "text": "void"
3191
+ }
3192
+ },
3028
3193
  "inheritedFrom": {
3029
3194
  "name": "AnchoredRegion",
3030
3195
  "module": "src/anchored-region/anchored-region.ts"
@@ -3032,23 +3197,13 @@
3032
3197
  },
3033
3198
  {
3034
3199
  "kind": "field",
3035
- "name": "intersectionService",
3200
+ "name": "fixedPlacement",
3036
3201
  "type": {
3037
- "text": "IntersectionService"
3202
+ "text": "boolean"
3038
3203
  },
3039
- "privacy": "private",
3040
- "static": true,
3041
- "default": "new IntersectionService()",
3042
- "inheritedFrom": {
3043
- "name": "AnchoredRegion",
3044
- "module": "src/anchored-region/anchored-region.ts"
3045
- }
3046
- },
3047
- {
3048
- "kind": "field",
3049
- "name": "update",
3050
3204
  "privacy": "public",
3051
- "description": "update position",
3205
+ "default": "false",
3206
+ "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,",
3052
3207
  "inheritedFrom": {
3053
3208
  "name": "AnchoredRegion",
3054
3209
  "module": "src/anchored-region/anchored-region.ts"
@@ -3056,29 +3211,27 @@
3056
3211
  },
3057
3212
  {
3058
3213
  "kind": "method",
3059
- "name": "disconnectResizeDetector",
3214
+ "name": "fixedPlacementChanged",
3060
3215
  "privacy": "private",
3061
3216
  "return": {
3062
3217
  "type": {
3063
3218
  "text": "void"
3064
3219
  }
3065
3220
  },
3066
- "description": "destroys the instance's resize observer",
3067
3221
  "inheritedFrom": {
3068
3222
  "name": "AnchoredRegion",
3069
3223
  "module": "src/anchored-region/anchored-region.ts"
3070
3224
  }
3071
3225
  },
3072
3226
  {
3073
- "kind": "method",
3074
- "name": "initializeResizeDetector",
3075
- "privacy": "private",
3076
- "return": {
3077
- "type": {
3078
- "text": "void"
3079
- }
3227
+ "kind": "field",
3228
+ "name": "autoUpdateMode",
3229
+ "type": {
3230
+ "text": "AutoUpdateMode"
3080
3231
  },
3081
- "description": "initializes the instance's resize observer",
3232
+ "privacy": "public",
3233
+ "default": "\"anchor\"",
3234
+ "description": "Defines what triggers the anchored region to revaluate positioning",
3082
3235
  "inheritedFrom": {
3083
3236
  "name": "AnchoredRegion",
3084
3237
  "module": "src/anchored-region/anchored-region.ts"
@@ -3086,29 +3239,41 @@
3086
3239
  },
3087
3240
  {
3088
3241
  "kind": "method",
3089
- "name": "updateForAttributeChange",
3242
+ "name": "autoUpdateModeChanged",
3090
3243
  "privacy": "private",
3091
3244
  "return": {
3092
3245
  "type": {
3093
3246
  "text": "void"
3094
3247
  }
3095
3248
  },
3096
- "description": "react to attribute changes that don't require a reset",
3249
+ "parameters": [
3250
+ {
3251
+ "name": "prevMode",
3252
+ "type": {
3253
+ "text": "AutoUpdateMode"
3254
+ }
3255
+ },
3256
+ {
3257
+ "name": "newMode",
3258
+ "type": {
3259
+ "text": "AutoUpdateMode"
3260
+ }
3261
+ }
3262
+ ],
3097
3263
  "inheritedFrom": {
3098
3264
  "name": "AnchoredRegion",
3099
3265
  "module": "src/anchored-region/anchored-region.ts"
3100
3266
  }
3101
3267
  },
3102
3268
  {
3103
- "kind": "method",
3104
- "name": "initialize",
3105
- "privacy": "private",
3106
- "return": {
3107
- "type": {
3108
- "text": "void"
3109
- }
3269
+ "kind": "field",
3270
+ "name": "anchorElement",
3271
+ "type": {
3272
+ "text": "HTMLElement | null"
3110
3273
  },
3111
- "description": "fully initializes the component",
3274
+ "privacy": "public",
3275
+ "default": "null",
3276
+ "description": "The HTML element being used as the anchor",
3112
3277
  "inheritedFrom": {
3113
3278
  "name": "AnchoredRegion",
3114
3279
  "module": "src/anchored-region/anchored-region.ts"
@@ -3116,14 +3281,27 @@
3116
3281
  },
3117
3282
  {
3118
3283
  "kind": "method",
3119
- "name": "requestReset",
3284
+ "name": "anchorElementChanged",
3120
3285
  "privacy": "private",
3121
3286
  "return": {
3122
3287
  "type": {
3123
3288
  "text": "void"
3124
3289
  }
3125
3290
  },
3126
- "description": "Request a reset if there are currently no open requests",
3291
+ "inheritedFrom": {
3292
+ "name": "AnchoredRegion",
3293
+ "module": "src/anchored-region/anchored-region.ts"
3294
+ }
3295
+ },
3296
+ {
3297
+ "kind": "field",
3298
+ "name": "viewportElement",
3299
+ "type": {
3300
+ "text": "HTMLElement | null"
3301
+ },
3302
+ "privacy": "public",
3303
+ "default": "null",
3304
+ "description": "The HTML element being used as the viewport",
3127
3305
  "inheritedFrom": {
3128
3306
  "name": "AnchoredRegion",
3129
3307
  "module": "src/anchored-region/anchored-region.ts"
@@ -3131,14 +3309,13 @@
3131
3309
  },
3132
3310
  {
3133
3311
  "kind": "method",
3134
- "name": "setInitialState",
3312
+ "name": "viewportElementChanged",
3135
3313
  "privacy": "private",
3136
3314
  "return": {
3137
3315
  "type": {
3138
3316
  "text": "void"
3139
3317
  }
3140
3318
  },
3141
- "description": "sets the starting configuration for component internal values",
3142
3319
  "inheritedFrom": {
3143
3320
  "name": "AnchoredRegion",
3144
3321
  "module": "src/anchored-region/anchored-region.ts"
@@ -3146,9 +3323,12 @@
3146
3323
  },
3147
3324
  {
3148
3325
  "kind": "field",
3149
- "name": "startObservers",
3150
- "privacy": "private",
3151
- "description": "starts observers",
3326
+ "name": "verticalPosition",
3327
+ "type": {
3328
+ "text": "AnchoredRegionPositionLabel | undefined"
3329
+ },
3330
+ "privacy": "public",
3331
+ "description": "indicates the current horizontal position of the region",
3152
3332
  "inheritedFrom": {
3153
3333
  "name": "AnchoredRegion",
3154
3334
  "module": "src/anchored-region/anchored-region.ts"
@@ -3156,9 +3336,12 @@
3156
3336
  },
3157
3337
  {
3158
3338
  "kind": "field",
3159
- "name": "requestPositionUpdates",
3160
- "privacy": "private",
3161
- "description": "get position updates",
3339
+ "name": "horizontalPosition",
3340
+ "type": {
3341
+ "text": "AnchoredRegionPositionLabel | undefined"
3342
+ },
3343
+ "privacy": "public",
3344
+ "description": "indicates the current vertical position of the region",
3162
3345
  "inheritedFrom": {
3163
3346
  "name": "AnchoredRegion",
3164
3347
  "module": "src/anchored-region/anchored-region.ts"
@@ -3166,9 +3349,12 @@
3166
3349
  },
3167
3350
  {
3168
3351
  "kind": "field",
3169
- "name": "stopObservers",
3352
+ "name": "translateX",
3353
+ "type": {
3354
+ "text": "number"
3355
+ },
3170
3356
  "privacy": "private",
3171
- "description": "stops observers",
3357
+ "description": "values to be applied to the component's transform on render",
3172
3358
  "inheritedFrom": {
3173
3359
  "name": "AnchoredRegion",
3174
3360
  "module": "src/anchored-region/anchored-region.ts"
@@ -3176,9 +3362,11 @@
3176
3362
  },
3177
3363
  {
3178
3364
  "kind": "field",
3179
- "name": "getViewport",
3365
+ "name": "translateY",
3366
+ "type": {
3367
+ "text": "number"
3368
+ },
3180
3369
  "privacy": "private",
3181
- "description": "Gets the viewport element by id, or defaults to document root",
3182
3370
  "inheritedFrom": {
3183
3371
  "name": "AnchoredRegion",
3184
3372
  "module": "src/anchored-region/anchored-region.ts"
@@ -3186,9 +3374,12 @@
3186
3374
  },
3187
3375
  {
3188
3376
  "kind": "field",
3189
- "name": "getAnchor",
3377
+ "name": "regionWidth",
3378
+ "type": {
3379
+ "text": "string"
3380
+ },
3190
3381
  "privacy": "private",
3191
- "description": "Gets the anchor element by id",
3382
+ "description": "the span to be applied to the region on each axis",
3192
3383
  "inheritedFrom": {
3193
3384
  "name": "AnchoredRegion",
3194
3385
  "module": "src/anchored-region/anchored-region.ts"
@@ -3196,9 +3387,11 @@
3196
3387
  },
3197
3388
  {
3198
3389
  "kind": "field",
3199
- "name": "handleIntersection",
3390
+ "name": "regionHeight",
3391
+ "type": {
3392
+ "text": "string"
3393
+ },
3200
3394
  "privacy": "private",
3201
- "description": "Handle intersections",
3202
3395
  "inheritedFrom": {
3203
3396
  "name": "AnchoredRegion",
3204
3397
  "module": "src/anchored-region/anchored-region.ts"
@@ -3206,9 +3399,12 @@
3206
3399
  },
3207
3400
  {
3208
3401
  "kind": "field",
3209
- "name": "applyIntersectionEntries",
3402
+ "name": "resizeDetector",
3403
+ "type": {
3404
+ "text": "ResizeObserverClassDefinition | null"
3405
+ },
3210
3406
  "privacy": "private",
3211
- "description": "iterate through intersection entries and apply data",
3407
+ "default": "null",
3212
3408
  "inheritedFrom": {
3213
3409
  "name": "AnchoredRegion",
3214
3410
  "module": "src/anchored-region/anchored-region.ts"
@@ -3216,9 +3412,11 @@
3216
3412
  },
3217
3413
  {
3218
3414
  "kind": "field",
3219
- "name": "updateRegionOffset",
3415
+ "name": "viewportRect",
3416
+ "type": {
3417
+ "text": "ClientRect | DOMRect | undefined"
3418
+ },
3220
3419
  "privacy": "private",
3221
- "description": "Update the offset values",
3222
3420
  "inheritedFrom": {
3223
3421
  "name": "AnchoredRegion",
3224
3422
  "module": "src/anchored-region/anchored-region.ts"
@@ -3226,9 +3424,11 @@
3226
3424
  },
3227
3425
  {
3228
3426
  "kind": "field",
3229
- "name": "isRectDifferent",
3427
+ "name": "anchorRect",
3428
+ "type": {
3429
+ "text": "ClientRect | DOMRect | undefined"
3430
+ },
3230
3431
  "privacy": "private",
3231
- "description": "compare rects to see if there is enough change to justify a DOM update",
3232
3432
  "inheritedFrom": {
3233
3433
  "name": "AnchoredRegion",
3234
3434
  "module": "src/anchored-region/anchored-region.ts"
@@ -3236,9 +3436,11 @@
3236
3436
  },
3237
3437
  {
3238
3438
  "kind": "field",
3239
- "name": "handleResize",
3439
+ "name": "regionRect",
3440
+ "type": {
3441
+ "text": "ClientRect | DOMRect | undefined"
3442
+ },
3240
3443
  "privacy": "private",
3241
- "description": "Handle resize events",
3242
3444
  "inheritedFrom": {
3243
3445
  "name": "AnchoredRegion",
3244
3446
  "module": "src/anchored-region/anchored-region.ts"
@@ -3246,9 +3448,13 @@
3246
3448
  },
3247
3449
  {
3248
3450
  "kind": "field",
3249
- "name": "reset",
3451
+ "name": "baseHorizontalOffset",
3452
+ "type": {
3453
+ "text": "number"
3454
+ },
3250
3455
  "privacy": "private",
3251
- "description": "resets the component",
3456
+ "default": "0",
3457
+ "description": "base offsets between the positioner's base position and the anchor's",
3252
3458
  "inheritedFrom": {
3253
3459
  "name": "AnchoredRegion",
3254
3460
  "module": "src/anchored-region/anchored-region.ts"
@@ -3256,9 +3462,12 @@
3256
3462
  },
3257
3463
  {
3258
3464
  "kind": "field",
3259
- "name": "updateLayout",
3465
+ "name": "baseVerticalOffset",
3466
+ "type": {
3467
+ "text": "number"
3468
+ },
3260
3469
  "privacy": "private",
3261
- "description": "Recalculate layout related state values",
3470
+ "default": "0",
3262
3471
  "inheritedFrom": {
3263
3472
  "name": "AnchoredRegion",
3264
3473
  "module": "src/anchored-region/anchored-region.ts"
@@ -3266,9 +3475,12 @@
3266
3475
  },
3267
3476
  {
3268
3477
  "kind": "field",
3269
- "name": "updateRegionStyle",
3478
+ "name": "pendingPositioningUpdate",
3479
+ "type": {
3480
+ "text": "boolean"
3481
+ },
3270
3482
  "privacy": "private",
3271
- "description": "Updates the style string applied to the region element as well as the css classes attached\nto the root element",
3483
+ "default": "false",
3272
3484
  "inheritedFrom": {
3273
3485
  "name": "AnchoredRegion",
3274
3486
  "module": "src/anchored-region/anchored-region.ts"
@@ -3276,9 +3488,12 @@
3276
3488
  },
3277
3489
  {
3278
3490
  "kind": "field",
3279
- "name": "updatePositionClasses",
3491
+ "name": "pendingReset",
3492
+ "type": {
3493
+ "text": "boolean"
3494
+ },
3280
3495
  "privacy": "private",
3281
- "description": "Updates the css classes that reflect the current position of the element",
3496
+ "default": "false",
3282
3497
  "inheritedFrom": {
3283
3498
  "name": "AnchoredRegion",
3284
3499
  "module": "src/anchored-region/anchored-region.ts"
@@ -3286,9 +3501,11 @@
3286
3501
  },
3287
3502
  {
3288
3503
  "kind": "field",
3289
- "name": "setHorizontalPosition",
3504
+ "name": "currentDirection",
3505
+ "type": {
3506
+ "text": "Direction"
3507
+ },
3290
3508
  "privacy": "private",
3291
- "description": "Get horizontal positioning state based on desired position",
3292
3509
  "inheritedFrom": {
3293
3510
  "name": "AnchoredRegion",
3294
3511
  "module": "src/anchored-region/anchored-region.ts"
@@ -3296,9 +3513,12 @@
3296
3513
  },
3297
3514
  {
3298
3515
  "kind": "field",
3299
- "name": "setVerticalPosition",
3516
+ "name": "regionVisible",
3517
+ "type": {
3518
+ "text": "boolean"
3519
+ },
3300
3520
  "privacy": "private",
3301
- "description": "Set vertical positioning state based on desired position",
3521
+ "default": "false",
3302
3522
  "inheritedFrom": {
3303
3523
  "name": "AnchoredRegion",
3304
3524
  "module": "src/anchored-region/anchored-region.ts"
@@ -3306,9 +3526,12 @@
3306
3526
  },
3307
3527
  {
3308
3528
  "kind": "field",
3309
- "name": "getPositioningOptions",
3529
+ "name": "forceUpdate",
3530
+ "type": {
3531
+ "text": "boolean"
3532
+ },
3310
3533
  "privacy": "private",
3311
- "description": "Get available positions based on positioning mode",
3534
+ "default": "false",
3312
3535
  "inheritedFrom": {
3313
3536
  "name": "AnchoredRegion",
3314
3537
  "module": "src/anchored-region/anchored-region.ts"
@@ -3316,9 +3539,12 @@
3316
3539
  },
3317
3540
  {
3318
3541
  "kind": "field",
3319
- "name": "getAvailableSpace",
3542
+ "name": "updateThreshold",
3543
+ "type": {
3544
+ "text": "number"
3545
+ },
3320
3546
  "privacy": "private",
3321
- "description": "Get the space available for a particular relative position",
3547
+ "default": "0.5",
3322
3548
  "inheritedFrom": {
3323
3549
  "name": "AnchoredRegion",
3324
3550
  "module": "src/anchored-region/anchored-region.ts"
@@ -3326,9 +3552,13 @@
3326
3552
  },
3327
3553
  {
3328
3554
  "kind": "field",
3329
- "name": "getNextRegionDimension",
3555
+ "name": "intersectionService",
3556
+ "type": {
3557
+ "text": "IntersectionService"
3558
+ },
3330
3559
  "privacy": "private",
3331
- "description": "Get region dimensions",
3560
+ "static": true,
3561
+ "default": "new IntersectionService()",
3332
3562
  "inheritedFrom": {
3333
3563
  "name": "AnchoredRegion",
3334
3564
  "module": "src/anchored-region/anchored-region.ts"
@@ -3336,560 +3566,312 @@
3336
3566
  },
3337
3567
  {
3338
3568
  "kind": "field",
3339
- "name": "startAutoUpdateEventListeners",
3340
- "privacy": "private",
3341
- "description": "starts event listeners that can trigger auto updating",
3569
+ "name": "update",
3570
+ "privacy": "public",
3571
+ "description": "update position",
3342
3572
  "inheritedFrom": {
3343
3573
  "name": "AnchoredRegion",
3344
3574
  "module": "src/anchored-region/anchored-region.ts"
3345
3575
  }
3346
3576
  },
3347
3577
  {
3348
- "kind": "field",
3349
- "name": "stopAutoUpdateEventListeners",
3578
+ "kind": "method",
3579
+ "name": "disconnectResizeDetector",
3350
3580
  "privacy": "private",
3351
- "description": "stops event listeners that can trigger auto updating",
3581
+ "return": {
3582
+ "type": {
3583
+ "text": "void"
3584
+ }
3585
+ },
3586
+ "description": "destroys the instance's resize observer",
3352
3587
  "inheritedFrom": {
3353
3588
  "name": "AnchoredRegion",
3354
3589
  "module": "src/anchored-region/anchored-region.ts"
3355
3590
  }
3356
3591
  },
3357
3592
  {
3358
- "kind": "field",
3359
- "name": "_presentation",
3360
- "type": {
3361
- "text": "ComponentPresentation | null | undefined"
3362
- },
3593
+ "kind": "method",
3594
+ "name": "initializeResizeDetector",
3363
3595
  "privacy": "private",
3364
- "default": "void 0",
3365
- "inheritedFrom": {
3366
- "name": "FoundationElement",
3367
- "module": "src/foundation-element/foundation-element.ts"
3368
- }
3369
- },
3370
- {
3371
- "kind": "field",
3372
- "name": "$presentation",
3373
- "type": {
3374
- "text": "ComponentPresentation | null"
3375
- },
3376
- "privacy": "public",
3377
- "description": "A property which resolves the ComponentPresentation instance\nfor the current component.",
3378
- "inheritedFrom": {
3379
- "name": "FoundationElement",
3380
- "module": "src/foundation-element/foundation-element.ts"
3381
- }
3382
- },
3383
- {
3384
- "kind": "field",
3385
- "name": "template",
3386
- "type": {
3387
- "text": "ElementViewTemplate | void | null"
3596
+ "return": {
3597
+ "type": {
3598
+ "text": "void"
3599
+ }
3388
3600
  },
3389
- "privacy": "public",
3390
- "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.",
3601
+ "description": "initializes the instance's resize observer",
3391
3602
  "inheritedFrom": {
3392
- "name": "FoundationElement",
3393
- "module": "src/foundation-element/foundation-element.ts"
3603
+ "name": "AnchoredRegion",
3604
+ "module": "src/anchored-region/anchored-region.ts"
3394
3605
  }
3395
3606
  },
3396
3607
  {
3397
3608
  "kind": "method",
3398
- "name": "templateChanged",
3399
- "privacy": "protected",
3609
+ "name": "updateForAttributeChange",
3610
+ "privacy": "private",
3400
3611
  "return": {
3401
3612
  "type": {
3402
3613
  "text": "void"
3403
3614
  }
3404
3615
  },
3616
+ "description": "react to attribute changes that don't require a reset",
3405
3617
  "inheritedFrom": {
3406
- "name": "FoundationElement",
3407
- "module": "src/foundation-element/foundation-element.ts"
3618
+ "name": "AnchoredRegion",
3619
+ "module": "src/anchored-region/anchored-region.ts"
3408
3620
  }
3409
3621
  },
3410
3622
  {
3411
- "kind": "field",
3412
- "name": "styles",
3413
- "type": {
3414
- "text": "ElementStyles | void | null"
3623
+ "kind": "method",
3624
+ "name": "initialize",
3625
+ "privacy": "private",
3626
+ "return": {
3627
+ "type": {
3628
+ "text": "void"
3629
+ }
3415
3630
  },
3416
- "privacy": "public",
3417
- "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.",
3631
+ "description": "fully initializes the component",
3418
3632
  "inheritedFrom": {
3419
- "name": "FoundationElement",
3420
- "module": "src/foundation-element/foundation-element.ts"
3633
+ "name": "AnchoredRegion",
3634
+ "module": "src/anchored-region/anchored-region.ts"
3421
3635
  }
3422
3636
  },
3423
3637
  {
3424
3638
  "kind": "method",
3425
- "name": "stylesChanged",
3426
- "privacy": "protected",
3639
+ "name": "requestReset",
3640
+ "privacy": "private",
3427
3641
  "return": {
3428
3642
  "type": {
3429
3643
  "text": "void"
3430
3644
  }
3431
3645
  },
3646
+ "description": "Request a reset if there are currently no open requests",
3432
3647
  "inheritedFrom": {
3433
- "name": "FoundationElement",
3434
- "module": "src/foundation-element/foundation-element.ts"
3648
+ "name": "AnchoredRegion",
3649
+ "module": "src/anchored-region/anchored-region.ts"
3435
3650
  }
3436
3651
  },
3437
3652
  {
3438
3653
  "kind": "method",
3439
- "name": "compose",
3440
- "privacy": "public",
3441
- "static": true,
3654
+ "name": "setInitialState",
3655
+ "privacy": "private",
3442
3656
  "return": {
3443
3657
  "type": {
3444
- "text": "(\n overrideDefinition?: OverrideFoundationElementDefinition<T>\n ) => FoundationElementRegistry<T, K>"
3658
+ "text": "void"
3445
3659
  }
3446
3660
  },
3447
- "parameters": [
3448
- {
3449
- "name": "this",
3450
- "type": {
3451
- "text": "K"
3452
- }
3453
- },
3454
- {
3455
- "name": "elementDefinition",
3456
- "type": {
3457
- "text": "T"
3458
- },
3459
- "description": "The definition of the element to create the registry\nfunction for."
3460
- }
3461
- ],
3462
- "description": "Defines an element registry function with a set of element definition defaults.",
3463
- "inheritedFrom": {
3464
- "name": "FoundationElement",
3465
- "module": "src/foundation-element/foundation-element.ts"
3466
- }
3467
- }
3468
- ],
3469
- "events": [
3470
- {
3471
- "description": "Fires a custom 'loaded' event when the region is loaded and visible",
3472
- "name": "loaded",
3661
+ "description": "sets the starting configuration for component internal values",
3473
3662
  "inheritedFrom": {
3474
3663
  "name": "AnchoredRegion",
3475
3664
  "module": "src/anchored-region/anchored-region.ts"
3476
3665
  }
3477
3666
  },
3478
3667
  {
3479
- "description": "Fires a custom 'positionchange' event when the position has changed",
3480
- "name": "positionchange",
3668
+ "kind": "field",
3669
+ "name": "startObservers",
3670
+ "privacy": "private",
3671
+ "description": "starts observers",
3481
3672
  "inheritedFrom": {
3482
3673
  "name": "AnchoredRegion",
3483
3674
  "module": "src/anchored-region/anchored-region.ts"
3484
3675
  }
3485
- }
3486
- ]
3487
- },
3488
- {
3489
- "kind": "variable",
3490
- "name": "foundationAnchoredRegionShadowOptions",
3491
- "type": {
3492
- "text": "ShadowRootInit"
3493
- },
3494
- "default": "{\n delegatesFocus: true,\n mode: 'open',\n}"
3495
- },
3496
- {
3497
- "kind": "variable",
3498
- "name": "defaultAnchoredRegionConfig",
3499
- "type": {
3500
- "text": "object"
3501
- },
3502
- "default": "{}"
3503
- },
3504
- {
3505
- "kind": "variable",
3506
- "name": "foundationAnchoredRegion",
3507
- "description": "The Foundation Anchored Region",
3508
- "privacy": "public"
3509
- }
3510
- ],
3511
- "exports": [
3512
- {
3513
- "kind": "js",
3514
- "name": "AnchoredRegion",
3515
- "declaration": {
3516
- "name": "AnchoredRegion",
3517
- "module": "src/anchored-region/anchored-region.ts"
3518
- }
3519
- },
3520
- {
3521
- "kind": "js",
3522
- "name": "foundationAnchoredRegionShadowOptions",
3523
- "declaration": {
3524
- "name": "foundationAnchoredRegionShadowOptions",
3525
- "module": "src/anchored-region/anchored-region.ts"
3526
- }
3527
- },
3528
- {
3529
- "kind": "js",
3530
- "name": "defaultAnchoredRegionConfig",
3531
- "declaration": {
3532
- "name": "defaultAnchoredRegionConfig",
3533
- "module": "src/anchored-region/anchored-region.ts"
3534
- }
3535
- },
3536
- {
3537
- "kind": "js",
3538
- "name": "foundationAnchoredRegion",
3539
- "declaration": {
3540
- "name": "foundationAnchoredRegion",
3541
- "module": "src/anchored-region/anchored-region.ts"
3542
- }
3543
- }
3544
- ]
3545
- },
3546
- {
3547
- "kind": "javascript-module",
3548
- "path": "src/anchored-region/index.ts",
3549
- "declarations": [],
3550
- "exports": [
3551
- {
3552
- "kind": "js",
3553
- "name": "*",
3554
- "declaration": {
3555
- "name": "*",
3556
- "package": "./anchor-region.template"
3557
- }
3558
- },
3559
- {
3560
- "kind": "js",
3561
- "name": "*",
3562
- "declaration": {
3563
- "name": "*",
3564
- "package": "./anchored-region.styles"
3565
- }
3566
- },
3567
- {
3568
- "kind": "js",
3569
- "name": "*",
3570
- "declaration": {
3571
- "name": "*",
3572
- "package": "./anchored-region"
3573
- }
3574
- }
3575
- ]
3576
- },
3577
- {
3578
- "kind": "javascript-module",
3579
- "path": "src/anchor/anchor.styles.ts",
3580
- "declarations": [
3581
- {
3582
- "kind": "function",
3583
- "name": "foundationAnchorStyles",
3584
- "return": {
3585
- "type": {
3586
- "text": "ElementStyles"
3587
- }
3588
- },
3589
- "parameters": [
3590
- {
3591
- "name": "context",
3592
- "type": {
3593
- "text": "ElementDefinitionContext"
3594
- }
3595
3676
  },
3596
3677
  {
3597
- "name": "definition",
3598
- "type": {
3599
- "text": "FoundationElementDefinition"
3600
- }
3601
- }
3602
- ]
3603
- }
3604
- ],
3605
- "exports": [
3606
- {
3607
- "kind": "js",
3608
- "name": "foundationAnchorStyles",
3609
- "declaration": {
3610
- "name": "foundationAnchorStyles",
3611
- "module": "src/anchor/anchor.styles.ts"
3612
- }
3613
- }
3614
- ]
3615
- },
3616
- {
3617
- "kind": "javascript-module",
3618
- "path": "src/anchor/anchor.template.ts",
3619
- "declarations": [
3620
- {
3621
- "kind": "function",
3622
- "name": "foundationAnchorTemplate",
3623
- "return": {
3624
- "type": {
3625
- "text": "ViewTemplate<Anchor>"
3626
- }
3627
- },
3628
- "parameters": [
3629
- {
3630
- "name": "context",
3631
- "type": {
3632
- "text": "ElementDefinitionContext"
3678
+ "kind": "field",
3679
+ "name": "requestPositionUpdates",
3680
+ "privacy": "private",
3681
+ "description": "get position updates",
3682
+ "inheritedFrom": {
3683
+ "name": "AnchoredRegion",
3684
+ "module": "src/anchored-region/anchored-region.ts"
3633
3685
  }
3634
3686
  },
3635
3687
  {
3636
- "name": "definition",
3637
- "type": {
3638
- "text": "FoundationElementDefinition"
3639
- }
3640
- }
3641
- ]
3642
- }
3643
- ],
3644
- "exports": [
3645
- {
3646
- "kind": "js",
3647
- "name": "foundationAnchorTemplate",
3648
- "declaration": {
3649
- "name": "foundationAnchorTemplate",
3650
- "module": "src/anchor/anchor.template.ts"
3651
- }
3652
- }
3653
- ]
3654
- },
3655
- {
3656
- "kind": "javascript-module",
3657
- "path": "src/anchor/anchor.ts",
3658
- "declarations": [
3659
- {
3660
- "kind": "class",
3661
- "description": "",
3662
- "name": "Anchor",
3663
- "superclass": {
3664
- "name": "FASTAnchor",
3665
- "package": "@microsoft/fast-components"
3666
- },
3667
- "tagName": "%%prefix%%-anchor",
3668
- "customElement": true,
3669
- "attributes": [
3670
- {
3671
- "name": "download",
3672
- "type": {
3673
- "text": "string"
3674
- },
3675
- "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.",
3676
- "fieldName": "download",
3688
+ "kind": "field",
3689
+ "name": "stopObservers",
3690
+ "privacy": "private",
3691
+ "description": "stops observers",
3677
3692
  "inheritedFrom": {
3678
- "name": "Anchor",
3679
- "module": "src/anchor/anchor.ts"
3693
+ "name": "AnchoredRegion",
3694
+ "module": "src/anchored-region/anchored-region.ts"
3680
3695
  }
3681
3696
  },
3682
3697
  {
3683
- "name": "href",
3684
- "type": {
3685
- "text": "string"
3686
- },
3687
- "description": "The URL the hyperlink references. See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a | <a> element for more information.",
3688
- "fieldName": "href",
3698
+ "kind": "field",
3699
+ "name": "getViewport",
3700
+ "privacy": "private",
3701
+ "description": "Gets the viewport element by id, or defaults to document root",
3689
3702
  "inheritedFrom": {
3690
- "name": "Anchor",
3691
- "module": "src/anchor/anchor.ts"
3703
+ "name": "AnchoredRegion",
3704
+ "module": "src/anchored-region/anchored-region.ts"
3692
3705
  }
3693
3706
  },
3694
3707
  {
3695
- "name": "hreflang",
3696
- "type": {
3697
- "text": "string"
3698
- },
3699
- "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.",
3700
- "fieldName": "hreflang",
3708
+ "kind": "field",
3709
+ "name": "getAnchor",
3710
+ "privacy": "private",
3711
+ "description": "Gets the anchor element by id",
3701
3712
  "inheritedFrom": {
3702
- "name": "Anchor",
3703
- "module": "src/anchor/anchor.ts"
3713
+ "name": "AnchoredRegion",
3714
+ "module": "src/anchored-region/anchored-region.ts"
3704
3715
  }
3705
3716
  },
3706
3717
  {
3707
- "name": "ping",
3708
- "type": {
3709
- "text": "string"
3710
- },
3711
- "description": "See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a | <a> element for more information.",
3712
- "fieldName": "ping",
3718
+ "kind": "field",
3719
+ "name": "handleIntersection",
3720
+ "privacy": "private",
3721
+ "description": "Handle intersections",
3722
+ "inheritedFrom": {
3723
+ "name": "AnchoredRegion",
3724
+ "module": "src/anchored-region/anchored-region.ts"
3725
+ }
3726
+ },
3727
+ {
3728
+ "kind": "field",
3729
+ "name": "applyIntersectionEntries",
3730
+ "privacy": "private",
3731
+ "description": "iterate through intersection entries and apply data",
3713
3732
  "inheritedFrom": {
3714
- "name": "Anchor",
3715
- "module": "src/anchor/anchor.ts"
3733
+ "name": "AnchoredRegion",
3734
+ "module": "src/anchored-region/anchored-region.ts"
3716
3735
  }
3717
3736
  },
3718
3737
  {
3719
- "name": "referrerpolicy",
3720
- "type": {
3721
- "text": "string"
3722
- },
3723
- "description": "See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a | <a> element for more information.",
3724
- "fieldName": "referrerpolicy",
3738
+ "kind": "field",
3739
+ "name": "updateRegionOffset",
3740
+ "privacy": "private",
3741
+ "description": "Update the offset values",
3725
3742
  "inheritedFrom": {
3726
- "name": "Anchor",
3727
- "module": "src/anchor/anchor.ts"
3743
+ "name": "AnchoredRegion",
3744
+ "module": "src/anchored-region/anchored-region.ts"
3728
3745
  }
3729
3746
  },
3730
3747
  {
3731
- "name": "rel",
3732
- "type": {
3733
- "text": "string"
3734
- },
3735
- "description": "See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a | <a> element for more information.",
3736
- "fieldName": "rel",
3748
+ "kind": "field",
3749
+ "name": "isRectDifferent",
3750
+ "privacy": "private",
3751
+ "description": "compare rects to see if there is enough change to justify a DOM update",
3737
3752
  "inheritedFrom": {
3738
- "name": "Anchor",
3739
- "module": "src/anchor/anchor.ts"
3753
+ "name": "AnchoredRegion",
3754
+ "module": "src/anchored-region/anchored-region.ts"
3740
3755
  }
3741
3756
  },
3742
3757
  {
3743
- "name": "target",
3744
- "type": {
3745
- "text": "\"_self\" | \"_blank\" | \"_parent\" | \"_top\""
3746
- },
3747
- "description": "See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a | <a> element for more information.",
3748
- "fieldName": "target",
3758
+ "kind": "field",
3759
+ "name": "handleResize",
3760
+ "privacy": "private",
3761
+ "description": "Handle resize events",
3749
3762
  "inheritedFrom": {
3750
- "name": "Anchor",
3751
- "module": "src/anchor/anchor.ts"
3763
+ "name": "AnchoredRegion",
3764
+ "module": "src/anchored-region/anchored-region.ts"
3752
3765
  }
3753
3766
  },
3754
3767
  {
3755
- "name": "type",
3756
- "type": {
3757
- "text": "string"
3758
- },
3759
- "description": "See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a | <a> element for more information.",
3760
- "fieldName": "type",
3768
+ "kind": "field",
3769
+ "name": "reset",
3770
+ "privacy": "private",
3771
+ "description": "resets the component",
3761
3772
  "inheritedFrom": {
3762
- "name": "Anchor",
3763
- "module": "src/anchor/anchor.ts"
3773
+ "name": "AnchoredRegion",
3774
+ "module": "src/anchored-region/anchored-region.ts"
3764
3775
  }
3765
- }
3766
- ],
3767
- "members": [
3776
+ },
3768
3777
  {
3769
3778
  "kind": "field",
3770
- "name": "download",
3771
- "type": {
3772
- "text": "string"
3773
- },
3774
- "privacy": "public",
3775
- "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.",
3779
+ "name": "updateLayout",
3780
+ "privacy": "private",
3781
+ "description": "Recalculate layout related state values",
3776
3782
  "inheritedFrom": {
3777
- "name": "Anchor",
3778
- "module": "src/anchor/anchor.ts"
3783
+ "name": "AnchoredRegion",
3784
+ "module": "src/anchored-region/anchored-region.ts"
3779
3785
  }
3780
3786
  },
3781
3787
  {
3782
3788
  "kind": "field",
3783
- "name": "href",
3784
- "type": {
3785
- "text": "string"
3786
- },
3787
- "privacy": "public",
3788
- "description": "The URL the hyperlink references. See {@link https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a | <a> element } for more information.",
3789
+ "name": "updateRegionStyle",
3790
+ "privacy": "private",
3791
+ "description": "Updates the style string applied to the region element as well as the css classes attached\nto the root element",
3789
3792
  "inheritedFrom": {
3790
- "name": "Anchor",
3791
- "module": "src/anchor/anchor.ts"
3793
+ "name": "AnchoredRegion",
3794
+ "module": "src/anchored-region/anchored-region.ts"
3792
3795
  }
3793
3796
  },
3794
3797
  {
3795
3798
  "kind": "field",
3796
- "name": "hreflang",
3797
- "type": {
3798
- "text": "string"
3799
- },
3800
- "privacy": "public",
3801
- "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.",
3799
+ "name": "updatePositionClasses",
3800
+ "privacy": "private",
3801
+ "description": "Updates the css classes that reflect the current position of the element",
3802
3802
  "inheritedFrom": {
3803
- "name": "Anchor",
3804
- "module": "src/anchor/anchor.ts"
3803
+ "name": "AnchoredRegion",
3804
+ "module": "src/anchored-region/anchored-region.ts"
3805
3805
  }
3806
3806
  },
3807
3807
  {
3808
3808
  "kind": "field",
3809
- "name": "ping",
3810
- "type": {
3811
- "text": "string"
3812
- },
3813
- "privacy": "public",
3814
- "description": "See {@link https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a | <a> element } for more information.",
3809
+ "name": "setHorizontalPosition",
3810
+ "privacy": "private",
3811
+ "description": "Get horizontal positioning state based on desired position",
3815
3812
  "inheritedFrom": {
3816
- "name": "Anchor",
3817
- "module": "src/anchor/anchor.ts"
3813
+ "name": "AnchoredRegion",
3814
+ "module": "src/anchored-region/anchored-region.ts"
3818
3815
  }
3819
3816
  },
3820
3817
  {
3821
3818
  "kind": "field",
3822
- "name": "referrerpolicy",
3823
- "type": {
3824
- "text": "string"
3825
- },
3826
- "privacy": "public",
3827
- "description": "See {@link https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a | <a> element } for more information.",
3819
+ "name": "setVerticalPosition",
3820
+ "privacy": "private",
3821
+ "description": "Set vertical positioning state based on desired position",
3828
3822
  "inheritedFrom": {
3829
- "name": "Anchor",
3830
- "module": "src/anchor/anchor.ts"
3823
+ "name": "AnchoredRegion",
3824
+ "module": "src/anchored-region/anchored-region.ts"
3831
3825
  }
3832
3826
  },
3833
3827
  {
3834
3828
  "kind": "field",
3835
- "name": "rel",
3836
- "type": {
3837
- "text": "string"
3838
- },
3839
- "privacy": "public",
3840
- "description": "See {@link https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a | <a> element } for more information.",
3829
+ "name": "getPositioningOptions",
3830
+ "privacy": "private",
3831
+ "description": "Get available positions based on positioning mode",
3841
3832
  "inheritedFrom": {
3842
- "name": "Anchor",
3843
- "module": "src/anchor/anchor.ts"
3833
+ "name": "AnchoredRegion",
3834
+ "module": "src/anchored-region/anchored-region.ts"
3844
3835
  }
3845
3836
  },
3846
3837
  {
3847
3838
  "kind": "field",
3848
- "name": "target",
3849
- "type": {
3850
- "text": "\"_self\" | \"_blank\" | \"_parent\" | \"_top\""
3851
- },
3852
- "privacy": "public",
3853
- "description": "See {@link https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a | <a> element } for more information.",
3839
+ "name": "getAvailableSpace",
3840
+ "privacy": "private",
3841
+ "description": "Get the space available for a particular relative position",
3854
3842
  "inheritedFrom": {
3855
- "name": "Anchor",
3856
- "module": "src/anchor/anchor.ts"
3843
+ "name": "AnchoredRegion",
3844
+ "module": "src/anchored-region/anchored-region.ts"
3857
3845
  }
3858
3846
  },
3859
3847
  {
3860
3848
  "kind": "field",
3861
- "name": "type",
3862
- "type": {
3863
- "text": "string"
3864
- },
3865
- "privacy": "public",
3866
- "description": "See {@link https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a | <a> element } for more information.",
3849
+ "name": "getNextRegionDimension",
3850
+ "privacy": "private",
3851
+ "description": "Get region dimensions",
3867
3852
  "inheritedFrom": {
3868
- "name": "Anchor",
3869
- "module": "src/anchor/anchor.ts"
3853
+ "name": "AnchoredRegion",
3854
+ "module": "src/anchored-region/anchored-region.ts"
3870
3855
  }
3871
3856
  },
3872
3857
  {
3873
3858
  "kind": "field",
3874
- "name": "control",
3875
- "type": {
3876
- "text": "HTMLAnchorElement | undefined"
3877
- },
3878
- "privacy": "public",
3879
- "description": "References the root element",
3859
+ "name": "startAutoUpdateEventListeners",
3860
+ "privacy": "private",
3861
+ "description": "starts event listeners that can trigger auto updating",
3880
3862
  "inheritedFrom": {
3881
- "name": "Anchor",
3882
- "module": "src/anchor/anchor.ts"
3863
+ "name": "AnchoredRegion",
3864
+ "module": "src/anchored-region/anchored-region.ts"
3883
3865
  }
3884
3866
  },
3885
3867
  {
3886
3868
  "kind": "field",
3887
- "name": "handleUnsupportedDelegatesFocus",
3869
+ "name": "stopAutoUpdateEventListeners",
3888
3870
  "privacy": "private",
3889
- "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",
3871
+ "description": "stops event listeners that can trigger auto updating",
3890
3872
  "inheritedFrom": {
3891
- "name": "Anchor",
3892
- "module": "src/anchor/anchor.ts"
3873
+ "name": "AnchoredRegion",
3874
+ "module": "src/anchored-region/anchored-region.ts"
3893
3875
  }
3894
3876
  },
3895
3877
  {
@@ -4003,11 +3985,29 @@
4003
3985
  "module": "src/foundation-element/foundation-element.ts"
4004
3986
  }
4005
3987
  }
3988
+ ],
3989
+ "events": [
3990
+ {
3991
+ "description": "Fires a custom 'loaded' event when the region is loaded and visible",
3992
+ "name": "loaded",
3993
+ "inheritedFrom": {
3994
+ "name": "AnchoredRegion",
3995
+ "module": "src/anchored-region/anchored-region.ts"
3996
+ }
3997
+ },
3998
+ {
3999
+ "description": "Fires a custom 'positionchange' event when the position has changed",
4000
+ "name": "positionchange",
4001
+ "inheritedFrom": {
4002
+ "name": "AnchoredRegion",
4003
+ "module": "src/anchored-region/anchored-region.ts"
4004
+ }
4005
+ }
4006
4006
  ]
4007
4007
  },
4008
4008
  {
4009
4009
  "kind": "variable",
4010
- "name": "foundationAnchorShadowOptions",
4010
+ "name": "foundationAnchoredRegionShadowOptions",
4011
4011
  "type": {
4012
4012
  "text": "ShadowRootInit"
4013
4013
  },
@@ -4015,7 +4015,7 @@
4015
4015
  },
4016
4016
  {
4017
4017
  "kind": "variable",
4018
- "name": "defaultAnchorConfig",
4018
+ "name": "defaultAnchoredRegionConfig",
4019
4019
  "type": {
4020
4020
  "text": "object"
4021
4021
  },
@@ -4023,49 +4023,49 @@
4023
4023
  },
4024
4024
  {
4025
4025
  "kind": "variable",
4026
- "name": "foundationAnchor",
4027
- "description": "The Foundation Anchor",
4026
+ "name": "foundationAnchoredRegion",
4027
+ "description": "The Foundation Anchored Region",
4028
4028
  "privacy": "public"
4029
4029
  }
4030
4030
  ],
4031
4031
  "exports": [
4032
4032
  {
4033
4033
  "kind": "js",
4034
- "name": "Anchor",
4034
+ "name": "AnchoredRegion",
4035
4035
  "declaration": {
4036
- "name": "Anchor",
4037
- "module": "src/anchor/anchor.ts"
4036
+ "name": "AnchoredRegion",
4037
+ "module": "src/anchored-region/anchored-region.ts"
4038
4038
  }
4039
4039
  },
4040
4040
  {
4041
4041
  "kind": "js",
4042
- "name": "foundationAnchorShadowOptions",
4042
+ "name": "foundationAnchoredRegionShadowOptions",
4043
4043
  "declaration": {
4044
- "name": "foundationAnchorShadowOptions",
4045
- "module": "src/anchor/anchor.ts"
4044
+ "name": "foundationAnchoredRegionShadowOptions",
4045
+ "module": "src/anchored-region/anchored-region.ts"
4046
4046
  }
4047
4047
  },
4048
4048
  {
4049
4049
  "kind": "js",
4050
- "name": "defaultAnchorConfig",
4050
+ "name": "defaultAnchoredRegionConfig",
4051
4051
  "declaration": {
4052
- "name": "defaultAnchorConfig",
4053
- "module": "src/anchor/anchor.ts"
4052
+ "name": "defaultAnchoredRegionConfig",
4053
+ "module": "src/anchored-region/anchored-region.ts"
4054
4054
  }
4055
4055
  },
4056
4056
  {
4057
4057
  "kind": "js",
4058
- "name": "foundationAnchor",
4058
+ "name": "foundationAnchoredRegion",
4059
4059
  "declaration": {
4060
- "name": "foundationAnchor",
4061
- "module": "src/anchor/anchor.ts"
4060
+ "name": "foundationAnchoredRegion",
4061
+ "module": "src/anchored-region/anchored-region.ts"
4062
4062
  }
4063
4063
  }
4064
4064
  ]
4065
4065
  },
4066
4066
  {
4067
4067
  "kind": "javascript-module",
4068
- "path": "src/anchor/index.ts",
4068
+ "path": "src/anchored-region/index.ts",
4069
4069
  "declarations": [],
4070
4070
  "exports": [
4071
4071
  {
@@ -4073,7 +4073,7 @@
4073
4073
  "name": "*",
4074
4074
  "declaration": {
4075
4075
  "name": "*",
4076
- "package": "./anchor.template"
4076
+ "package": "./anchor-region.template"
4077
4077
  }
4078
4078
  },
4079
4079
  {
@@ -4081,7 +4081,7 @@
4081
4081
  "name": "*",
4082
4082
  "declaration": {
4083
4083
  "name": "*",
4084
- "package": "./anchor.styles"
4084
+ "package": "./anchored-region.styles"
4085
4085
  }
4086
4086
  },
4087
4087
  {
@@ -4089,7 +4089,7 @@
4089
4089
  "name": "*",
4090
4090
  "declaration": {
4091
4091
  "name": "*",
4092
- "package": "./anchor"
4092
+ "package": "./anchored-region"
4093
4093
  }
4094
4094
  }
4095
4095
  ]