From fcd5e40c834e2477d529013746167ed130dbcc02 Mon Sep 17 00:00:00 2001 From: Brian Heston <47367562+bheston@users.noreply.github.com> Date: Tue, 12 Dec 2023 20:19:43 -0800 Subject: [PATCH] Doc updates --- .../web-components/fast-foundation/docs/api-report.md | 4 ++-- .../src/progress-ring/progress-ring.template.ts | 1 + .../fast-foundation/src/progress-ring/progress-ring.ts | 2 +- .../web-components/fast-foundation/src/progress/README.md | 8 +++----- .../fast-foundation/src/progress/progress.template.ts | 1 + .../fast-foundation/src/progress/progress.ts | 2 +- 6 files changed, 9 insertions(+), 9 deletions(-) diff --git a/packages/web-components/fast-foundation/docs/api-report.md b/packages/web-components/fast-foundation/docs/api-report.md index 1e97a922d5f..eb940ef62ef 100644 --- a/packages/web-components/fast-foundation/docs/api-report.md +++ b/packages/web-components/fast-foundation/docs/api-report.md @@ -2529,7 +2529,7 @@ export type PickerOptions = { // @public export function pickerTemplate(options: PickerOptions): ElementViewTemplate; -// @public (undocumented) +// @public export const progressIndicatorTemplate: ViewTemplate; // @public @@ -2538,7 +2538,7 @@ export type ProgressOptions = { indeterminateIndicator?: StaticallyComposableHTML; }; -// @public (undocumented) +// @public export const progressRingIndicatorTemplate: ViewTemplate; // @public diff --git a/packages/web-components/fast-foundation/src/progress-ring/progress-ring.template.ts b/packages/web-components/fast-foundation/src/progress-ring/progress-ring.template.ts index 84d27baa1b2..d4d20789e26 100644 --- a/packages/web-components/fast-foundation/src/progress-ring/progress-ring.template.ts +++ b/packages/web-components/fast-foundation/src/progress-ring/progress-ring.template.ts @@ -5,6 +5,7 @@ import type { FASTProgressRing } from "./progress-ring.js"; import type { ProgressRingOptions } from "./progress-ring.options.js"; /** + * The default template for the indicator element of the {@link @microsoft/fast-foundation#FASTProgressRing} component. * @public */ export const progressRingIndicatorTemplate = html` diff --git a/packages/web-components/fast-foundation/src/progress-ring/progress-ring.ts b/packages/web-components/fast-foundation/src/progress-ring/progress-ring.ts index 5966563b583..c88bde8d64b 100644 --- a/packages/web-components/fast-foundation/src/progress-ring/progress-ring.ts +++ b/packages/web-components/fast-foundation/src/progress-ring/progress-ring.ts @@ -1,7 +1,7 @@ import { FASTBaseProgress } from "../progress/base-progress.js"; /** - * An circular Progress HTML Element. + * A circular Progress HTML Element. * Implements the {@link https://www.w3.org/TR/wai-aria-1.1/#progressbar | ARIA progressbar }. * * @slot determinate - The slot for the determinate indicator diff --git a/packages/web-components/fast-foundation/src/progress/README.md b/packages/web-components/fast-foundation/src/progress/README.md index d5567a37843..4de218209c2 100644 --- a/packages/web-components/fast-foundation/src/progress/README.md +++ b/packages/web-components/fast-foundation/src/progress/README.md @@ -3,7 +3,7 @@ id: progress title: fast-progress sidebar_label: progress custom_edit_url: https://github.com/microsoft/fast/edit/master/packages/web-components/fast-foundation/src/progress/README.md -description: fast-progress is a web component used to display the length of time a process will take or to visualize percentage value. +description: fast-progress is used to display the length of time a process will take or to visualize percentage value or to represent an unspecified wait time. --- *Progress* and *progress ring* are used to display the length of time a process will take or to visualize percentage value (referred to as a **determinate** state) and to represent an unspecified wait time (referred to as an **indeterminate** state). *Progress* components are typically visually represented by a circular or linear animation. When the `value` attribute is passed the state is **determinate**, otherwise it is **indeterminate**. @@ -40,8 +40,7 @@ import { provideFASTDesignSystem() .register( fastProgress({ - indeterminateIndicator1: `...your indeterminate indicator...`, - indeterminateIndicator2: `...your indeterminate indicator...` + indeterminateIndicator: `...your indeterminate indicator...` }), fastProgressRing({ indeterminateIndicator: `...your indeterminate indicator...` @@ -79,8 +78,7 @@ export const myProgress = Progress.compose({ baseName: "progress", template, styles, - indeterminateIndicator1: `...default indeterminate indicator...`, - indeterminateIndicator2: `...default indeterminate indicator...`, + indeterminateIndicator: `...default indeterminate indicator...`, }); ``` diff --git a/packages/web-components/fast-foundation/src/progress/progress.template.ts b/packages/web-components/fast-foundation/src/progress/progress.template.ts index 967f7c70709..3446e06c398 100644 --- a/packages/web-components/fast-foundation/src/progress/progress.template.ts +++ b/packages/web-components/fast-foundation/src/progress/progress.template.ts @@ -5,6 +5,7 @@ import type { FASTProgress } from "./progress.js"; import type { ProgressOptions } from "./progress.options.js"; /** + * The default template for the indicator element of the {@link @microsoft/fast-foundation#FASTProgressRing} component. * @public */ export const progressIndicatorTemplate = html` diff --git a/packages/web-components/fast-foundation/src/progress/progress.ts b/packages/web-components/fast-foundation/src/progress/progress.ts index 7fc40b10ca8..4f68e8efac6 100644 --- a/packages/web-components/fast-foundation/src/progress/progress.ts +++ b/packages/web-components/fast-foundation/src/progress/progress.ts @@ -1,7 +1,7 @@ import { FASTBaseProgress } from "./base-progress.js"; /** - * An Progress HTML Element. + * A Progress HTML Element. * Implements the {@link https://www.w3.org/TR/wai-aria-1.1/#progressbar | ARIA progressbar }. * * @slot determinate - The slot for the determinate indicator