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