diff --git a/packages/web-components/fast-components-msft/docs/api-report.md b/packages/web-components/fast-components-msft/docs/api-report.md index 0683ce5294c..ffa11e37192 100644 --- a/packages/web-components/fast-components-msft/docs/api-report.md +++ b/packages/web-components/fast-components-msft/docs/api-report.md @@ -34,67 +34,69 @@ import { TextField } from '@microsoft/fast-foundation'; // @internal (undocumented) export const AccentButtonStyles: import("@microsoft/fast-element").ElementStyles; -// @public (undocumented) +// @public export const accentFillActiveBehavior: import("@microsoft/fast-foundation").CSSCustomPropertyBehavior; -// @public (undocumented) +// @public export const accentFillFocusBehavior: import("@microsoft/fast-foundation").CSSCustomPropertyBehavior; -// @public (undocumented) +// @public export const accentFillHoverBehavior: import("@microsoft/fast-foundation").CSSCustomPropertyBehavior; -// @public (undocumented) +// @public export const accentFillLargeActiveBehavior: import("@microsoft/fast-foundation").CSSCustomPropertyBehavior; -// @public (undocumented) +// @public export const accentFillLargeFocusBehavior: import("@microsoft/fast-foundation").CSSCustomPropertyBehavior; -// @public (undocumented) +// @public export const accentFillLargeHoverBehavior: import("@microsoft/fast-foundation").CSSCustomPropertyBehavior; -// @public (undocumented) +// @public export const accentFillLargeRestBehavior: import("@microsoft/fast-foundation").CSSCustomPropertyBehavior; -// @public (undocumented) +// @public export const accentFillLargeSelectedBehavior: import("@microsoft/fast-foundation").CSSCustomPropertyBehavior; -// @public (undocumented) +// @public export const accentFillRestBehavior: import("@microsoft/fast-foundation").CSSCustomPropertyBehavior; -// @public (undocumented) +// @public export const accentFillSelectedBehavior: import("@microsoft/fast-foundation").CSSCustomPropertyBehavior; -// @public (undocumented) +// @public export const accentForegroundActiveBehavior: import("@microsoft/fast-foundation").CSSCustomPropertyBehavior; -// @public (undocumented) +// @public export const accentForegroundCutRestBehavior: import("@microsoft/fast-foundation").CSSCustomPropertyBehavior; -// @public (undocumented) +// @public export const accentForegroundFocusBehavior: import("@microsoft/fast-foundation").CSSCustomPropertyBehavior; -// @public (undocumented) +// @public export const accentForegroundHoverBehavior: import("@microsoft/fast-foundation").CSSCustomPropertyBehavior; -// @public (undocumented) +// @public export const accentForegroundLargeActiveBehavior: import("@microsoft/fast-foundation").CSSCustomPropertyBehavior; -// @public (undocumented) +// @public export const accentForegroundLargeFocusBehavior: import("@microsoft/fast-foundation").CSSCustomPropertyBehavior; -// @public (undocumented) +// @public export const accentForegroundLargeHoverBehavior: import("@microsoft/fast-foundation").CSSCustomPropertyBehavior; -// @public (undocumented) +// @public export const accentForegroundLargeRestBehavior: import("@microsoft/fast-foundation").CSSCustomPropertyBehavior; -// @public (undocumented) +// @public export const accentForegroundRestBehavior: import("@microsoft/fast-foundation").CSSCustomPropertyBehavior; -// @public +// Warning: (ae-internal-missing-underscore) The name "ambientShadow" should be prefixed with an underscore because the declaration is marked as @internal +// +// @internal export const ambientShadow = "0 0 calc((var(--elevation) * 0.225px) + 2px) rgba(0, 0, 0, calc(.11 * (2 - var(--background-luminance, 1))))"; -// @public (undocumented) +// @public export type BadgeAppearance = "accent" | "lightweight" | "neutral" | string; // Warning: (ae-internal-missing-underscore) The name "BaseButtonStyles" should be prefixed with an underscore because the declaration is marked as @internal @@ -102,43 +104,45 @@ export type BadgeAppearance = "accent" | "lightweight" | "neutral" | string; // @internal (undocumented) export const BaseButtonStyles: import("@microsoft/fast-element").ElementStyles; -// @public (undocumented) +// Warning: (ae-internal-missing-underscore) The name "directionalShadow" should be prefixed with an underscore because the declaration is marked as @internal +// +// @internal (undocumented) export const directionalShadow = "0 calc(var(--elevation) * 0.4px) calc((var(--elevation) * 0.9px)) rgba(0, 0, 0, calc(.13 * (2 - var(--background-luminance, 1))))"; -// @public (undocumented) +// @public export const elevation: string; -// @public (undocumented) +// @public export class FASTAccordion extends Accordion { } -// @public (undocumented) +// @public export class FASTAccordionItem extends AccordionItem { } -// @public (undocumented) +// @public export class FASTAnchor extends Anchor { } -// @public (undocumented) +// @public export class FASTBadge extends Badge { // (undocumented) appearance: BadgeAppearance; } -// @public (undocumented) +// @public export class FASTButton extends Button { } -// @public (undocumented) +// @public export class FASTCard extends Card { } -// @public (undocumented) +// @public export class FASTCheckbox extends Checkbox { } -// @public (undocumented) +// @public export class FASTDesignSystemProvider extends DesignSystemProvider implements Omit { // (undocumented) accentBaseColor: string; @@ -278,67 +282,67 @@ export class FASTDesignSystemProvider extends DesignSystemProvider implements Om typeRampPlus6LineHeight: string; } -// @public (undocumented) +// @public export class FASTDialog extends Dialog { } -// @public (undocumented) +// @public export class FASTDivider extends Divider { } -// @public (undocumented) +// @public export class FASTFlipper extends Flipper { } -// @public (undocumented) +// @public export class FASTProgress extends BaseProgress { } -// @public (undocumented) +// @public export class FASTProgressRing extends BaseProgress { } -// @public (undocumented) +// @public export class FASTRadio extends Radio { } -// @public (undocumented) +// @public export class FASTRadioGroup extends RadioGroup { } -// @public (undocumented) +// @public export class FASTSlider extends Slider { } -// @public (undocumented) +// @public export class FASTSliderLabel extends SliderLabel { } -// @public (undocumented) +// @public export class FASTSwitch extends Switch { } -// @public (undocumented) +// @public export class FASTTab extends Tab { } -// @public (undocumented) +// @public export class FASTTabPanel extends TabPanel { } -// @public (undocumented) +// @public export class FASTTabs extends Tabs { } -// @public (undocumented) +// @public export class FASTTextArea extends TextArea { } -// @public (undocumented) +// @public export class FASTTextField extends TextField { } -// @public (undocumented) +// @public export const heightNumber = "(var(--base-height-multiplier) + var(--density)) * var(--design-unit)"; // Warning: (ae-internal-missing-underscore) The name "HypertextStyles" should be prefixed with an underscore because the declaration is marked as @internal @@ -351,130 +355,130 @@ export const HypertextStyles: import("@microsoft/fast-element").ElementStyles; // @internal (undocumented) export const LightweightButtonStyles: import("@microsoft/fast-element").ElementStyles; -// @public (undocumented) +// @public export const neutralDividerRestBehavior: import("@microsoft/fast-foundation").CSSCustomPropertyBehavior; -// @public (undocumented) +// @public export const neutralFillActiveBehavior: import("@microsoft/fast-foundation").CSSCustomPropertyBehavior; -// @public (undocumented) +// @public export const neutralFillCardRestBehavior: import("@microsoft/fast-foundation").CSSCustomPropertyBehavior; -// @public (undocumented) +// @public export const neutralFillFocusBehavior: import("@microsoft/fast-foundation").CSSCustomPropertyBehavior; -// @public (undocumented) +// @public export const neutralFillHoverBehavior: import("@microsoft/fast-foundation").CSSCustomPropertyBehavior; -// @public (undocumented) +// @public export const neutralFillInputActiveBehavior: import("@microsoft/fast-foundation").CSSCustomPropertyBehavior; -// @public (undocumented) +// @public export const neutralFillInputFocusBehavior: import("@microsoft/fast-foundation").CSSCustomPropertyBehavior; -// @public (undocumented) +// @public export const neutralFillInputHoverBehavior: import("@microsoft/fast-foundation").CSSCustomPropertyBehavior; -// @public (undocumented) +// @public export const neutralFillInputRestBehavior: import("@microsoft/fast-foundation").CSSCustomPropertyBehavior; -// @public (undocumented) +// @public export const neutralFillRestBehavior: import("@microsoft/fast-foundation").CSSCustomPropertyBehavior; -// @public (undocumented) +// @public export const neutralFillSelectedBehavior: import("@microsoft/fast-foundation").CSSCustomPropertyBehavior; -// @public (undocumented) +// @public export const neutralFillStealthActiveBehavior: import("@microsoft/fast-foundation").CSSCustomPropertyBehavior; -// @public (undocumented) +// @public export const neutralFillStealthFocusBehavior: import("@microsoft/fast-foundation").CSSCustomPropertyBehavior; -// @public (undocumented) +// @public export const neutralFillStealthHoverBehavior: import("@microsoft/fast-foundation").CSSCustomPropertyBehavior; -// @public (undocumented) +// @public export const neutralFillStealthRestBehavior: import("@microsoft/fast-foundation").CSSCustomPropertyBehavior; -// @public (undocumented) +// @public export const neutralFillStealthSelectedBehavior: import("@microsoft/fast-foundation").CSSCustomPropertyBehavior; -// @public (undocumented) +// @public export const neutralFillToggleActiveBehavior: import("@microsoft/fast-foundation").CSSCustomPropertyBehavior; -// @public (undocumented) +// @public export const neutralFillToggleFocusBehavior: import("@microsoft/fast-foundation").CSSCustomPropertyBehavior; -// @public (undocumented) +// @public export const neutralFillToggleHoverBehavior: import("@microsoft/fast-foundation").CSSCustomPropertyBehavior; -// @public (undocumented) +// @public export const neutralFillToggleRestBehavior: import("@microsoft/fast-foundation").CSSCustomPropertyBehavior; -// @public (undocumented) +// @public export const neutralFocusBehavior: import("@microsoft/fast-foundation").CSSCustomPropertyBehavior; -// @public (undocumented) +// @public export const neutralFocusInnerAccentBehavior: import("@microsoft/fast-foundation").CSSCustomPropertyBehavior; -// @public (undocumented) +// @public export const neutralForegroundActiveBehavior: import("@microsoft/fast-foundation").CSSCustomPropertyBehavior; -// @public (undocumented) +// @public export const neutralForegroundFocusBehavior: import("@microsoft/fast-foundation").CSSCustomPropertyBehavior; -// @public (undocumented) +// @public export const neutralForegroundHintBehavior: import("@microsoft/fast-foundation").CSSCustomPropertyBehavior; -// @public (undocumented) +// @public export const neutralForegroundHintLargeBehavior: import("@microsoft/fast-foundation").CSSCustomPropertyBehavior; -// @public (undocumented) +// @public export const neutralForegroundHoverBehavior: import("@microsoft/fast-foundation").CSSCustomPropertyBehavior; -// @public (undocumented) +// @public export const neutralForegroundRestBehavior: import("@microsoft/fast-foundation").CSSCustomPropertyBehavior; -// @public (undocumented) +// @public export const neutralForegroundToggleBehavior: import("@microsoft/fast-foundation").CSSCustomPropertyBehavior; -// @public (undocumented) +// @public export const neutralForegroundToggleLargeBehavior: import("@microsoft/fast-foundation").CSSCustomPropertyBehavior; -// @public (undocumented) +// @public export const neutralLayerCardBehavior: import("@microsoft/fast-foundation").CSSCustomPropertyBehavior; -// @public (undocumented) +// @public export const neutralLayerCardContainerBehavior: import("@microsoft/fast-foundation").CSSCustomPropertyBehavior; -// @public (undocumented) +// @public export const neutralLayerFloatingBehavior: import("@microsoft/fast-foundation").CSSCustomPropertyBehavior; -// @public (undocumented) +// @public export const neutralLayerL1AltBehavior: import("@microsoft/fast-foundation").CSSCustomPropertyBehavior; -// @public (undocumented) +// @public export const neutralLayerL1Behavior: import("@microsoft/fast-foundation").CSSCustomPropertyBehavior; -// @public (undocumented) +// @public export const neutralLayerL2Behavior: import("@microsoft/fast-foundation").CSSCustomPropertyBehavior; -// @public (undocumented) +// @public export const neutralLayerL3Behavior: import("@microsoft/fast-foundation").CSSCustomPropertyBehavior; -// @public (undocumented) +// @public export const neutralLayerL4Behavior: import("@microsoft/fast-foundation").CSSCustomPropertyBehavior; -// @public (undocumented) +// @public export const neutralOutlineActiveBehavior: import("@microsoft/fast-foundation").CSSCustomPropertyBehavior; -// @public (undocumented) +// @public export const neutralOutlineFocusBehavior: import("@microsoft/fast-foundation").CSSCustomPropertyBehavior; -// @public (undocumented) +// @public export const neutralOutlineHoverBehavior: import("@microsoft/fast-foundation").CSSCustomPropertyBehavior; -// @public (undocumented) +// @public export const neutralOutlineRestBehavior: import("@microsoft/fast-foundation").CSSCustomPropertyBehavior; // Warning: (ae-internal-missing-underscore) The name "OutlineButtonStyles" should be prefixed with an underscore because the declaration is marked as @internal diff --git a/packages/web-components/fast-components-msft/package.json b/packages/web-components/fast-components-msft/package.json index ceb5decc4ab..a5e6c023edd 100644 --- a/packages/web-components/fast-components-msft/package.json +++ b/packages/web-components/fast-components-msft/package.json @@ -21,6 +21,7 @@ "scripts": { "clean:dist": "node ../../../build/clean.js dist", "doc": "api-extractor run --local", + "doc:ci": "api-extractor run --local", "build": "tsc -p ./tsconfig.json && rollup -c && npm run doc", "dev": "tsc -p ./tsconfig.json -w", "tdd": "npm run dev & npm run test-chrome:watch", @@ -31,7 +32,7 @@ "eslint:fix": "eslint . --ext .ts --fix", "start": "start-storybook -p 6006", "build-storybook": "build-storybook", - "test": "npm run test-chrome:verbose", + "test": "yarn test-chrome:verbose && yarn doc:ci", "test-node": "mocha --reporter min --exit dist/esm/__test__/setup-node.js './dist/esm/**/*.spec.js'", "test-node:verbose": "mocha --reporter spec --exit dist/esm/__test__/setup-node.js './dist/esm/**/*.spec.js'", "test-chrome": "karma start karma.conf.js --browsers=ChromeHeadlessOpt --single-run --coverage", diff --git a/packages/web-components/fast-components-msft/src/accordion/accordion-item/index.ts b/packages/web-components/fast-components-msft/src/accordion/accordion-item/index.ts index 050d06f0543..79dabfe1dc4 100644 --- a/packages/web-components/fast-components-msft/src/accordion/accordion-item/index.ts +++ b/packages/web-components/fast-components-msft/src/accordion/accordion-item/index.ts @@ -5,6 +5,15 @@ import { } from "@microsoft/fast-foundation"; import { AccordionItemStyles as styles } from "./accordion-item.styles"; +/** + * The FAST Accordion Item Element. Implements {@link @microsoft/fast-foundation#AccordionItem}, + * {@link @microsoft/fast-foundation#AccordionItemTemplate} + * + * + * @public + * @remarks + * HTML Element: \ + */ @customElement({ name: "fast-accordion-item", template, diff --git a/packages/web-components/fast-components-msft/src/accordion/index.ts b/packages/web-components/fast-components-msft/src/accordion/index.ts index d4cc0670ac7..5cbafbb3dca 100644 --- a/packages/web-components/fast-components-msft/src/accordion/index.ts +++ b/packages/web-components/fast-components-msft/src/accordion/index.ts @@ -4,6 +4,15 @@ import { AccordionStyles as styles } from "./accordion.styles"; export * from "./accordion-item/index"; +/** + * The FAST Accordion Element. Implements {@link @microsoft/fast-foundation#Accordion}, + * {@link @microsoft/fast-foundation#AccordionTemplate} + * + * + * @public + * @remarks + * HTML Element: \ + */ @customElement({ name: "fast-accordion", template, diff --git a/packages/web-components/fast-components-msft/src/anchor/index.ts b/packages/web-components/fast-components-msft/src/anchor/index.ts index 02489bf9df8..2de5da2d170 100644 --- a/packages/web-components/fast-components-msft/src/anchor/index.ts +++ b/packages/web-components/fast-components-msft/src/anchor/index.ts @@ -2,7 +2,17 @@ import { customElement } from "@microsoft/fast-element"; import { Anchor, AnchorTemplate as template } from "@microsoft/fast-foundation"; import { AnchorStyles as styles } from "./anchor.styles"; -// Anchor +/** + * The FAST Anchor Element. Implements {@link @microsoft/fast-foundation#Anchor}, + * {@link @microsoft/fast-foundation#AnchorTemplate} + * + * + * @public + * @remarks + * HTML Element: \ + * + * {@link https://developer.mozilla.org/en-US/docs/Web/API/ShadowRoot/delegatesFocus | delegatesFocus} + */ @customElement({ name: "fast-anchor", template, diff --git a/packages/web-components/fast-components-msft/src/badge/index.ts b/packages/web-components/fast-components-msft/src/badge/index.ts index 264a40bdd04..95641e19014 100644 --- a/packages/web-components/fast-components-msft/src/badge/index.ts +++ b/packages/web-components/fast-components-msft/src/badge/index.ts @@ -2,8 +2,21 @@ import { attr, customElement, DOM } from "@microsoft/fast-element"; import { Badge, BadgeTemplate as template } from "@microsoft/fast-foundation"; import { BadgeStyles as styles } from "./badge.styles"; +/** + * Badge appearance options. + * @public + */ export type BadgeAppearance = "accent" | "lightweight" | "neutral" | string; +/** + * The FAST Badge Element. Implements {@link @microsoft/fast-foundation#Badge}, + * {@link @microsoft/fast-foundation#BadgeTemplate} + * + * + * @public + * @remarks + * HTML Element: \ + */ @customElement({ name: "fast-badge", template, diff --git a/packages/web-components/fast-components-msft/src/button/index.ts b/packages/web-components/fast-components-msft/src/button/index.ts index b91d7961425..2bf99463ce7 100644 --- a/packages/web-components/fast-components-msft/src/button/index.ts +++ b/packages/web-components/fast-components-msft/src/button/index.ts @@ -2,7 +2,17 @@ import { customElement } from "@microsoft/fast-element"; import { Button, ButtonTemplate as template } from "@microsoft/fast-foundation"; import { ButtonStyles as styles } from "./button.styles"; -// Button +/** + * The FAST Button Element. Implements {@link @microsoft/fast-foundation#Button}, + * {@link @microsoft/fast-foundation#ButtonTemplate} + * + * + * @public + * @remarks + * HTML Element: \ + * + * {@link https://developer.mozilla.org/en-US/docs/Web/API/ShadowRoot/delegatesFocus | delegatesFocus} + */ @customElement({ name: "fast-button", template, diff --git a/packages/web-components/fast-components-msft/src/card/index.ts b/packages/web-components/fast-components-msft/src/card/index.ts index 4bba1416411..5c3323e5f6d 100644 --- a/packages/web-components/fast-components-msft/src/card/index.ts +++ b/packages/web-components/fast-components-msft/src/card/index.ts @@ -2,6 +2,15 @@ import { customElement } from "@microsoft/fast-element"; import { Card, CardTemplate as template } from "@microsoft/fast-foundation"; import { CardStyles as styles } from "./card.styles"; +/** + * The FAST Card Element. Implements {@link @microsoft/fast-foundation#Card}, + * {@link @microsoft/fast-foundation#CardTemplate} + * + * + * @public + * @remarks + * HTML Element: \ + */ @customElement({ name: "fast-card", template, diff --git a/packages/web-components/fast-components-msft/src/checkbox/index.ts b/packages/web-components/fast-components-msft/src/checkbox/index.ts index 3213c2c745e..77e4be66eb9 100644 --- a/packages/web-components/fast-components-msft/src/checkbox/index.ts +++ b/packages/web-components/fast-components-msft/src/checkbox/index.ts @@ -2,6 +2,15 @@ import { customElement } from "@microsoft/fast-element"; import { Checkbox, CheckboxTemplate as template } from "@microsoft/fast-foundation"; import { CheckboxStyles as styles } from "./checkbox.styles"; +/** + * The FAST Checkbox Element. Implements {@link @microsoft/fast-foundation#Checkbox}, + * {@link @microsoft/fast-foundation#CheckboxTemplate} + * + * + * @public + * @remarks + * HTML Element: \ + */ @customElement({ name: "fast-checkbox", template, diff --git a/packages/web-components/fast-components-msft/src/design-system-provider/index.ts b/packages/web-components/fast-components-msft/src/design-system-provider/index.ts index 2e6b48252d4..f7f4f1fef2d 100644 --- a/packages/web-components/fast-components-msft/src/design-system-provider/index.ts +++ b/packages/web-components/fast-components-msft/src/design-system-provider/index.ts @@ -27,6 +27,15 @@ const backgroundStyles = css` } `.withBehaviors(color); +/** + * The FAST DesignSystemProvider Element. Implements {@link @microsoft/fast-foundation#DesignSystemProvider}, + * {@link @microsoft/fast-foundation#DesignSystemProviderTemplate} + * + * + * @public + * @remarks + * HTML Element: \ + */ @designSystemProvider({ name: "fast-design-system-provider", template, diff --git a/packages/web-components/fast-components-msft/src/dialog/index.ts b/packages/web-components/fast-components-msft/src/dialog/index.ts index 3c5471ce387..46d73c936a8 100644 --- a/packages/web-components/fast-components-msft/src/dialog/index.ts +++ b/packages/web-components/fast-components-msft/src/dialog/index.ts @@ -2,6 +2,15 @@ import { customElement } from "@microsoft/fast-element"; import { Dialog, DialogTemplate as template } from "@microsoft/fast-foundation"; import { DialogStyles as styles } from "./dialog.styles"; +/** + * The FAST Dialog Element. Implements {@link @microsoft/fast-foundation#Dialog}, + * {@link @microsoft/fast-foundation#DialogTemplate} + * + * + * @public + * @remarks + * HTML Element: \ + */ @customElement({ name: "fast-dialog", template, diff --git a/packages/web-components/fast-components-msft/src/divider/index.ts b/packages/web-components/fast-components-msft/src/divider/index.ts index d805262a9c3..acab45c6b12 100644 --- a/packages/web-components/fast-components-msft/src/divider/index.ts +++ b/packages/web-components/fast-components-msft/src/divider/index.ts @@ -2,6 +2,15 @@ import { customElement } from "@microsoft/fast-element"; import { Divider, DividerTemplate as template } from "@microsoft/fast-foundation"; import { DividerStyles as styles } from "./divider.styles"; +/** + * The FAST Divider Element. Implements {@link @microsoft/fast-foundation#Divider}, + * {@link @microsoft/fast-foundation#DividerTemplate} + * + * + * @public + * @remarks + * HTML Element: \ + */ @customElement({ name: "fast-divider", template, diff --git a/packages/web-components/fast-components-msft/src/flipper/index.ts b/packages/web-components/fast-components-msft/src/flipper/index.ts index 3c8dc08570c..7f7dbf0ea12 100644 --- a/packages/web-components/fast-components-msft/src/flipper/index.ts +++ b/packages/web-components/fast-components-msft/src/flipper/index.ts @@ -2,6 +2,15 @@ import { customElement } from "@microsoft/fast-element"; import { Flipper, FlipperTemplate as template } from "@microsoft/fast-foundation"; import { FlipperStyles as styles } from "./flipper.styles"; +/** + * The FAST Flipper Element. Implements {@link @microsoft/fast-foundation#Flipper}, + * {@link @microsoft/fast-foundation#FlipperTemplate} + * + * + * @public + * @remarks + * HTML Element: \ + */ @customElement({ name: "fast-flipper", template, diff --git a/packages/web-components/fast-components-msft/src/progress/progress-ring/index.ts b/packages/web-components/fast-components-msft/src/progress/progress-ring/index.ts index 8a149539d98..dc6fee00820 100644 --- a/packages/web-components/fast-components-msft/src/progress/progress-ring/index.ts +++ b/packages/web-components/fast-components-msft/src/progress/progress-ring/index.ts @@ -5,6 +5,15 @@ import { } from "@microsoft/fast-foundation"; import { ProgressRingStyles as styles } from "./progress-ring.styles"; +/** + * The FAST Progress Ring Element. Implements {@link @microsoft/fast-foundation#BaseProgress}, + * {@link @microsoft/fast-foundation#ProgressRingTemplate} + * + * + * @public + * @remarks + * HTML Element: \ + */ @customElement({ name: "fast-progress-ring", template, diff --git a/packages/web-components/fast-components-msft/src/progress/progress/index.ts b/packages/web-components/fast-components-msft/src/progress/progress/index.ts index 5abb518d84a..f860b5dbf73 100644 --- a/packages/web-components/fast-components-msft/src/progress/progress/index.ts +++ b/packages/web-components/fast-components-msft/src/progress/progress/index.ts @@ -2,6 +2,15 @@ import { customElement } from "@microsoft/fast-element"; import { BaseProgress, ProgressTemplate as template } from "@microsoft/fast-foundation"; import { ProgressStyles as styles } from "./progress.styles"; +/** + * The FAST Progress Element. Implements {@link @microsoft/fast-foundation#BaseProgress}, + * {@link @microsoft/fast-foundation#ProgressTemplate} + * + * + * @public + * @remarks + * HTML Element: \ + */ @customElement({ name: "fast-progress", template, diff --git a/packages/web-components/fast-components-msft/src/radio-group/index.ts b/packages/web-components/fast-components-msft/src/radio-group/index.ts index 7c5b3ae8b22..c3c1894cca2 100644 --- a/packages/web-components/fast-components-msft/src/radio-group/index.ts +++ b/packages/web-components/fast-components-msft/src/radio-group/index.ts @@ -2,6 +2,15 @@ import { customElement } from "@microsoft/fast-element"; import { RadioGroup, RadioGroupTemplate as template } from "@microsoft/fast-foundation"; import { RadioGroupStyles as styles } from "./radio-group.styles"; +/** + * The FAST Radio Group Element. Implements {@link @microsoft/fast-foundation#RadioGroup}, + * {@link @microsoft/fast-foundation#RadioGroupTemplate} + * + * + * @public + * @remarks + * HTML Element: \ + */ @customElement({ name: "fast-radio-group", template, diff --git a/packages/web-components/fast-components-msft/src/radio/index.ts b/packages/web-components/fast-components-msft/src/radio/index.ts index 06068933fcf..cddd1aaab2d 100644 --- a/packages/web-components/fast-components-msft/src/radio/index.ts +++ b/packages/web-components/fast-components-msft/src/radio/index.ts @@ -2,6 +2,15 @@ import { customElement } from "@microsoft/fast-element"; import { Radio, RadioTemplate as template } from "@microsoft/fast-foundation"; import { RadioStyles as styles } from "./radio.styles"; +/** + * The FAST Radio Element. Implements {@link @microsoft/fast-foundation#Radio}, + * {@link @microsoft/fast-foundation#RadioTemplate} + * + * + * @public + * @remarks + * HTML Element: \ + */ @customElement({ name: "fast-radio", template, diff --git a/packages/web-components/fast-components-msft/src/slider-label/index.ts b/packages/web-components/fast-components-msft/src/slider-label/index.ts index bf8f9e94402..d75583956ed 100644 --- a/packages/web-components/fast-components-msft/src/slider-label/index.ts +++ b/packages/web-components/fast-components-msft/src/slider-label/index.ts @@ -2,6 +2,15 @@ import { customElement } from "@microsoft/fast-element"; import { SliderLabel, SliderLabelTemplate as template } from "@microsoft/fast-foundation"; import { SliderLabelStyles as styles } from "./slider-label.styles"; +/** + * The FAST Slider Label Custom Element. Implements {@link @microsoft/fast-foundation#SliderLabel}, + * {@link @microsoft/fast-foundation#SliderLabelTemplate} + * + * + * @public + * @remarks + * HTML Element: \ + */ @customElement({ name: "fast-slider-label", template, diff --git a/packages/web-components/fast-components-msft/src/slider/index.ts b/packages/web-components/fast-components-msft/src/slider/index.ts index e177019719e..a32da2f05bf 100644 --- a/packages/web-components/fast-components-msft/src/slider/index.ts +++ b/packages/web-components/fast-components-msft/src/slider/index.ts @@ -2,6 +2,15 @@ import { customElement } from "@microsoft/fast-element"; import { Slider, SliderTemplate as template } from "@microsoft/fast-foundation"; import { SliderStyles as styles } from "./slider.styles"; +/** + * The FAST Slider Custom Element. Implements {@link @microsoft/fast-foundation#Slider}, + * {@link @microsoft/fast-foundation#SliderTemplate} + * + * + * @public + * @remarks + * HTML Element: \ + */ @customElement({ name: "fast-slider", template, diff --git a/packages/web-components/fast-components-msft/src/styles/behaviors.ts b/packages/web-components/fast-components-msft/src/styles/behaviors.ts index 02181257187..7d428b3a4d2 100644 --- a/packages/web-components/fast-components-msft/src/styles/behaviors.ts +++ b/packages/web-components/fast-components-msft/src/styles/behaviors.ts @@ -31,306 +31,550 @@ import { } from "@microsoft/fast-components-styles-msft"; import { FASTDesignSystemProvider } from "../design-system-provider"; +/** + * Behavior to resolve and make available the neutral-foreground-rest CSS custom property. + * @public + */ export const neutralForegroundRestBehavior = cssCustomPropertyBehaviorFactory( "neutral-foreground-rest", x => neutralForeground(x).rest, FASTDesignSystemProvider.findProvider ); +/** + * Behavior to resolve and make available the neutral-foreground-hover CSS custom property. + * @public + */ export const neutralForegroundHoverBehavior = cssCustomPropertyBehaviorFactory( "neutral-foreground-hover", x => neutralForeground(x).hover, FASTDesignSystemProvider.findProvider ); +/** + * Behavior to resolve and make available the neutral-foreground-active CSS custom property. + * @public + */ export const neutralForegroundActiveBehavior = cssCustomPropertyBehaviorFactory( "neutral-foreground-active", x => neutralForeground(x).active, FASTDesignSystemProvider.findProvider ); +/** + * Behavior to resolve and make available the neutral-foreground-focus CSS custom property. + * @public + */ export const neutralForegroundFocusBehavior = cssCustomPropertyBehaviorFactory( "neutral-foreground-focus", x => neutralForeground(x).focus, FASTDesignSystemProvider.findProvider ); +/** + * Behavior to resolve and make available the neutral-foreground-toggle CSS custom property. + * @public + */ export const neutralForegroundToggleBehavior = cssCustomPropertyBehaviorFactory( "neutral-foreground-toggle", neutralForegroundToggle, FASTDesignSystemProvider.findProvider ); +/** + * Behavior to resolve and make available the neutral-foreground-toggle-large CSS custom property. + * @public + */ export const neutralForegroundToggleLargeBehavior = cssCustomPropertyBehaviorFactory( "neutral-foreground-toggle-large", neutralForegroundToggleLarge, FASTDesignSystemProvider.findProvider ); +/** + * Behavior to resolve and make available the neutral-foreground-hint CSS custom property. + * @public + */ export const neutralForegroundHintBehavior = cssCustomPropertyBehaviorFactory( "neutral-foreground-hint", neutralForegroundHint, FASTDesignSystemProvider.findProvider ); +/** + * Behavior to resolve and make available the neutral-foreground-hint-large CSS custom property. + * @public + */ export const neutralForegroundHintLargeBehavior = cssCustomPropertyBehaviorFactory( "neutral-foreground-hint-large", neutralForegroundHintLarge, FASTDesignSystemProvider.findProvider ); +/** + * Behavior to resolve and make available the accent-foreground-rest CSS custom property. + * @public + */ export const accentForegroundRestBehavior = cssCustomPropertyBehaviorFactory( "accent-foreground-rest", x => accentForeground(x).rest, FASTDesignSystemProvider.findProvider ); +/** + * Behavior to resolve and make available the accent-foreground-hover CSS custom property. + * @public + */ export const accentForegroundHoverBehavior = cssCustomPropertyBehaviorFactory( "accent-foreground-hover", x => accentForeground(x).hover, FASTDesignSystemProvider.findProvider ); +/** + * Behavior to resolve and make available the accent-foreground-active CSS custom property. + * @public + */ export const accentForegroundActiveBehavior = cssCustomPropertyBehaviorFactory( "accent-foreground-active", x => accentForeground(x).active, FASTDesignSystemProvider.findProvider ); +/** + * Behavior to resolve and make available the accent-foreground-focus CSS custom property. + * @public + */ export const accentForegroundFocusBehavior = cssCustomPropertyBehaviorFactory( "accent-foreground-focus", x => accentForeground(x).focus, FASTDesignSystemProvider.findProvider ); +/** + * Behavior to resolve and make available the accent-foreground-cut-rest CSS custom property. + * @public + */ export const accentForegroundCutRestBehavior = cssCustomPropertyBehaviorFactory( "accent-foreground-cut-rest", x => accentForegroundCut(x), FASTDesignSystemProvider.findProvider ); +/** + * Behavior to resolve and make available the accent-foreground-large-rest CSS custom property. + * @public + */ export const accentForegroundLargeRestBehavior = cssCustomPropertyBehaviorFactory( "accent-foreground-large-rest", x => accentForegroundLarge(x).rest, FASTDesignSystemProvider.findProvider ); +/** + * Behavior to resolve and make available the accent-foreground-large-hover CSS custom property. + * @public + */ export const accentForegroundLargeHoverBehavior = cssCustomPropertyBehaviorFactory( "accent-foreground-large-hover", x => accentForegroundLarge(x).hover, FASTDesignSystemProvider.findProvider ); +/** + * Behavior to resolve and make available the accent-foreground-large-active CSS custom property. + * @public + */ export const accentForegroundLargeActiveBehavior = cssCustomPropertyBehaviorFactory( "accent-foreground-large-active", x => accentForegroundLarge(x).active, FASTDesignSystemProvider.findProvider ); +/** + * Behavior to resolve and make available the accent-foreground-large-focus CSS custom property. + * @public + */ export const accentForegroundLargeFocusBehavior = cssCustomPropertyBehaviorFactory( "accent-foreground-large-focus", x => accentForegroundLarge(x).focus, FASTDesignSystemProvider.findProvider ); +/** + * Behavior to resolve and make available the neutral-fill-rest CSS custom property. + * @public + */ export const neutralFillRestBehavior = cssCustomPropertyBehaviorFactory( "neutral-fill-rest", x => neutralFill(x).rest, FASTDesignSystemProvider.findProvider ); +/** + * Behavior to resolve and make available the neutral-fill-hover CSS custom property. + * @public + */ export const neutralFillHoverBehavior = cssCustomPropertyBehaviorFactory( "neutral-fill-hover", x => neutralFill(x).hover, FASTDesignSystemProvider.findProvider ); +/** + * Behavior to resolve and make available the neutral-fill-active CSS custom property. + * @public + */ export const neutralFillActiveBehavior = cssCustomPropertyBehaviorFactory( "neutral-fill-active", x => neutralFill(x).active, FASTDesignSystemProvider.findProvider ); +/** + * Behavior to resolve and make available the neutral-fill-focus CSS custom property. + * @public + */ export const neutralFillFocusBehavior = cssCustomPropertyBehaviorFactory( "neutral-fill-focus", x => neutralFill(x).focus, FASTDesignSystemProvider.findProvider ); +/** + * Behavior to resolve and make available the neutral-fill-selected CSS custom property. + * @public + */ export const neutralFillSelectedBehavior = cssCustomPropertyBehaviorFactory( "neutral-fill-selected", x => neutralFill(x).selected, FASTDesignSystemProvider.findProvider ); +/** + * Behavior to resolve and make available the neutral-fill-stealth-rest CSS custom property. + * @public + */ export const neutralFillStealthRestBehavior = cssCustomPropertyBehaviorFactory( "neutral-fill-stealth-rest", x => neutralFillStealth(x).rest, FASTDesignSystemProvider.findProvider ); +/** + * Behavior to resolve and make available the neutral-fill-stealth-hover CSS custom property. + * @public + */ export const neutralFillStealthHoverBehavior = cssCustomPropertyBehaviorFactory( "neutral-fill-stealth-hover", x => neutralFillStealth(x).hover, FASTDesignSystemProvider.findProvider ); +/** + * Behavior to resolve and make available the neutral-fill-stealth-active CSS custom property. + * @public + */ export const neutralFillStealthActiveBehavior = cssCustomPropertyBehaviorFactory( "neutral-fill-stealth-active", x => neutralFillStealth(x).active, FASTDesignSystemProvider.findProvider ); +/** + * Behavior to resolve and make available the neutral-fill-stealth-focus CSS custom property. + * @public + */ export const neutralFillStealthFocusBehavior = cssCustomPropertyBehaviorFactory( "neutral-fill-stealth-focus", x => neutralFillStealth(x).focus, FASTDesignSystemProvider.findProvider ); +/** + * Behavior to resolve and make available the neutral-fill-stealth-selected CSS custom property. + * @public + */ export const neutralFillStealthSelectedBehavior = cssCustomPropertyBehaviorFactory( "neutral-fill-stealth-selected", x => neutralFillStealth(x).selected, FASTDesignSystemProvider.findProvider ); +/** + * Behavior to resolve and make available the neutral-fill-toggle-rest CSS custom property. + * @public + */ export const neutralFillToggleRestBehavior = cssCustomPropertyBehaviorFactory( "neutral-fill-toggle-rest", x => neutralFillToggle(x).rest, FASTDesignSystemProvider.findProvider ); +/** + * Behavior to resolve and make available the neutral-fill-toggle-hover CSS custom property. + * @public + */ export const neutralFillToggleHoverBehavior = cssCustomPropertyBehaviorFactory( "neutral-fill-toggle-hover", x => neutralFillToggle(x).hover, FASTDesignSystemProvider.findProvider ); +/** + * Behavior to resolve and make available the neutral-fill-toggle-active CSS custom property. + * @public + */ export const neutralFillToggleActiveBehavior = cssCustomPropertyBehaviorFactory( "neutral-fill-toggle-active", x => neutralFillToggle(x).active, FASTDesignSystemProvider.findProvider ); +/** + * Behavior to resolve and make available the neutral-fill-toggle-focus CSS custom property. + * @public + */ export const neutralFillToggleFocusBehavior = cssCustomPropertyBehaviorFactory( "neutral-fill-toggle-focus", x => neutralFillToggle(x).focus, FASTDesignSystemProvider.findProvider ); +/** + * Behavior to resolve and make available the neutral-fill-input-rest CSS custom property. + * @public + */ export const neutralFillInputRestBehavior = cssCustomPropertyBehaviorFactory( "neutral-fill-input-rest", x => neutralFillInput(x).rest, FASTDesignSystemProvider.findProvider ); +/** + * Behavior to resolve and make available the neutral-fill-input-hover CSS custom property. + * @public + */ export const neutralFillInputHoverBehavior = cssCustomPropertyBehaviorFactory( "neutral-fill-input-hover", x => neutralFillInput(x).hover, FASTDesignSystemProvider.findProvider ); +/** + * Behavior to resolve and make available the neutral-fill-input-active CSS custom property. + * @public + */ export const neutralFillInputActiveBehavior = cssCustomPropertyBehaviorFactory( "neutral-fill-input-active", x => neutralFillInput(x).active, FASTDesignSystemProvider.findProvider ); +/** + * Behavior to resolve and make available the neutral-fill-input-focus CSS custom property. + * @public + */ export const neutralFillInputFocusBehavior = cssCustomPropertyBehaviorFactory( "neutral-fill-input-focus", x => neutralFillInput(x).focus, FASTDesignSystemProvider.findProvider ); +/** + * Behavior to resolve and make available the accent-fill-rest CSS custom property. + * @public + */ export const accentFillRestBehavior = cssCustomPropertyBehaviorFactory( "accent-fill-rest", x => accentFill(x).rest, FASTDesignSystemProvider.findProvider ); +/** + * Behavior to resolve and make available the accent-fill-hover CSS custom property. + * @public + */ export const accentFillHoverBehavior = cssCustomPropertyBehaviorFactory( "accent-fill-hover", x => accentFill(x).hover, FASTDesignSystemProvider.findProvider ); +/** + * Behavior to resolve and make available the accent-fill-active CSS custom property. + * @public + */ export const accentFillActiveBehavior = cssCustomPropertyBehaviorFactory( "accent-fill-active", x => accentFill(x).active, FASTDesignSystemProvider.findProvider ); +/** + * Behavior to resolve and make available the accent-fill-focus CSS custom property. + * @public + */ export const accentFillFocusBehavior = cssCustomPropertyBehaviorFactory( "accent-fill-focus", x => accentFill(x).focus, FASTDesignSystemProvider.findProvider ); +/** + * Behavior to resolve and make available the accent-fill-selected CSS custom property. + * @public + */ export const accentFillSelectedBehavior = cssCustomPropertyBehaviorFactory( "accent-fill-selected", x => accentFill(x).selected, FASTDesignSystemProvider.findProvider ); +/** + * Behavior to resolve and make available the accent-fill-large-rest CSS custom property. + * @public + */ export const accentFillLargeRestBehavior = cssCustomPropertyBehaviorFactory( "accent-fill-large-rest", x => accentFillLarge(x).rest, FASTDesignSystemProvider.findProvider ); +/** + * Behavior to resolve and make available the accent-fill-large-hover CSS custom property. + * @public + */ export const accentFillLargeHoverBehavior = cssCustomPropertyBehaviorFactory( "accent-fill-large-hover", x => accentFillLarge(x).hover, FASTDesignSystemProvider.findProvider ); +/** + * Behavior to resolve and make available the accent-fill-large-active CSS custom property. + * @public + */ export const accentFillLargeActiveBehavior = cssCustomPropertyBehaviorFactory( "accent-fill-large-active", x => accentFillLarge(x).active, FASTDesignSystemProvider.findProvider ); +/** + * Behavior to resolve and make available the accent-fill-large-focus CSS custom property. + * @public + */ export const accentFillLargeFocusBehavior = cssCustomPropertyBehaviorFactory( "accent-fill-large-focus", x => accentFillLarge(x).focus, FASTDesignSystemProvider.findProvider ); +/** + * Behavior to resolve and make available the accent-fill-large-selected CSS custom property. + * @public + */ export const accentFillLargeSelectedBehavior = cssCustomPropertyBehaviorFactory( "accent-fill-large-selected", x => accentFillLarge(x).selected, FASTDesignSystemProvider.findProvider ); +/** + * Behavior to resolve and make available the neutral-fill-card-rest CSS custom property. + * @public + */ export const neutralFillCardRestBehavior = cssCustomPropertyBehaviorFactory( "neutral-fill-card-rest", x => neutralFillCard(x), FASTDesignSystemProvider.findProvider ); +/** + * Behavior to resolve and make available the neutral-outline-rest CSS custom property. + * @public + */ export const neutralOutlineRestBehavior = cssCustomPropertyBehaviorFactory( "neutral-outline-rest", x => neutralOutline(x).rest, FASTDesignSystemProvider.findProvider ); +/** + * Behavior to resolve and make available the neutral-outline-hover CSS custom property. + * @public + */ export const neutralOutlineHoverBehavior = cssCustomPropertyBehaviorFactory( "neutral-outline-hover", x => neutralOutline(x).hover, FASTDesignSystemProvider.findProvider ); +/** + * Behavior to resolve and make available the neutral-outline-active CSS custom property. + * @public + */ export const neutralOutlineActiveBehavior = cssCustomPropertyBehaviorFactory( "neutral-outline-active", x => neutralOutline(x).active, FASTDesignSystemProvider.findProvider ); +/** + * Behavior to resolve and make available the neutral-outline-focus CSS custom property. + * @public + */ export const neutralOutlineFocusBehavior = cssCustomPropertyBehaviorFactory( "neutral-outline-focus", x => neutralOutline(x).focus, FASTDesignSystemProvider.findProvider ); +/** + * Behavior to resolve and make available the neutral-divider-rest CSS custom property. + * @public + */ export const neutralDividerRestBehavior = cssCustomPropertyBehaviorFactory( "neutral-divider-rest", neutralDividerRest, FASTDesignSystemProvider.findProvider ); +/** + * Behavior to resolve and make available the neutral-layer-floating CSS custom property. + * @public + */ export const neutralLayerFloatingBehavior = cssCustomPropertyBehaviorFactory( "neutral-layer-floating", neutralLayerFloating, FASTDesignSystemProvider.findProvider ); +/** + * Behavior to resolve and make available the neutral-layer-card CSS custom property. + * @public + */ export const neutralLayerCardBehavior = cssCustomPropertyBehaviorFactory( "neutral-layer-card", neutralLayerCard, FASTDesignSystemProvider.findProvider ); +/** + * Behavior to resolve and make available the neutral-layer-card-container CSS custom property. + * @public + */ export const neutralLayerCardContainerBehavior = cssCustomPropertyBehaviorFactory( "neutral-layer-card-container", neutralLayerCardContainer, FASTDesignSystemProvider.findProvider ); +/** + * Behavior to resolve and make available the neutral-layer-l1 CSS custom property. + * @public + */ export const neutralLayerL1Behavior = cssCustomPropertyBehaviorFactory( "neutral-layer-l1", neutralLayerL1, FASTDesignSystemProvider.findProvider ); +/** + * Behavior to resolve and make available the neutral-layer-l1-alt CSS custom property. + * @public + */ export const neutralLayerL1AltBehavior = cssCustomPropertyBehaviorFactory( "neutral-layer-l1-alt", neutralLayerL1Alt, FASTDesignSystemProvider.findProvider ); +/** + * Behavior to resolve and make available the neutral-layer-l2 CSS custom property. + * @public + */ export const neutralLayerL2Behavior = cssCustomPropertyBehaviorFactory( "neutral-layer-l2", neutralLayerL2, FASTDesignSystemProvider.findProvider ); +/** + * Behavior to resolve and make available the neutral-layer-l3 CSS custom property. + * @public + */ export const neutralLayerL3Behavior = cssCustomPropertyBehaviorFactory( "neutral-layer-l3", neutralLayerL3, FASTDesignSystemProvider.findProvider ); +/** + * Behavior to resolve and make available the neutral-layer-l4 CSS custom property. + * @public + */ export const neutralLayerL4Behavior = cssCustomPropertyBehaviorFactory( "neutral-layer-l4", neutralLayerL4, FASTDesignSystemProvider.findProvider ); +/** + * Behavior to resolve and make available the neutral-focus CSS custom property. + * @public + */ export const neutralFocusBehavior = cssCustomPropertyBehaviorFactory( "neutral-focus", neutralFocus, FASTDesignSystemProvider.findProvider ); +/** + * Behavior to resolve and make available the neutral-focus-inner-accent CSS custom property. + * @public + */ export const neutralFocusInnerAccentBehavior = cssCustomPropertyBehaviorFactory( "neutral-focus-inner-accent", neutralFocusInnerAccent(accentBaseColor), diff --git a/packages/web-components/fast-components-msft/src/styles/elevation.ts b/packages/web-components/fast-components-msft/src/styles/elevation.ts index 488ed8e27ab..09685e60376 100644 --- a/packages/web-components/fast-components-msft/src/styles/elevation.ts +++ b/packages/web-components/fast-components-msft/src/styles/elevation.ts @@ -4,10 +4,23 @@ * TODO: The --background-luminance will need to be derived from JavaScript. For now * this is hard-coded to a 1, the relative luminance of pure white. * https://github.com/microsoft/fast-dna/issues/2778 + * + * @internal */ export const ambientShadow = "0 0 calc((var(--elevation) * 0.225px) + 2px) rgba(0, 0, 0, calc(.11 * (2 - var(--background-luminance, 1))))"; + +/** + * @internal + */ export const directionalShadow = "0 calc(var(--elevation) * 0.4px) calc((var(--elevation) * 0.9px)) rgba(0, 0, 0, calc(.13 * (2 - var(--background-luminance, 1))))"; +/** + * Applies the box-shadow CSS rule set to the elevation formula. + * Control this formula with the --elevation CSS Custom Property + * by setting --elevation to a number. + * + * @public + */ export const elevation = `box-shadow: ${ambientShadow}, ${directionalShadow};`; diff --git a/packages/web-components/fast-components-msft/src/styles/size.ts b/packages/web-components/fast-components-msft/src/styles/size.ts index 9fa9b90fa84..68ecbf3c4e4 100644 --- a/packages/web-components/fast-components-msft/src/styles/size.ts +++ b/packages/web-components/fast-components-msft/src/styles/size.ts @@ -1,2 +1,6 @@ +/** + * The height of height of a standard control (expressed as a number) to be used in CSS. + * @public + */ export const heightNumber = "(var(--base-height-multiplier) + var(--density)) * var(--design-unit)"; diff --git a/packages/web-components/fast-components-msft/src/switch/index.ts b/packages/web-components/fast-components-msft/src/switch/index.ts index a88348c7af1..870cf7a7703 100644 --- a/packages/web-components/fast-components-msft/src/switch/index.ts +++ b/packages/web-components/fast-components-msft/src/switch/index.ts @@ -2,6 +2,15 @@ import { customElement } from "@microsoft/fast-element"; import { Switch, SwitchTemplate as template } from "@microsoft/fast-foundation"; import { SwitchStyles as styles } from "./switch.styles"; +/** + * The FAST Switch Custom Element. Implements {@link @microsoft/fast-foundation#Switch}, + * {@link @microsoft/fast-foundation#SwitchTemplate} + * + * + * @public + * @remarks + * HTML Element: \ + */ @customElement({ name: "fast-switch", template, diff --git a/packages/web-components/fast-components-msft/src/tabs/index.ts b/packages/web-components/fast-components-msft/src/tabs/index.ts index 4d888504ea9..c5acf25a343 100644 --- a/packages/web-components/fast-components-msft/src/tabs/index.ts +++ b/packages/web-components/fast-components-msft/src/tabs/index.ts @@ -2,6 +2,15 @@ import { customElement } from "@microsoft/fast-element"; import { Tabs, TabsTemplate as template } from "@microsoft/fast-foundation"; import { TabsStyles as styles } from "./tabs.styles"; +/** + * The FAST Tabs Custom Element. Implements {@link @microsoft/fast-foundation#Tabs}, + * {@link @microsoft/fast-foundation#TabsTemplate} + * + * + * @public + * @remarks + * HTML Element: \ + */ @customElement({ name: "fast-tabs", template, diff --git a/packages/web-components/fast-components-msft/src/tabs/tab-panel/index.ts b/packages/web-components/fast-components-msft/src/tabs/tab-panel/index.ts index 021baa40986..e1a3d585e37 100644 --- a/packages/web-components/fast-components-msft/src/tabs/tab-panel/index.ts +++ b/packages/web-components/fast-components-msft/src/tabs/tab-panel/index.ts @@ -2,6 +2,15 @@ import { customElement } from "@microsoft/fast-element"; import { TabPanel, TabPanelTemplate as template } from "@microsoft/fast-foundation"; import { TabPanelStyles as styles } from "./tab-panel.styles"; +/** + * The FAST Tab Panel Custom Element. Implements {@link @microsoft/fast-foundation#TabPanel}, + * {@link @microsoft/fast-foundation#TabPanelTemplate} + * + * + * @public + * @remarks + * HTML Element: \ + */ @customElement({ name: "fast-tab-panel", template, diff --git a/packages/web-components/fast-components-msft/src/tabs/tab/index.ts b/packages/web-components/fast-components-msft/src/tabs/tab/index.ts index d19777c7797..51d67ddab03 100644 --- a/packages/web-components/fast-components-msft/src/tabs/tab/index.ts +++ b/packages/web-components/fast-components-msft/src/tabs/tab/index.ts @@ -2,6 +2,15 @@ import { customElement } from "@microsoft/fast-element"; import { Tab, TabTemplate as template } from "@microsoft/fast-foundation"; import { TabStyles as styles } from "./tab.styles"; +/** + * The FAST Tab Custom Element. Implements {@link @microsoft/fast-foundation#Tab}, + * {@link @microsoft/fast-foundation#TabTemplate} + * + * + * @public + * @remarks + * HTML Element: \ + */ @customElement({ name: "fast-tab", template, diff --git a/packages/web-components/fast-components-msft/src/text-area/index.ts b/packages/web-components/fast-components-msft/src/text-area/index.ts index a8b678d68e2..791f8cd293b 100644 --- a/packages/web-components/fast-components-msft/src/text-area/index.ts +++ b/packages/web-components/fast-components-msft/src/text-area/index.ts @@ -2,6 +2,17 @@ import { customElement } from "@microsoft/fast-element"; import { TextAreaTemplate as template, TextArea } from "@microsoft/fast-foundation"; import { TextAreaStyles as styles } from "./text-area.styles"; +/** + * The FAST Text Area Custom Element. Implements {@link @microsoft/fast-foundation#TextArea}, + * {@link @microsoft/fast-foundation#TextAreaTemplate} + * + * + * @public + * @remarks + * HTML Element: \ + * + * {@link https://developer.mozilla.org/en-US/docs/Web/API/ShadowRoot/delegatesFocus | delegatesFocus} + */ @customElement({ name: "fast-text-area", template, diff --git a/packages/web-components/fast-components-msft/src/text-field/index.ts b/packages/web-components/fast-components-msft/src/text-field/index.ts index 0efecfcb240..01613ae9305 100644 --- a/packages/web-components/fast-components-msft/src/text-field/index.ts +++ b/packages/web-components/fast-components-msft/src/text-field/index.ts @@ -2,6 +2,17 @@ import { customElement } from "@microsoft/fast-element"; import { TextFieldTemplate as template, TextField } from "@microsoft/fast-foundation"; import { TextFieldStyles as styles } from "./text-field.styles"; +/** + * The FAST Text Field Custom Element. Implements {@link @microsoft/fast-foundation#TextField}, + * {@link @microsoft/fast-foundation#TextFieldTemplate} + * + * + * @public + * @remarks + * HTML Element: \ + * + * {@link https://developer.mozilla.org/en-US/docs/Web/API/ShadowRoot/delegatesFocus | delegatesFocus} + */ @customElement({ name: "fast-text-field", template, diff --git a/packages/web-components/fast-components-msft/temp/api-report.md b/packages/web-components/fast-components-msft/temp/api-report.md index 0683ce5294c..ffa11e37192 100644 --- a/packages/web-components/fast-components-msft/temp/api-report.md +++ b/packages/web-components/fast-components-msft/temp/api-report.md @@ -34,67 +34,69 @@ import { TextField } from '@microsoft/fast-foundation'; // @internal (undocumented) export const AccentButtonStyles: import("@microsoft/fast-element").ElementStyles; -// @public (undocumented) +// @public export const accentFillActiveBehavior: import("@microsoft/fast-foundation").CSSCustomPropertyBehavior; -// @public (undocumented) +// @public export const accentFillFocusBehavior: import("@microsoft/fast-foundation").CSSCustomPropertyBehavior; -// @public (undocumented) +// @public export const accentFillHoverBehavior: import("@microsoft/fast-foundation").CSSCustomPropertyBehavior; -// @public (undocumented) +// @public export const accentFillLargeActiveBehavior: import("@microsoft/fast-foundation").CSSCustomPropertyBehavior; -// @public (undocumented) +// @public export const accentFillLargeFocusBehavior: import("@microsoft/fast-foundation").CSSCustomPropertyBehavior; -// @public (undocumented) +// @public export const accentFillLargeHoverBehavior: import("@microsoft/fast-foundation").CSSCustomPropertyBehavior; -// @public (undocumented) +// @public export const accentFillLargeRestBehavior: import("@microsoft/fast-foundation").CSSCustomPropertyBehavior; -// @public (undocumented) +// @public export const accentFillLargeSelectedBehavior: import("@microsoft/fast-foundation").CSSCustomPropertyBehavior; -// @public (undocumented) +// @public export const accentFillRestBehavior: import("@microsoft/fast-foundation").CSSCustomPropertyBehavior; -// @public (undocumented) +// @public export const accentFillSelectedBehavior: import("@microsoft/fast-foundation").CSSCustomPropertyBehavior; -// @public (undocumented) +// @public export const accentForegroundActiveBehavior: import("@microsoft/fast-foundation").CSSCustomPropertyBehavior; -// @public (undocumented) +// @public export const accentForegroundCutRestBehavior: import("@microsoft/fast-foundation").CSSCustomPropertyBehavior; -// @public (undocumented) +// @public export const accentForegroundFocusBehavior: import("@microsoft/fast-foundation").CSSCustomPropertyBehavior; -// @public (undocumented) +// @public export const accentForegroundHoverBehavior: import("@microsoft/fast-foundation").CSSCustomPropertyBehavior; -// @public (undocumented) +// @public export const accentForegroundLargeActiveBehavior: import("@microsoft/fast-foundation").CSSCustomPropertyBehavior; -// @public (undocumented) +// @public export const accentForegroundLargeFocusBehavior: import("@microsoft/fast-foundation").CSSCustomPropertyBehavior; -// @public (undocumented) +// @public export const accentForegroundLargeHoverBehavior: import("@microsoft/fast-foundation").CSSCustomPropertyBehavior; -// @public (undocumented) +// @public export const accentForegroundLargeRestBehavior: import("@microsoft/fast-foundation").CSSCustomPropertyBehavior; -// @public (undocumented) +// @public export const accentForegroundRestBehavior: import("@microsoft/fast-foundation").CSSCustomPropertyBehavior; -// @public +// Warning: (ae-internal-missing-underscore) The name "ambientShadow" should be prefixed with an underscore because the declaration is marked as @internal +// +// @internal export const ambientShadow = "0 0 calc((var(--elevation) * 0.225px) + 2px) rgba(0, 0, 0, calc(.11 * (2 - var(--background-luminance, 1))))"; -// @public (undocumented) +// @public export type BadgeAppearance = "accent" | "lightweight" | "neutral" | string; // Warning: (ae-internal-missing-underscore) The name "BaseButtonStyles" should be prefixed with an underscore because the declaration is marked as @internal @@ -102,43 +104,45 @@ export type BadgeAppearance = "accent" | "lightweight" | "neutral" | string; // @internal (undocumented) export const BaseButtonStyles: import("@microsoft/fast-element").ElementStyles; -// @public (undocumented) +// Warning: (ae-internal-missing-underscore) The name "directionalShadow" should be prefixed with an underscore because the declaration is marked as @internal +// +// @internal (undocumented) export const directionalShadow = "0 calc(var(--elevation) * 0.4px) calc((var(--elevation) * 0.9px)) rgba(0, 0, 0, calc(.13 * (2 - var(--background-luminance, 1))))"; -// @public (undocumented) +// @public export const elevation: string; -// @public (undocumented) +// @public export class FASTAccordion extends Accordion { } -// @public (undocumented) +// @public export class FASTAccordionItem extends AccordionItem { } -// @public (undocumented) +// @public export class FASTAnchor extends Anchor { } -// @public (undocumented) +// @public export class FASTBadge extends Badge { // (undocumented) appearance: BadgeAppearance; } -// @public (undocumented) +// @public export class FASTButton extends Button { } -// @public (undocumented) +// @public export class FASTCard extends Card { } -// @public (undocumented) +// @public export class FASTCheckbox extends Checkbox { } -// @public (undocumented) +// @public export class FASTDesignSystemProvider extends DesignSystemProvider implements Omit { // (undocumented) accentBaseColor: string; @@ -278,67 +282,67 @@ export class FASTDesignSystemProvider extends DesignSystemProvider implements Om typeRampPlus6LineHeight: string; } -// @public (undocumented) +// @public export class FASTDialog extends Dialog { } -// @public (undocumented) +// @public export class FASTDivider extends Divider { } -// @public (undocumented) +// @public export class FASTFlipper extends Flipper { } -// @public (undocumented) +// @public export class FASTProgress extends BaseProgress { } -// @public (undocumented) +// @public export class FASTProgressRing extends BaseProgress { } -// @public (undocumented) +// @public export class FASTRadio extends Radio { } -// @public (undocumented) +// @public export class FASTRadioGroup extends RadioGroup { } -// @public (undocumented) +// @public export class FASTSlider extends Slider { } -// @public (undocumented) +// @public export class FASTSliderLabel extends SliderLabel { } -// @public (undocumented) +// @public export class FASTSwitch extends Switch { } -// @public (undocumented) +// @public export class FASTTab extends Tab { } -// @public (undocumented) +// @public export class FASTTabPanel extends TabPanel { } -// @public (undocumented) +// @public export class FASTTabs extends Tabs { } -// @public (undocumented) +// @public export class FASTTextArea extends TextArea { } -// @public (undocumented) +// @public export class FASTTextField extends TextField { } -// @public (undocumented) +// @public export const heightNumber = "(var(--base-height-multiplier) + var(--density)) * var(--design-unit)"; // Warning: (ae-internal-missing-underscore) The name "HypertextStyles" should be prefixed with an underscore because the declaration is marked as @internal @@ -351,130 +355,130 @@ export const HypertextStyles: import("@microsoft/fast-element").ElementStyles; // @internal (undocumented) export const LightweightButtonStyles: import("@microsoft/fast-element").ElementStyles; -// @public (undocumented) +// @public export const neutralDividerRestBehavior: import("@microsoft/fast-foundation").CSSCustomPropertyBehavior; -// @public (undocumented) +// @public export const neutralFillActiveBehavior: import("@microsoft/fast-foundation").CSSCustomPropertyBehavior; -// @public (undocumented) +// @public export const neutralFillCardRestBehavior: import("@microsoft/fast-foundation").CSSCustomPropertyBehavior; -// @public (undocumented) +// @public export const neutralFillFocusBehavior: import("@microsoft/fast-foundation").CSSCustomPropertyBehavior; -// @public (undocumented) +// @public export const neutralFillHoverBehavior: import("@microsoft/fast-foundation").CSSCustomPropertyBehavior; -// @public (undocumented) +// @public export const neutralFillInputActiveBehavior: import("@microsoft/fast-foundation").CSSCustomPropertyBehavior; -// @public (undocumented) +// @public export const neutralFillInputFocusBehavior: import("@microsoft/fast-foundation").CSSCustomPropertyBehavior; -// @public (undocumented) +// @public export const neutralFillInputHoverBehavior: import("@microsoft/fast-foundation").CSSCustomPropertyBehavior; -// @public (undocumented) +// @public export const neutralFillInputRestBehavior: import("@microsoft/fast-foundation").CSSCustomPropertyBehavior; -// @public (undocumented) +// @public export const neutralFillRestBehavior: import("@microsoft/fast-foundation").CSSCustomPropertyBehavior; -// @public (undocumented) +// @public export const neutralFillSelectedBehavior: import("@microsoft/fast-foundation").CSSCustomPropertyBehavior; -// @public (undocumented) +// @public export const neutralFillStealthActiveBehavior: import("@microsoft/fast-foundation").CSSCustomPropertyBehavior; -// @public (undocumented) +// @public export const neutralFillStealthFocusBehavior: import("@microsoft/fast-foundation").CSSCustomPropertyBehavior; -// @public (undocumented) +// @public export const neutralFillStealthHoverBehavior: import("@microsoft/fast-foundation").CSSCustomPropertyBehavior; -// @public (undocumented) +// @public export const neutralFillStealthRestBehavior: import("@microsoft/fast-foundation").CSSCustomPropertyBehavior; -// @public (undocumented) +// @public export const neutralFillStealthSelectedBehavior: import("@microsoft/fast-foundation").CSSCustomPropertyBehavior; -// @public (undocumented) +// @public export const neutralFillToggleActiveBehavior: import("@microsoft/fast-foundation").CSSCustomPropertyBehavior; -// @public (undocumented) +// @public export const neutralFillToggleFocusBehavior: import("@microsoft/fast-foundation").CSSCustomPropertyBehavior; -// @public (undocumented) +// @public export const neutralFillToggleHoverBehavior: import("@microsoft/fast-foundation").CSSCustomPropertyBehavior; -// @public (undocumented) +// @public export const neutralFillToggleRestBehavior: import("@microsoft/fast-foundation").CSSCustomPropertyBehavior; -// @public (undocumented) +// @public export const neutralFocusBehavior: import("@microsoft/fast-foundation").CSSCustomPropertyBehavior; -// @public (undocumented) +// @public export const neutralFocusInnerAccentBehavior: import("@microsoft/fast-foundation").CSSCustomPropertyBehavior; -// @public (undocumented) +// @public export const neutralForegroundActiveBehavior: import("@microsoft/fast-foundation").CSSCustomPropertyBehavior; -// @public (undocumented) +// @public export const neutralForegroundFocusBehavior: import("@microsoft/fast-foundation").CSSCustomPropertyBehavior; -// @public (undocumented) +// @public export const neutralForegroundHintBehavior: import("@microsoft/fast-foundation").CSSCustomPropertyBehavior; -// @public (undocumented) +// @public export const neutralForegroundHintLargeBehavior: import("@microsoft/fast-foundation").CSSCustomPropertyBehavior; -// @public (undocumented) +// @public export const neutralForegroundHoverBehavior: import("@microsoft/fast-foundation").CSSCustomPropertyBehavior; -// @public (undocumented) +// @public export const neutralForegroundRestBehavior: import("@microsoft/fast-foundation").CSSCustomPropertyBehavior; -// @public (undocumented) +// @public export const neutralForegroundToggleBehavior: import("@microsoft/fast-foundation").CSSCustomPropertyBehavior; -// @public (undocumented) +// @public export const neutralForegroundToggleLargeBehavior: import("@microsoft/fast-foundation").CSSCustomPropertyBehavior; -// @public (undocumented) +// @public export const neutralLayerCardBehavior: import("@microsoft/fast-foundation").CSSCustomPropertyBehavior; -// @public (undocumented) +// @public export const neutralLayerCardContainerBehavior: import("@microsoft/fast-foundation").CSSCustomPropertyBehavior; -// @public (undocumented) +// @public export const neutralLayerFloatingBehavior: import("@microsoft/fast-foundation").CSSCustomPropertyBehavior; -// @public (undocumented) +// @public export const neutralLayerL1AltBehavior: import("@microsoft/fast-foundation").CSSCustomPropertyBehavior; -// @public (undocumented) +// @public export const neutralLayerL1Behavior: import("@microsoft/fast-foundation").CSSCustomPropertyBehavior; -// @public (undocumented) +// @public export const neutralLayerL2Behavior: import("@microsoft/fast-foundation").CSSCustomPropertyBehavior; -// @public (undocumented) +// @public export const neutralLayerL3Behavior: import("@microsoft/fast-foundation").CSSCustomPropertyBehavior; -// @public (undocumented) +// @public export const neutralLayerL4Behavior: import("@microsoft/fast-foundation").CSSCustomPropertyBehavior; -// @public (undocumented) +// @public export const neutralOutlineActiveBehavior: import("@microsoft/fast-foundation").CSSCustomPropertyBehavior; -// @public (undocumented) +// @public export const neutralOutlineFocusBehavior: import("@microsoft/fast-foundation").CSSCustomPropertyBehavior; -// @public (undocumented) +// @public export const neutralOutlineHoverBehavior: import("@microsoft/fast-foundation").CSSCustomPropertyBehavior; -// @public (undocumented) +// @public export const neutralOutlineRestBehavior: import("@microsoft/fast-foundation").CSSCustomPropertyBehavior; // Warning: (ae-internal-missing-underscore) The name "OutlineButtonStyles" should be prefixed with an underscore because the declaration is marked as @internal diff --git a/packages/web-components/fast-components/src/anchor/index.ts b/packages/web-components/fast-components/src/anchor/index.ts index 693259ba5c1..2de5da2d170 100644 --- a/packages/web-components/fast-components/src/anchor/index.ts +++ b/packages/web-components/fast-components/src/anchor/index.ts @@ -10,6 +10,8 @@ import { AnchorStyles as styles } from "./anchor.styles"; * @public * @remarks * HTML Element: \ + * + * {@link https://developer.mozilla.org/en-US/docs/Web/API/ShadowRoot/delegatesFocus | delegatesFocus} */ @customElement({ name: "fast-anchor", diff --git a/packages/web-components/fast-components/src/button/index.ts b/packages/web-components/fast-components/src/button/index.ts index 47409145977..2bf99463ce7 100644 --- a/packages/web-components/fast-components/src/button/index.ts +++ b/packages/web-components/fast-components/src/button/index.ts @@ -10,6 +10,8 @@ import { ButtonStyles as styles } from "./button.styles"; * @public * @remarks * HTML Element: \ + * + * {@link https://developer.mozilla.org/en-US/docs/Web/API/ShadowRoot/delegatesFocus | delegatesFocus} */ @customElement({ name: "fast-button", diff --git a/packages/web-components/fast-foundation/docs/api-report.md b/packages/web-components/fast-foundation/docs/api-report.md index 2f75ae7824d..e79dd096e0f 100644 --- a/packages/web-components/fast-foundation/docs/api-report.md +++ b/packages/web-components/fast-foundation/docs/api-report.md @@ -51,6 +51,9 @@ export const AccordionItemTemplate: import("@microsoft/fast-element").ViewTempla // @public export const AccordionTemplate: import("@microsoft/fast-element").ViewTemplate; +// Warning: (ae-different-release-tags) This symbol has another declaration with a different release tag +// Warning: (ae-internal-mixed-release-tag) Mixed release tags are not allowed for "Anchor" because one of its declarations is marked as @internal +// // @public export class Anchor extends FASTElement { appearance: AnchorAppearance; @@ -64,7 +67,7 @@ export class Anchor extends FASTElement { type: string; } -// @public (undocumented) +// @internal export interface Anchor extends StartEnd { } @@ -95,7 +98,9 @@ export class BaseProgress extends FASTElement { value: number; } +// Warning: (ae-different-release-tags) This symbol has another declaration with a different release tag // Warning: (ae-forgotten-export) The symbol "FormAssociated" needs to be exported by the entry point index.d.ts +// Warning: (ae-internal-mixed-release-tag) Mixed release tags are not allowed for "Button" because one of its declarations is marked as @internal // // @public export class Button extends FormAssociated { @@ -117,7 +122,7 @@ export class Button extends FormAssociated { value: string; } -// @public (undocumented) +// @internal export interface Button extends StartEnd { } @@ -404,6 +409,9 @@ export class Menu extends FASTElement { items: HTMLSlotElement; } +// Warning: (ae-different-release-tags) This symbol has another declaration with a different release tag +// Warning: (ae-internal-mixed-release-tag) Mixed release tags are not allowed for "MenuItem" because one of its declarations is marked as @internal +// // @public export class MenuItem extends FASTElement { checked: boolean; @@ -416,7 +424,7 @@ export class MenuItem extends FASTElement { role: MenuItemRole; } -// @public (undocumented) +// @internal export interface MenuItem extends StartEnd { } @@ -636,6 +644,9 @@ export class TabPanel extends FASTElement { // @public export const TabPanelTemplate: import("@microsoft/fast-element").ViewTemplate; +// Warning: (ae-different-release-tags) This symbol has another declaration with a different release tag +// Warning: (ae-internal-mixed-release-tag) Mixed release tags are not allowed for "Tabs" because one of its declarations is marked as @internal +// // @public export class Tabs extends FASTElement { constructor(); @@ -655,7 +666,7 @@ export class Tabs extends FASTElement { tabsChanged(): void; } -// @public (undocumented) +// @internal export interface Tabs extends StartEnd { } @@ -719,6 +730,9 @@ export enum TextAreaResize { // @public export const TextAreaTemplate: import("@microsoft/fast-element").ViewTemplate; +// Warning: (ae-different-release-tags) This symbol has another declaration with a different release tag +// Warning: (ae-internal-mixed-release-tag) Mixed release tags are not allowed for "TextField" because one of its declarations is marked as @internal +// // @public export class TextField extends FormAssociated { // @internal @@ -746,7 +760,7 @@ export class TextField extends FormAssociated { type: TextFieldType; } -// @public (undocumented) +// @internal export interface TextField extends StartEnd { } diff --git a/sites/website/src/docs/api/fast-components-msft.api.json b/sites/website/src/docs/api/fast-components-msft.api.json index 8711c746401..1911b32669c 100644 --- a/sites/website/src/docs/api/fast-components-msft.api.json +++ b/sites/website/src/docs/api/fast-components-msft.api.json @@ -18,7 +18,7 @@ { "kind": "Variable", "canonicalReference": "@microsoft/fast-components-msft!accentFillActiveBehavior:var", - "docComment": "", + "docComment": "/**\n * Behavior to resolve and make available the accent-fill-active CSS custom property.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", @@ -44,7 +44,7 @@ { "kind": "Variable", "canonicalReference": "@microsoft/fast-components-msft!accentFillFocusBehavior:var", - "docComment": "", + "docComment": "/**\n * Behavior to resolve and make available the accent-fill-focus CSS custom property.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", @@ -70,7 +70,7 @@ { "kind": "Variable", "canonicalReference": "@microsoft/fast-components-msft!accentFillHoverBehavior:var", - "docComment": "", + "docComment": "/**\n * Behavior to resolve and make available the accent-fill-hover CSS custom property.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", @@ -96,7 +96,7 @@ { "kind": "Variable", "canonicalReference": "@microsoft/fast-components-msft!accentFillLargeActiveBehavior:var", - "docComment": "", + "docComment": "/**\n * Behavior to resolve and make available the accent-fill-large-active CSS custom property.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", @@ -122,7 +122,7 @@ { "kind": "Variable", "canonicalReference": "@microsoft/fast-components-msft!accentFillLargeFocusBehavior:var", - "docComment": "", + "docComment": "/**\n * Behavior to resolve and make available the accent-fill-large-focus CSS custom property.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", @@ -148,7 +148,7 @@ { "kind": "Variable", "canonicalReference": "@microsoft/fast-components-msft!accentFillLargeHoverBehavior:var", - "docComment": "", + "docComment": "/**\n * Behavior to resolve and make available the accent-fill-large-hover CSS custom property.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", @@ -174,7 +174,7 @@ { "kind": "Variable", "canonicalReference": "@microsoft/fast-components-msft!accentFillLargeRestBehavior:var", - "docComment": "", + "docComment": "/**\n * Behavior to resolve and make available the accent-fill-large-rest CSS custom property.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", @@ -200,7 +200,7 @@ { "kind": "Variable", "canonicalReference": "@microsoft/fast-components-msft!accentFillLargeSelectedBehavior:var", - "docComment": "", + "docComment": "/**\n * Behavior to resolve and make available the accent-fill-large-selected CSS custom property.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", @@ -226,7 +226,7 @@ { "kind": "Variable", "canonicalReference": "@microsoft/fast-components-msft!accentFillRestBehavior:var", - "docComment": "", + "docComment": "/**\n * Behavior to resolve and make available the accent-fill-rest CSS custom property.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", @@ -252,7 +252,7 @@ { "kind": "Variable", "canonicalReference": "@microsoft/fast-components-msft!accentFillSelectedBehavior:var", - "docComment": "", + "docComment": "/**\n * Behavior to resolve and make available the accent-fill-selected CSS custom property.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", @@ -278,7 +278,7 @@ { "kind": "Variable", "canonicalReference": "@microsoft/fast-components-msft!accentForegroundActiveBehavior:var", - "docComment": "", + "docComment": "/**\n * Behavior to resolve and make available the accent-foreground-active CSS custom property.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", @@ -304,7 +304,7 @@ { "kind": "Variable", "canonicalReference": "@microsoft/fast-components-msft!accentForegroundCutRestBehavior:var", - "docComment": "", + "docComment": "/**\n * Behavior to resolve and make available the accent-foreground-cut-rest CSS custom property.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", @@ -330,7 +330,7 @@ { "kind": "Variable", "canonicalReference": "@microsoft/fast-components-msft!accentForegroundFocusBehavior:var", - "docComment": "", + "docComment": "/**\n * Behavior to resolve and make available the accent-foreground-focus CSS custom property.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", @@ -356,7 +356,7 @@ { "kind": "Variable", "canonicalReference": "@microsoft/fast-components-msft!accentForegroundHoverBehavior:var", - "docComment": "", + "docComment": "/**\n * Behavior to resolve and make available the accent-foreground-hover CSS custom property.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", @@ -382,7 +382,7 @@ { "kind": "Variable", "canonicalReference": "@microsoft/fast-components-msft!accentForegroundLargeActiveBehavior:var", - "docComment": "", + "docComment": "/**\n * Behavior to resolve and make available the accent-foreground-large-active CSS custom property.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", @@ -408,7 +408,7 @@ { "kind": "Variable", "canonicalReference": "@microsoft/fast-components-msft!accentForegroundLargeFocusBehavior:var", - "docComment": "", + "docComment": "/**\n * Behavior to resolve and make available the accent-foreground-large-focus CSS custom property.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", @@ -434,7 +434,7 @@ { "kind": "Variable", "canonicalReference": "@microsoft/fast-components-msft!accentForegroundLargeHoverBehavior:var", - "docComment": "", + "docComment": "/**\n * Behavior to resolve and make available the accent-foreground-large-hover CSS custom property.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", @@ -460,7 +460,7 @@ { "kind": "Variable", "canonicalReference": "@microsoft/fast-components-msft!accentForegroundLargeRestBehavior:var", - "docComment": "", + "docComment": "/**\n * Behavior to resolve and make available the accent-foreground-large-rest CSS custom property.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", @@ -486,7 +486,7 @@ { "kind": "Variable", "canonicalReference": "@microsoft/fast-components-msft!accentForegroundRestBehavior:var", - "docComment": "", + "docComment": "/**\n * Behavior to resolve and make available the accent-foreground-rest CSS custom property.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", @@ -509,27 +509,10 @@ "endIndex": 3 } }, - { - "kind": "Variable", - "canonicalReference": "@microsoft/fast-components-msft!ambientShadow:var", - "docComment": "/**\n * Define shadow algorithms.\n *\n * TODO: The --background-luminance will need to be derived from JavaScript. For now this is hard-coded to a 1, the relative luminance of pure white. https://github.com/microsoft/fast-dna/issues/2778\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "ambientShadow = \"0 0 calc((var(--elevation) * 0.225px) + 2px) rgba(0, 0, 0, calc(.11 * (2 - var(--background-luminance, 1))))\"" - } - ], - "releaseTag": "Public", - "name": "ambientShadow", - "variableTypeTokenRange": { - "startIndex": 0, - "endIndex": 0 - } - }, { "kind": "TypeAlias", "canonicalReference": "@microsoft/fast-components-msft!BadgeAppearance:type", - "docComment": "", + "docComment": "/**\n * Badge appearance options.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", @@ -551,27 +534,10 @@ "endIndex": 2 } }, - { - "kind": "Variable", - "canonicalReference": "@microsoft/fast-components-msft!directionalShadow:var", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "directionalShadow = \"0 calc(var(--elevation) * 0.4px) calc((var(--elevation) * 0.9px)) rgba(0, 0, 0, calc(.13 * (2 - var(--background-luminance, 1))))\"" - } - ], - "releaseTag": "Public", - "name": "directionalShadow", - "variableTypeTokenRange": { - "startIndex": 0, - "endIndex": 0 - } - }, { "kind": "Variable", "canonicalReference": "@microsoft/fast-components-msft!elevation:var", - "docComment": "", + "docComment": "/**\n * Applies the box-shadow CSS rule set to the elevation formula. Control this formula with the --elevation CSS Custom Property by setting --elevation to a number.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", @@ -592,7 +558,7 @@ { "kind": "Class", "canonicalReference": "@microsoft/fast-components-msft!FASTAccordion:class", - "docComment": "", + "docComment": "/**\n * The FAST Accordion Element. Implements {@link @microsoft/fast-foundation#Accordion}, {@link @microsoft/fast-foundation#AccordionTemplate}\n *\n * @remarks\n *\n * HTML Element: \\\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", @@ -620,7 +586,7 @@ { "kind": "Class", "canonicalReference": "@microsoft/fast-components-msft!FASTAccordionItem:class", - "docComment": "", + "docComment": "/**\n * The FAST Accordion Item Element. Implements {@link @microsoft/fast-foundation#AccordionItem}, {@link @microsoft/fast-foundation#AccordionItemTemplate}\n *\n * @remarks\n *\n * HTML Element: \\\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", @@ -648,7 +614,7 @@ { "kind": "Class", "canonicalReference": "@microsoft/fast-components-msft!FASTAnchor:class", - "docComment": "", + "docComment": "/**\n * The FAST Anchor Element. Implements {@link @microsoft/fast-foundation#Anchor}, {@link @microsoft/fast-foundation#AnchorTemplate}\n *\n * @remarks\n *\n * HTML Element: \\\n *\n * {@link https://developer.mozilla.org/en-US/docs/Web/API/ShadowRoot/delegatesFocus | delegatesFocus}\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", @@ -676,7 +642,7 @@ { "kind": "Class", "canonicalReference": "@microsoft/fast-components-msft!FASTBadge:class", - "docComment": "", + "docComment": "/**\n * The FAST Badge Element. Implements {@link @microsoft/fast-foundation#Badge}, {@link @microsoft/fast-foundation#BadgeTemplate}\n *\n * @remarks\n *\n * HTML Element: \\\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", @@ -732,7 +698,7 @@ { "kind": "Class", "canonicalReference": "@microsoft/fast-components-msft!FASTButton:class", - "docComment": "", + "docComment": "/**\n * The FAST Button Element. Implements {@link @microsoft/fast-foundation#Button}, {@link @microsoft/fast-foundation#ButtonTemplate}\n *\n * @remarks\n *\n * HTML Element: \\\n *\n * {@link https://developer.mozilla.org/en-US/docs/Web/API/ShadowRoot/delegatesFocus | delegatesFocus}\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", @@ -760,7 +726,7 @@ { "kind": "Class", "canonicalReference": "@microsoft/fast-components-msft!FASTCard:class", - "docComment": "", + "docComment": "/**\n * The FAST Card Element. Implements {@link @microsoft/fast-foundation#Card}, {@link @microsoft/fast-foundation#CardTemplate}\n *\n * @remarks\n *\n * HTML Element: \\\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", @@ -788,7 +754,7 @@ { "kind": "Class", "canonicalReference": "@microsoft/fast-components-msft!FASTCheckbox:class", - "docComment": "", + "docComment": "/**\n * The FAST Checkbox Element. Implements {@link @microsoft/fast-foundation#Checkbox}, {@link @microsoft/fast-foundation#CheckboxTemplate}\n *\n * @remarks\n *\n * HTML Element: \\\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", @@ -816,7 +782,7 @@ { "kind": "Class", "canonicalReference": "@microsoft/fast-components-msft!FASTDesignSystemProvider:class", - "docComment": "", + "docComment": "/**\n * The FAST DesignSystemProvider Element. Implements {@link @microsoft/fast-foundation#DesignSystemProvider}, {@link @microsoft/fast-foundation#DesignSystemProviderTemplate}\n *\n * @remarks\n *\n * HTML Element: \\\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", @@ -2667,7 +2633,7 @@ { "kind": "Class", "canonicalReference": "@microsoft/fast-components-msft!FASTDialog:class", - "docComment": "", + "docComment": "/**\n * The FAST Dialog Element. Implements {@link @microsoft/fast-foundation#Dialog}, {@link @microsoft/fast-foundation#DialogTemplate}\n *\n * @remarks\n *\n * HTML Element: \\\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", @@ -2695,7 +2661,7 @@ { "kind": "Class", "canonicalReference": "@microsoft/fast-components-msft!FASTDivider:class", - "docComment": "", + "docComment": "/**\n * The FAST Divider Element. Implements {@link @microsoft/fast-foundation#Divider}, {@link @microsoft/fast-foundation#DividerTemplate}\n *\n * @remarks\n *\n * HTML Element: \\\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", @@ -2723,7 +2689,7 @@ { "kind": "Class", "canonicalReference": "@microsoft/fast-components-msft!FASTFlipper:class", - "docComment": "", + "docComment": "/**\n * The FAST Flipper Element. Implements {@link @microsoft/fast-foundation#Flipper}, {@link @microsoft/fast-foundation#FlipperTemplate}\n *\n * @remarks\n *\n * HTML Element: \\\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", @@ -2751,7 +2717,7 @@ { "kind": "Class", "canonicalReference": "@microsoft/fast-components-msft!FASTProgress:class", - "docComment": "", + "docComment": "/**\n * The FAST Progress Element. Implements {@link @microsoft/fast-foundation#BaseProgress}, {@link @microsoft/fast-foundation#ProgressTemplate}\n *\n * @remarks\n *\n * HTML Element: \\\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", @@ -2779,7 +2745,7 @@ { "kind": "Class", "canonicalReference": "@microsoft/fast-components-msft!FASTProgressRing:class", - "docComment": "", + "docComment": "/**\n * The FAST Progress Ring Element. Implements {@link @microsoft/fast-foundation#BaseProgress}, {@link @microsoft/fast-foundation#ProgressRingTemplate}\n *\n * @remarks\n *\n * HTML Element: \\\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", @@ -2807,7 +2773,7 @@ { "kind": "Class", "canonicalReference": "@microsoft/fast-components-msft!FASTRadio:class", - "docComment": "", + "docComment": "/**\n * The FAST Radio Element. Implements {@link @microsoft/fast-foundation#Radio}, {@link @microsoft/fast-foundation#RadioTemplate}\n *\n * @remarks\n *\n * HTML Element: \\\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", @@ -2835,7 +2801,7 @@ { "kind": "Class", "canonicalReference": "@microsoft/fast-components-msft!FASTRadioGroup:class", - "docComment": "", + "docComment": "/**\n * The FAST Radio Group Element. Implements {@link @microsoft/fast-foundation#RadioGroup}, {@link @microsoft/fast-foundation#RadioGroupTemplate}\n *\n * @remarks\n *\n * HTML Element: \\\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", @@ -2863,7 +2829,7 @@ { "kind": "Class", "canonicalReference": "@microsoft/fast-components-msft!FASTSlider:class", - "docComment": "", + "docComment": "/**\n * The FAST Slider Custom Element. Implements {@link @microsoft/fast-foundation#Slider}, {@link @microsoft/fast-foundation#SliderTemplate}\n *\n * @remarks\n *\n * HTML Element: \\\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", @@ -2891,7 +2857,7 @@ { "kind": "Class", "canonicalReference": "@microsoft/fast-components-msft!FASTSliderLabel:class", - "docComment": "", + "docComment": "/**\n * The FAST Slider Label Custom Element. Implements {@link @microsoft/fast-foundation#SliderLabel}, {@link @microsoft/fast-foundation#SliderLabelTemplate}\n *\n * @remarks\n *\n * HTML Element: \\\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", @@ -2919,7 +2885,7 @@ { "kind": "Class", "canonicalReference": "@microsoft/fast-components-msft!FASTSwitch:class", - "docComment": "", + "docComment": "/**\n * The FAST Switch Custom Element. Implements {@link @microsoft/fast-foundation#Switch}, {@link @microsoft/fast-foundation#SwitchTemplate}\n *\n * @remarks\n *\n * HTML Element: \\\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", @@ -2947,7 +2913,7 @@ { "kind": "Class", "canonicalReference": "@microsoft/fast-components-msft!FASTTab:class", - "docComment": "", + "docComment": "/**\n * The FAST Tab Custom Element. Implements {@link @microsoft/fast-foundation#Tab}, {@link @microsoft/fast-foundation#TabTemplate}\n *\n * @remarks\n *\n * HTML Element: \\\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", @@ -2975,7 +2941,7 @@ { "kind": "Class", "canonicalReference": "@microsoft/fast-components-msft!FASTTabPanel:class", - "docComment": "", + "docComment": "/**\n * The FAST Tab Panel Custom Element. Implements {@link @microsoft/fast-foundation#TabPanel}, {@link @microsoft/fast-foundation#TabPanelTemplate}\n *\n * @remarks\n *\n * HTML Element: \\\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", @@ -3003,7 +2969,7 @@ { "kind": "Class", "canonicalReference": "@microsoft/fast-components-msft!FASTTabs:class", - "docComment": "", + "docComment": "/**\n * The FAST Tabs Custom Element. Implements {@link @microsoft/fast-foundation#Tabs}, {@link @microsoft/fast-foundation#TabsTemplate}\n *\n * @remarks\n *\n * HTML Element: \\\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", @@ -3031,7 +2997,7 @@ { "kind": "Class", "canonicalReference": "@microsoft/fast-components-msft!FASTTextArea:class", - "docComment": "", + "docComment": "/**\n * The FAST Text Area Custom Element. Implements {@link @microsoft/fast-foundation#TextArea}, {@link @microsoft/fast-foundation#TextAreaTemplate}\n *\n * @remarks\n *\n * HTML Element: \\\n *\n * {@link https://developer.mozilla.org/en-US/docs/Web/API/ShadowRoot/delegatesFocus | delegatesFocus}\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", @@ -3059,7 +3025,7 @@ { "kind": "Class", "canonicalReference": "@microsoft/fast-components-msft!FASTTextField:class", - "docComment": "", + "docComment": "/**\n * The FAST Text Field Custom Element. Implements {@link @microsoft/fast-foundation#TextField}, {@link @microsoft/fast-foundation#TextFieldTemplate}\n *\n * @remarks\n *\n * HTML Element: \\\n *\n * {@link https://developer.mozilla.org/en-US/docs/Web/API/ShadowRoot/delegatesFocus | delegatesFocus}\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", @@ -3087,7 +3053,7 @@ { "kind": "Variable", "canonicalReference": "@microsoft/fast-components-msft!heightNumber:var", - "docComment": "", + "docComment": "/**\n * The height of height of a standard control (expressed as a number) to be used in CSS.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", @@ -3104,7 +3070,7 @@ { "kind": "Variable", "canonicalReference": "@microsoft/fast-components-msft!neutralDividerRestBehavior:var", - "docComment": "", + "docComment": "/**\n * Behavior to resolve and make available the neutral-divider-rest CSS custom property.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", @@ -3130,7 +3096,7 @@ { "kind": "Variable", "canonicalReference": "@microsoft/fast-components-msft!neutralFillActiveBehavior:var", - "docComment": "", + "docComment": "/**\n * Behavior to resolve and make available the neutral-fill-active CSS custom property.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", @@ -3156,7 +3122,7 @@ { "kind": "Variable", "canonicalReference": "@microsoft/fast-components-msft!neutralFillCardRestBehavior:var", - "docComment": "", + "docComment": "/**\n * Behavior to resolve and make available the neutral-fill-card-rest CSS custom property.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", @@ -3182,7 +3148,7 @@ { "kind": "Variable", "canonicalReference": "@microsoft/fast-components-msft!neutralFillFocusBehavior:var", - "docComment": "", + "docComment": "/**\n * Behavior to resolve and make available the neutral-fill-focus CSS custom property.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", @@ -3208,7 +3174,7 @@ { "kind": "Variable", "canonicalReference": "@microsoft/fast-components-msft!neutralFillHoverBehavior:var", - "docComment": "", + "docComment": "/**\n * Behavior to resolve and make available the neutral-fill-hover CSS custom property.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", @@ -3234,7 +3200,7 @@ { "kind": "Variable", "canonicalReference": "@microsoft/fast-components-msft!neutralFillInputActiveBehavior:var", - "docComment": "", + "docComment": "/**\n * Behavior to resolve and make available the neutral-fill-input-active CSS custom property.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", @@ -3260,7 +3226,7 @@ { "kind": "Variable", "canonicalReference": "@microsoft/fast-components-msft!neutralFillInputFocusBehavior:var", - "docComment": "", + "docComment": "/**\n * Behavior to resolve and make available the neutral-fill-input-focus CSS custom property.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", @@ -3286,7 +3252,7 @@ { "kind": "Variable", "canonicalReference": "@microsoft/fast-components-msft!neutralFillInputHoverBehavior:var", - "docComment": "", + "docComment": "/**\n * Behavior to resolve and make available the neutral-fill-input-hover CSS custom property.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", @@ -3312,7 +3278,7 @@ { "kind": "Variable", "canonicalReference": "@microsoft/fast-components-msft!neutralFillInputRestBehavior:var", - "docComment": "", + "docComment": "/**\n * Behavior to resolve and make available the neutral-fill-input-rest CSS custom property.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", @@ -3338,7 +3304,7 @@ { "kind": "Variable", "canonicalReference": "@microsoft/fast-components-msft!neutralFillRestBehavior:var", - "docComment": "", + "docComment": "/**\n * Behavior to resolve and make available the neutral-fill-rest CSS custom property.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", @@ -3364,7 +3330,7 @@ { "kind": "Variable", "canonicalReference": "@microsoft/fast-components-msft!neutralFillSelectedBehavior:var", - "docComment": "", + "docComment": "/**\n * Behavior to resolve and make available the neutral-fill-selected CSS custom property.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", @@ -3390,7 +3356,7 @@ { "kind": "Variable", "canonicalReference": "@microsoft/fast-components-msft!neutralFillStealthActiveBehavior:var", - "docComment": "", + "docComment": "/**\n * Behavior to resolve and make available the neutral-fill-stealth-active CSS custom property.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", @@ -3416,7 +3382,7 @@ { "kind": "Variable", "canonicalReference": "@microsoft/fast-components-msft!neutralFillStealthFocusBehavior:var", - "docComment": "", + "docComment": "/**\n * Behavior to resolve and make available the neutral-fill-stealth-focus CSS custom property.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", @@ -3442,7 +3408,7 @@ { "kind": "Variable", "canonicalReference": "@microsoft/fast-components-msft!neutralFillStealthHoverBehavior:var", - "docComment": "", + "docComment": "/**\n * Behavior to resolve and make available the neutral-fill-stealth-hover CSS custom property.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", @@ -3468,7 +3434,7 @@ { "kind": "Variable", "canonicalReference": "@microsoft/fast-components-msft!neutralFillStealthRestBehavior:var", - "docComment": "", + "docComment": "/**\n * Behavior to resolve and make available the neutral-fill-stealth-rest CSS custom property.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", @@ -3494,7 +3460,7 @@ { "kind": "Variable", "canonicalReference": "@microsoft/fast-components-msft!neutralFillStealthSelectedBehavior:var", - "docComment": "", + "docComment": "/**\n * Behavior to resolve and make available the neutral-fill-stealth-selected CSS custom property.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", @@ -3520,7 +3486,7 @@ { "kind": "Variable", "canonicalReference": "@microsoft/fast-components-msft!neutralFillToggleActiveBehavior:var", - "docComment": "", + "docComment": "/**\n * Behavior to resolve and make available the neutral-fill-toggle-active CSS custom property.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", @@ -3546,7 +3512,7 @@ { "kind": "Variable", "canonicalReference": "@microsoft/fast-components-msft!neutralFillToggleFocusBehavior:var", - "docComment": "", + "docComment": "/**\n * Behavior to resolve and make available the neutral-fill-toggle-focus CSS custom property.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", @@ -3572,7 +3538,7 @@ { "kind": "Variable", "canonicalReference": "@microsoft/fast-components-msft!neutralFillToggleHoverBehavior:var", - "docComment": "", + "docComment": "/**\n * Behavior to resolve and make available the neutral-fill-toggle-hover CSS custom property.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", @@ -3598,7 +3564,7 @@ { "kind": "Variable", "canonicalReference": "@microsoft/fast-components-msft!neutralFillToggleRestBehavior:var", - "docComment": "", + "docComment": "/**\n * Behavior to resolve and make available the neutral-fill-toggle-rest CSS custom property.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", @@ -3624,7 +3590,7 @@ { "kind": "Variable", "canonicalReference": "@microsoft/fast-components-msft!neutralFocusBehavior:var", - "docComment": "", + "docComment": "/**\n * Behavior to resolve and make available the neutral-focus CSS custom property.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", @@ -3650,7 +3616,7 @@ { "kind": "Variable", "canonicalReference": "@microsoft/fast-components-msft!neutralFocusInnerAccentBehavior:var", - "docComment": "", + "docComment": "/**\n * Behavior to resolve and make available the neutral-focus-inner-accent CSS custom property.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", @@ -3676,7 +3642,7 @@ { "kind": "Variable", "canonicalReference": "@microsoft/fast-components-msft!neutralForegroundActiveBehavior:var", - "docComment": "", + "docComment": "/**\n * Behavior to resolve and make available the neutral-foreground-active CSS custom property.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", @@ -3702,7 +3668,7 @@ { "kind": "Variable", "canonicalReference": "@microsoft/fast-components-msft!neutralForegroundFocusBehavior:var", - "docComment": "", + "docComment": "/**\n * Behavior to resolve and make available the neutral-foreground-focus CSS custom property.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", @@ -3728,7 +3694,7 @@ { "kind": "Variable", "canonicalReference": "@microsoft/fast-components-msft!neutralForegroundHintBehavior:var", - "docComment": "", + "docComment": "/**\n * Behavior to resolve and make available the neutral-foreground-hint CSS custom property.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", @@ -3754,7 +3720,7 @@ { "kind": "Variable", "canonicalReference": "@microsoft/fast-components-msft!neutralForegroundHintLargeBehavior:var", - "docComment": "", + "docComment": "/**\n * Behavior to resolve and make available the neutral-foreground-hint-large CSS custom property.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", @@ -3780,7 +3746,7 @@ { "kind": "Variable", "canonicalReference": "@microsoft/fast-components-msft!neutralForegroundHoverBehavior:var", - "docComment": "", + "docComment": "/**\n * Behavior to resolve and make available the neutral-foreground-hover CSS custom property.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", @@ -3806,7 +3772,7 @@ { "kind": "Variable", "canonicalReference": "@microsoft/fast-components-msft!neutralForegroundRestBehavior:var", - "docComment": "", + "docComment": "/**\n * Behavior to resolve and make available the neutral-foreground-rest CSS custom property.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", @@ -3832,7 +3798,7 @@ { "kind": "Variable", "canonicalReference": "@microsoft/fast-components-msft!neutralForegroundToggleBehavior:var", - "docComment": "", + "docComment": "/**\n * Behavior to resolve and make available the neutral-foreground-toggle CSS custom property.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", @@ -3858,7 +3824,7 @@ { "kind": "Variable", "canonicalReference": "@microsoft/fast-components-msft!neutralForegroundToggleLargeBehavior:var", - "docComment": "", + "docComment": "/**\n * Behavior to resolve and make available the neutral-foreground-toggle-large CSS custom property.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", @@ -3884,7 +3850,7 @@ { "kind": "Variable", "canonicalReference": "@microsoft/fast-components-msft!neutralLayerCardBehavior:var", - "docComment": "", + "docComment": "/**\n * Behavior to resolve and make available the neutral-layer-card CSS custom property.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", @@ -3910,7 +3876,7 @@ { "kind": "Variable", "canonicalReference": "@microsoft/fast-components-msft!neutralLayerCardContainerBehavior:var", - "docComment": "", + "docComment": "/**\n * Behavior to resolve and make available the neutral-layer-card-container CSS custom property.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", @@ -3936,7 +3902,7 @@ { "kind": "Variable", "canonicalReference": "@microsoft/fast-components-msft!neutralLayerFloatingBehavior:var", - "docComment": "", + "docComment": "/**\n * Behavior to resolve and make available the neutral-layer-floating CSS custom property.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", @@ -3962,7 +3928,7 @@ { "kind": "Variable", "canonicalReference": "@microsoft/fast-components-msft!neutralLayerL1AltBehavior:var", - "docComment": "", + "docComment": "/**\n * Behavior to resolve and make available the neutral-layer-l1-alt CSS custom property.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", @@ -3988,7 +3954,7 @@ { "kind": "Variable", "canonicalReference": "@microsoft/fast-components-msft!neutralLayerL1Behavior:var", - "docComment": "", + "docComment": "/**\n * Behavior to resolve and make available the neutral-layer-l1 CSS custom property.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", @@ -4014,7 +3980,7 @@ { "kind": "Variable", "canonicalReference": "@microsoft/fast-components-msft!neutralLayerL2Behavior:var", - "docComment": "", + "docComment": "/**\n * Behavior to resolve and make available the neutral-layer-l2 CSS custom property.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", @@ -4040,7 +4006,7 @@ { "kind": "Variable", "canonicalReference": "@microsoft/fast-components-msft!neutralLayerL3Behavior:var", - "docComment": "", + "docComment": "/**\n * Behavior to resolve and make available the neutral-layer-l3 CSS custom property.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", @@ -4066,7 +4032,7 @@ { "kind": "Variable", "canonicalReference": "@microsoft/fast-components-msft!neutralLayerL4Behavior:var", - "docComment": "", + "docComment": "/**\n * Behavior to resolve and make available the neutral-layer-l4 CSS custom property.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", @@ -4092,7 +4058,7 @@ { "kind": "Variable", "canonicalReference": "@microsoft/fast-components-msft!neutralOutlineActiveBehavior:var", - "docComment": "", + "docComment": "/**\n * Behavior to resolve and make available the neutral-outline-active CSS custom property.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", @@ -4118,7 +4084,7 @@ { "kind": "Variable", "canonicalReference": "@microsoft/fast-components-msft!neutralOutlineFocusBehavior:var", - "docComment": "", + "docComment": "/**\n * Behavior to resolve and make available the neutral-outline-focus CSS custom property.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", @@ -4144,7 +4110,7 @@ { "kind": "Variable", "canonicalReference": "@microsoft/fast-components-msft!neutralOutlineHoverBehavior:var", - "docComment": "", + "docComment": "/**\n * Behavior to resolve and make available the neutral-outline-hover CSS custom property.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", @@ -4170,7 +4136,7 @@ { "kind": "Variable", "canonicalReference": "@microsoft/fast-components-msft!neutralOutlineRestBehavior:var", - "docComment": "", + "docComment": "/**\n * Behavior to resolve and make available the neutral-outline-rest CSS custom property.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", diff --git a/sites/website/src/docs/api/fast-components.api.json b/sites/website/src/docs/api/fast-components.api.json index 7a2fd069613..e251516359e 100644 --- a/sites/website/src/docs/api/fast-components.api.json +++ b/sites/website/src/docs/api/fast-components.api.json @@ -611,7 +611,7 @@ { "kind": "Class", "canonicalReference": "@microsoft/fast-components!FASTAnchor:class", - "docComment": "/**\n * The FAST Anchor Element. Implements {@link @microsoft/fast-foundation#Anchor}, {@link @microsoft/fast-foundation#AnchorTemplate}\n *\n * @remarks\n *\n * HTML Element: \\\n *\n * @public\n */\n", + "docComment": "/**\n * The FAST Anchor Element. Implements {@link @microsoft/fast-foundation#Anchor}, {@link @microsoft/fast-foundation#AnchorTemplate}\n *\n * @remarks\n *\n * HTML Element: \\\n *\n * {@link https://developer.mozilla.org/en-US/docs/Web/API/ShadowRoot/delegatesFocus | delegatesFocus}\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", @@ -667,7 +667,7 @@ { "kind": "Class", "canonicalReference": "@microsoft/fast-components!FASTButton:class", - "docComment": "/**\n * The FAST Button Element. Implements {@link @microsoft/fast-foundation#Button}, {@link @microsoft/fast-foundation#ButtonTemplate}\n *\n * @remarks\n *\n * HTML Element: \\\n *\n * @public\n */\n", + "docComment": "/**\n * The FAST Button Element. Implements {@link @microsoft/fast-foundation#Button}, {@link @microsoft/fast-foundation#ButtonTemplate}\n *\n * @remarks\n *\n * HTML Element: \\\n *\n * {@link https://developer.mozilla.org/en-US/docs/Web/API/ShadowRoot/delegatesFocus | delegatesFocus}\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", diff --git a/sites/website/src/docs/api/fast-foundation.api.json b/sites/website/src/docs/api/fast-foundation.api.json index 4c8c89fd93a..2163f7808f4 100644 --- a/sites/website/src/docs/api/fast-foundation.api.json +++ b/sites/website/src/docs/api/fast-foundation.api.json @@ -18,7 +18,7 @@ { "kind": "Class", "canonicalReference": "@microsoft/fast-foundation!Accordion:class", - "docComment": "/**\n * An Accordion Custom HTML Element Implements {@link https://www.w3.org/TR/wai-aria-practices-1.1/#accordion | ARIA Accordion}.\n *\n * @remarks\n *\n * Designed to be used with {@link @microsoft/fast-foundation#AccordionTemplate} and {@link @microsoft/fast-foundation#AccordionItem}.\n *\n * @public\n */\n", + "docComment": "/**\n * An Accordion Custom HTML Element Implements {@link https://www.w3.org/TR/wai-aria-practices-1.1/#accordion | ARIA Accordion}.\n *\n * @remarks\n *\n * Designed to be used with {@link @microsoft/fast-foundation#AccordionTemplate} and {@link @microsoft/fast-foundation#(AccordionItem:class)}.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", @@ -40,7 +40,7 @@ { "kind": "Property", "canonicalReference": "@microsoft/fast-foundation!Accordion#expandmode:member", - "docComment": "/**\n * Controls the expand mode of the Accordion, either allowing single or multiple item expansion.\n *\n * @remarks\n *\n * HTML attribute: expand-mode\n *\n * @defaultValue\n *\n * {@link AccordionExpandMode.multi}\n *\n * @public\n */\n", + "docComment": "/**\n * Controls the expand mode of the Accordion, either allowing single or multiple item expansion.\n *\n * @remarks\n *\n * HTML attribute: expand-mode\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", @@ -87,7 +87,7 @@ { "kind": "EnumMember", "canonicalReference": "@microsoft/fast-foundation!AccordionExpandMode.multi:member", - "docComment": "/**\n * Designates multiple {@link @microsoft/fast-foundation#AccordionItem | AccordionItems} can be open simultaneously.\n */\n", + "docComment": "/**\n * Designates multiple {@link @microsoft/fast-foundation#(AccordionItem:class) | AccordionItems} can be open simultaneously.\n */\n", "excerptTokens": [ { "kind": "Content", @@ -108,7 +108,7 @@ { "kind": "EnumMember", "canonicalReference": "@microsoft/fast-foundation!AccordionExpandMode.single:member", - "docComment": "/**\n * Designates only a single {@link @microsoft/fast-foundation#AccordionItem} can be open a time.\n */\n", + "docComment": "/**\n * Designates only a single {@link @microsoft/fast-foundation#(AccordionItem:class)} can be open a time.\n */\n", "excerptTokens": [ { "kind": "Content", @@ -131,7 +131,7 @@ { "kind": "Class", "canonicalReference": "@microsoft/fast-foundation!AccordionItem:class", - "docComment": "/**\n * An individual item in an {@link @microsoft/fast-foundation#Accordion}.\n *\n * @public\n */\n", + "docComment": "/**\n * An individual item in an {@link @microsoft/fast-foundation#(Accordion:class)}.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", @@ -238,7 +238,7 @@ { "kind": "Variable", "canonicalReference": "@microsoft/fast-foundation!AccordionItemTemplate:var", - "docComment": "", + "docComment": "/**\n * The template for the {@link @microsoft/fast-foundation#(AccordionItem:class)} component.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", @@ -277,7 +277,7 @@ { "kind": "Variable", "canonicalReference": "@microsoft/fast-foundation!AccordionTemplate:var", - "docComment": "", + "docComment": "/**\n * The template for the {@link @microsoft/fast-foundation#Accordion} component.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", @@ -610,7 +610,7 @@ { "kind": "Variable", "canonicalReference": "@microsoft/fast-foundation!AnchorTemplate:var", - "docComment": "", + "docComment": "/**\n * The template for the {@link @microsoft/fast-foundation#(Anchor:class)} component.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", @@ -707,7 +707,7 @@ { "kind": "Class", "canonicalReference": "@microsoft/fast-foundation!Badge:class", - "docComment": "", + "docComment": "/**\n * A Badge Custom HTML Element.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", @@ -729,7 +729,7 @@ { "kind": "Property", "canonicalReference": "@microsoft/fast-foundation!Badge#circular:member", - "docComment": "", + "docComment": "/**\n * Indicates the element should be circular\n *\n * @remarks\n *\n * HTML Attribute: circular\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", @@ -755,7 +755,7 @@ { "kind": "Property", "canonicalReference": "@microsoft/fast-foundation!Badge#color:member", - "docComment": "", + "docComment": "/**\n * Indicates the badge should have a filled style.\n *\n * @remarks\n *\n * HTML Attribute: color\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", @@ -781,7 +781,7 @@ { "kind": "Property", "canonicalReference": "@microsoft/fast-foundation!Badge#fill:member", - "docComment": "", + "docComment": "/**\n * Indicates the badge should have a filled style.\n *\n * @remarks\n *\n * HTML Attribute: fill\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", @@ -814,7 +814,7 @@ { "kind": "Variable", "canonicalReference": "@microsoft/fast-foundation!BadgeTemplate:var", - "docComment": "", + "docComment": "/**\n * The template for the {@link @microsoft/fast-foundation#Badge} component.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", @@ -853,7 +853,7 @@ { "kind": "Class", "canonicalReference": "@microsoft/fast-foundation!BaseProgress:class", - "docComment": "", + "docComment": "/**\n * An Progress HTML Element. Implements the {@link https://www.w3.org/TR/wai-aria-1.1/#progressbar | ARIA progressbar}.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", @@ -875,7 +875,7 @@ { "kind": "Property", "canonicalReference": "@microsoft/fast-foundation!BaseProgress#max:member", - "docComment": "", + "docComment": "/**\n * The maximum value\n *\n * @remarks\n *\n * HTML Attribute: max\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", @@ -901,7 +901,7 @@ { "kind": "Property", "canonicalReference": "@microsoft/fast-foundation!BaseProgress#min:member", - "docComment": "", + "docComment": "/**\n * The minimum value\n *\n * @remarks\n *\n * HTML Attribute: min\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", @@ -927,7 +927,7 @@ { "kind": "Property", "canonicalReference": "@microsoft/fast-foundation!BaseProgress#paused:member", - "docComment": "", + "docComment": "/**\n * Indicates the progress is paused\n *\n * @remarks\n *\n * HTML Attribute: paused\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", @@ -953,7 +953,7 @@ { "kind": "Property", "canonicalReference": "@microsoft/fast-foundation!BaseProgress#value:member", - "docComment": "", + "docComment": "/**\n * The value of the progress\n *\n * @remarks\n *\n * HTML Attribute: value\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", @@ -986,7 +986,7 @@ { "kind": "Class", "canonicalReference": "@microsoft/fast-foundation!Button:class", - "docComment": "", + "docComment": "/**\n * An Button Custom HTML Element. Based largely on the {@link https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button |