@genesislcap/foundation-ui 14.310.0 → 14.310.2-alpha-8853fb3.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.
@@ -804,6 +804,14 @@
804
804
  "package": "./utils/base-datasource"
805
805
  }
806
806
  },
807
+ {
808
+ "kind": "js",
809
+ "name": "*",
810
+ "declaration": {
811
+ "name": "*",
812
+ "package": "./utils/shortcut-manager"
813
+ }
814
+ },
807
815
  {
808
816
  "kind": "js",
809
817
  "name": "getDesignSystemPrefix",
@@ -1255,188 +1263,6 @@
1255
1263
  }
1256
1264
  ]
1257
1265
  },
1258
- {
1259
- "kind": "javascript-module",
1260
- "path": "src/accordion/accordion.styles.ts",
1261
- "declarations": [
1262
- {
1263
- "kind": "function",
1264
- "name": "foundationAccordionStyles",
1265
- "return": {
1266
- "type": {
1267
- "text": "ElementStyles"
1268
- }
1269
- },
1270
- "parameters": [
1271
- {
1272
- "name": "context",
1273
- "type": {
1274
- "text": "ElementDefinitionContext"
1275
- }
1276
- },
1277
- {
1278
- "name": "definition",
1279
- "type": {
1280
- "text": "FoundationElementDefinition"
1281
- }
1282
- }
1283
- ]
1284
- }
1285
- ],
1286
- "exports": [
1287
- {
1288
- "kind": "js",
1289
- "name": "foundationAccordionStyles",
1290
- "declaration": {
1291
- "name": "foundationAccordionStyles",
1292
- "module": "src/accordion/accordion.styles.ts"
1293
- }
1294
- }
1295
- ]
1296
- },
1297
- {
1298
- "kind": "javascript-module",
1299
- "path": "src/accordion/accordion.template.ts",
1300
- "declarations": [
1301
- {
1302
- "kind": "function",
1303
- "name": "foundationAccordionTemplate",
1304
- "return": {
1305
- "type": {
1306
- "text": "ViewTemplate<Accordion>"
1307
- }
1308
- },
1309
- "parameters": [
1310
- {
1311
- "name": "context",
1312
- "type": {
1313
- "text": "ElementDefinitionContext"
1314
- }
1315
- },
1316
- {
1317
- "name": "definition",
1318
- "type": {
1319
- "text": "FoundationElementDefinition"
1320
- }
1321
- }
1322
- ]
1323
- }
1324
- ],
1325
- "exports": [
1326
- {
1327
- "kind": "js",
1328
- "name": "foundationAccordionTemplate",
1329
- "declaration": {
1330
- "name": "foundationAccordionTemplate",
1331
- "module": "src/accordion/accordion.template.ts"
1332
- }
1333
- }
1334
- ]
1335
- },
1336
- {
1337
- "kind": "javascript-module",
1338
- "path": "src/accordion/accordion.ts",
1339
- "declarations": [
1340
- {
1341
- "kind": "class",
1342
- "description": "",
1343
- "name": "Accordion",
1344
- "superclass": {
1345
- "name": "FASTAccordion",
1346
- "package": "@microsoft/fast-foundation"
1347
- },
1348
- "tagName": "%%prefix%%-accordion",
1349
- "customElement": true
1350
- },
1351
- {
1352
- "kind": "variable",
1353
- "name": "foundationAccordionShadowOptions",
1354
- "type": {
1355
- "text": "ShadowRootInit"
1356
- },
1357
- "default": "{\n delegatesFocus: true,\n mode: 'open',\n}"
1358
- },
1359
- {
1360
- "kind": "variable",
1361
- "name": "defaultAccordionConfig",
1362
- "type": {
1363
- "text": "object"
1364
- },
1365
- "default": "{}"
1366
- },
1367
- {
1368
- "kind": "variable",
1369
- "name": "foundationAccordion",
1370
- "description": "The Foundation Accordion",
1371
- "privacy": "public"
1372
- }
1373
- ],
1374
- "exports": [
1375
- {
1376
- "kind": "js",
1377
- "name": "Accordion",
1378
- "declaration": {
1379
- "name": "Accordion",
1380
- "module": "src/accordion/accordion.ts"
1381
- }
1382
- },
1383
- {
1384
- "kind": "js",
1385
- "name": "foundationAccordionShadowOptions",
1386
- "declaration": {
1387
- "name": "foundationAccordionShadowOptions",
1388
- "module": "src/accordion/accordion.ts"
1389
- }
1390
- },
1391
- {
1392
- "kind": "js",
1393
- "name": "defaultAccordionConfig",
1394
- "declaration": {
1395
- "name": "defaultAccordionConfig",
1396
- "module": "src/accordion/accordion.ts"
1397
- }
1398
- },
1399
- {
1400
- "kind": "js",
1401
- "name": "foundationAccordion",
1402
- "declaration": {
1403
- "name": "foundationAccordion",
1404
- "module": "src/accordion/accordion.ts"
1405
- }
1406
- }
1407
- ]
1408
- },
1409
- {
1410
- "kind": "javascript-module",
1411
- "path": "src/accordion/index.ts",
1412
- "declarations": [],
1413
- "exports": [
1414
- {
1415
- "kind": "js",
1416
- "name": "*",
1417
- "declaration": {
1418
- "name": "*",
1419
- "package": "./accordion.template"
1420
- }
1421
- },
1422
- {
1423
- "kind": "js",
1424
- "name": "*",
1425
- "declaration": {
1426
- "name": "*",
1427
- "package": "./accordion.styles"
1428
- }
1429
- },
1430
- {
1431
- "kind": "js",
1432
- "name": "*",
1433
- "declaration": {
1434
- "name": "*",
1435
- "package": "./accordion"
1436
- }
1437
- }
1438
- ]
1439
- },
1440
1266
  {
1441
1267
  "kind": "javascript-module",
1442
1268
  "path": "src/_config/index.ts",
@@ -2423,14 +2249,14 @@
2423
2249
  },
