chore: anchored region not beta (microsoft#5720)

* anchored region not beta * Change files * comment * tweak
whatitslike · Mar 14, 2022 · b996b05 · b996b05
1 parent 0d5185b
commit b996b05
Show file tree

Hide file tree

Showing 4 changed files with 42 additions and 44 deletions.
diff --git a/change/@microsoft-fast-foundation-31b9963a-7258-440a-8440-0430cb340b72.json b/change/@microsoft-fast-foundation-31b9963a-7258-440a-8440-0430cb340b72.json
@@ -0,0 +1,7 @@
+{
+  "type": "patch",
+  "comment": "anchored region not beta",
+  "packageName": "@microsoft/fast-foundation",
+  "email": "scomea@microsoft.com",
+  "dependentChangeType": "patch"
+}
diff --git a/packages/web-components/fast-foundation/docs/api-report.md b/packages/web-components/fast-foundation/docs/api-report.md
@@ -91,13 +91,12 @@ export class Anchor extends FoundationElement {
 export interface Anchor extends StartEnd, DelegatesARIALink {
 }
 
-// @beta
+// @public
 export class AnchoredRegion extends FoundationElement {
     // @internal (undocumented)
     adoptedCallback(): void;
     anchor: string;
     anchorElement: HTMLElement | null;
-    // (undocumented)
     autoUpdateMode: AutoUpdateMode;
     // @internal (undocumented)
     connectedCallback(): void;
@@ -127,33 +126,26 @@ export class AnchoredRegion extends FoundationElement {
 
 // @public
 export interface AnchoredRegionConfig {
-    // Warning: (ae-incompatible-release-tags) The symbol "autoUpdateMode" is marked as @public, but its signature references "AutoUpdateMode" which is marked as @beta
     readonly autoUpdateMode?: AutoUpdateMode;
     readonly fixedPlacement?: boolean;
-    // Warning: (ae-incompatible-release-tags) The symbol "horizontalDefaultPosition" is marked as @public, but its signature references "HorizontalPosition" which is marked as @beta
     readonly horizontalDefaultPosition?: HorizontalPosition;
     readonly horizontalInset?: boolean;
-    // Warning: (ae-incompatible-release-tags) The symbol "horizontalPositioningMode" is marked as @public, but its signature references "AxisPositioningMode" which is marked as @beta
     readonly horizontalPositioningMode?: AxisPositioningMode;
-    // Warning: (ae-incompatible-release-tags) The symbol "horizontalScaling" is marked as @public, but its signature references "AxisScalingMode" which is marked as @beta
     readonly horizontalScaling?: AxisScalingMode;
     readonly horizontalThreshold?: number;
     readonly horizontalViewportLock?: boolean;
-    // Warning: (ae-incompatible-release-tags) The symbol "verticalDefaultPosition" is marked as @public, but its signature references "VerticalPosition" which is marked as @beta
     readonly verticalDefaultPosition?: VerticalPosition;
     readonly verticalInset?: boolean;
-    // Warning: (ae-incompatible-release-tags) The symbol "verticalPositioningMode" is marked as @public, but its signature references "AxisPositioningMode" which is marked as @beta
     readonly verticalPositioningMode?: AxisPositioningMode;
-    // Warning: (ae-incompatible-release-tags) The symbol "verticalScaling" is marked as @public, but its signature references "AxisScalingMode" which is marked as @beta
     readonly verticalScaling?: AxisScalingMode;
     readonly verticalThreshold?: number;
     readonly verticalViewportLock?: boolean;
 }
 
-// @beta
+// @public
 export type AnchoredRegionPositionLabel = "start" | "insetStart" | "insetEnd" | "end" | "center";
 
-// @beta
+// @public
 export const anchoredRegionTemplate: FoundationElementTemplate<ViewTemplate<AnchoredRegion>>;
 
 // @public
@@ -188,7 +180,7 @@ export class ARIAGlobalStatesAndProperties {
     ariaRoledescription: string;
 }
 
-// @beta
+// @public
 export type AutoUpdateMode = "anchor" | "auto";
 
 // @public
@@ -209,10 +201,10 @@ export type AvatarOptions = FoundationElementDefinition & {
 // @public
 export const avatarTemplate: FoundationElementTemplate<ViewTemplate<Avatar>, AvatarOptions>;
 
-// @beta
+// @public
 export type AxisPositioningMode = "uncontrolled" | "locktodefault" | "dynamic";
 
-// @beta
+// @public
 export type AxisScalingMode = "anchor" | "fill" | "content";
 
 // @public
@@ -1302,7 +1294,7 @@ export const getDirection: (rootNode: HTMLElement) => Direction;
 // @public
 export const hidden = ":host([hidden]){display:none}";
 
-// @beta
+// @public
 export type HorizontalPosition = "start" | "end" | "left" | "right" | "center" | "unset";
 
 // @public
@@ -2613,7 +2605,6 @@ export const toolbarTemplate: FoundationElementTemplate<ViewTemplate<Toolbar>, T
 export class Tooltip extends FoundationElement {
     anchor: string;
     anchorElement: HTMLElement | null;
-    // Warning: (ae-incompatible-release-tags) The symbol "autoUpdateMode" is marked as @public, but its signature references "AutoUpdateMode" which is marked as @beta
     autoUpdateMode: AutoUpdateMode;
     // (undocumented)
     connectedCallback(): void;
@@ -2762,7 +2753,7 @@ export const treeViewTemplate: FoundationElementTemplate<ViewTemplate<TreeView>>
 // @internal (undocumented)
 export function validateKey(key: any): void;
 
-// @beta
+// @public
 export type VerticalPosition = "top" | "bottom" | "center" | "unset";
 
 // @public

diff --git a/packages/web-components/fast-foundation/src/anchored-region/anchored-region.template.ts b/packages/web-components/fast-foundation/src/anchored-region/anchored-region.template.ts
@@ -5,7 +5,7 @@ import type { AnchoredRegion } from "./anchored-region";
 
 /**
  * The template for the {@link @microsoft/fast-foundation#(AnchoredRegion:class)} component.
- * @beta
+ * @public
  */
 export const anchoredRegionTemplate: FoundationElementTemplate<ViewTemplate<
     AnchoredRegion

diff --git a/packages/web-components/fast-foundation/src/anchored-region/anchored-region.ts b/packages/web-components/fast-foundation/src/anchored-region/anchored-region.ts
@@ -11,28 +11,28 @@ import type {
 /**
  * Defines the base behavior of an anchored region on a particular axis
  *
- * @beta
+ * @public
  */
 export type AxisPositioningMode = "uncontrolled" | "locktodefault" | "dynamic";
 
 /**
  * Defines the scaling behavior of an anchored region on a particular axis
  *
- * @beta
+ * @public
  */
 export type AxisScalingMode = "anchor" | "fill" | "content";
 
 /**
  * Defines the horizontal positioning options for an anchored region
  *
- * @beta
+ * @public
  */
 export type HorizontalPosition = "start" | "end" | "left" | "right" | "center" | "unset";
 
 /**
  * Defines the vertical positioning options for an anchored region
  *
- * @beta
+ * @public
  */
 export type VerticalPosition = "top" | "bottom" | "center" | "unset";
 
@@ -46,15 +46,15 @@ export type VerticalPosition = "top" | "bottom" | "center" | "unset";
  * - the viewport resizes
  * - any scroll event in the document
  *
- * @beta
+ * @public
  */
 export type AutoUpdateMode = "anchor" | "auto";
 
 /**
  * Describes the possible positions of the region relative
  * to its anchor. Depending on the axis start = left/top, end = right/bottom
  *
- * @beta
+ * @public
  */
 export type AnchoredRegionPositionLabel =
     | "start"
@@ -74,13 +74,13 @@ interface Dimension {
 /**
  * An anchored region Custom HTML Element.
  *
- * @beta
+ * @public
  */
 export class AnchoredRegion extends FoundationElement {
     /**
      * The HTML ID of the anchor element this region is positioned relative to
      *
-     * @beta
+     * @public
      * @remarks
      * HTML Attribute: anchor
      */
@@ -95,7 +95,7 @@ export class AnchoredRegion extends FoundationElement {
     /**
      * The HTML ID of the viewport element this region is positioned relative to
      *
-     * @beta
+     * @public
      * @remarks
      * HTML Attribute: anchor
      */
@@ -113,7 +113,7 @@ export class AnchoredRegion extends FoundationElement {
      * 'dynamic' decides placement based on available space
      * 'uncontrolled' does not control placement on the horizontal axis
      *
-     * @beta
+     * @public
      * @remarks
      * HTML Attribute: horizontal-positioning-mode
      */
@@ -126,7 +126,7 @@ export class AnchoredRegion extends FoundationElement {
     /**
      * The default horizontal position of the region relative to the anchor element
      *
-     * @beta
+     * @public
      * @remarks
      * HTML Attribute: horizontal-default-position
      */
@@ -139,7 +139,7 @@ export class AnchoredRegion extends FoundationElement {
     /**
      * Whether the region remains in the viewport (ie. detaches from the anchor) on the horizontal axis
      *
-     * @beta
+     * @public
      * @remarks
      * HTML Attribute: horizontal-viewport-lock
      */
@@ -152,7 +152,7 @@ export class AnchoredRegion extends FoundationElement {
     /**
      * Whether the region overlaps the anchor on the horizontal axis
      *
-     * @beta
+     * @public
      * @remarks
      * HTML Attribute: horizontal-inset
      */
@@ -166,7 +166,7 @@ export class AnchoredRegion extends FoundationElement {
      * How narrow the space allocated to the default position has to be before the widest area
      * is selected for layout
      *
-     * @beta
+     * @public
      * @remarks
      * HTML Attribute: horizontal-threshold
      */
@@ -179,7 +179,7 @@ export class AnchoredRegion extends FoundationElement {
     /**
      * Defines how the width of the region is calculated
      *
-     * @beta
+     * @public
      * @remarks
      * HTML Attribute: horizontal-scaling
      */
@@ -195,7 +195,7 @@ export class AnchoredRegion extends FoundationElement {
      * 'dynamic' decides placement based on available space
      * 'uncontrolled' does not control placement on the vertical axis
      *
-     * @beta
+     * @public
      * @remarks
      * HTML Attribute: vertical-positioning-mode
      */
@@ -208,7 +208,7 @@ export class AnchoredRegion extends FoundationElement {
     /**
      * The default vertical position of the region relative to the anchor element
      *
-     * @beta
+     * @public
      * @remarks
      * HTML Attribute: vertical-default-position
      */
@@ -221,7 +221,7 @@ export class AnchoredRegion extends FoundationElement {
     /**
      * Whether the region remains in the viewport (ie. detaches from the anchor) on the vertical axis
      *
-     * @beta
+     * @public
      * @remarks
      * HTML Attribute: vertical-viewport-lock
      */
@@ -234,7 +234,7 @@ export class AnchoredRegion extends FoundationElement {
     /**
      * Whether the region overlaps the anchor on the vertical axis
      *
-     * @beta
+     * @public
      * @remarks
      * HTML Attribute: vertical-inset
      */
@@ -248,7 +248,7 @@ export class AnchoredRegion extends FoundationElement {
      * How short the space allocated to the default position has to be before the tallest area
      * is selected for layout
      *
-     * @beta
+     * @public
      * @remarks
      * HTML Attribute: vertical-threshold
      */
@@ -261,7 +261,7 @@ export class AnchoredRegion extends FoundationElement {
     /**
      * Defines how the height of the region is calculated
      *
-     * @beta
+     * @public
      * @remarks
      * HTML Attribute: vertical-scaling
      */
@@ -276,7 +276,7 @@ export class AnchoredRegion extends FoundationElement {
      * Otherwise the region uses "position: absolute".
      * Fixed placement allows the region to break out of parent containers,
      *
-     * @beta
+     * @public
      * @remarks
      * HTML Attribute: fixed-placement
      */
@@ -292,9 +292,9 @@ export class AnchoredRegion extends FoundationElement {
     }
 
     /**
+     * Defines what triggers the anchored region to revaluate positioning
      *
-     *
-     * @beta
+     * @public
      * @remarks
      * HTML Attribute: auto-update-mode
      */
@@ -321,7 +321,7 @@ export class AnchoredRegion extends FoundationElement {
     /**
      * The HTML element being used as the anchor
      *
-     * @beta
+     * @public
      */
     @observable
     public anchorElement: HTMLElement | null = null;
@@ -332,7 +332,7 @@ export class AnchoredRegion extends FoundationElement {
     /**
      * The HTML element being used as the viewport
      *
-     * @beta
+     * @public
      */
     @observable
     public viewportElement: HTMLElement | null = null;