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