2424
2250
  {
2425
2251
  "kind": "javascript-module",
2426
- "path": "src/anchored-region/anchor-region.template.ts",
2252
+ "path": "src/anchor/anchor.styles.ts",
2427
2253
  "declarations": [
2428
2254
  {
2429
2255
  "kind": "function",
2430
- "name": "foundationAnchoredRegionTemplate",
2256
+ "name": "foundationAnchorStyles",
2431
2257
  "return": {
2432
2258
  "type": {
2433
- "text": "ViewTemplate<AnchoredRegion>"
2259
+ "text": "ElementStyles"
2434
2260
  }
2435
2261
  },
2436
2262
  "parameters": [
@@ -2452,24 +2278,24 @@
2452
2278
  "exports": [
2453
2279
  {
2454
2280
  "kind": "js",
2455
- "name": "foundationAnchoredRegionTemplate",
2281
+ "name": "foundationAnchorStyles",
2456
2282
  "declaration": {
2457
- "name": "foundationAnchoredRegionTemplate",
2458
- "module": "src/anchored-region/anchor-region.template.ts"
2283
+ "name": "foundationAnchorStyles",
2284
+ "module": "src/anchor/anchor.styles.ts"
2459
2285
  }
2460
2286
  }
2461
2287
  ]
2462
2288
  },
2463
2289
  {
2464
2290
  "kind": "javascript-module",
2465
- "path": "src/anchored-region/anchored-region.styles.ts",
2291
+ "path": "src/anchor/anchor.template.ts",
2466
2292
  "declarations": [
2467
2293
  {
2468
2294
  "kind": "function",
2469
- "name": "foundationAnchoredRegionStyles",
2295
+ "name": "foundationAnchorTemplate",
2470
2296
  "return": {
2471
2297
  "type": {
2472
- "text": "ElementStyles"
2298
+ "text": "ViewTemplate<Anchor>"
2473
2299
  }
2474
2300
  },
2475
2301
  "parameters": [
@@ -2491,664 +2317,948 @@
2491
2317
  "exports": [
2492
2318
  {
2493
2319
  "kind": "js",
2494
- "name": "foundationAnchoredRegionStyles",
2320
+ "name": "foundationAnchorTemplate",
2495
2321
  "declaration": {
2496
- "name": "foundationAnchoredRegionStyles",
2497
- "module": "src/anchored-region/anchored-region.styles.ts"
2322
+ "name": "foundationAnchorTemplate",
2323
+ "module": "src/anchor/anchor.template.ts"
2498
2324
  }
2499
2325
  }
2500
2326
  ]
2501
2327
  },
2502
2328
  {
2503
2329
  "kind": "javascript-module",
2504
- "path": "src/anchored-region/anchored-region.ts",
2330
+ "path": "src/anchor/anchor.ts",
2505
2331
  "declarations": [
2506
2332
  {
2507
2333
  "kind": "class",
2508
2334
  "description": "",
2509
- "name": "AnchoredRegion",
2335
+ "name": "Anchor",
2510
2336
  "superclass": {
2511
- "name": "FASTAnchoredRegion",
2337
+ "name": "FASTAnchor",
2512
2338
  "package": "@microsoft/fast-components"
2513
2339
  },
2514
- "tagName": "%%prefix%%-anchored-region",
2340
+ "tagName": "%%prefix%%-anchor",
2515
2341
  "customElement": true,
2516
2342
  "attributes": [
2517
2343
  {
2518
- "name": "anchor",
2344
+ "name": "download",
2519
2345
  "type": {
2520
2346
  "text": "string"
2521
2347
  },
2522
- "default": "\"\"",
2523
- "description": "The HTML ID of the anchor element this region is positioned relative to",
2524
- "fieldName": "anchor",
2348
+ "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.",
2349
+ "fieldName": "download",
2525
2350
  "inheritedFrom": {
2526
- "name": "AnchoredRegion",
2527
- "module": "src/anchored-region/anchored-region.ts"
2351
+ "name": "Anchor",
2352
+ "module": "src/anchor/anchor.ts"
2528
2353
  }
2529
2354
  },
2530
2355
  {
2531
- "name": "viewport",
2356
+ "name": "href",
2532
2357
  "type": {
2533
2358
  "text": "string"
2534
2359
  },
2535
- "default": "\"\"",
2536
- "description": "The HTML ID of the viewport element this region is positioned relative to",
2537
- "fieldName": "viewport",
2360
+ "description": "The URL the hyperlink references. See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a | <a> element for more information.",
2361
+ "fieldName": "href",
2538
2362
  "inheritedFrom": {
2539
- "name": "AnchoredRegion",
2540
- "module": "src/anchored-region/anchored-region.ts"
2363
+ "name": "Anchor",
2364
+ "module": "src/anchor/anchor.ts"
2541
2365
  }
2542
2366
  },
2543
2367
  {
2544
- "name": "horizontal-positioning-mode",
2368
+ "name": "hreflang",
2545
2369
  "type": {
2546
- "text": "AxisPositioningMode"
2370
+ "text": "string"
2547
2371
  },
2548
- "default": "\"uncontrolled\"",
2549
- "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",
2550
- "fieldName": "horizontalPositioningMode",
2372
+ "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.",
2373
+ "fieldName": "hreflang",
2551
2374
  "inheritedFrom": {
2552
- "name": "AnchoredRegion",
2553
- "module": "src/anchored-region/anchored-region.ts"
2375
+ "name": "Anchor",
2376
+ "module": "src/anchor/anchor.ts"
2554
2377
  }
2555
2378
  },
2556
2379
  {
2557
- "name": "horizontal-default-position",
2380
+ "name": "ping",
2558
2381
  "type": {
2559
- "text": "HorizontalPosition"
2382
+ "text": "string"
2560
2383
  },
2561
- "default": "\"unset\"",
2562
- "description": "The default horizontal position of the region relative to the anchor element",
2563
- "fieldName": "horizontalDefaultPosition",
2384
+ "description": "See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a | <a> element for more information.",
2385
+ "fieldName": "ping",
2564
2386
  "inheritedFrom": {
2565
- "name": "AnchoredRegion",
2566
- "module": "src/anchored-region/anchored-region.ts"
2387
+ "name": "Anchor",
2388
+ "module": "src/anchor/anchor.ts"
2567
2389
  }
2568
2390
  },
2569
2391
  {
2570
- "name": "horizontal-viewport-lock",
2392
+ "name": "referrerpolicy",
2571
2393
  "type": {
2572
- "text": "boolean"
2394
+ "text": "string"
2573
2395
  },
2574
- "default": "false",
2575
- "description": "Whether the region remains in the viewport (ie. detaches from the anchor) on the horizontal axis",
2576
- "fieldName": "horizontalViewportLock",
2396
+ "description": "See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a | <a> element for more information.",
2397
+ "fieldName": "referrerpolicy",
2577
2398
  "inheritedFrom": {
2578
- "name": "AnchoredRegion",
2579
- "module": "src/anchored-region/anchored-region.ts"
2399
+ "name": "Anchor",
2400
+ "module": "src/anchor/anchor.ts"
2580
2401
  }
2581
2402
  },
2582
2403
  {
2583
- "name": "horizontal-inset",
2404
+ "name": "rel",
2584
2405
  "type": {
2585
- "text": "boolean"
2406
+ "text": "string"
2586
2407
  },
2587
- "default": "false",
2588
- "description": "Whether the region overlaps the anchor on the horizontal axis",
2589
- "fieldName": "horizontalInset",
2408
+ "description": "See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a | <a> element for more information.",
2409
+ "fieldName": "rel",
2590
2410
  "inheritedFrom": {
2591
- "name": "AnchoredRegion",
2592
- "module": "src/anchored-region/anchored-region.ts"
2411
+ "name": "Anchor",
2412
+ "module": "src/anchor/anchor.ts"
2593
2413
  }
2594
2414
  },
2595
2415
  {
2596
- "name": "horizontal-threshold",
2416
+ "name": "target",
2597
2417
  "type": {
2598
- "text": "number"
2418
+ "text": "\"_self\" | \"_blank\" | \"_parent\" | \"_top\""
2599
2419
  },
2600
- "description": "How narrow the space allocated to the default position has to be before the widest area\nis selected for layout",
2601
- "fieldName": "horizontalThreshold",
2420
+ "description": "See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a | <a> element for more information.",
2421
+ "fieldName": "target",
2602
2422
  "inheritedFrom": {
2603
- "name": "AnchoredRegion",
2604
- "module": "src/anchored-region/anchored-region.ts"
2423
+ "name": "Anchor",
2424
+ "module": "src/anchor/anchor.ts"
2605
2425
  }
2606
2426
  },
2607
2427
  {
2608
- "name": "horizontal-scaling",
2428
+ "name": "type",
2609
2429
  "type": {
2610
- "text": "AxisScalingMode"
2430
+ "text": "string"
2611
2431
  },
2612
- "default": "\"content\"",
2613
- "description": "Defines how the width of the region is calculated",
2614
- "fieldName": "horizontalScaling",
2432
+ "description": "See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a | <a> element for more information.",
2433
+ "fieldName": "type",
2615
2434
  "inheritedFrom": {
2616
- "name": "AnchoredRegion",
2617
- "module": "src/anchored-region/anchored-region.ts"
2435
+ "name": "Anchor",
2436
+ "module": "src/anchor/anchor.ts"
2618
2437
  }
2619
- },
2438
+ }
2439
+ ],
2440
+ "members": [
2620
2441
  {
2621
- "name": "vertical-positioning-mode",
2442
+ "kind": "field",
2443
+ "name": "download",
2622
2444
  "type": {
2623
- "text": "AxisPositioningMode"
2445
+ "text": "string"
2624
2446
  },
2625
- "default": "\"uncontrolled\"",
2626
- "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",
2627
- "fieldName": "verticalPositioningMode",
2447
+ "privacy": "public",
2448
+ "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.",
2628
2449
  "inheritedFrom": {
2629
- "name": "AnchoredRegion",
2630
- "module": "src/anchored-region/anchored-region.ts"
2450
+ "name": "Anchor",
2451
+ "module": "src/anchor/anchor.ts"
2631
2452
  }
2632
2453
  },
2633
2454
  {
2634
- "name": "vertical-default-position",
2455
+ "kind": "field",
2456
+ "name": "href",
2635
2457
  "type": {
2636
- "text": "VerticalPosition"
2458
+ "text": "string"
2637
2459
  },
2638
- "default": "\"unset\"",
2639
- "description": "The default vertical position of the region relative to the anchor element",
2640
- "fieldName": "verticalDefaultPosition",
2460
+ "privacy": "public",
2461
+ "description": "The URL the hyperlink references. See {@link https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a | <a> element } for more information.",
2641
2462
  "inheritedFrom": {
2642
- "name": "AnchoredRegion",
2643
- "module": "src/anchored-region/anchored-region.ts"
2463
+ "name": "Anchor",
2464
+ "module": "src/anchor/anchor.ts"
2644
2465
  }
2645
2466
  },
2646
2467
  {
2647
- "name": "vertical-viewport-lock",
2468
+ "kind": "field",
2469
+ "name": "hreflang",
2648
2470
  "type": {
2649
- "text": "boolean"
2471
+ "text": "string"
2650
2472
  },
2651
- "default": "false",
2652
- "description": "Whether the region remains in the viewport (ie. detaches from the anchor) on the vertical axis",
2653
- "fieldName": "verticalViewportLock",
2473
+ "privacy": "public",
2474
+ "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.",
2654
2475
  "inheritedFrom": {
2655
- "name": "AnchoredRegion",
2656
- "module": "src/anchored-region/anchored-region.ts"
2476
+ "name": "Anchor",
2477
+ "module": "src/anchor/anchor.ts"
2657
2478
  }
2658
2479
  },
2659
2480
  {
2660
- "name": "vertical-inset",
2481
+ "kind": "field",
2482
+ "name": "ping",
2661
2483
  "type": {
2662
- "text": "boolean"
2484
+ "text": "string"
2663
2485
  },
2664
- "default": "false",
2665
- "description": "Whether the region overlaps the anchor on the vertical axis",
2666
- "fieldName": "verticalInset",
2486
+ "privacy": "public",
2487
+ "description": "See {@link https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a | <a> element } for more information.",
2667
2488
  "inheritedFrom": {
2668
- "name": "AnchoredRegion",
2669
- "module": "src/anchored-region/anchored-region.ts"
2489
+ "name": "Anchor",
2490
+ "module": "src/anchor/anchor.ts"
2670
2491
  }
2671
2492
  },
2672
2493
  {
2673
- "name": "vertical-threshold",
2494
+ "kind": "field",
2495
+ "name": "referrerpolicy",
2674
2496
  "type": {
2675
- "text": "number"
2497
+ "text": "string"
2676
2498
  },
2677
- "description": "How short the space allocated to the default position has to be before the tallest area\nis selected for layout",
2678
- "fieldName": "verticalThreshold",
2499
+ "privacy": "public",
2500
+ "description": "See {@link https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a | <a> element } for more information.",
2679
2501
  "inheritedFrom": {
2680
- "name": "AnchoredRegion",
2681
- "module": "src/anchored-region/anchored-region.ts"
2502
+ "name": "Anchor",
2503
+ "module": "src/anchor/anchor.ts"
2682
2504
  }
2683
2505
  },
2684
2506
  {
2685
- "name": "vertical-scaling",
2507
+ "kind": "field",
2508
+ "name": "rel",
2686
2509
  "type": {
2687
- "text": "AxisScalingMode"
2510
+ "text": "string"
2688
2511
  },
2689
- "default": "\"content\"",
2690
- "description": "Defines how the height of the region is calculated",
2691
- "fieldName": "verticalScaling",
2512
+ "privacy": "public",
2513
+ "description": "See {@link https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a | <a> element } for more information.",
2692
2514
  "inheritedFrom": {
2693
- "name": "AnchoredRegion",
2694
- "module": "src/anchored-region/anchored-region.ts"
2515
+ "name": "Anchor",
2516
+ "module": "src/anchor/anchor.ts"
2695
2517
  }
2696
2518
  },
2697
2519
  {
2698
- "name": "fixed-placement",
2520
+ "kind": "field",
2521
+ "name": "target",
2699
2522
  "type": {
2700
- "text": "boolean"
2523
+ "text": "\"_self\" | \"_blank\" | \"_parent\" | \"_top\""
2701
2524
  },
2702
- "default": "false",
2703
- "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,",
2704
- "fieldName": "fixedPlacement",
2525
+ "privacy": "public",
2526
+ "description": "See {@link https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a | <a> element } for more information.",
2705
2527
  "inheritedFrom": {
2706
- "name": "AnchoredRegion",
2707
- "module": "src/anchored-region/anchored-region.ts"
2528
+ "name": "Anchor",
2529
+ "module": "src/anchor/anchor.ts"
2708
2530
  }
2709
2531
  },
2710
2532
  {
2711
- "name": "auto-update-mode",
2533
+ "kind": "field",
2534
+ "name": "type",
2712
2535
  "type": {
2713
- "text": "AutoUpdateMode"
2536
+ "text": "string"
2714
2537
  },
2715
- "default": "\"anchor\"",
2716
- "description": "Defines what triggers the anchored region to revaluate positioning",
2717
- "fieldName": "autoUpdateMode",
2538
+ "privacy": "public",
2539
+ "description": "See {@link https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a | <a> element } for more information.",
2718
2540
  "inheritedFrom": {
2719
- "name": "AnchoredRegion",
2720
- "module": "src/anchored-region/anchored-region.ts"
2541
+ "name": "Anchor",
2542
+ "module": "src/anchor/anchor.ts"
2721
2543
  }
2722
- }
2723
- ],
2724
- "members": [
2544
+ },
2725
2545
  {
2726
2546
  "kind": "field",
2727
- "name": "anchor",
2547
+ "name": "control",
2728
2548
  "type": {
2729
- "text": "string"
2549
+ "text": "HTMLAnchorElement | undefined"
2730
2550
  },
2731
2551
  "privacy": "public",
2732
- "default": "\"\"",
2733
- "description": "The HTML ID of the anchor element this region is positioned relative to",
2552
+ "description": "References the root element",
2734
2553
  "inheritedFrom": {
2735
- "name": "AnchoredRegion",
2736
- "module": "src/anchored-region/anchored-region.ts"
2554
+ "name": "Anchor",
2555
+ "module": "src/anchor/anchor.ts"
2737
2556
  }
2738
2557
  },
2739
2558
  {
2740
- "kind": "method",
2741
- "name": "anchorChanged",
2559
+ "kind": "field",
2560
+ "name": "handleUnsupportedDelegatesFocus",
2742
2561
  "privacy": "private",
2743
- "return": {
2744
- "type": {
2745
- "text": "void"
2746
- }
2747
- },
2562
+ "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",
2748
2563
  "inheritedFrom": {
2749
- "name": "AnchoredRegion",
2750
- "module": "src/anchored-region/anchored-region.ts"
2564
+ "name": "Anchor",
2565
+ "module": "src/anchor/anchor.ts"
2751
2566
  }
2752
2567
  },
2753
2568
  {
2754
2569
  "kind": "field",
2755
- "name": "viewport",
2570
+ "name": "_presentation",
2756
2571
  "type": {
2757
- "text": "string"
2572
+ "text": "ComponentPresentation | null | undefined"
2758
2573
  },
2759
- "privacy": "public",
2760
- "default": "\"\"",
2761
- "description": "The HTML ID of the viewport element this region is positioned relative to",
2574
+ "privacy": "private",
2575
+ "default": "void 0",
2762
2576
  "inheritedFrom": {
2763
- "name": "AnchoredRegion",
2764
- "module": "src/anchored-region/anchored-region.ts"
2577
+ "name": "FoundationElement",
2578
+ "module": "src/foundation-element/foundation-element.ts"
2765
2579
  }
2766
2580
  },
2767
2581
  {
2768
- "kind": "method",
2769
- "name": "viewportChanged",
2770
- "privacy": "private",
2771
- "return": {
2772
- "type": {
2773
- "text": "void"
2774
- }
2582
+ "kind": "field",
2583
+ "name": "$presentation",
2584
+ "type": {
2585
+ "text": "ComponentPresentation | null"
2775
2586
  },
2587
+ "privacy": "public",
2588
+ "description": "A property which resolves the ComponentPresentation instance\nfor the current component.",
2776
2589
  "inheritedFrom": {
2777
- "name": "AnchoredRegion",
2778
- "module": "src/anchored-region/anchored-region.ts"
2590
+ "name": "FoundationElement",
2591
+ "module": "src/foundation-element/foundation-element.ts"
2779
2592
  }
2780
2593
  },
2781
2594
  {
2782
2595
  "kind": "field",
2783
- "name": "horizontalPositioningMode",
2596
+ "name": "template",
2784
2597
  "type": {
2785
- "text": "AxisPositioningMode"
2598
+ "text": "ElementViewTemplate | void | null"
2786
2599
  },
2787
2600
  "privacy": "public",
2788
- "default": "\"uncontrolled\"",
2789
- "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",
2601
+ "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.",
2790
2602
  "inheritedFrom": {
2791
- "name": "AnchoredRegion",
2792
- "module": "src/anchored-region/anchored-region.ts"
2603
+ "name": "FoundationElement",
2604
+ "module": "src/foundation-element/foundation-element.ts"
2793
2605
  }
2794
2606
  },
2795
2607
  {
2796
2608
  "kind": "method",
2797
- "name": "horizontalPositioningModeChanged",
2798
- "privacy": "private",
2609
+ "name": "templateChanged",
2610
+ "privacy": "protected",
2799
2611
  "return": {
2800
2612
  "type": {
2801
2613
  "text": "void"
2802
2614
  }
2803
2615
  },
2804
2616
  "inheritedFrom": {
2805
- "name": "AnchoredRegion",
2806
- "module": "src/anchored-region/anchored-region.ts"
2807
- }
2617
+ "name": "FoundationElement",
2618
+ "module": "src/foundation-element/foundation-element.ts"
2619
+ }
2808
2620
  },
2809
2621
  {
2810
2622
  "kind": "field",
2811
- "name": "horizontalDefaultPosition",
2623
+ "name": "styles",
2812
2624
  "type": {
2813
- "text": "HorizontalPosition"
2625
+ "text": "ElementStyles | void | null"
2814
2626
  },
2815
2627
  "privacy": "public",
2816
- "default": "\"unset\"",
2817
- "description": "The default horizontal position of the region relative to the anchor element",
2628
+ "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.",
2818
2629
  "inheritedFrom": {
2819
- "name": "AnchoredRegion",
2820
- "module": "src/anchored-region/anchored-region.ts"
2630
+ "name": "FoundationElement",
2631
+ "module": "src/foundation-element/foundation-element.ts"
2821
2632
  }
2822
2633
  },
2823
2634
  {
2824
2635
  "kind": "method",
2825
- "name": "horizontalDefaultPositionChanged",
2826
- "privacy": "private",
2636
+ "name": "stylesChanged",
2637
+ "privacy": "protected",
2827
2638
  "return": {
2828
2639
  "type": {
2829
2640
  "text": "void"
2830
2641
  }
2831
2642
  },
2832
2643
  "inheritedFrom": {
2833
- "name": "AnchoredRegion",
2834
- "module": "src/anchored-region/anchored-region.ts"
2835
- }
2836
- },
2837
- {
2838
- "kind": "field",
2839
- "name": "horizontalViewportLock",
2840
- "type": {
2841
- "text": "boolean"
2842
- },
2843
- "privacy": "public",
2844
- "default": "false",
2845
- "description": "Whether the region remains in the viewport (ie. detaches from the anchor) on the horizontal axis",
2846
- "inheritedFrom": {
2847
- "name": "AnchoredRegion",
2848
- "module": "src/anchored-region/anchored-region.ts"
2644
+ "name": "FoundationElement",
2645
+ "module": "src/foundation-element/foundation-element.ts"
2849
2646
  }
2850
2647
  },
2851
2648
  {
2852
2649
  "kind": "method",
2853
- "name": "horizontalViewportLockChanged",
2854
- "privacy": "private",
2650
+ "name": "compose",
2651
+ "privacy": "public",
2652
+ "static": true,
2855
2653
  "return": {
2856
2654
  "type": {
2857
- "text": "void"
2655
+ "text": "(\n overrideDefinition?: OverrideFoundationElementDefinition<T>\n ) => FoundationElementRegistry<T, K>"
2858
2656
  }
2859
2657
  },
2658
+ "parameters": [
2659
+ {
2660
+ "name": "this",
2661
+ "type": {
2662
+ "text": "K"
2663
+ }
2664
+ },
2665
+ {
2666
+ "name": "elementDefinition",
2667
+ "type": {
2668
+ "text": "T"
2669
+ },
2670
+ "description": "The definition of the element to create the registry\nfunction for."
2671
+ }
2672
+ ],
2673
+ "description": "Defines an element registry function with a set of element definition defaults.",
2860
2674
  "inheritedFrom": {
2861
- "name": "AnchoredRegion",
2862
- "module": "src/anchored-region/anchored-region.ts"
2675
+ "name": "FoundationElement",
2676
+ "module": "src/foundation-element/foundation-element.ts"
2863
2677
  }
2864
- },
2678
+ }
2679
+ ]
2680
+ },
2681
+ {
2682
+ "kind": "variable",
2683
+ "name": "foundationAnchorShadowOptions",
2684
+ "type": {
2685
+ "text": "ShadowRootInit"
2686
+ },
2687
+ "default": "{\n delegatesFocus: true,\n mode: 'open',\n}"
2688
+ },
2689
+ {
2690
+ "kind": "variable",
2691
+ "name": "defaultAnchorConfig",
2692
+ "type": {
2693
+ "text": "object"
2694
+ },
2695
+ "default": "{}"
2696
+ },
2697
+ {
2698
+ "kind": "variable",
2699
+ "name": "foundationAnchor",
2700
+ "description": "The Foundation Anchor",
2701
+ "privacy": "public"
2702
+ }
2703
+ ],
2704
+ "exports": [
2705
+ {
2706
+ "kind": "js",
2707
+ "name": "Anchor",
2708
+ "declaration": {
2709
+ "name": "Anchor",
2710
+ "module": "src/anchor/anchor.ts"
2711
+ }
2712
+ },
2713
+ {
2714
+ "kind": "js",
2715
+ "name": "foundationAnchorShadowOptions",
2716
+ "declaration": {
2717
+ "name": "foundationAnchorShadowOptions",
2718
+ "module": "src/anchor/anchor.ts"
2719
+ }
2720
+ },
2721
+ {
2722
+ "kind": "js",
2723
+ "name": "defaultAnchorConfig",
2724
+ "declaration": {
2725
+ "name": "defaultAnchorConfig",
2726
+ "module": "src/anchor/anchor.ts"
2727
+ }
2728
+ },
2729
+ {
2730
+ "kind": "js",
2731
+ "name": "foundationAnchor",
2732
+ "declaration": {
2733
+ "name": "foundationAnchor",
2734
+ "module": "src/anchor/anchor.ts"
2735
+ }
2736
+ }
2737
+ ]
2738
+ },
2739
+ {
2740
+ "kind": "javascript-module",
2741
+ "path": "src/anchor/index.ts",
2742
+ "declarations": [],
2743
+ "exports": [
2744
+ {
2745
+ "kind": "js",
2746
+ "name": "*",
2747
+ "declaration": {
2748
+ "name": "*",
2749
+ "package": "./anchor.template"
2750
+ }
2751
+ },
2752
+ {
2753
+ "kind": "js",
2754
+ "name": "*",
2755
+ "declaration": {
2756
+ "name": "*",
2757
+ "package": "./anchor.styles"
2758
+ }
2759
+ },
2760
+ {
2761
+ "kind": "js",
2762
+ "name": "*",
2763
+ "declaration": {
2764
+ "name": "*",
2765
+ "package": "./anchor"
2766
+ }
2767
+ }
2768
+ ]
2769
+ },
2770
+ {
2771
+ "kind": "javascript-module",
2772
+ "path": "src/accordion/accordion.styles.ts",
2773
+ "declarations": [
2774
+ {
2775
+ "kind": "function",
2776
+ "name": "foundationAccordionStyles",
2777
+ "return": {
2778
+ "type": {
2779
+ "text": "ElementStyles"
2780
+ }
2781
+ },
2782
+ "parameters": [
2865
2783
  {
2866
- "kind": "field",
2867
- "name": "horizontalInset",
2784
+ "name": "context",
2868
2785
  "type": {
2869
- "text": "boolean"
2870
- },
2871
- "privacy": "public",
2872
- "default": "false",
2873
- "description": "Whether the region overlaps the anchor on the horizontal axis",
2874
- "inheritedFrom": {
2875
- "name": "AnchoredRegion",
2876
- "module": "src/anchored-region/anchored-region.ts"
2786
+ "text": "ElementDefinitionContext"
2877
2787
  }
2878
2788
  },
2879
2789
  {
2880
- "kind": "method",
2881
- "name": "horizontalInsetChanged",
2882
- "privacy": "private",
2883
- "return": {
2884
- "type": {
2885
- "text": "void"
2886
- }
2887
- },
2888
- "inheritedFrom": {
2889
- "name": "AnchoredRegion",
2890
- "module": "src/anchored-region/anchored-region.ts"
2790
+ "name": "definition",
2791
+ "type": {
2792
+ "text": "FoundationElementDefinition"
2793
+ }
2794
+ }
2795
+ ]
2796
+ }
2797
+ ],
2798
+ "exports": [
2799
+ {
2800
+ "kind": "js",
2801
+ "name": "foundationAccordionStyles",
2802
+ "declaration": {
2803
+ "name": "foundationAccordionStyles",
2804
+ "module": "src/accordion/accordion.styles.ts"
2805
+ }
2806
+ }
2807
+ ]
2808
+ },
2809
+ {
2810
+ "kind": "javascript-module",
2811
+ "path": "src/accordion/accordion.template.ts",
2812
+ "declarations": [
2813
+ {
2814
+ "kind": "function",
2815
+ "name": "foundationAccordionTemplate",
2816
+ "return": {
2817
+ "type": {
2818
+ "text": "ViewTemplate<Accordion>"
2819
+ }
2820
+ },
2821
+ "parameters": [
2822
+ {
2823
+ "name": "context",
2824
+ "type": {
2825
+ "text": "ElementDefinitionContext"
2891
2826
  }
2892
2827
  },
2893
2828
  {
2894
- "kind": "field",
2895
- "name": "horizontalThreshold",
2829
+ "name": "definition",
2896
2830
  "type": {
2897
- "text": "number"
2898
- },
2899
- "privacy": "public",
2900
- "description": "How narrow the space allocated to the default position has to be before the widest area\nis selected for layout",
2901
- "inheritedFrom": {
2902
- "name": "AnchoredRegion",
2903
- "module": "src/anchored-region/anchored-region.ts"
2831
+ "text": "FoundationElementDefinition"
2832
+ }
2833
+ }
2834
+ ]
2835
+ }
2836
+ ],
2837
+ "exports": [
2838
+ {
2839
+ "kind": "js",
2840
+ "name": "foundationAccordionTemplate",
2841
+ "declaration": {
2842
+ "name": "foundationAccordionTemplate",
2843
+ "module": "src/accordion/accordion.template.ts"
2844
+ }
2845
+ }
2846
+ ]
2847
+ },
2848
+ {
2849
+ "kind": "javascript-module",
2850
+ "path": "src/accordion/accordion.ts",
2851
+ "declarations": [
2852
+ {
2853
+ "kind": "class",
2854
+ "description": "",
2855
+ "name": "Accordion",
2856
+ "superclass": {
2857
+ "name": "FASTAccordion",
2858
+ "package": "@microsoft/fast-foundation"
2859
+ },
2860
+ "tagName": "%%prefix%%-accordion",
2861
+ "customElement": true
2862
+ },
2863
+ {
2864
+ "kind": "variable",
2865
+ "name": "foundationAccordionShadowOptions",
2866
+ "type": {
2867
+ "text": "ShadowRootInit"
2868
+ },
2869
+ "default": "{\n delegatesFocus: true,\n mode: 'open',\n}"
2870
+ },
2871
+ {
2872
+ "kind": "variable",
2873
+ "name": "defaultAccordionConfig",
2874
+ "type": {
2875
+ "text": "object"
2876
+ },
2877
+ "default": "{}"
2878
+ },
2879
+ {
2880
+ "kind": "variable",
2881
+ "name": "foundationAccordion",
2882
+ "description": "The Foundation Accordion",
2883
+ "privacy": "public"
2884
+ }
2885
+ ],
2886
+ "exports": [
2887
+ {
2888
+ "kind": "js",
2889
+ "name": "Accordion",
2890
+ "declaration": {
2891
+ "name": "Accordion",
2892
+ "module": "src/accordion/accordion.ts"
2893
+ }
2894
+ },
2895
+ {
2896
+ "kind": "js",
2897
+ "name": "foundationAccordionShadowOptions",
2898
+ "declaration": {
2899
+ "name": "foundationAccordionShadowOptions",
2900
+ "module": "src/accordion/accordion.ts"
2901
+ }
2902
+ },
2903
+ {
2904
+ "kind": "js",
2905
+ "name": "defaultAccordionConfig",
2906
+ "declaration": {
2907
+ "name": "defaultAccordionConfig",
2908
+ "module": "src/accordion/accordion.ts"
2909
+ }
2910
+ },
2911
+ {
2912
+ "kind": "js",
2913
+ "name": "foundationAccordion",
2914
+ "declaration": {
2915
+ "name": "foundationAccordion",
2916
+ "module": "src/accordion/accordion.ts"
2917
+ }
2918
+ }
2919
+ ]
2920
+ },
2921
+ {
2922
+ "kind": "javascript-module",
2923
+ "path": "src/accordion/index.ts",
2924
+ "declarations": [],
2925
+ "exports": [
2926
+ {
2927
+ "kind": "js",
2928
+ "name": "*",
2929
+ "declaration": {
2930
+ "name": "*",
2931
+ "package": "./accordion.template"
2932
+ }
2933
+ },
2934
+ {
2935
+ "kind": "js",
2936
+ "name": "*",
2937
+ "declaration": {
2938
+ "name": "*",
2939
+ "package": "./accordion.styles"
2940
+ }
2941
+ },
2942
+ {
2943
+ "kind": "js",
2944
+ "name": "*",
2945
+ "declaration": {
2946
+ "name": "*",
2947
+ "package": "./accordion"
2948
+ }
2949
+ }
2950
+ ]
2951
+ },
2952
+ {
2953
+ "kind": "javascript-module",
2954
+ "path": "src/anchored-region/anchor-region.template.ts",
2955
+ "declarations": [
2956
+ {
2957
+ "kind": "function",
2958
+ "name": "foundationAnchoredRegionTemplate",
2959
+ "return": {
2960
+ "type": {
2961
+ "text": "ViewTemplate<AnchoredRegion>"
2962
+ }
2963
+ },
2964
+ "parameters": [
2965
+ {
2966
+ "name": "context",
2967
+ "type": {
2968
+ "text": "ElementDefinitionContext"
2904
2969
  }
2905
2970
  },
2906
2971
  {
2907
- "kind": "method",
2908
- "name": "horizontalThresholdChanged",
2909
- "privacy": "private",
2910
- "return": {
2911
- "type": {
2912
- "text": "void"
2913
- }
2914
- },
2915
- "inheritedFrom": {
2916
- "name": "AnchoredRegion",
2917
- "module": "src/anchored-region/anchored-region.ts"
2972
+ "name": "definition",
2973
+ "type": {
2974
+ "text": "FoundationElementDefinition"
2975
+ }
2976
+ }
2977
+ ]
2978
+ }
2979
+ ],
2980
+ "exports": [
2981
+ {
2982
+ "kind": "js",
2983
+ "name": "foundationAnchoredRegionTemplate",
2984
+ "declaration": {
2985
+ "name": "foundationAnchoredRegionTemplate",
2986
+ "module": "src/anchored-region/anchor-region.template.ts"
2987
+ }
2988
+ }
2989
+ ]
2990
+ },
2991
+ {
2992
+ "kind": "javascript-module",
2993
+ "path": "src/anchored-region/anchored-region.styles.ts",
2994
+ "declarations": [
2995
+ {
2996
+ "kind": "function",
2997
+ "name": "foundationAnchoredRegionStyles",
2998
+ "return": {
2999
+ "type": {
3000
+ "text": "ElementStyles"
3001
+ }
3002
+ },
3003
+ "parameters": [
3004
+ {
3005
+ "name": "context",
3006
+ "type": {
3007
+ "text": "ElementDefinitionContext"
2918
3008
  }
2919
3009
  },
2920
3010
  {
2921
- "kind": "field",
2922
- "name": "horizontalScaling",
3011
+ "name": "definition",
2923
3012
  "type": {
2924
- "text": "AxisScalingMode"
3013
+ "text": "FoundationElementDefinition"
3014
+ }
3015
+ }
3016
+ ]
3017
+ }
3018
+ ],
3019
+ "exports": [
3020
+ {
3021
+ "kind": "js",
3022
+ "name": "foundationAnchoredRegionStyles",
3023
+ "declaration": {
3024
+ "name": "foundationAnchoredRegionStyles",
3025
+ "module": "src/anchored-region/anchored-region.styles.ts"
3026
+ }
3027
+ }
3028
+ ]
3029
+ },
3030
+ {
3031
+ "kind": "javascript-module",
3032
+ "path": "src/anchored-region/anchored-region.ts",
3033
+ "declarations": [
3034
+ {
3035
+ "kind": "class",
3036
+ "description": "",
3037
+ "name": "AnchoredRegion",
3038
+ "superclass": {
3039
+ "name": "FASTAnchoredRegion",
3040
+ "package": "@microsoft/fast-components"
3041
+ },
3042
+ "tagName": "%%prefix%%-anchored-region",
3043
+ "customElement": true,
3044
+ "attributes": [
3045
+ {
3046
+ "name": "anchor",
3047
+ "type": {
3048
+ "text": "string"
2925
3049
  },
2926
- "privacy": "public",
2927
- "default": "\"content\"",
2928
- "description": "Defines how the width of the region is calculated",
3050
+ "default": "\"\"",
3051
+ "description": "The HTML ID of the anchor element this region is positioned relative to",
3052
+ "fieldName": "anchor",
2929
3053
  "inheritedFrom": {
2930
3054
  "name": "AnchoredRegion",
2931
3055
  "module": "src/anchored-region/anchored-region.ts"
2932
3056
  }
2933
3057
  },
2934
3058
  {
2935
- "kind": "method",
2936
- "name": "horizontalScalingChanged",
2937
- "privacy": "private",
2938
- "return": {
2939
- "type": {
2940
- "text": "void"
2941
- }
3059
+ "name": "viewport",
3060
+ "type": {
3061
+ "text": "string"
2942
3062
  },
3063
+ "default": "\"\"",
3064
+ "description": "The HTML ID of the viewport element this region is positioned relative to",
3065
+ "fieldName": "viewport",
2943
3066
  "inheritedFrom": {
2944
3067
  "name": "AnchoredRegion",
2945
3068
  "module": "src/anchored-region/anchored-region.ts"
2946
3069
  }
2947
3070
  },
2948
3071
  {
2949
- "kind": "field",
2950
- "name": "verticalPositioningMode",
3072
+ "name": "horizontal-positioning-mode",
2951
3073
  "type": {
2952
3074
  "text": "AxisPositioningMode"
2953
3075
  },
2954
- "privacy": "public",
2955
3076
  "default": "\"uncontrolled\"",
2956
- "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",
3077
+ "description": "Sets what logic the component uses to determine horizontal placement.\n'locktodefault' forces the default position\n'dynamic' decides placement based on available space\n'uncontrolled' does not control placement on the horizontal axis",
3078
+ "fieldName": "horizontalPositioningMode",
2957
3079
  "inheritedFrom": {
2958
3080
  "name": "AnchoredRegion",
2959
3081
  "module": "src/anchored-region/anchored-region.ts"
2960
3082
  }
2961
3083
  },
2962
3084
  {
2963
- "kind": "method",
2964
- "name": "verticalPositioningModeChanged",
2965
- "privacy": "private",
2966
- "return": {
2967
- "type": {
2968
- "text": "void"
2969
- }
3085
+ "name": "horizontal-default-position",
3086
+ "type": {
3087
+ "text": "HorizontalPosition"
2970
3088
  },
3089
+ "default": "\"unset\"",
3090
+ "description": "The default horizontal position of the region relative to the anchor element",
3091
+ "fieldName": "horizontalDefaultPosition",
2971
3092
  "inheritedFrom": {
2972
3093
  "name": "AnchoredRegion",
2973
3094
  "module": "src/anchored-region/anchored-region.ts"
2974
3095
  }
2975
3096
  },
2976
3097
  {
2977
- "kind": "field",
2978
- "name": "verticalDefaultPosition",
3098
+ "name": "horizontal-viewport-lock",
2979
3099
  "type": {
2980
- "text": "VerticalPosition"
3100
+ "text": "boolean"
2981
3101
  },
2982
- "privacy": "public",
2983
- "default": "\"unset\"",
2984
- "description": "The default vertical position of the region relative to the anchor element",
3102
+ "default": "false",
3103
+ "description": "Whether the region remains in the viewport (ie. detaches from the anchor) on the horizontal axis",
3104
+ "fieldName": "horizontalViewportLock",
2985
3105
  "inheritedFrom": {
2986
3106
  "name": "AnchoredRegion",
2987
3107
  "module": "src/anchored-region/anchored-region.ts"
2988
3108
  }
2989
3109
  },
2990
3110
  {
2991
- "kind": "method",
2992
- "name": "verticalDefaultPositionChanged",
2993
- "privacy": "private",
2994
- "return": {
2995
- "type": {
2996
- "text": "void"
2997
- }
3111
+ "name": "horizontal-inset",
3112
+ "type": {
3113
+ "text": "boolean"
2998
3114
  },
3115
+ "default": "false",
3116
+ "description": "Whether the region overlaps the anchor on the horizontal axis",
3117
+ "fieldName": "horizontalInset",
2999
3118
  "inheritedFrom": {
3000
3119
  "name": "AnchoredRegion",
3001
3120
  "module": "src/anchored-region/anchored-region.ts"
3002
3121
  }
3003
3122
  },
3004
3123
  {
3005
- "kind": "field",
3006
- "name": "verticalViewportLock",
3124
+ "name": "horizontal-threshold",
3007
3125
  "type": {
3008
- "text": "boolean"
3126
+ "text": "number"
3009
3127
  },
3010
- "privacy": "public",
3011
- "default": "false",
3012
- "description": "Whether the region remains in the viewport (ie. detaches from the anchor) on the vertical axis",
3128
+ "description": "How narrow the space allocated to the default position has to be before the widest area\nis selected for layout",
3129
+ "fieldName": "horizontalThreshold",
3013
3130
  "inheritedFrom": {
3014
3131
  "name": "AnchoredRegion",
3015
3132
  "module": "src/anchored-region/anchored-region.ts"
3016
3133
  }
3017
3134
  },
3018
3135
  {
3019
- "kind": "method",
3020
- "name": "verticalViewportLockChanged",
3021
- "privacy": "private",
3022
- "return": {
3023
- "type": {
3024
- "text": "void"
3025
- }
3136
+ "name": "horizontal-scaling",
3137
+ "type": {
3138
+ "text": "AxisScalingMode"
3026
3139
  },
3140
+ "default": "\"content\"",
3141
+ "description": "Defines how the width of the region is calculated",
3142
+ "fieldName": "horizontalScaling",
3027
3143
  "inheritedFrom": {
3028
3144
  "name": "AnchoredRegion",
3029
3145
  "module": "src/anchored-region/anchored-region.ts"
3030
3146
  }
3031
3147
  },
3032
3148
  {
3033
- "kind": "field",
3034
- "name": "verticalInset",
3149
+ "name": "vertical-positioning-mode",
3035
3150
  "type": {
3036
- "text": "boolean"
3151
+ "text": "AxisPositioningMode"
3037
3152
  },
3038
- "privacy": "public",
3039
- "default": "false",
3040
- "description": "Whether the region overlaps the anchor on the vertical axis",
3153
+ "default": "\"uncontrolled\"",
3154
+ "description": "Sets what logic the component uses to determine vertical placement.\n'locktodefault' forces the default position\n'dynamic' decides placement based on available space\n'uncontrolled' does not control placement on the vertical axis",
3155
+ "fieldName": "verticalPositioningMode",
3041
3156
  "inheritedFrom": {
3042
3157
  "name": "AnchoredRegion",
3043
3158
  "module": "src/anchored-region/anchored-region.ts"
3044
3159
  }
3045
3160
  },
3046
3161
  {
3047
- "kind": "method",
3048
- "name": "verticalInsetChanged",
3049
- "privacy": "private",
3050
- "return": {
3051
- "type": {
3052
- "text": "void"
3053
- }
3162
+ "name": "vertical-default-position",
3163
+ "type": {
3164
+ "text": "VerticalPosition"
3054
3165
  },
3166
+ "default": "\"unset\"",
3167
+ "description": "The default vertical position of the region relative to the anchor element",
3168
+ "fieldName": "verticalDefaultPosition",
3055
3169
  "inheritedFrom": {
3056
3170
  "name": "AnchoredRegion",
3057
3171
  "module": "src/anchored-region/anchored-region.ts"
3058
3172
  }
3059
3173
  },
3060
3174
  {
3061
- "kind": "field",
3062
- "name": "verticalThreshold",
3175
+ "name": "vertical-viewport-lock",
3063
3176
  "type": {
3064
- "text": "number"
3177
+ "text": "boolean"
3065
3178
  },
3066
- "privacy": "public",
3067
- "description": "How short the space allocated to the default position has to be before the tallest area\nis selected for layout",
3179
+ "default": "false",
3180
+ "description": "Whether the region remains in the viewport (ie. detaches from the anchor) on the vertical axis",
3181
+ "fieldName": "verticalViewportLock",
3068
3182
  "inheritedFrom": {
3069
3183
  "name": "AnchoredRegion",
3070
3184
  "module": "src/anchored-region/anchored-region.ts"
3071
3185
  }
3072
3186
  },
3073
3187
  {
3074
- "kind": "method",
3075
- "name": "verticalThresholdChanged",
3076
- "privacy": "private",
3077
- "return": {
3078
- "type": {
3079
- "text": "void"
3080
- }
3188
+ "name": "vertical-inset",
3189
+ "type": {
3190
+ "text": "boolean"
3081
3191
  },
3192
+ "default": "false",
3193
+ "description": "Whether the region overlaps the anchor on the vertical axis",
3194
+ "fieldName": "verticalInset",
3082
3195
  "inheritedFrom": {
3083
3196
  "name": "AnchoredRegion",
3084
3197
  "module": "src/anchored-region/anchored-region.ts"
3085
3198
  }
3086
3199
  },
3087
3200
  {
3088
- "kind": "field",
3089
- "name": "verticalScaling",
3201
+ "name": "vertical-threshold",
3090
3202
  "type": {
3091
- "text": "AxisScalingMode"
3203
+ "text": "number"
3092
3204
  },
3093
- "privacy": "public",
3094
- "default": "\"content\"",
3095
- "description": "Defines how the height of the region is calculated",
3205
+ "description": "How short the space allocated to the default position has to be before the tallest area\nis selected for layout",
3206
+ "fieldName": "verticalThreshold",
3096
3207
  "inheritedFrom": {
3097
3208
  "name": "AnchoredRegion",
3098
3209
  "module": "src/anchored-region/anchored-region.ts"
3099
3210
  }
3100
3211
  },
3101
3212
  {
3102
- "kind": "method",
3103
- "name": "verticalScalingChanged",
3104
- "privacy": "private",
3105
- "return": {
3106
- "type": {
3107
- "text": "void"
3108
- }
3213
+ "name": "vertical-scaling",
3214
+ "type": {
3215
+ "text": "AxisScalingMode"
3109
3216
  },
3217
+ "default": "\"content\"",
3218
+ "description": "Defines how the height of the region is calculated",
3219
+ "fieldName": "verticalScaling",
3110
3220
  "inheritedFrom": {
3111
3221
  "name": "AnchoredRegion",
3112
3222
  "module": "src/anchored-region/anchored-region.ts"
3113
3223
  }
3114
3224
  },
3115
3225
  {
3116
- "kind": "field",
3117
- "name": "fixedPlacement",
3226
+ "name": "fixed-placement",
3118
3227
  "type": {
3119
3228
  "text": "boolean"
3120
3229
  },
3121
- "privacy": "public",
3122
3230
  "default": "false",
3123
3231
  "description": "Whether the region is positioned using css \"position: fixed\".\nOtherwise the region uses \"position: absolute\".\nFixed placement allows the region to break out of parent containers,",
3232
+ "fieldName": "fixedPlacement",
3124
3233
  "inheritedFrom": {
3125
3234
  "name": "AnchoredRegion",
3126
3235
  "module": "src/anchored-region/anchored-region.ts"
3127
3236
  }
3128
3237
  },
3129
3238
  {
3130
- "kind": "method",
3131
- "name": "fixedPlacementChanged",
3132
- "privacy": "private",
3133
- "return": {
3134
- "type": {
3135
- "text": "void"
3136
- }
3239
+ "name": "auto-update-mode",
3240
+ "type": {
3241
+ "text": "AutoUpdateMode"
3137
3242
  },
3243
+ "default": "\"anchor\"",
3244
+ "description": "Defines what triggers the anchored region to revaluate positioning",
3245
+ "fieldName": "autoUpdateMode",
3138
3246
  "inheritedFrom": {
3139
3247
  "name": "AnchoredRegion",
3140
3248
  "module": "src/anchored-region/anchored-region.ts"
3141
3249
  }
3142
- },
3250
+ }
3251
+ ],
3252
+ "members": [
3143
3253
  {
3144
3254
  "kind": "field",
3145
- "name": "autoUpdateMode",
3255
+ "name": "anchor",
3146
3256
  "type": {
3147
- "text": "AutoUpdateMode"
3257
+ "text": "string"
3148
3258
  },
3149
3259
  "privacy": "public",
3150
- "default": "\"anchor\"",
3151
- "description": "Defines what triggers the anchored region to revaluate positioning",
3260
+ "default": "\"\"",
3261
+ "description": "The HTML ID of the anchor element this region is positioned relative to",
3152
3262
  "inheritedFrom": {
3153
3263
  "name": "AnchoredRegion",
3154
3264
  "module": "src/anchored-region/anchored-region.ts"
@@ -3156,27 +3266,13 @@
3156
3266
  },
3157
3267
  {
3158
3268
  "kind": "method",
3159
- "name": "autoUpdateModeChanged",
3269
+ "name": "anchorChanged",
3160
3270
  "privacy": "private",
3161
3271
  "return": {
3162
3272
  "type": {
3163
3273
  "text": "void"
3164
3274
  }
3165
3275
  },
3166
- "parameters": [
3167
- {
3168
- "name": "prevMode",
3169
- "type": {
3170
- "text": "AutoUpdateMode"
3171
- }
3172
- },
3173
- {
3174
- "name": "newMode",
3175
- "type": {
3176
- "text": "AutoUpdateMode"
3177
- }
3178
- }
3179
- ],
3180
3276
  "inheritedFrom": {
3181
3277
  "name": "AnchoredRegion",
3182
3278
  "module": "src/anchored-region/anchored-region.ts"
@@ -3184,13 +3280,13 @@
3184
3280
  },
3185
3281
  {
3186
3282
  "kind": "field",
3187
- "name": "anchorElement",
3283
+ "name": "viewport",
3188
3284
  "type": {
3189
- "text": "HTMLElement | null"
3285
+ "text": "string"
3190
3286
  },
3191
3287
  "privacy": "public",
3192
- "default": "null",
3193
- "description": "The HTML element being used as the anchor",
3288
+ "default": "\"\"",
3289
+ "description": "The HTML ID of the viewport element this region is positioned relative to",
3194
3290
  "inheritedFrom": {
3195
3291
  "name": "AnchoredRegion",
3196
3292
  "module": "src/anchored-region/anchored-region.ts"
@@ -3198,7 +3294,7 @@
3198
3294
  },
3199
3295
  {
3200
3296
  "kind": "method",
3201
- "name": "anchorElementChanged",
3297
+ "name": "viewportChanged",
3202
3298
  "privacy": "private",
3203
3299
  "return": {
3204
3300
  "type": {
@@ -3212,13 +3308,13 @@
3212
3308
  },
3213
3309
  {
3214
3310
  "kind": "field",
3215
- "name": "viewportElement",
3311
+ "name": "horizontalPositioningMode",
3216
3312
  "type": {
3217
- "text": "HTMLElement | null"
3313
+ "text": "AxisPositioningMode"
3218
3314
  },
3219
3315
  "privacy": "public",
3220
- "default": "null",
3221
- "description": "The HTML element being used as the viewport",
3316
+ "default": "\"uncontrolled\"",
3317
+ "description": "Sets what logic the component uses to determine horizontal placement.\n'locktodefault' forces the default position\n'dynamic' decides placement based on available space\n'uncontrolled' does not control placement on the horizontal axis",
3222
3318
  "inheritedFrom": {
3223
3319
  "name": "AnchoredRegion",
3224
3320
  "module": "src/anchored-region/anchored-region.ts"
@@ -3226,7 +3322,7 @@
3226
3322
  },
3227
3323
  {
3228
3324
  "kind": "method",
3229
- "name": "viewportElementChanged",
3325
+ "name": "horizontalPositioningModeChanged",
3230
3326
  "privacy": "private",
3231
3327
  "return": {
3232
3328
  "type": {
@@ -3240,50 +3336,27 @@
3240
3336
  },
3241
3337
  {
3242
3338
  "kind": "field",
3243
- "name": "verticalPosition",
3244
- "type": {
3245
- "text": "AnchoredRegionPositionLabel | undefined"
3246
- },
3247
- "privacy": "public",
3248
- "description": "indicates the current horizontal position of the region",
3249
- "inheritedFrom": {
3250
- "name": "AnchoredRegion",
3251
- "module": "src/anchored-region/anchored-region.ts"
3252
- }
3253
- },
3254
- {
3255
- "kind": "field",
3256
- "name": "horizontalPosition",
3339
+ "name": "horizontalDefaultPosition",
3257
3340
  "type": {
3258
- "text": "AnchoredRegionPositionLabel | undefined"
3341
+ "text": "HorizontalPosition"
3259
3342
  },
3260
3343
  "privacy": "public",
3261
- "description": "indicates the current vertical position of the region",
3344
+ "default": "\"unset\"",
3345
+ "description": "The default horizontal position of the region relative to the anchor element",
3262
3346
  "inheritedFrom": {
3263
3347
  "name": "AnchoredRegion",
3264
3348
  "module": "src/anchored-region/anchored-region.ts"
3265
3349
  }
3266
3350
  },
3267
3351
  {
3268
- "kind": "field",
3269
- "name": "translateX",
3270
- "type": {
3271
- "text": "number"
3272
- },
3352
+ "kind": "method",
3353
+ "name": "horizontalDefaultPositionChanged",
3273
3354
  "privacy": "private",
3274
- "description": "values to be applied to the component's transform on render",
3275
- "inheritedFrom": {
3276
- "name": "AnchoredRegion",
3277
- "module": "src/anchored-region/anchored-region.ts"
3278
- }
3279
- },
3280
- {
3281
- "kind": "field",
3282
- "name": "translateY",
3283
- "type": {
3284
- "text": "number"
3355
+ "return": {
3356
+ "type": {
3357
+ "text": "void"
3358
+ }
3285
3359
  },
3286
- "privacy": "private",
3287
3360
  "inheritedFrom": {
3288
3361
  "name": "AnchoredRegion",
3289
3362
  "module": "src/anchored-region/anchored-region.ts"
@@ -3291,37 +3364,27 @@
3291
3364
  },
3292
3365
  {
3293
3366
  "kind": "field",
3294
- "name": "regionWidth",
3367
+ "name": "horizontalViewportLock",
3295
3368
  "type": {
3296
- "text": "string"
3369
+ "text": "boolean"
3297
3370
  },
3298
- "privacy": "private",
3299
- "description": "the span to be applied to the region on each axis",
3371
+ "privacy": "public",
3372
+ "default": "false",
3373
+ "description": "Whether the region remains in the viewport (ie. detaches from the anchor) on the horizontal axis",
3300
3374
  "inheritedFrom": {
3301
3375
  "name": "AnchoredRegion",
3302
3376
  "module": "src/anchored-region/anchored-region.ts"
3303
3377
  }
3304
3378
  },
3305
3379
  {
3306
- "kind": "field",
3307
- "name": "regionHeight",
3308
- "type": {
3309
- "text": "string"
3310
- },
3380
+ "kind": "method",
3381
+ "name": "horizontalViewportLockChanged",
3311
3382
  "privacy": "private",
3312
- "inheritedFrom": {
3313
- "name": "AnchoredRegion",
3314
- "module": "src/anchored-region/anchored-region.ts"
3315
- }
3316
- },
3317
- {
3318
- "kind": "field",
3319
- "name": "resizeDetector",
3320
- "type": {
3321
- "text": "ResizeObserverClassDefinition | null"
3383
+ "return": {
3384
+ "type": {
3385
+ "text": "void"
3386
+ }
3322
3387
  },
3323
- "privacy": "private",
3324
- "default": "null",
3325
3388
  "inheritedFrom": {
3326
3389
  "name": "AnchoredRegion",
3327
3390
  "module": "src/anchored-region/anchored-region.ts"
@@ -3329,35 +3392,27 @@
3329
3392
  },
3330
3393
  {
3331
3394
  "kind": "field",
3332
- "name": "viewportRect",
3395
+ "name": "horizontalInset",
3333
3396
  "type": {
3334
- "text": "ClientRect | DOMRect | undefined"
3397
+ "text": "boolean"
3335
3398
  },
3336
- "privacy": "private",
3399
+ "privacy": "public",
3400
+ "default": "false",
3401
+ "description": "Whether the region overlaps the anchor on the horizontal axis",
3337
3402
  "inheritedFrom": {
3338
3403
  "name": "AnchoredRegion",
3339
3404
  "module": "src/anchored-region/anchored-region.ts"
3340
3405
  }
3341
3406
  },
3342
3407
  {
3343
- "kind": "field",
3344
- "name": "anchorRect",
3345
- "type": {
3346
- "text": "ClientRect | DOMRect | undefined"
3347
- },
3408
+ "kind": "method",
3409
+ "name": "horizontalInsetChanged",
3348
3410
  "privacy": "private",
3349
- "inheritedFrom": {
3350
- "name": "AnchoredRegion",
3351
- "module": "src/anchored-region/anchored-region.ts"
3352
- }
3353
- },
3354
- {
3355
- "kind": "field",
3356
- "name": "regionRect",
3357
- "type": {
3358
- "text": "ClientRect | DOMRect | undefined"
3411
+ "return": {
3412
+ "type": {
3413
+ "text": "void"
3414
+ }
3359
3415
  },
3360
- "privacy": "private",
3361
3416
  "inheritedFrom": {
3362
3417
  "name": "AnchoredRegion",
3363
3418
  "module": "src/anchored-region/anchored-region.ts"
@@ -3365,39 +3420,26 @@
3365
3420
  },
3366
3421
  {
3367
3422
  "kind": "field",
3368
- "name": "baseHorizontalOffset",
3423
+ "name": "horizontalThreshold",
3369
3424
  "type": {
3370
3425
  "text": "number"
3371
3426
  },
3372
- "privacy": "private",
3373
- "default": "0",
3374
- "description": "base offsets between the positioner's base position and the anchor's",
3427
+ "privacy": "public",
3428
+ "description": "How narrow the space allocated to the default position has to be before the widest area\nis selected for layout",
3375
3429
  "inheritedFrom": {
3376
3430
  "name": "AnchoredRegion",
3377
3431
  "module": "src/anchored-region/anchored-region.ts"
3378
3432
  }
3379
3433
  },
3380
3434
  {
3381
- "kind": "field",
3382
- "name": "baseVerticalOffset",
3383
- "type": {
3384
- "text": "number"
3385
- },
3435
+ "kind": "method",
3436
+ "name": "horizontalThresholdChanged",
3386
3437
  "privacy": "private",
3387
- "default": "0",
3388
- "inheritedFrom": {
3389
- "name": "AnchoredRegion",
3390
- "module": "src/anchored-region/anchored-region.ts"
3391
- }
3392
- },
3393
- {
3394
- "kind": "field",
3395
- "name": "pendingPositioningUpdate",
3396
- "type": {
3397
- "text": "boolean"
3438
+ "return": {
3439
+ "type": {
3440
+ "text": "void"
3441
+ }
3398
3442
  },
3399
- "privacy": "private",
3400
- "default": "false",
3401
3443
  "inheritedFrom": {
3402
3444
  "name": "AnchoredRegion",
3403
3445
  "module": "src/anchored-region/anchored-region.ts"
@@ -3405,37 +3447,27 @@
3405
3447
  },
3406
3448
  {
3407
3449
  "kind": "field",
3408
- "name": "pendingReset",
3450
+ "name": "horizontalScaling",
3409
3451
  "type": {
3410
- "text": "boolean"
3452
+ "text": "AxisScalingMode"
3411
3453
  },
3412
- "privacy": "private",
3413
- "default": "false",
3454
+ "privacy": "public",
3455
+ "default": "\"content\"",
3456
+ "description": "Defines how the width of the region is calculated",
3414
3457
  "inheritedFrom": {
3415
3458
  "name": "AnchoredRegion",
3416
3459
  "module": "src/anchored-region/anchored-region.ts"
3417
3460
  }
3418
3461
  },
3419
3462
  {
3420
- "kind": "field",
3421
- "name": "currentDirection",
3422
- "type": {
3423
- "text": "Direction"
3424
- },
3463
+ "kind": "method",
3464
+ "name": "horizontalScalingChanged",
3425
3465
  "privacy": "private",
3426
- "inheritedFrom": {
3427
- "name": "AnchoredRegion",
3428
- "module": "src/anchored-region/anchored-region.ts"
3429
- }
3430
- },
3431
- {
3432
- "kind": "field",
3433
- "name": "regionVisible",
3434
- "type": {
3435
- "text": "boolean"
3466
+ "return": {
3467
+ "type": {
3468
+ "text": "void"
3469
+ }
3436
3470
  },
3437
- "privacy": "private",
3438
- "default": "false",
3439
3471
  "inheritedFrom": {
3440
3472
  "name": "AnchoredRegion",
3441
3473
  "module": "src/anchored-region/anchored-region.ts"
@@ -3443,25 +3475,27 @@
3443
3475
  },
3444
3476
  {
3445
3477
  "kind": "field",
3446
- "name": "forceUpdate",
3478
+ "name": "verticalPositioningMode",
3447
3479
  "type": {
3448
- "text": "boolean"
3480
+ "text": "AxisPositioningMode"
3449
3481
  },
3450
- "privacy": "private",
3451
- "default": "false",
3482
+ "privacy": "public",
3483
+ "default": "\"uncontrolled\"",
3484
+ "description": "Sets what logic the component uses to determine vertical placement.\n'locktodefault' forces the default position\n'dynamic' decides placement based on available space\n'uncontrolled' does not control placement on the vertical axis",
3452
3485
  "inheritedFrom": {
3453
3486
  "name": "AnchoredRegion",
3454
3487
  "module": "src/anchored-region/anchored-region.ts"
3455
3488
  }
3456
3489
  },
3457
3490
  {
3458
- "kind": "field",
3459
- "name": "updateThreshold",
3460
- "type": {
3461
- "text": "number"
3462
- },
3491
+ "kind": "method",
3492
+ "name": "verticalPositioningModeChanged",
3463
3493
  "privacy": "private",
3464
- "default": "0.5",
3494
+ "return": {
3495
+ "type": {
3496
+ "text": "void"
3497
+ }
3498
+ },
3465
3499
  "inheritedFrom": {
3466
3500
  "name": "AnchoredRegion",
3467
3501
  "module": "src/anchored-region/anchored-region.ts"
@@ -3469,38 +3503,13 @@
3469
3503
  },
3470
3504
  {
3471
3505
  "kind": "field",
3472
- "name": "intersectionService",
3506
+ "name": "verticalDefaultPosition",
3473
3507
  "type": {
3474
- "text": "IntersectionService"
3508
+ "text": "VerticalPosition"
3475
3509
  },
3476
- "privacy": "private",
3477
- "static": true,
3478
- "default": "new IntersectionService()",
3479
- "inheritedFrom": {
3480
- "name": "AnchoredRegion",
3481
- "module": "src/anchored-region/anchored-region.ts"
3482
- }
3483
- },
3484
- {
3485
- "kind": "field",
3486
- "name": "update",
3487
3510
  "privacy": "public",
3488
- "description": "update position",
3489
- "inheritedFrom": {
3490
- "name": "AnchoredRegion",
3491
- "module": "src/anchored-region/anchored-region.ts"
3492
- }
3493
- },
3494
- {
3495
- "kind": "method",
3496
- "name": "disconnectResizeDetector",
3497
- "privacy": "private",
3498
- "return": {
3499
- "type": {
3500
- "text": "void"
3501
- }
3502
- },
3503
- "description": "destroys the instance's resize observer",
3511
+ "default": "\"unset\"",
3512
+ "description": "The default vertical position of the region relative to the anchor element",
3504
3513
  "inheritedFrom": {
3505
3514
  "name": "AnchoredRegion",
3506
3515
  "module": "src/anchored-region/anchored-region.ts"
@@ -3508,29 +3517,27 @@
3508
3517
  },
3509
3518
  {
3510
3519
  "kind": "method",
3511
- "name": "initializeResizeDetector",
3520
+ "name": "verticalDefaultPositionChanged",
3512
3521
  "privacy": "private",
3513
3522
  "return": {
3514
3523
  "type": {
3515
3524
  "text": "void"
3516
3525
  }
3517
3526
  },
3518
- "description": "initializes the instance's resize observer",
3519
3527
  "inheritedFrom": {
3520
3528
  "name": "AnchoredRegion",
3521
3529
  "module": "src/anchored-region/anchored-region.ts"
3522
3530
  }
3523
3531
  },
3524
3532
  {
3525
- "kind": "method",
3526
- "name": "updateForAttributeChange",
3527
- "privacy": "private",
3528
- "return": {
3529
- "type": {
3530
- "text": "void"
3531
- }
3533
+ "kind": "field",
3534
+ "name": "verticalViewportLock",
3535
+ "type": {
3536
+ "text": "boolean"
3532
3537
  },
3533
- "description": "react to attribute changes that don't require a reset",
3538
+ "privacy": "public",
3539
+ "default": "false",
3540
+ "description": "Whether the region remains in the viewport (ie. detaches from the anchor) on the vertical axis",
3534
3541
  "inheritedFrom": {
3535
3542
  "name": "AnchoredRegion",
3536
3543
  "module": "src/anchored-region/anchored-region.ts"
@@ -3538,29 +3545,27 @@
3538
3545
  },
3539
3546
  {
3540
3547
  "kind": "method",
3541
- "name": "initialize",
3548
+ "name": "verticalViewportLockChanged",
3542
3549
  "privacy": "private",
3543
3550
  "return": {
3544
3551
  "type": {
3545
3552
  "text": "void"
3546
3553
  }
3547
3554
  },
3548
- "description": "fully initializes the component",
3549
3555
  "inheritedFrom": {
3550
3556
  "name": "AnchoredRegion",
3551
3557
  "module": "src/anchored-region/anchored-region.ts"
3552
3558
  }
3553
3559
  },
3554
3560
  {
3555
- "kind": "method",
3556
- "name": "requestReset",
3557
- "privacy": "private",
3558
- "return": {
3559
- "type": {
3560
- "text": "void"
3561
- }
3561
+ "kind": "field",
3562
+ "name": "verticalInset",
3563
+ "type": {
3564
+ "text": "boolean"
3562
3565
  },
3563
- "description": "Request a reset if there are currently no open requests",
3566
+ "privacy": "public",
3567
+ "default": "false",
3568
+ "description": "Whether the region overlaps the anchor on the vertical axis",
3564
3569
  "inheritedFrom": {
3565
3570
  "name": "AnchoredRegion",
3566
3571
  "module": "src/anchored-region/anchored-region.ts"
@@ -3568,14 +3573,13 @@
3568
3573
  },
3569
3574
  {
3570
3575
  "kind": "method",
3571
- "name": "setInitialState",
3576
+ "name": "verticalInsetChanged",
3572
3577
  "privacy": "private",
3573
3578
  "return": {
3574
3579
  "type": {
3575
3580
  "text": "void"
3576
3581
  }
3577
3582
  },
3578
- "description": "sets the starting configuration for component internal values",
3579
3583
  "inheritedFrom": {
3580
3584
  "name": "AnchoredRegion",
3581
3585
  "module": "src/anchored-region/anchored-region.ts"
@@ -3583,19 +3587,26 @@
3583
3587
  },
3584
3588
  {
3585
3589
  "kind": "field",
3586
- "name": "startObservers",
3587
- "privacy": "private",
3588
- "description": "starts observers",
3590
+ "name": "verticalThreshold",
3591
+ "type": {
3592
+ "text": "number"
3593
+ },
3594
+ "privacy": "public",
3595
+ "description": "How short the space allocated to the default position has to be before the tallest area\nis selected for layout",
3589
3596
  "inheritedFrom": {
3590
3597
  "name": "AnchoredRegion",
3591
3598
  "module": "src/anchored-region/anchored-region.ts"
3592
3599
  }
3593
3600
  },
3594
3601
  {
3595
- "kind": "field",
3596
- "name": "requestPositionUpdates",
3602
+ "kind": "method",
3603
+ "name": "verticalThresholdChanged",
3597
3604
  "privacy": "private",
3598
- "description": "get position updates",
3605
+ "return": {
3606
+ "type": {
3607
+ "text": "void"
3608
+ }
3609
+ },
3599
3610
  "inheritedFrom": {
3600
3611
  "name": "AnchoredRegion",
3601
3612
  "module": "src/anchored-region/anchored-region.ts"
@@ -3603,19 +3614,27 @@
3603
3614
  },
3604
3615
  {
3605
3616
  "kind": "field",
3606
- "name": "stopObservers",
3607
- "privacy": "private",
3608
- "description": "stops observers",
3617
+ "name": "verticalScaling",
3618
+ "type": {
3619
+ "text": "AxisScalingMode"
3620
+ },
3621
+ "privacy": "public",
3622
+ "default": "\"content\"",
3623
+ "description": "Defines how the height of the region is calculated",
3609
3624
  "inheritedFrom": {
3610
3625
  "name": "AnchoredRegion",
3611
3626
  "module": "src/anchored-region/anchored-region.ts"
3612
3627
  }
3613
3628
  },
3614
3629
  {
3615
- "kind": "field",
3616
- "name": "getViewport",
3630
+ "kind": "method",
3631
+ "name": "verticalScalingChanged",
3617
3632
  "privacy": "private",
3618
- "description": "Gets the viewport element by id, or defaults to document root",
3633
+ "return": {
3634
+ "type": {
3635
+ "text": "void"
3636
+ }
3637
+ },
3619
3638
  "inheritedFrom": {
3620
3639
  "name": "AnchoredRegion",
3621
3640
  "module": "src/anchored-region/anchored-region.ts"
@@ -3623,19 +3642,27 @@
3623
3642
  },
3624
3643
  {
3625
3644
  "kind": "field",
3626
- "name": "getAnchor",
3627
- "privacy": "private",
3628
- "description": "Gets the anchor element by id",
3645
+ "name": "fixedPlacement",
3646
+ "type": {
3647
+ "text": "boolean"
3648
+ },
3649
+ "privacy": "public",
3650
+ "default": "false",
3651
+ "description": "Whether the region is positioned using css \"position: fixed\".\nOtherwise the region uses \"position: absolute\".\nFixed placement allows the region to break out of parent containers,",
3629
3652
  "inheritedFrom": {
3630
3653
  "name": "AnchoredRegion",
3631
3654
  "module": "src/anchored-region/anchored-region.ts"
3632
3655
  }
3633
3656
  },
3634
3657
  {
3635
- "kind": "field",
3636
- "name": "handleIntersection",
3658
+ "kind": "method",
3659
+ "name": "fixedPlacementChanged",
3637
3660
  "privacy": "private",
3638
- "description": "Handle intersections",
3661
+ "return": {
3662
+ "type": {
3663
+ "text": "void"
3664
+ }
3665
+ },
3639
3666
  "inheritedFrom": {
3640
3667
  "name": "AnchoredRegion",
3641
3668
  "module": "src/anchored-region/anchored-region.ts"
@@ -3643,19 +3670,41 @@
3643
3670
  },
3644
3671
  {
3645
3672
  "kind": "field",
3646
- "name": "applyIntersectionEntries",
3647
- "privacy": "private",
3648
- "description": "iterate through intersection entries and apply data",
3673
+ "name": "autoUpdateMode",
3674
+ "type": {
3675
+ "text": "AutoUpdateMode"
3676
+ },
3677
+ "privacy": "public",
3678
+ "default": "\"anchor\"",
3679
+ "description": "Defines what triggers the anchored region to revaluate positioning",
3649
3680
  "inheritedFrom": {
3650
3681
  "name": "AnchoredRegion",
3651
3682
  "module": "src/anchored-region/anchored-region.ts"
3652
3683
  }
3653
3684
  },
3654
3685
  {
3655
- "kind": "field",
3656
- "name": "updateRegionOffset",
3686
+ "kind": "method",
3687
+ "name": "autoUpdateModeChanged",
3657
3688
  "privacy": "private",
3658
- "description": "Update the offset values",
3689
+ "return": {
3690
+ "type": {
3691
+ "text": "void"
3692
+ }
3693
+ },
3694
+ "parameters": [
3695
+ {
3696
+ "name": "prevMode",
3697
+ "type": {
3698
+ "text": "AutoUpdateMode"
3699
+ }
3700
+ },
3701
+ {
3702
+ "name": "newMode",
3703
+ "type": {
3704
+ "text": "AutoUpdateMode"
3705
+ }
3706
+ }
3707
+ ],
3659
3708
  "inheritedFrom": {
3660
3709
  "name": "AnchoredRegion",
3661
3710
  "module": "src/anchored-region/anchored-region.ts"
@@ -3663,19 +3712,27 @@
3663
3712
  },
3664
3713
  {
3665
3714
  "kind": "field",
3666
- "name": "isRectDifferent",
3667
- "privacy": "private",
3668
- "description": "compare rects to see if there is enough change to justify a DOM update",
3715
+ "name": "anchorElement",
3716
+ "type": {
3717
+ "text": "HTMLElement | null"
3718
+ },
3719
+ "privacy": "public",
3720
+ "default": "null",
3721
+ "description": "The HTML element being used as the anchor",
3669
3722
  "inheritedFrom": {
3670
3723
  "name": "AnchoredRegion",
3671
3724
  "module": "src/anchored-region/anchored-region.ts"
3672
3725
  }
3673
3726
  },
3674
3727
  {
3675
- "kind": "field",
3676
- "name": "handleResize",
3728
+ "kind": "method",
3729
+ "name": "anchorElementChanged",
3677
3730
  "privacy": "private",
3678
- "description": "Handle resize events",
3731
+ "return": {
3732
+ "type": {
3733
+ "text": "void"
3734
+ }
3735
+ },
3679
3736
  "inheritedFrom": {
3680
3737
  "name": "AnchoredRegion",
3681
3738
  "module": "src/anchored-region/anchored-region.ts"
@@ -3683,19 +3740,27 @@
3683
3740
  },
3684
3741
  {
3685
3742
  "kind": "field",
3686
- "name": "reset",
3687
- "privacy": "private",
3688
- "description": "resets the component",
3743
+ "name": "viewportElement",
3744
+ "type": {
3745
+ "text": "HTMLElement | null"
3746
+ },
3747
+ "privacy": "public",
3748
+ "default": "null",
3749
+ "description": "The HTML element being used as the viewport",
3689
3750
  "inheritedFrom": {
3690
3751
  "name": "AnchoredRegion",
3691
3752
  "module": "src/anchored-region/anchored-region.ts"
3692
3753
  }
3693
3754
  },
3694
3755
  {
3695
- "kind": "field",
3696
- "name": "updateLayout",
3756
+ "kind": "method",
3757
+ "name": "viewportElementChanged",
3697
3758
  "privacy": "private",
3698
- "description": "Recalculate layout related state values",
3759
+ "return": {
3760
+ "type": {
3761
+ "text": "void"
3762
+ }
3763
+ },
3699
3764
  "inheritedFrom": {
3700
3765
  "name": "AnchoredRegion",
3701
3766
  "module": "src/anchored-region/anchored-region.ts"
@@ -3703,9 +3768,12 @@
3703
3768
  },
3704
3769
  {
3705
3770
  "kind": "field",
3706
- "name": "updateRegionStyle",
3707
- "privacy": "private",
3708
- "description": "Updates the style string applied to the region element as well as the css classes attached\nto the root element",
3771
+ "name": "verticalPosition",
3772
+ "type": {
3773
+ "text": "AnchoredRegionPositionLabel | undefined"
3774
+ },
3775
+ "privacy": "public",
3776
+ "description": "indicates the current horizontal position of the region",
3709
3777
  "inheritedFrom": {
3710
3778
  "name": "AnchoredRegion",
3711
3779
  "module": "src/anchored-region/anchored-region.ts"
@@ -3713,9 +3781,12 @@
3713
3781
  },
3714
3782
  {
3715
3783
  "kind": "field",
3716
- "name": "updatePositionClasses",
3717
- "privacy": "private",
3718
- "description": "Updates the css classes that reflect the current position of the element",
3784
+ "name": "horizontalPosition",
3785
+ "type": {
3786
+ "text": "AnchoredRegionPositionLabel | undefined"
3787
+ },
3788
+ "privacy": "public",
3789
+ "description": "indicates the current vertical position of the region",
3719
3790
  "inheritedFrom": {
3720
3791
  "name": "AnchoredRegion",
3721
3792
  "module": "src/anchored-region/anchored-region.ts"
@@ -3723,9 +3794,12 @@
3723
3794
  },
3724
3795
  {
3725
3796
  "kind": "field",
3726
- "name": "setHorizontalPosition",
3797
+ "name": "translateX",
3798
+ "type": {
3799
+ "text": "number"
3800
+ },
3727
3801
  "privacy": "private",
3728
- "description": "Get horizontal positioning state based on desired position",
3802
+ "description": "values to be applied to the component's transform on render",
3729
3803
  "inheritedFrom": {
3730
3804
  "name": "AnchoredRegion",
3731
3805
  "module": "src/anchored-region/anchored-region.ts"
@@ -3733,9 +3807,11 @@
3733
3807
  },
3734
3808
  {
3735
3809
  "kind": "field",
3736
- "name": "setVerticalPosition",
3810
+ "name": "translateY",
3811
+ "type": {
3812
+ "text": "number"
3813
+ },
3737
3814
  "privacy": "private",
3738
- "description": "Set vertical positioning state based on desired position",
3739
3815
  "inheritedFrom": {
3740
3816
  "name": "AnchoredRegion",
3741
3817
  "module": "src/anchored-region/anchored-region.ts"
@@ -3743,9 +3819,12 @@
3743
3819
  },
3744
3820
  {
3745
3821
  "kind": "field",
3746
- "name": "getPositioningOptions",
3822
+ "name": "regionWidth",
3823
+ "type": {
3824
+ "text": "string"
3825
+ },
3747
3826
  "privacy": "private",
3748
- "description": "Get available positions based on positioning mode",
3827
+ "description": "the span to be applied to the region on each axis",
3749
3828
  "inheritedFrom": {
3750
3829
  "name": "AnchoredRegion",
3751
3830
  "module": "src/anchored-region/anchored-region.ts"
@@ -3753,9 +3832,11 @@
3753
3832
  },
3754
3833
  {
3755
3834
  "kind": "field",
3756
- "name": "getAvailableSpace",
3835
+ "name": "regionHeight",
3836
+ "type": {
3837
+ "text": "string"
3838
+ },
3757
3839
  "privacy": "private",
3758
- "description": "Get the space available for a particular relative position",
3759
3840
  "inheritedFrom": {
3760
3841
  "name": "AnchoredRegion",
3761
3842
  "module": "src/anchored-region/anchored-region.ts"
@@ -3763,9 +3844,12 @@
3763
3844
  },
3764
3845
  {
3765
3846
  "kind": "field",
3766
- "name": "getNextRegionDimension",
3847
+ "name": "resizeDetector",
3848
+ "type": {
3849
+ "text": "ResizeObserverClassDefinition | null"
3850
+ },
3767
3851
  "privacy": "private",
3768
- "description": "Get region dimensions",
3852
+ "default": "null",
3769
3853
  "inheritedFrom": {
3770
3854
  "name": "AnchoredRegion",
3771
3855
  "module": "src/anchored-region/anchored-region.ts"
@@ -3773,9 +3857,11 @@
3773
3857
  },
3774
3858
  {
3775
3859
  "kind": "field",
3776
- "name": "startAutoUpdateEventListeners",
3860
+ "name": "viewportRect",
3861
+ "type": {
3862
+ "text": "ClientRect | DOMRect | undefined"
3863
+ },
3777
3864
  "privacy": "private",
3778
- "description": "starts event listeners that can trigger auto updating",
3779
3865
  "inheritedFrom": {
3780
3866
  "name": "AnchoredRegion",
3781
3867
  "module": "src/anchored-region/anchored-region.ts"
@@ -3783,9 +3869,11 @@
3783
3869
  },
3784
3870
  {
3785
3871
  "kind": "field",
3786
- "name": "stopAutoUpdateEventListeners",
3872
+ "name": "anchorRect",
3873
+ "type": {
3874
+ "text": "ClientRect | DOMRect | undefined"
3875
+ },
3787
3876
  "privacy": "private",
3788
- "description": "stops event listeners that can trigger auto updating",
3789
3877
  "inheritedFrom": {
3790
3878
  "name": "AnchoredRegion",
3791
3879
  "module": "src/anchored-region/anchored-region.ts"
@@ -3793,540 +3881,442 @@
3793
3881
  },
3794
3882
  {
3795
3883
  "kind": "field",
3796
- "name": "_presentation",
3884
+ "name": "regionRect",
3797
3885
  "type": {
3798
- "text": "ComponentPresentation | null | undefined"
3886
+ "text": "ClientRect | DOMRect | undefined"
3799
3887
  },
3800
3888
  "privacy": "private",
3801
- "default": "void 0",
3802
3889
  "inheritedFrom": {
3803
- "name": "FoundationElement",
3804
- "module": "src/foundation-element/foundation-element.ts"
3890
+ "name": "AnchoredRegion",
3891
+ "module": "src/anchored-region/anchored-region.ts"
3805
3892
  }
3806
3893
  },
3807
3894
  {
3808
3895
  "kind": "field",
3809
- "name": "$presentation",
3896
+ "name": "baseHorizontalOffset",
3810
3897
  "type": {
3811
- "text": "ComponentPresentation | null"
3898
+ "text": "number"
3812
3899
  },
3813
- "privacy": "public",
3814
- "description": "A property which resolves the ComponentPresentation instance\nfor the current component.",
3900
+ "privacy": "private",
3901
+ "default": "0",
3902
+ "description": "base offsets between the positioner's base position and the anchor's",
3815
3903
  "inheritedFrom": {
3816
- "name": "FoundationElement",
3817
- "module": "src/foundation-element/foundation-element.ts"
3904
+ "name": "AnchoredRegion",
3905
+ "module": "src/anchored-region/anchored-region.ts"
3818
3906
  }
3819
3907
  },
3820
3908
  {
3821
3909
  "kind": "field",
3822
- "name": "template",
3910
+ "name": "baseVerticalOffset",
3823
3911
  "type": {
3824
- "text": "ElementViewTemplate | void | null"
3825
- },
3826
- "privacy": "public",
3827
- "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.",
3828
- "inheritedFrom": {
3829
- "name": "FoundationElement",
3830
- "module": "src/foundation-element/foundation-element.ts"
3831
- }
3832
- },
3833
- {
3834
- "kind": "method",
3835
- "name": "templateChanged",
3836
- "privacy": "protected",
3837
- "return": {
3838
- "type": {
3839
- "text": "void"
3840
- }
3912
+ "text": "number"
3841
3913
  },
3914
+ "privacy": "private",
3915
+ "default": "0",
3842
3916
  "inheritedFrom": {
3843
- "name": "FoundationElement",
3844
- "module": "src/foundation-element/foundation-element.ts"
3917
+ "name": "AnchoredRegion",
3918
+ "module": "src/anchored-region/anchored-region.ts"
3845
3919
  }
3846
3920
  },
3847
3921
  {
3848
3922
  "kind": "field",
3849
- "name": "styles",
3923
+ "name": "pendingPositioningUpdate",
3850
3924
  "type": {
3851
- "text": "ElementStyles | void | null"
3852
- },
3853
- "privacy": "public",
3854
- "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.",
3855
- "inheritedFrom": {
3856
- "name": "FoundationElement",
3857
- "module": "src/foundation-element/foundation-element.ts"
3858
- }
3859
- },
3860
- {
3861
- "kind": "method",
3862
- "name": "stylesChanged",
3863
- "privacy": "protected",
3864
- "return": {
3865
- "type": {
3866
- "text": "void"
3867
- }
3868
- },
3869
- "inheritedFrom": {
3870
- "name": "FoundationElement",
3871
- "module": "src/foundation-element/foundation-element.ts"
3872
- }
3873
- },
3874
- {
3875
- "kind": "method",
3876
- "name": "compose",
3877
- "privacy": "public",
3878
- "static": true,
3879
- "return": {
3880
- "type": {
3881
- "text": "(\n overrideDefinition?: OverrideFoundationElementDefinition<T>\n ) => FoundationElementRegistry<T, K>"
3882
- }
3925
+ "text": "boolean"
3883
3926
  },
3884
- "parameters": [
3885
- {
3886
- "name": "this",
3887
- "type": {
3888
- "text": "K"
3889
- }
3890
- },
3891
- {
3892
- "name": "elementDefinition",
3893
- "type": {
3894
- "text": "T"
3895
- },
3896
- "description": "The definition of the element to create the registry\nfunction for."
3897
- }
3898
- ],
3899
- "description": "Defines an element registry function with a set of element definition defaults.",
3900
- "inheritedFrom": {
3901
- "name": "FoundationElement",
3902
- "module": "src/foundation-element/foundation-element.ts"
3903
- }
3904
- }
3905
- ],
3906
- "events": [
3907
- {
3908
- "description": "Fires a custom 'loaded' event when the region is loaded and visible",
3909
- "name": "loaded",
3927
+ "privacy": "private",
3928
+ "default": "false",
3910
3929
  "inheritedFrom": {
3911
3930
  "name": "AnchoredRegion",
3912
3931
  "module": "src/anchored-region/anchored-region.ts"
3913
3932
  }
3914
3933
  },
3915
3934
  {
3916
- "description": "Fires a custom 'positionchange' event when the position has changed",
3917
- "name": "positionchange",
3935
+ "kind": "field",
3936
+ "name": "pendingReset",
3937
+ "type": {
3938
+ "text": "boolean"
3939
+ },
3940
+ "privacy": "private",
3941
+ "default": "false",
3918
3942
  "inheritedFrom": {
3919
3943
  "name": "AnchoredRegion",
3920
3944
  "module": "src/anchored-region/anchored-region.ts"
3921
3945
  }
3922
- }
3923
- ]
3924
- },
3925
- {
3926
- "kind": "variable",
3927
- "name": "foundationAnchoredRegionShadowOptions",
3928
- "type": {
3929
- "text": "ShadowRootInit"
3930
- },
3931
- "default": "{\n delegatesFocus: true,\n mode: 'open',\n}"
3932
- },
3933
- {
3934
- "kind": "variable",
3935
- "name": "defaultAnchoredRegionConfig",
3936
- "type": {
3937
- "text": "object"
3938
- },
3939
- "default": "{}"
3940
- },
3941
- {
3942
- "kind": "variable",
3943
- "name": "foundationAnchoredRegion",
3944
- "description": "The Foundation Anchored Region",
3945
- "privacy": "public"
3946
- }
3947
- ],
3948
- "exports": [
3949
- {
3950
- "kind": "js",
3951
- "name": "AnchoredRegion",
3952
- "declaration": {
3953
- "name": "AnchoredRegion",
3954
- "module": "src/anchored-region/anchored-region.ts"
3955
- }
3956
- },
3957
- {
3958
- "kind": "js",
3959
- "name": "foundationAnchoredRegionShadowOptions",
3960
- "declaration": {
3961
- "name": "foundationAnchoredRegionShadowOptions",
3962
- "module": "src/anchored-region/anchored-region.ts"
3963
- }
3964
- },
3965
- {
3966
- "kind": "js",
3967
- "name": "defaultAnchoredRegionConfig",
3968
- "declaration": {
3969
- "name": "defaultAnchoredRegionConfig",
3970
- "module": "src/anchored-region/anchored-region.ts"
3971
- }
3972
- },
3973
- {
3974
- "kind": "js",
3975
- "name": "foundationAnchoredRegion",
3976
- "declaration": {
3977
- "name": "foundationAnchoredRegion",
3978
- "module": "src/anchored-region/anchored-region.ts"
3979
- }
3980
- }
3981
- ]
3982
- },
3983
- {
3984
- "kind": "javascript-module",
3985
- "path": "src/anchored-region/index.ts",
3986
- "declarations": [],
3987
- "exports": [
3988
- {
3989
- "kind": "js",
3990
- "name": "*",
3991
- "declaration": {
3992
- "name": "*",
3993
- "package": "./anchor-region.template"
3994
- }
3995
- },
3996
- {
3997
- "kind": "js",
3998
- "name": "*",
3999
- "declaration": {
4000
- "name": "*",
4001
- "package": "./anchored-region.styles"
4002
- }
4003
- },
4004
- {
4005
- "kind": "js",
4006
- "name": "*",
4007
- "declaration": {
4008
- "name": "*",
4009
- "package": "./anchored-region"
4010
- }
4011
- }
4012
- ]
4013
- },
4014
- {
4015
- "kind": "javascript-module",
4016
- "path": "src/anchor/anchor.styles.ts",
4017
- "declarations": [
4018
- {
4019
- "kind": "function",
4020
- "name": "foundationAnchorStyles",
4021
- "return": {
4022
- "type": {
4023
- "text": "ElementStyles"
4024
- }
4025
- },
4026
- "parameters": [
4027
- {
4028
- "name": "context",
4029
- "type": {
4030
- "text": "ElementDefinitionContext"
4031
- }
4032
- },
4033
- {
4034
- "name": "definition",
4035
- "type": {
4036
- "text": "FoundationElementDefinition"
4037
- }
4038
- }
4039
- ]
4040
- }
4041
- ],
4042
- "exports": [
4043
- {
4044
- "kind": "js",
4045
- "name": "foundationAnchorStyles",
4046
- "declaration": {
4047
- "name": "foundationAnchorStyles",
4048
- "module": "src/anchor/anchor.styles.ts"
4049
- }
4050
- }
4051
- ]
4052
- },
4053
- {
4054
- "kind": "javascript-module",
4055
- "path": "src/anchor/anchor.template.ts",
4056
- "declarations": [
4057
- {
4058
- "kind": "function",
4059
- "name": "foundationAnchorTemplate",
4060
- "return": {
4061
- "type": {
4062
- "text": "ViewTemplate<Anchor>"
4063
- }
4064
- },
4065
- "parameters": [
4066
- {
4067
- "name": "context",
4068
- "type": {
4069
- "text": "ElementDefinitionContext"
4070
- }
4071
3946
  },
4072
3947
  {
4073
- "name": "definition",
3948
+ "kind": "field",
3949
+ "name": "currentDirection",
4074
3950
  "type": {
4075
- "text": "FoundationElementDefinition"
4076
- }
4077
- }
4078
- ]
4079
- }
4080
- ],
4081
- "exports": [
4082
- {
4083
- "kind": "js",
4084
- "name": "foundationAnchorTemplate",
4085
- "declaration": {
4086
- "name": "foundationAnchorTemplate",
4087
- "module": "src/anchor/anchor.template.ts"
4088
- }
4089
- }
4090
- ]
4091
- },
4092
- {
4093
- "kind": "javascript-module",
4094
- "path": "src/anchor/anchor.ts",
4095
- "declarations": [
4096
- {
4097
- "kind": "class",
4098
- "description": "",
4099
- "name": "Anchor",
4100
- "superclass": {
4101
- "name": "FASTAnchor",
4102
- "package": "@microsoft/fast-components"
4103
- },
4104
- "tagName": "%%prefix%%-anchor",
4105
- "customElement": true,
4106
- "attributes": [
3951
+ "text": "Direction"
3952
+ },
3953
+ "privacy": "private",
3954
+ "inheritedFrom": {
3955
+ "name": "AnchoredRegion",
3956
+ "module": "src/anchored-region/anchored-region.ts"
3957
+ }
3958
+ },
4107
3959
  {
4108
- "name": "download",
3960
+ "kind": "field",
3961
+ "name": "regionVisible",
4109
3962
  "type": {
4110
- "text": "string"
3963
+ "text": "boolean"
4111
3964
  },
4112
- "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.",
4113
- "fieldName": "download",
3965
+ "privacy": "private",
3966
+ "default": "false",
4114
3967
  "inheritedFrom": {
4115
- "name": "Anchor",
4116
- "module": "src/anchor/anchor.ts"
3968
+ "name": "AnchoredRegion",
3969
+ "module": "src/anchored-region/anchored-region.ts"
4117
3970
  }
4118
3971
  },
4119
3972
  {
4120
- "name": "href",
3973
+ "kind": "field",
3974
+ "name": "forceUpdate",
4121
3975
  "type": {
4122
- "text": "string"
3976
+ "text": "boolean"
4123
3977
  },
4124
- "description": "The URL the hyperlink references. See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a | <a> element for more information.",
4125
- "fieldName": "href",
3978
+ "privacy": "private",
3979
+ "default": "false",
4126
3980
  "inheritedFrom": {
4127
- "name": "Anchor",
4128
- "module": "src/anchor/anchor.ts"
3981
+ "name": "AnchoredRegion",
3982
+ "module": "src/anchored-region/anchored-region.ts"
4129
3983
  }
4130
3984
  },
4131
3985
  {
4132
- "name": "hreflang",
3986
+ "kind": "field",
3987
+ "name": "updateThreshold",
4133
3988
  "type": {
4134
- "text": "string"
3989
+ "text": "number"
4135
3990
  },
4136
- "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.",
4137
- "fieldName": "hreflang",
3991
+ "privacy": "private",
3992
+ "default": "0.5",
4138
3993
  "inheritedFrom": {
4139
- "name": "Anchor",
4140
- "module": "src/anchor/anchor.ts"
3994
+ "name": "AnchoredRegion",
3995
+ "module": "src/anchored-region/anchored-region.ts"
4141
3996
  }
4142
3997
  },
4143
3998
  {
4144
- "name": "ping",
3999
+ "kind": "field",
4000
+ "name": "intersectionService",
4145
4001
  "type": {
4146
- "text": "string"
4002
+ "text": "IntersectionService"
4147
4003
  },
4148
- "description": "See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a | <a> element for more information.",
4149
- "fieldName": "ping",
4004
+ "privacy": "private",
4005
+ "static": true,
4006
+ "default": "new IntersectionService()",
4150
4007
  "inheritedFrom": {
4151
- "name": "Anchor",
4152
- "module": "src/anchor/anchor.ts"
4008
+ "name": "AnchoredRegion",
4009
+ "module": "src/anchored-region/anchored-region.ts"
4153
4010
  }
4154
4011
  },
4155
4012
  {
4156
- "name": "referrerpolicy",
4157
- "type": {
4158
- "text": "string"
4013
+ "kind": "field",
4014
+ "name": "update",
4015
+ "privacy": "public",
4016
+ "description": "update position",
4017
+ "inheritedFrom": {
4018
+ "name": "AnchoredRegion",
4019
+ "module": "src/anchored-region/anchored-region.ts"
4020
+ }
4021
+ },
4022
+ {
4023
+ "kind": "method",
4024
+ "name": "disconnectResizeDetector",
4025
+ "privacy": "private",
4026
+ "return": {
4027
+ "type": {
4028
+ "text": "void"
4029
+ }
4159
4030
  },
4160
- "description": "See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a | <a> element for more information.",
4161
- "fieldName": "referrerpolicy",
4031
+ "description": "destroys the instance's resize observer",
4162
4032
  "inheritedFrom": {
4163
- "name": "Anchor",
4164
- "module": "src/anchor/anchor.ts"
4033
+ "name": "AnchoredRegion",
4034
+ "module": "src/anchored-region/anchored-region.ts"
4165
4035
  }
4166
4036
  },
4167
4037
  {
4168
- "name": "rel",
4169
- "type": {
4170
- "text": "string"
4038
+ "kind": "method",
4039
+ "name": "initializeResizeDetector",
4040
+ "privacy": "private",
4041
+ "return": {
4042
+ "type": {
4043
+ "text": "void"
4044
+ }
4171
4045
  },
4172
- "description": "See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a | <a> element for more information.",
4173
- "fieldName": "rel",
4046
+ "description": "initializes the instance's resize observer",
4174
4047
  "inheritedFrom": {
4175
- "name": "Anchor",
4176
- "module": "src/anchor/anchor.ts"
4048
+ "name": "AnchoredRegion",
4049
+ "module": "src/anchored-region/anchored-region.ts"
4177
4050
  }
4178
4051
  },
4179
4052
  {
4180
- "name": "target",
4181
- "type": {
4182
- "text": "\"_self\" | \"_blank\" | \"_parent\" | \"_top\""
4053
+ "kind": "method",
4054
+ "name": "updateForAttributeChange",
4055
+ "privacy": "private",
4056
+ "return": {
4057
+ "type": {
4058
+ "text": "void"
4059
+ }
4183
4060
  },
4184
- "description": "See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a | <a> element for more information.",
4185
- "fieldName": "target",
4061
+ "description": "react to attribute changes that don't require a reset",
4186
4062
  "inheritedFrom": {
4187
- "name": "Anchor",
4188
- "module": "src/anchor/anchor.ts"
4063
+ "name": "AnchoredRegion",
4064
+ "module": "src/anchored-region/anchored-region.ts"
4189
4065
  }
4190
4066
  },
4191
4067
  {
4192
- "name": "type",
4193
- "type": {
4194
- "text": "string"
4068
+ "kind": "method",
4069
+ "name": "initialize",
4070
+ "privacy": "private",
4071
+ "return": {
4072
+ "type": {
4073
+ "text": "void"
4074
+ }
4195
4075
  },
4196
- "description": "See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a | <a> element for more information.",
4197
- "fieldName": "type",
4076
+ "description": "fully initializes the component",
4198
4077
  "inheritedFrom": {
4199
- "name": "Anchor",
4200
- "module": "src/anchor/anchor.ts"
4078
+ "name": "AnchoredRegion",
4079
+ "module": "src/anchored-region/anchored-region.ts"
4201
4080
  }
4202
- }
4203
- ],
4204
- "members": [
4081
+ },
4205
4082
  {
4206
- "kind": "field",
4207
- "name": "download",
4208
- "type": {
4209
- "text": "string"
4083
+ "kind": "method",
4084
+ "name": "requestReset",
4085
+ "privacy": "private",
4086
+ "return": {
4087
+ "type": {
4088
+ "text": "void"
4089
+ }
4210
4090
  },
4211
- "privacy": "public",
4212
- "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.",
4091
+ "description": "Request a reset if there are currently no open requests",
4213
4092
  "inheritedFrom": {
4214
- "name": "Anchor",
4215
- "module": "src/anchor/anchor.ts"
4093
+ "name": "AnchoredRegion",
4094
+ "module": "src/anchored-region/anchored-region.ts"
4216
4095
  }
4217
4096
  },
4218
4097
  {
4219
- "kind": "field",
4220
- "name": "href",
4221
- "type": {
4222
- "text": "string"
4098
+ "kind": "method",
4099
+ "name": "setInitialState",
4100
+ "privacy": "private",
4101
+ "return": {
4102
+ "type": {
4103
+ "text": "void"
4104
+ }
4223
4105
  },
4224
- "privacy": "public",
4225
- "description": "The URL the hyperlink references. See {@link https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a | <a> element } for more information.",
4106
+ "description": "sets the starting configuration for component internal values",
4226
4107
  "inheritedFrom": {
4227
- "name": "Anchor",
4228
- "module": "src/anchor/anchor.ts"
4108
+ "name": "AnchoredRegion",
4109
+ "module": "src/anchored-region/anchored-region.ts"
4229
4110
  }
4230
4111
  },
4231
4112
  {
4232
4113
  "kind": "field",
4233
- "name": "hreflang",
4234
- "type": {
4235
- "text": "string"
4236
- },
4237
- "privacy": "public",
4238
- "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.",
4114
+ "name": "startObservers",
4115
+ "privacy": "private",
4116
+ "description": "starts observers",
4239
4117
  "inheritedFrom": {
4240
- "name": "Anchor",
4241
- "module": "src/anchor/anchor.ts"
4118
+ "name": "AnchoredRegion",
4119
+ "module": "src/anchored-region/anchored-region.ts"
4242
4120
  }
4243
4121
  },
4244
4122
  {
4245
4123
  "kind": "field",
4246
- "name": "ping",
4247
- "type": {
4248
- "text": "string"
4249
- },
4250
- "privacy": "public",
4251
- "description": "See {@link https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a | <a> element } for more information.",
4124
+ "name": "requestPositionUpdates",
4125
+ "privacy": "private",
4126
+ "description": "get position updates",
4252
4127
  "inheritedFrom": {
4253
- "name": "Anchor",
4254
- "module": "src/anchor/anchor.ts"
4128
+ "name": "AnchoredRegion",
4129
+ "module": "src/anchored-region/anchored-region.ts"
4255
4130
  }
4256
4131
  },
4257
4132
  {
4258
4133
  "kind": "field",
4259
- "name": "referrerpolicy",
4260
- "type": {
4261
- "text": "string"
4262
- },
4263
- "privacy": "public",
4264
- "description": "See {@link https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a | <a> element } for more information.",
4134
+ "name": "stopObservers",
4135
+ "privacy": "private",
4136
+ "description": "stops observers",
4265
4137
  "inheritedFrom": {
4266
- "name": "Anchor",
4267
- "module": "src/anchor/anchor.ts"
4138
+ "name": "AnchoredRegion",
4139
+ "module": "src/anchored-region/anchored-region.ts"
4268
4140
  }
4269
4141
  },
4270
4142
  {
4271
4143
  "kind": "field",
4272
- "name": "rel",
4273
- "type": {
4274
- "text": "string"
4275
- },
4276
- "privacy": "public",
4277
- "description": "See {@link https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a | <a> element } for more information.",
4144
+ "name": "getViewport",
4145
+ "privacy": "private",
4146
+ "description": "Gets the viewport element by id, or defaults to document root",
4278
4147
  "inheritedFrom": {
4279
- "name": "Anchor",
4280
- "module": "src/anchor/anchor.ts"
4148
+ "name": "AnchoredRegion",
4149
+ "module": "src/anchored-region/anchored-region.ts"
4281
4150
  }
4282
4151
  },
4283
4152
  {
4284
4153
  "kind": "field",
4285
- "name": "target",
4286
- "type": {
4287
- "text": "\"_self\" | \"_blank\" | \"_parent\" | \"_top\""
4288
- },
4289
- "privacy": "public",
4290
- "description": "See {@link https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a | <a> element } for more information.",
4154
+ "name": "getAnchor",
4155
+ "privacy": "private",
4156
+ "description": "Gets the anchor element by id",
4291
4157
  "inheritedFrom": {
4292
- "name": "Anchor",
4293
- "module": "src/anchor/anchor.ts"
4158
+ "name": "AnchoredRegion",
4159
+ "module": "src/anchored-region/anchored-region.ts"
4294
4160
  }
4295
4161
  },
4296
4162
  {
4297
4163
  "kind": "field",
4298
- "name": "type",
4299
- "type": {
4300
- "text": "string"
4301
- },
4302
- "privacy": "public",
4303
- "description": "See {@link https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a | <a> element } for more information.",
4164
+ "name": "handleIntersection",
4165
+ "privacy": "private",
4166
+ "description": "Handle intersections",
4304
4167
  "inheritedFrom": {
4305
- "name": "Anchor",
4306
- "module": "src/anchor/anchor.ts"
4168
+ "name": "AnchoredRegion",
4169
+ "module": "src/anchored-region/anchored-region.ts"
4307
4170
  }
4308
4171
  },
4309
4172
  {
4310
4173
  "kind": "field",
4311
- "name": "control",
4312
- "type": {
4313
- "text": "HTMLAnchorElement | undefined"
4314
- },
4315
- "privacy": "public",
4316
- "description": "References the root element",
4174
+ "name": "applyIntersectionEntries",
4175
+ "privacy": "private",
4176
+ "description": "iterate through intersection entries and apply data",
4317
4177
  "inheritedFrom": {
4318
- "name": "Anchor",
4319
- "module": "src/anchor/anchor.ts"
4178
+ "name": "AnchoredRegion",
4179
+ "module": "src/anchored-region/anchored-region.ts"
4320
4180
  }
4321
4181
  },
4322
4182
  {
4323
4183
  "kind": "field",
4324
- "name": "handleUnsupportedDelegatesFocus",
4184
+ "name": "updateRegionOffset",
4325
4185
  "privacy": "private",
4326
- "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",
4186
+ "description": "Update the offset values",
4327
4187
  "inheritedFrom": {
4328
- "name": "Anchor",
4329
- "module": "src/anchor/anchor.ts"
4188
+ "name": "AnchoredRegion",
4189
+ "module": "src/anchored-region/anchored-region.ts"
4190
+ }
4191
+ },
4192
+ {
4193
+ "kind": "field",
4194
+ "name": "isRectDifferent",
4195
+ "privacy": "private",
4196
+ "description": "compare rects to see if there is enough change to justify a DOM update",
4197
+ "inheritedFrom": {
4198
+ "name": "AnchoredRegion",
4199
+ "module": "src/anchored-region/anchored-region.ts"
4200
+ }
4201
+ },
4202
+ {
4203
+ "kind": "field",
4204
+ "name": "handleResize",
4205
+ "privacy": "private",
4206
+ "description": "Handle resize events",
4207
+ "inheritedFrom": {
4208
+ "name": "AnchoredRegion",
4209
+ "module": "src/anchored-region/anchored-region.ts"
4210
+ }
4211
+ },
4212
+ {
4213
+ "kind": "field",
4214
+ "name": "reset",
4215
+ "privacy": "private",
4216
+ "description": "resets the component",
4217
+ "inheritedFrom": {
4218
+ "name": "AnchoredRegion",
4219
+ "module": "src/anchored-region/anchored-region.ts"
4220
+ }
4221
+ },
4222
+ {
4223
+ "kind": "field",
4224
+ "name": "updateLayout",
4225
+ "privacy": "private",
4226
+ "description": "Recalculate layout related state values",
4227
+ "inheritedFrom": {
4228
+ "name": "AnchoredRegion",
4229
+ "module": "src/anchored-region/anchored-region.ts"
4230
+ }
4231
+ },
4232
+ {
4233
+ "kind": "field",
4234
+ "name": "updateRegionStyle",
4235
+ "privacy": "private",
4236
+ "description": "Updates the style string applied to the region element as well as the css classes attached\nto the root element",
4237
+ "inheritedFrom": {
4238
+ "name": "AnchoredRegion",
4239
+ "module": "src/anchored-region/anchored-region.ts"
4240
+ }
4241
+ },
4242
+ {
4243
+ "kind": "field",
4244
+ "name": "updatePositionClasses",
4245
+ "privacy": "private",
4246
+ "description": "Updates the css classes that reflect the current position of the element",
4247
+ "inheritedFrom": {
4248
+ "name": "AnchoredRegion",
4249
+ "module": "src/anchored-region/anchored-region.ts"
4250
+ }
4251
+ },
4252
+ {
4253
+ "kind": "field",
4254
+ "name": "setHorizontalPosition",
4255
+ "privacy": "private",
4256
+ "description": "Get horizontal positioning state based on desired position",
4257
+ "inheritedFrom": {
4258
+ "name": "AnchoredRegion",
4259
+ "module": "src/anchored-region/anchored-region.ts"
4260
+ }
4261
+ },
4262
+ {
4263
+ "kind": "field",
4264
+ "name": "setVerticalPosition",
4265
+ "privacy": "private",
4266
+ "description": "Set vertical positioning state based on desired position",
4267
+ "inheritedFrom": {
4268
+ "name": "AnchoredRegion",
4269
+ "module": "src/anchored-region/anchored-region.ts"
4270
+ }
4271
+ },
4272
+ {
4273
+ "kind": "field",
4274
+ "name": "getPositioningOptions",
4275
+ "privacy": "private",
4276
+ "description": "Get available positions based on positioning mode",
4277
+ "inheritedFrom": {
4278
+ "name": "AnchoredRegion",
4279
+ "module": "src/anchored-region/anchored-region.ts"
4280
+ }
4281
+ },
4282
+ {
4283
+ "kind": "field",
4284
+ "name": "getAvailableSpace",
4285
+ "privacy": "private",
4286
+ "description": "Get the space available for a particular relative position",
4287
+ "inheritedFrom": {
4288
+ "name": "AnchoredRegion",
4289
+ "module": "src/anchored-region/anchored-region.ts"
4290
+ }
4291
+ },
4292
+ {
4293
+ "kind": "field",
4294
+ "name": "getNextRegionDimension",
4295
+ "privacy": "private",
4296
+ "description": "Get region dimensions",
4297
+ "inheritedFrom": {
4298
+ "name": "AnchoredRegion",
4299
+ "module": "src/anchored-region/anchored-region.ts"
4300
+ }
4301
+ },
4302
+ {
4303
+ "kind": "field",
4304
+ "name": "startAutoUpdateEventListeners",
4305
+ "privacy": "private",
4306
+ "description": "starts event listeners that can trigger auto updating",
4307
+ "inheritedFrom": {
4308
+ "name": "AnchoredRegion",
4309
+ "module": "src/anchored-region/anchored-region.ts"
4310
+ }
4311
+ },
4312
+ {
4313
+ "kind": "field",
4314
+ "name": "stopAutoUpdateEventListeners",
4315
+ "privacy": "private",
4316
+ "description": "stops event listeners that can trigger auto updating",
4317
+ "inheritedFrom": {
4318
+ "name": "AnchoredRegion",
4319
+ "module": "src/anchored-region/anchored-region.ts"
4330
4320
  }
4331
4321
  },
4332
4322
  {
@@ -4440,11 +4430,29 @@
4440
4430
  "module": "src/foundation-element/foundation-element.ts"
4441
4431
  }
4442
4432
  }
4433
+ ],
4434
+ "events": [
4435
+ {
4436
+ "description": "Fires a custom 'loaded' event when the region is loaded and visible",
4437
+ "name": "loaded",
4438
+ "inheritedFrom": {
4439
+ "name": "AnchoredRegion",
4440
+ "module": "src/anchored-region/anchored-region.ts"
4441
+ }
4442
+ },
4443
+ {
4444
+ "description": "Fires a custom 'positionchange' event when the position has changed",
4445
+ "name": "positionchange",
4446
+ "inheritedFrom": {
4447
+ "name": "AnchoredRegion",
4448
+ "module": "src/anchored-region/anchored-region.ts"
4449
+ }
4450
+ }
4443
4451
  ]
4444
4452
  },
4445
4453
  {
4446
4454
  "kind": "variable",
4447
- "name": "foundationAnchorShadowOptions",
4455
+ "name": "foundationAnchoredRegionShadowOptions",
4448
4456
  "type": {
4449
4457
  "text": "ShadowRootInit"
4450
4458
  },
@@ -4452,7 +4460,7 @@
4452
4460
  },
4453
4461
  {
4454
4462
  "kind": "variable",
4455
- "name": "defaultAnchorConfig",
4463
+ "name": "defaultAnchoredRegionConfig",
4456
4464
  "type": {
4457
4465
  "text": "object"
4458
4466
  },
@@ -4460,49 +4468,49 @@
4460
4468
  },
4461
4469
  {
4462
4470
  "kind": "variable",
4463
- "name": "foundationAnchor",
4464
- "description": "The Foundation Anchor",
4471
+ "name": "foundationAnchoredRegion",
4472
+ "description": "The Foundation Anchored Region",
4465
4473
  "privacy": "public"
4466
4474
  }
4467
4475
  ],
4468
4476
  "exports": [
4469
4477
  {
4470
4478
  "kind": "js",
4471
- "name": "Anchor",
4479
+ "name": "AnchoredRegion",
4472
4480
  "declaration": {
4473
- "name": "Anchor",
4474
- "module": "src/anchor/anchor.ts"
4481
+ "name": "AnchoredRegion",
4482
+ "module": "src/anchored-region/anchored-region.ts"
4475
4483
  }
4476
4484
  },
4477
4485
  {
4478
4486
  "kind": "js",
4479
- "name": "foundationAnchorShadowOptions",
4487
+ "name": "foundationAnchoredRegionShadowOptions",
4480
4488
  "declaration": {
4481
- "name": "foundationAnchorShadowOptions",
4482
- "module": "src/anchor/anchor.ts"
4489
+ "name": "foundationAnchoredRegionShadowOptions",
4490
+ "module": "src/anchored-region/anchored-region.ts"
4483
4491
  }
4484
4492
  },
4485
4493
  {
4486
4494
  "kind": "js",
4487
- "name": "defaultAnchorConfig",
4495
+ "name": "defaultAnchoredRegionConfig",
4488
4496
  "declaration": {
4489
- "name": "defaultAnchorConfig",
4490
- "module": "src/anchor/anchor.ts"
4497
+ "name": "defaultAnchoredRegionConfig",
4498
+ "module": "src/anchored-region/anchored-region.ts"
4491
4499
  }
4492
4500
  },
4493
4501
  {
4494
4502
  "kind": "js",
4495
- "name": "foundationAnchor",
4503
+ "name": "foundationAnchoredRegion",
4496
4504
  "declaration": {
4497
- "name": "foundationAnchor",
4498
- "module": "src/anchor/anchor.ts"
4505
+ "name": "foundationAnchoredRegion",
4506
+ "module": "src/anchored-region/anchored-region.ts"
4499
4507
  }
4500
4508
  }
4501
4509
  ]
4502
4510
  },
4503
4511
  {
4504
4512
  "kind": "javascript-module",
4505
- "path": "src/anchor/index.ts",
4513
+ "path": "src/anchored-region/index.ts",
4506
4514
  "declarations": [],
4507
4515
  "exports": [
4508
4516
  {
@@ -4510,7 +4518,7 @@
4510
4518
  "name": "*",
4511
4519
  "declaration": {
4512
4520
  "name": "*",
4513
- "package": "./anchor.template"
4521
+ "package": "./anchor-region.template"
4514
4522
  }
4515
4523
  },
4516
4524
  {
@@ -4518,7 +4526,7 @@
4518
4526
  "name": "*",
4519
4527
  "declaration": {
4520
4528
  "name": "*",
4521
- "package": "./anchor.styles"
4529
+ "package": "./anchored-region.styles"
4522
4530
  }
4523
4531
  },
4524
4532
  {
@@ -4526,7 +4534,7 @@
4526
4534
  "name": "*",
4527
4535
  "declaration": {
4528
4536
  "name": "*",
4529
- "package": "./anchor"
4537
+ "package": "./anchored-region"
4530
4538
  }
4531
4539
  }
4532
4540
  ]
@@ -28481,6 +28489,13 @@
28481
28489
  "text": "HTMLElement"
28482
28490
  }
28483
28491
  },
28492
+ {
28493
+ "kind": "field",
28494
+ "name": "connect",
28495
+ "type": {
28496
+ "text": "Connect"
28497
+ }
28498
+ },
28484
28499
  {
28485
28500
  "kind": "field",
28486
28501
  "name": "resourceName",
@@ -28515,6 +28530,14 @@
28515
28530
  },
28516
28531
  "privacy": "protected"
28517
28532
  },
28533
+ {
28534
+ "kind": "field",
28535
+ "name": "connectionSub",
28536
+ "type": {
28537
+ "text": "Subscription"
28538
+ },
28539
+ "privacy": "protected"
28540
+ },
28518
28541
  {
28519
28542
  "kind": "field",
28520
28543
  "name": "datasource",
@@ -28523,6 +28546,39 @@
28523
28546
  },
28524
28547
  "privacy": "private"
28525
28548
  },
28549
+ {
28550
+ "kind": "method",
28551
+ "name": "handleReconnection",
28552
+ "privacy": "private",
28553
+ "return": {
28554
+ "type": {
28555
+ "text": "Promise<void>"
28556
+ }
28557
+ },
28558
+ "description": "Handles reconnection logic when the connection is established"
28559
+ },
28560
+ {
28561
+ "kind": "method",
28562
+ "name": "initializeDatasource",
28563
+ "privacy": "private",
28564
+ "return": {
28565
+ "type": {
28566
+ "text": "Promise<void>"
28567
+ }
28568
+ },
28569
+ "description": "Initializes the datasource for the notification resource"
28570
+ },
28571
+ {
28572
+ "kind": "method",
28573
+ "name": "setupDataSubscription",
28574
+ "privacy": "private",
28575
+ "return": {
28576
+ "type": {
28577
+ "text": "void"
28578
+ }
28579
+ },
28580
+ "description": "Sets up the data subscription to handle incoming notifications"
28581
+ },
28526
28582
  {
28527
28583
  "kind": "method",
28528
28584
  "name": "handleStreamUpdate",
@@ -49391,6 +49447,14 @@
49391
49447
  "name": "*",
49392
49448
  "package": "./options-datasource-utils"
49393
49449
  }
49450
+ },
49451
+ {
49452
+ "kind": "js",
49453
+ "name": "*",
49454
+ "declaration": {
49455
+ "name": "*",
49456
+ "package": "./shortcut-manager"
49457
+ }
49394
49458
  }
49395
49459
  ]
49396
49460
  },
@@ -52405,6 +52469,432 @@
52405
52469
  }
52406
52470
  ]
52407
52471
  },
52472
+ {
52473
+ "kind": "javascript-module",
52474
+ "path": "src/utils/shortcut-manager/index.ts",
52475
+ "declarations": [],
52476
+ "exports": [
52477
+ {
52478
+ "kind": "js",
52479
+ "name": "*",
52480
+ "declaration": {
52481
+ "name": "*",
52482
+ "package": "./shortcut-manager"
52483
+ }
52484
+ },
52485
+ {
52486
+ "kind": "js",
52487
+ "name": "*",
52488
+ "declaration": {
52489
+ "name": "*",
52490
+ "package": "./shortcut-listener"
52491
+ }
52492
+ }
52493
+ ]
52494
+ },
52495
+ {
52496
+ "kind": "javascript-module",
52497
+ "path": "src/utils/shortcut-manager/shortcut-listener.ts",
52498
+ "declarations": [
52499
+ {
52500
+ "kind": "class",
52501
+ "description": "",
52502
+ "name": "FoundationShortcutListener",
52503
+ "members": [
52504
+ {
52505
+ "kind": "field",
52506
+ "name": "shortcutManager",
52507
+ "type": {
52508
+ "text": "ShortcutManager"
52509
+ }
52510
+ },
52511
+ {
52512
+ "kind": "field",
52513
+ "name": "keyListener",
52514
+ "type": {
52515
+ "text": "((event: KeyboardEvent) => void) | null"
52516
+ },
52517
+ "privacy": "private",
52518
+ "default": "null"
52519
+ },
52520
+ {
52521
+ "kind": "field",
52522
+ "name": "isListening",
52523
+ "type": {
52524
+ "text": "boolean"
52525
+ },
52526
+ "privacy": "private",
52527
+ "default": "false"
52528
+ },
52529
+ {
52530
+ "kind": "method",
52531
+ "name": "setupStateSubscription",
52532
+ "privacy": "private"
52533
+ },
52534
+ {
52535
+ "kind": "method",
52536
+ "name": "cleanupStateSubscription",
52537
+ "privacy": "private"
52538
+ },
52539
+ {
52540
+ "kind": "method",
52541
+ "name": "addKeyListener",
52542
+ "privacy": "private"
52543
+ },
52544
+ {
52545
+ "kind": "method",
52546
+ "name": "removeKeyListener",
52547
+ "privacy": "private"
52548
+ },
52549
+ {
52550
+ "kind": "method",
52551
+ "name": "handleKeyDown",
52552
+ "privacy": "private",
52553
+ "parameters": [
52554
+ {
52555
+ "name": "event",
52556
+ "type": {
52557
+ "text": "KeyboardEvent"
52558
+ }
52559
+ }
52560
+ ]
52561
+ },
52562
+ {
52563
+ "kind": "method",
52564
+ "name": "isInputElement",
52565
+ "privacy": "private",
52566
+ "return": {
52567
+ "type": {
52568
+ "text": "boolean"
52569
+ }
52570
+ },
52571
+ "parameters": [
52572
+ {
52573
+ "name": "element",
52574
+ "type": {
52575
+ "text": "HTMLElement | null"
52576
+ }
52577
+ }
52578
+ ]
52579
+ }
52580
+ ],
52581
+ "superclass": {
52582
+ "name": "FASTElement",
52583
+ "package": "@microsoft/fast-element"
52584
+ },
52585
+ "customElement": true
52586
+ }
52587
+ ],
52588
+ "exports": [
52589
+ {
52590
+ "kind": "js",
52591
+ "name": "FoundationShortcutListener",
52592
+ "declaration": {
52593
+ "name": "FoundationShortcutListener",
52594
+ "module": "src/utils/shortcut-manager/shortcut-listener.ts"
52595
+ }
52596
+ },
52597
+ {
52598
+ "kind": "custom-element-definition",
52599
+ "name": "foundation-shortcut-listener",
52600
+ "declaration": {
52601
+ "name": "FoundationShortcutListener",
52602
+ "module": "src/utils/shortcut-manager/shortcut-listener.ts"
52603
+ }
52604
+ }
52605
+ ]
52606
+ },
52607
+ {
52608
+ "kind": "javascript-module",
52609
+ "path": "src/utils/shortcut-manager/shortcut-manager.ts",
52610
+ "declarations": [
52611
+ {
52612
+ "kind": "class",
52613
+ "description": "",
52614
+ "name": "DefaultShortcutManager",
52615
+ "members": [
52616
+ {
52617
+ "kind": "field",
52618
+ "name": "shortcuts",
52619
+ "privacy": "private",
52620
+ "default": "new Map<string, ShortcutDefinition>()"
52621
+ },
52622
+ {
52623
+ "kind": "field",
52624
+ "name": "keyCombinationMap",
52625
+ "privacy": "private",
52626
+ "default": "new Map<string, string>()"
52627
+ },
52628
+ {
52629
+ "kind": "field",
52630
+ "name": "_isPausedSubject",
52631
+ "privacy": "private",
52632
+ "default": "new BehaviorSubject<boolean>(false)"
52633
+ },
52634
+ {
52635
+ "kind": "field",
52636
+ "name": "isPaused",
52637
+ "type": {
52638
+ "text": "boolean"
52639
+ },
52640
+ "readonly": true
52641
+ },
52642
+ {
52643
+ "kind": "field",
52644
+ "name": "isPaused$",
52645
+ "type": {
52646
+ "text": "Observable<boolean>"
52647
+ },
52648
+ "readonly": true
52649
+ },
52650
+ {
52651
+ "kind": "field",
52652
+ "name": "isPausedSubject",
52653
+ "type": {
52654
+ "text": "BehaviorSubject<boolean>"
52655
+ },
52656
+ "readonly": true
52657
+ },
52658
+ {
52659
+ "kind": "method",
52660
+ "name": "registerShortcuts",
52661
+ "return": {
52662
+ "type": {
52663
+ "text": "void"
52664
+ }
52665
+ },
52666
+ "parameters": [
52667
+ {
52668
+ "name": "shortcuts",
52669
+ "type": {
52670
+ "text": "ShortcutDefinition[]"
52671
+ }
52672
+ }
52673
+ ]
52674
+ },
52675
+ {
52676
+ "kind": "method",
52677
+ "name": "registerShortcut",
52678
+ "return": {
52679
+ "type": {
52680
+ "text": "ShortcutRegistrationResult"
52681
+ }
52682
+ },
52683
+ "parameters": [
52684
+ {
52685
+ "name": "shortcut",
52686
+ "type": {
52687
+ "text": "ShortcutDefinition"
52688
+ }
52689
+ }
52690
+ ]
52691
+ },
52692
+ {
52693
+ "kind": "method",
52694
+ "name": "unregisterShortcut",
52695
+ "return": {
52696
+ "type": {
52697
+ "text": "void"
52698
+ }
52699
+ },
52700
+ "parameters": [
52701
+ {
52702
+ "name": "id",
52703
+ "type": {
52704
+ "text": "string"
52705
+ }
52706
+ }
52707
+ ]
52708
+ },
52709
+ {
52710
+ "kind": "method",
52711
+ "name": "unregisterShortcutsByContext",
52712
+ "return": {
52713
+ "type": {
52714
+ "text": "void"
52715
+ }
52716
+ },
52717
+ "parameters": [
52718
+ {
52719
+ "name": "context",
52720
+ "type": {
52721
+ "text": "string"
52722
+ }
52723
+ }
52724
+ ]
52725
+ },
52726
+ {
52727
+ "kind": "method",
52728
+ "name": "executeShortcut",
52729
+ "return": {
52730
+ "type": {
52731
+ "text": "void"
52732
+ }
52733
+ },
52734
+ "parameters": [
52735
+ {
52736
+ "name": "id",
52737
+ "type": {
52738
+ "text": "string"
52739
+ }
52740
+ }
52741
+ ]
52742
+ },
52743
+ {
52744
+ "kind": "method",
52745
+ "name": "getShortcuts",
52746
+ "return": {
52747
+ "type": {
52748
+ "text": "ShortcutDefinition[]"
52749
+ }
52750
+ }
52751
+ },
52752
+ {
52753
+ "kind": "method",
52754
+ "name": "getShortcutsByContext",
52755
+ "return": {
52756
+ "type": {
52757
+ "text": "ShortcutDefinition[]"
52758
+ }
52759
+ },
52760
+ "parameters": [
52761
+ {
52762
+ "name": "context",
52763
+ "type": {
52764
+ "text": "string"
52765
+ }
52766
+ }
52767
+ ]
52768
+ },
52769
+ {
52770
+ "kind": "method",
52771
+ "name": "findShortcutByKeyCombination",
52772
+ "return": {
52773
+ "type": {
52774
+ "text": "ShortcutDefinition | undefined"
52775
+ }
52776
+ },
52777
+ "parameters": [
52778
+ {
52779
+ "name": "key",
52780
+ "type": {
52781
+ "text": "string"
52782
+ }
52783
+ },
52784
+ {
52785
+ "name": "ctrlKey",
52786
+ "default": "false"
52787
+ },
52788
+ {
52789
+ "name": "altKey",
52790
+ "default": "false"
52791
+ },
52792
+ {
52793
+ "name": "shiftKey",
52794
+ "default": "false"
52795
+ },
52796
+ {
52797
+ "name": "metaKey",
52798
+ "default": "false"
52799
+ }
52800
+ ]
52801
+ },
52802
+ {
52803
+ "kind": "method",
52804
+ "name": "pause",
52805
+ "return": {
52806
+ "type": {
52807
+ "text": "void"
52808
+ }
52809
+ }
52810
+ },
52811
+ {
52812
+ "kind": "method",
52813
+ "name": "resume",
52814
+ "return": {
52815
+ "type": {
52816
+ "text": "void"
52817
+ }
52818
+ }
52819
+ },
52820
+ {
52821
+ "kind": "method",
52822
+ "name": "createKeyCombinationKey",
52823
+ "privacy": "private",
52824
+ "return": {
52825
+ "type": {
52826
+ "text": "string"
52827
+ }
52828
+ },
52829
+ "parameters": [
52830
+ {
52831
+ "name": "key",
52832
+ "type": {
52833
+ "text": "string"
52834
+ }
52835
+ },
52836
+ {
52837
+ "name": "ctrlKey",
52838
+ "default": "false"
52839
+ },
52840
+ {
52841
+ "name": "altKey",
52842
+ "default": "false"
52843
+ },
52844
+ {
52845
+ "name": "shiftKey",
52846
+ "default": "false"
52847
+ },
52848
+ {
52849
+ "name": "metaKey",
52850
+ "default": "false"
52851
+ }
52852
+ ]
52853
+ },
52854
+ {
52855
+ "kind": "method",
52856
+ "name": "isElementFocused",
52857
+ "privacy": "private",
52858
+ "return": {
52859
+ "type": {
52860
+ "text": "boolean"
52861
+ }
52862
+ },
52863
+ "parameters": [
52864
+ {
52865
+ "name": "element",
52866
+ "type": {
52867
+ "text": "HTMLElement | any"
52868
+ }
52869
+ }
52870
+ ]
52871
+ }
52872
+ ]
52873
+ },
52874
+ {
52875
+ "kind": "variable",
52876
+ "name": "ShortcutManager"
52877
+ }
52878
+ ],
52879
+ "exports": [
52880
+ {
52881
+ "kind": "js",
52882
+ "name": "DefaultShortcutManager",
52883
+ "declaration": {
52884
+ "name": "DefaultShortcutManager",
52885
+ "module": "src/utils/shortcut-manager/shortcut-manager.ts"
52886
+ }
52887
+ },
52888
+ {
52889
+ "kind": "js",
52890
+ "name": "ShortcutManager",
52891
+ "declaration": {
52892
+ "name": "ShortcutManager",
52893
+ "module": "src/utils/shortcut-manager/shortcut-manager.ts"
52894
+ }
52895
+ }
52896
+ ]
52897
+ },
52408
52898
  {
52409
52899
  "kind": "javascript-module",
52410
52900
  "path": "src/_config/styles/external/index.ts",