chore: fix tsdoc for link web component template (microsoft#31690)

spmonahan · Jun 12, 2024 · f5a3153 · f5a3153
1 parent ef5d226
commit f5a3153
Show file tree

Hide file tree

Showing 5 changed files with 12 additions and 5 deletions.
diff --git a/change/@fluentui-web-components-1b9d3e46-3d21-40fa-839e-84141cee53b3.json b/change/@fluentui-web-components-1b9d3e46-3d21-40fa-839e-84141cee53b3.json
@@ -0,0 +1,7 @@
+{
+ "type": "none",
+ "comment": "fix tsdoc for link template",
+ "packageName": "@fluentui/web-components",
+ "email": "13071055+chrisdholt@users.noreply.github.com",
+ "dependentChangeType": "none"
+}
diff --git a/packages/web-components/docs/api-report.md b/packages/web-components/docs/api-report.md
@@ -2191,7 +2191,7 @@ export const lineHeightHero900 = "var(--lineHeightHero900)";
 // @public
 export class Link extends BaseAnchor {
  appearance?: LinkAppearance | undefined;
- inline?: boolean;
+ inline: boolean;
 }
 
 // @public

diff --git a/packages/web-components/src/link/link.options.ts b/packages/web-components/src/link/link.options.ts
@@ -10,7 +10,7 @@ export const LinkAppearance = {
 } as const;
 
 /**
- * An Link can be secondary, primary, outline, subtle, transparent
+ * An Link can be subtle or the default appearance
  * @public
  */
 export type LinkAppearance = ValuesOf<typeof LinkAppearance>;

diff --git a/packages/web-components/src/link/link.template.ts b/packages/web-components/src/link/link.template.ts
@@ -2,7 +2,7 @@ import { ElementViewTemplate, html, ViewTemplate } from '@microsoft/fast-element
 import type { Link } from './link.js';
 
 /**
- * The template for the Button component.
+ * The template for the Link component.
  * @public
  */
 export function anchorTemplate<T extends Link>(): ViewTemplate<T> {
@@ -18,7 +18,7 @@ export function anchorTemplate<T extends Link>(): ViewTemplate<T> {
 }
 
 /**
- * The template for the Button component.
+ * The template for the Link component.
  * @public
  */
 export const template: ElementViewTemplate<Link> = anchorTemplate();
diff --git a/packages/web-components/src/link/link.ts b/packages/web-components/src/link/link.ts
@@ -34,5 +34,5 @@ export class Link extends BaseAnchor {
  * HTML Attribute: `inline`
  */
  @attr({ mode: 'boolean' })
- public inline?: boolean = false;
+ public inline: boolean = false;
 }