From 3fb5043cb532024213ceca0abfef328fd48e1be3 Mon Sep 17 00:00:00 2001 From: Nicholas Rice Date: Tue, 16 Jun 2020 14:34:33 -0700 Subject: [PATCH] chore: add API docs for fast-components (#3321) * Document component implementations * document recipes * update the rest of the elements * update site * wire docs to ci * pretty pretty --- .../fast-components/docs/api-report.md | 174 +- .../fast-components/package.json | 3 +- .../src/accordion/accordion-item/index.ts | 9 + .../fast-components/src/accordion/index.ts | 9 + .../fast-components/src/anchor/index.ts | 10 +- .../fast-components/src/badge/index.ts | 9 + .../fast-components/src/button/index.ts | 10 +- .../fast-components/src/card/index.ts | 9 + .../fast-components/src/checkbox/index.ts | 9 + .../src/color/create-color-palette.js | 6 +- .../src/color/neutral-fill-card.ts | 6 + .../src/color/neutral-layer.ts | 4 +- .../fast-components/src/color/palette.ts | 10 +- .../src/design-system-provider/index.ts | 9 + .../fast-components/src/dialog/index.ts | 9 + .../fast-components/src/divider/index.ts | 9 + .../fast-components/src/fast-design-system.ts | 8 + .../fast-components/src/flipper/index.ts | 9 + .../fast-components/src/index.ts | 1 + .../fast-components/src/menu-item/index.ts | 9 + .../fast-components/src/menu/index.ts | 9 + .../src/progress/progress-ring/index.ts | 9 + .../src/progress/progress/index.ts | 9 + .../fast-components/src/radio-group/index.ts | 9 + .../fast-components/src/radio/index.ts | 9 + .../fast-components/src/slider-label/index.ts | 9 + .../fast-components/src/slider/index.ts | 9 + .../fast-components/src/styles/recipes.ts | 61 + .../fast-components/src/switch/index.ts | 9 + .../fast-components/src/tabs/index.ts | 9 + .../src/tabs/tab-panel/index.ts | 9 + .../fast-components/src/tabs/tab/index.ts | 9 + .../fast-components/src/text-area/index.ts | 11 + .../fast-components/src/text-field/index.ts | 11 + .../fast-components/temp/api-report.md | 174 +- .../docs/api/fast-components-msft.api.json | 2372 ++++++++++-- .../src/docs/api/fast-components.api.json | 1940 +++++++++- .../src/docs/api/fast-foundation.api.json | 3273 +++-------------- 38 files changed, 4898 insertions(+), 3365 deletions(-) diff --git a/packages/web-components/fast-components/docs/api-report.md b/packages/web-components/fast-components/docs/api-report.md index 42a8e2707e2..23218565aae 100644 --- a/packages/web-components/fast-components/docs/api-report.md +++ b/packages/web-components/fast-components/docs/api-report.md @@ -192,37 +192,153 @@ export const accentForegroundRestBehavior: import("@microsoft/fast-foundation"). // @public export function createColorPalette(baseColor: any): 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 { } -// @public (undocumented) +// @public export class FASTButton extends Button { } -// @public (undocumented) +// @public export class FASTCard extends Card { } -// @public (undocumented) +// @public export class FASTCheckbox extends Checkbox { } -// Warning: (ae-forgotten-export) The symbol "FASTDesignSystem" needs to be exported by the entry point index.d.ts -// -// @public (undocumented) +// @public +export interface FASTDesignSystem { + accentBaseColor: string; + // (undocumented) + accentFillActiveDelta: number; + // (undocumented) + accentFillFocusDelta: number; + // (undocumented) + accentFillHoverDelta: number; + accentFillRestDelta: number; + // (undocumented) + accentFillSelectedDelta: number; + // (undocumented) + accentForegroundActiveDelta: number; + // (undocumented) + accentForegroundFocusDelta: number; + // (undocumented) + accentForegroundHoverDelta: number; + accentForegroundRestDelta: number; + accentPalette: string[]; + backgroundColor: string; + baseHeightMultiplier: number; + baseHorizontalSpacingMultiplier: number; + baseLayerLuminance: number; + cornerRadius: number; + density: number; + designUnit: number; + disabledOpacity: number; + focusOutlineWidth: number; + neutralDividerRestDelta: number; + // (undocumented) + neutralFillActiveDelta: number; + neutralFillCardDelta: number; + // (undocumented) + neutralFillFocusDelta: number; + // (undocumented) + neutralFillHoverDelta: number; + // (undocumented) + neutralFillInputActiveDelta: number; + // (undocumented) + neutralFillInputFocusDelta: number; + // (undocumented) + neutralFillInputHoverDelta: number; + neutralFillInputRestDelta: number; + // (undocumented) + neutralFillInputSelectedDelta: number; + // (undocumented) + neutralFillRestDelta: number; + // (undocumented) + neutralFillSelectedDelta: number; + // (undocumented) + neutralFillStealthActiveDelta: number; + // (undocumented) + neutralFillStealthFocusDelta: number; + // (undocumented) + neutralFillStealthHoverDelta: number; + neutralFillStealthRestDelta: number; + // (undocumented) + neutralFillStealthSelectedDelta: number; + // (undocumented) + neutralFillToggleActiveDelta: number; + // (undocumented) + neutralFillToggleFocusDelta: number; + neutralFillToggleHoverDelta: number; + // (undocumented) + neutralForegroundActiveDelta: number; + // (undocumented) + neutralForegroundFocusDelta: number; + neutralForegroundHoverDelta: number; + // (undocumented) + neutralOutlineActiveDelta: number; + // (undocumented) + neutralOutlineFocusDelta: number; + // (undocumented) + neutralOutlineHoverDelta: number; + neutralOutlineRestDelta: number; + neutralPalette: string[]; + outlineWidth: number; + // (undocumented) + typeRampBaseFontSize: string; + // (undocumented) + typeRampBaseLineHeight: string; + // (undocumented) + typeRampMinus1FontSize: string; + // (undocumented) + typeRampMinus1LineHeight: string; + typeRampMinus2FontSize: string; + // (undocumented) + typeRampMinus2LineHeight: string; + // (undocumented) + typeRampPlus1FontSize: string; + // (undocumented) + typeRampPlus1LineHeight: string; + // (undocumented) + typeRampPlus2FontSize: string; + // (undocumented) + typeRampPlus2LineHeight: string; + // (undocumented) + typeRampPlus3FontSize: string; + // (undocumented) + typeRampPlus3LineHeight: string; + // (undocumented) + typeRampPlus4FontSize: string; + // (undocumented) + typeRampPlus4LineHeight: string; + // (undocumented) + typeRampPlus5FontSize: string; + // (undocumented) + typeRampPlus5LineHeight: string; + // (undocumented) + typeRampPlus6FontSize: string; + // (undocumented) + typeRampPlus6LineHeight: string; +} + +// @public +export const fastDesignSystemDefaults: FASTDesignSystem; + +// @public export class FASTDesignSystemProvider extends DesignSystemProvider implements FASTDesignSystem { accentBaseColor: string; // (undocumented) @@ -357,71 +473,71 @@ export class FASTDesignSystemProvider extends DesignSystemProvider implements FA 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 FASTMenu extends Menu { } -// @public (undocumented) +// @public export class FASTMenuItem extends MenuItem { } -// @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 { } @@ -451,14 +567,14 @@ export const neutralFillActive: SwatchRecipe; export const neutralFillActiveBehavior: import("@microsoft/fast-foundation").CSSCustomPropertyBehavior; // Warning: (ae-forgotten-export) The symbol "Swatch" needs to be exported by the entry point index.d.ts -// Warning: (ae-internal-mixed-release-tag) Mixed release tags are not allowed for "neutralFillCard" because one of its declarations is marked as @internal +// Warning: (ae-internal-missing-underscore) The name "neutralFillCard" should be prefixed with an underscore because the declaration is marked as @internal // // @internal (undocumented) export function neutralFillCard(designSystem: FASTDesignSystem): Swatch; // Warning: (ae-forgotten-export) The symbol "SwatchResolver" needs to be exported by the entry point index.d.ts // -// @public (undocumented) +// @internal (undocumented) export function neutralFillCard(backgroundResolver: SwatchResolver): SwatchResolver; // @public diff --git a/packages/web-components/fast-components/package.json b/packages/web-components/fast-components/package.json index 0353bf517a9..e9ffe2535db 100644 --- a/packages/web-components/fast-components/package.json +++ b/packages/web-components/fast-components/package.json @@ -21,6 +21,7 @@ "scripts": { "clean:dist": "node ../../../build/clean.js dist", "doc": "api-extractor run --local", + "doc:ci": "api-extractor run", "build": "npm run generate-default-palettes && tsc -p ./tsconfig.json && rollup -c && npm run doc", "dev": "tsc -p ./tsconfig.json -w", "tdd": "npm run dev & npm run test-chrome:watch", @@ -32,7 +33,7 @@ "start": "start-storybook -p 6006", "build-storybook": "build-storybook", "generate-default-palettes": "node -r esm build/generate-default-palettes.js", - "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:watch": "mocha --reporter min --exit dist/esm/__test__/setup-node.js --watch './dist/esm/**/*.spec.js'", "test-node:verbose": "mocha --reporter spec --exit dist/esm/__test__/setup-node.js './dist/esm/**/*.spec.js'", diff --git a/packages/web-components/fast-components/src/accordion/accordion-item/index.ts b/packages/web-components/fast-components/src/accordion/accordion-item/index.ts index 050d06f0543..79dabfe1dc4 100644 --- a/packages/web-components/fast-components/src/accordion/accordion-item/index.ts +++ b/packages/web-components/fast-components/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/src/accordion/index.ts b/packages/web-components/fast-components/src/accordion/index.ts index d4cc0670ac7..5cbafbb3dca 100644 --- a/packages/web-components/fast-components/src/accordion/index.ts +++ b/packages/web-components/fast-components/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/src/anchor/index.ts b/packages/web-components/fast-components/src/anchor/index.ts index 02489bf9df8..693259ba5c1 100644 --- a/packages/web-components/fast-components/src/anchor/index.ts +++ b/packages/web-components/fast-components/src/anchor/index.ts @@ -2,7 +2,15 @@ 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: \ + */ @customElement({ name: "fast-anchor", template, diff --git a/packages/web-components/fast-components/src/badge/index.ts b/packages/web-components/fast-components/src/badge/index.ts index c4191e7e382..b0012e13e3c 100644 --- a/packages/web-components/fast-components/src/badge/index.ts +++ b/packages/web-components/fast-components/src/badge/index.ts @@ -2,6 +2,15 @@ import { customElement } from "@microsoft/fast-element"; import { Badge, BadgeTemplate as template } from "@microsoft/fast-foundation"; import { BadgeStyles as styles } from "./badge.styles"; +/** + * 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/src/button/index.ts b/packages/web-components/fast-components/src/button/index.ts index b91d7961425..47409145977 100644 --- a/packages/web-components/fast-components/src/button/index.ts +++ b/packages/web-components/fast-components/src/button/index.ts @@ -2,7 +2,15 @@ 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: \ + */ @customElement({ name: "fast-button", template, diff --git a/packages/web-components/fast-components/src/card/index.ts b/packages/web-components/fast-components/src/card/index.ts index 4bba1416411..5c3323e5f6d 100644 --- a/packages/web-components/fast-components/src/card/index.ts +++ b/packages/web-components/fast-components/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/src/checkbox/index.ts b/packages/web-components/fast-components/src/checkbox/index.ts index 3213c2c745e..77e4be66eb9 100644 --- a/packages/web-components/fast-components/src/checkbox/index.ts +++ b/packages/web-components/fast-components/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/src/color/create-color-palette.js b/packages/web-components/fast-components/src/color/create-color-palette.js index 46fd8decb72..fcb3746a177 100644 --- a/packages/web-components/fast-components/src/color/create-color-palette.js +++ b/packages/web-components/fast-components/src/color/create-color-palette.js @@ -2,8 +2,10 @@ import { ComponentStateColorPalette } from "@microsoft/fast-colors"; /** * Creates a color palette from a provided source color - * @param {ColorRGBA64} baseColor - * @returns {string[]} + * @param baseColor - ColorRGBA64 + * @returns string[] + * + * @public */ export function createColorPalette(baseColor) { return new ComponentStateColorPalette({ diff --git a/packages/web-components/fast-components/src/color/neutral-fill-card.ts b/packages/web-components/fast-components/src/color/neutral-fill-card.ts index 70a6bfc407b..e49ea678777 100644 --- a/packages/web-components/fast-components/src/color/neutral-fill-card.ts +++ b/packages/web-components/fast-components/src/color/neutral-fill-card.ts @@ -24,7 +24,13 @@ const neutralCardFillAlgorithm: SwatchResolver = ( * @internal */ export function neutralFillCard(designSystem: FASTDesignSystem): Swatch; +/** + * @internal + */ export function neutralFillCard(backgroundResolver: SwatchResolver): SwatchResolver; +/** + * @internal + */ export function neutralFillCard(arg: any): any { if (typeof arg === "function") { return (designSystem: FASTDesignSystem): Swatch => { diff --git a/packages/web-components/fast-components/src/color/neutral-layer.ts b/packages/web-components/fast-components/src/color/neutral-layer.ts index a9e4be0c3ca..da0899fd6f9 100644 --- a/packages/web-components/fast-components/src/color/neutral-layer.ts +++ b/packages/web-components/fast-components/src/color/neutral-layer.ts @@ -18,7 +18,9 @@ import { } from "./common"; /** - * Recommended values for light and dark mode for `baseLayerLuminance` in the design system. + * Recommended values for light and dark mode for {@link @microsoft/fast-components#FASTDesignSystem.baseLayerLuminance}. + * + * @public */ export enum StandardLuminance { LightMode = 1, diff --git a/packages/web-components/fast-components/src/color/palette.ts b/packages/web-components/fast-components/src/color/palette.ts index 0862812f653..73c9712e0b8 100644 --- a/packages/web-components/fast-components/src/color/palette.ts +++ b/packages/web-components/fast-components/src/color/palette.ts @@ -19,6 +19,7 @@ import { /** * The named palettes of the MSFT design system * @deprecated - use neutralPalette and accentPalette functions instead + * @public */ export enum PaletteType { neutral = "neutral", @@ -27,6 +28,8 @@ export enum PaletteType { /** * The structure of a color palette + * + * @public */ export type Palette = Swatch[]; @@ -146,8 +149,11 @@ export function findClosestSwatchIndex( /** * Determines if the design-system should be considered in "dark mode". - * We're in dark mode if we have more contrast between #000000 and our background - * color than #FFFFFF and our background color. That threshold can be expressed as a relative luminance + * + * @public + * @privateRemarks + * A color is in dark mode if there is more contrast between #000000 and a background + * color than #FFFFFF and a background color. That threshold can be expressed as a relative luminance * using the contrast formula as (1 + 0.5) / (bg + 0.05) === (bg + 0.05) / (0 + 0.05), * which reduces to the following, where bg is the relative luminance of the background color */ diff --git a/packages/web-components/fast-components/src/design-system-provider/index.ts b/packages/web-components/fast-components/src/design-system-provider/index.ts index 26d94799a9a..ea841347260 100644 --- a/packages/web-components/fast-components/src/design-system-provider/index.ts +++ b/packages/web-components/fast-components/src/design-system-provider/index.ts @@ -23,6 +23,15 @@ const backgroundStyles = css` } `.withBehaviors(color); +/** + * The FAST DesignSystemProvider Element. Implements {@link @microsoft/fast-foundation#DesignSystemProvider}, + * {@link @microsoft/fast-foundation#DesignSystemProviderTemplate} and {@link @microsoft/fast-components#FASTDesignSystem} + * + * + * @public + * @remarks + * HTML Element: \ + */ @designSystemProvider({ name: "fast-design-system-provider", template, diff --git a/packages/web-components/fast-components/src/dialog/index.ts b/packages/web-components/fast-components/src/dialog/index.ts index 3c5471ce387..46d73c936a8 100644 --- a/packages/web-components/fast-components/src/dialog/index.ts +++ b/packages/web-components/fast-components/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/src/divider/index.ts b/packages/web-components/fast-components/src/divider/index.ts index d805262a9c3..acab45c6b12 100644 --- a/packages/web-components/fast-components/src/divider/index.ts +++ b/packages/web-components/fast-components/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/src/fast-design-system.ts b/packages/web-components/fast-components/src/fast-design-system.ts index 2d3b12c0ba2..5e1eba1a783 100644 --- a/packages/web-components/fast-components/src/fast-design-system.ts +++ b/packages/web-components/fast-components/src/fast-design-system.ts @@ -5,6 +5,10 @@ import { export type DesignSystemResolver = (d: Y) => T; +/** + * Defines the properties in the FAST Design System + * @public + */ export interface FASTDesignSystem { /** * Type-ramp font-size and line-height values @@ -178,6 +182,10 @@ export interface FASTDesignSystem { neutralOutlineFocusDelta: number; } +/** + * The default values for {@link FASTDesignSystem} + * @public + */ export const fastDesignSystemDefaults: FASTDesignSystem = { typeRampMinus2FontSize: "10px", typeRampMinus2LineHeight: "16px", diff --git a/packages/web-components/fast-components/src/flipper/index.ts b/packages/web-components/fast-components/src/flipper/index.ts index 3c8dc08570c..7f7dbf0ea12 100644 --- a/packages/web-components/fast-components/src/flipper/index.ts +++ b/packages/web-components/fast-components/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/src/index.ts b/packages/web-components/fast-components/src/index.ts index 71e390d2b9b..7316cd05b95 100644 --- a/packages/web-components/fast-components/src/index.ts +++ b/packages/web-components/fast-components/src/index.ts @@ -6,6 +6,7 @@ export * from "./card/index"; export * from "./checkbox/index"; export * from "./color/index"; export * from "./design-system-provider/index"; +export { FASTDesignSystem, fastDesignSystemDefaults } from "./fast-design-system"; export * from "./dialog/index"; export * from "./divider/index"; export * from "./flipper/index"; diff --git a/packages/web-components/fast-components/src/menu-item/index.ts b/packages/web-components/fast-components/src/menu-item/index.ts index 894e94c0c67..42427f7473b 100644 --- a/packages/web-components/fast-components/src/menu-item/index.ts +++ b/packages/web-components/fast-components/src/menu-item/index.ts @@ -2,6 +2,15 @@ import { customElement } from "@microsoft/fast-element"; import { MenuItem, MenuItemTemplate as template } from "@microsoft/fast-foundation"; import { MenuItemStyles as styles } from "./menu-item.styles"; +/** + * The FAST Menu Item Element. Implements {@link @microsoft/fast-foundation#MenuItem}, + * {@link @microsoft/fast-foundation#MenuItemTemplate} + * + * + * @public + * @remarks + * HTML Element: \ + */ @customElement({ name: "fast-menu-item", template, diff --git a/packages/web-components/fast-components/src/menu/index.ts b/packages/web-components/fast-components/src/menu/index.ts index f0167e0eb8f..51dd806d976 100644 --- a/packages/web-components/fast-components/src/menu/index.ts +++ b/packages/web-components/fast-components/src/menu/index.ts @@ -2,6 +2,15 @@ import { customElement } from "@microsoft/fast-element"; import { Menu, MenuTemplate as template } from "@microsoft/fast-foundation"; import { MenuStyles as styles } from "./menu.styles"; +/** + * The FAST Menu Element. Implements {@link @microsoft/fast-foundation#Menu}, + * {@link @microsoft/fast-foundation#MenuTemplate} + * + * + * @public + * @remarks + * HTML Element: \ + */ @customElement({ name: "fast-menu", template, diff --git a/packages/web-components/fast-components/src/progress/progress-ring/index.ts b/packages/web-components/fast-components/src/progress/progress-ring/index.ts index 8a149539d98..dc6fee00820 100644 --- a/packages/web-components/fast-components/src/progress/progress-ring/index.ts +++ b/packages/web-components/fast-components/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/src/progress/progress/index.ts b/packages/web-components/fast-components/src/progress/progress/index.ts index 5abb518d84a..f860b5dbf73 100644 --- a/packages/web-components/fast-components/src/progress/progress/index.ts +++ b/packages/web-components/fast-components/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/src/radio-group/index.ts b/packages/web-components/fast-components/src/radio-group/index.ts index 7c5b3ae8b22..c3c1894cca2 100644 --- a/packages/web-components/fast-components/src/radio-group/index.ts +++ b/packages/web-components/fast-components/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/src/radio/index.ts b/packages/web-components/fast-components/src/radio/index.ts index 06068933fcf..cddd1aaab2d 100644 --- a/packages/web-components/fast-components/src/radio/index.ts +++ b/packages/web-components/fast-components/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/src/slider-label/index.ts b/packages/web-components/fast-components/src/slider-label/index.ts index bf8f9e94402..d75583956ed 100644 --- a/packages/web-components/fast-components/src/slider-label/index.ts +++ b/packages/web-components/fast-components/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/src/slider/index.ts b/packages/web-components/fast-components/src/slider/index.ts index e177019719e..a32da2f05bf 100644 --- a/packages/web-components/fast-components/src/slider/index.ts +++ b/packages/web-components/fast-components/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/src/styles/recipes.ts b/packages/web-components/fast-components/src/styles/recipes.ts index 715aa8f3fc8..df41ffafdc5 100644 --- a/packages/web-components/fast-components/src/styles/recipes.ts +++ b/packages/web-components/fast-components/src/styles/recipes.ts @@ -33,6 +33,7 @@ import { FASTDesignSystemProvider } from "../design-system-provider/index"; /** * Behavior to resolve and make available the neutral-foreground-rest CSS custom property. + * @public */ export const neutralForegroundRestBehavior = cssCustomPropertyBehaviorFactory( "neutral-foreground-rest", @@ -41,6 +42,7 @@ export const neutralForegroundRestBehavior = cssCustomPropertyBehaviorFactory( ); /** * Behavior to resolve and make available the neutral-foreground-hover CSS custom property. + * @public */ export const neutralForegroundHoverBehavior = cssCustomPropertyBehaviorFactory( "neutral-foreground-hover", @@ -49,6 +51,7 @@ export const neutralForegroundHoverBehavior = cssCustomPropertyBehaviorFactory( ); /** * Behavior to resolve and make available the neutral-foreground-active CSS custom property. + * @public */ export const neutralForegroundActiveBehavior = cssCustomPropertyBehaviorFactory( "neutral-foreground-active", @@ -57,6 +60,7 @@ export const neutralForegroundActiveBehavior = cssCustomPropertyBehaviorFactory( ); /** * Behavior to resolve and make available the neutral-foreground-focus CSS custom property. + * @public */ export const neutralForegroundFocusBehavior = cssCustomPropertyBehaviorFactory( "neutral-foreground-focus", @@ -65,6 +69,7 @@ export const neutralForegroundFocusBehavior = cssCustomPropertyBehaviorFactory( ); /** * Behavior to resolve and make available the neutral-foreground-toggle CSS custom property. + * @public */ export const neutralForegroundToggleBehavior = cssCustomPropertyBehaviorFactory( "neutral-foreground-toggle", @@ -73,6 +78,7 @@ export const neutralForegroundToggleBehavior = cssCustomPropertyBehaviorFactory( ); /** * Behavior to resolve and make available the neutral-foreground-toggle-large CSS custom property. + * @public */ export const neutralForegroundToggleLargeBehavior = cssCustomPropertyBehaviorFactory( "neutral-foreground-toggle-large", @@ -81,6 +87,7 @@ export const neutralForegroundToggleLargeBehavior = cssCustomPropertyBehaviorFac ); /** * Behavior to resolve and make available the neutral-foreground-hint CSS custom property. + * @public */ export const neutralForegroundHintBehavior = cssCustomPropertyBehaviorFactory( "neutral-foreground-hint", @@ -89,6 +96,7 @@ export const neutralForegroundHintBehavior = cssCustomPropertyBehaviorFactory( ); /** * Behavior to resolve and make available the neutral-foreground-hint-large CSS custom property. + * @public */ export const neutralForegroundHintLargeBehavior = cssCustomPropertyBehaviorFactory( "neutral-foreground-hint-large", @@ -97,6 +105,7 @@ export const neutralForegroundHintLargeBehavior = cssCustomPropertyBehaviorFacto ); /** * Behavior to resolve and make available the accent-foreground-rest CSS custom property. + * @public */ export const accentForegroundRestBehavior = cssCustomPropertyBehaviorFactory( "accent-foreground-rest", @@ -105,6 +114,7 @@ export const accentForegroundRestBehavior = cssCustomPropertyBehaviorFactory( ); /** * Behavior to resolve and make available the accent-foreground-hover CSS custom property. + * @public */ export const accentForegroundHoverBehavior = cssCustomPropertyBehaviorFactory( "accent-foreground-hover", @@ -113,6 +123,7 @@ export const accentForegroundHoverBehavior = cssCustomPropertyBehaviorFactory( ); /** * Behavior to resolve and make available the accent-foreground-active CSS custom property. + * @public */ export const accentForegroundActiveBehavior = cssCustomPropertyBehaviorFactory( "accent-foreground-active", @@ -121,6 +132,7 @@ export const accentForegroundActiveBehavior = cssCustomPropertyBehaviorFactory( ); /** * Behavior to resolve and make available the accent-foreground-focus CSS custom property. + * @public */ export const accentForegroundFocusBehavior = cssCustomPropertyBehaviorFactory( "accent-foreground-focus", @@ -129,6 +141,7 @@ export const accentForegroundFocusBehavior = cssCustomPropertyBehaviorFactory( ); /** * Behavior to resolve and make available the accent-foreground-cut-rest CSS custom property. + * @public */ export const accentForegroundCutRestBehavior = cssCustomPropertyBehaviorFactory( "accent-foreground-cut-rest", @@ -137,6 +150,7 @@ export const accentForegroundCutRestBehavior = cssCustomPropertyBehaviorFactory( ); /** * Behavior to resolve and make available the accent-foreground-large-rest CSS custom property. + * @public */ export const accentForegroundLargeRestBehavior = cssCustomPropertyBehaviorFactory( "accent-foreground-large-rest", @@ -145,6 +159,7 @@ export const accentForegroundLargeRestBehavior = cssCustomPropertyBehaviorFactor ); /** * Behavior to resolve and make available the accent-foreground-large-hover CSS custom property. + * @public */ export const accentForegroundLargeHoverBehavior = cssCustomPropertyBehaviorFactory( "accent-foreground-large-hover", @@ -153,6 +168,7 @@ export const accentForegroundLargeHoverBehavior = cssCustomPropertyBehaviorFacto ); /** * Behavior to resolve and make available the accent-foreground-large-active CSS custom property. + * @public */ export const accentForegroundLargeActiveBehavior = cssCustomPropertyBehaviorFactory( "accent-foreground-large-active", @@ -161,6 +177,7 @@ export const accentForegroundLargeActiveBehavior = cssCustomPropertyBehaviorFact ); /** * Behavior to resolve and make available the accent-foreground-large-focus CSS custom property. + * @public */ export const accentForegroundLargeFocusBehavior = cssCustomPropertyBehaviorFactory( "accent-foreground-large-focus", @@ -169,6 +186,7 @@ export const accentForegroundLargeFocusBehavior = cssCustomPropertyBehaviorFacto ); /** * Behavior to resolve and make available the neutral-fill-rest CSS custom property. + * @public */ export const neutralFillRestBehavior = cssCustomPropertyBehaviorFactory( "neutral-fill-rest", @@ -177,6 +195,7 @@ export const neutralFillRestBehavior = cssCustomPropertyBehaviorFactory( ); /** * Behavior to resolve and make available the neutral-fill-hover CSS custom property. + * @public */ export const neutralFillHoverBehavior = cssCustomPropertyBehaviorFactory( "neutral-fill-hover", @@ -185,6 +204,7 @@ export const neutralFillHoverBehavior = cssCustomPropertyBehaviorFactory( ); /** * Behavior to resolve and make available the neutral-fill-active CSS custom property. + * @public */ export const neutralFillActiveBehavior = cssCustomPropertyBehaviorFactory( "neutral-fill-active", @@ -193,6 +213,7 @@ export const neutralFillActiveBehavior = cssCustomPropertyBehaviorFactory( ); /** * Behavior to resolve and make available the neutral-fill-focus CSS custom property. + * @public */ export const neutralFillFocusBehavior = cssCustomPropertyBehaviorFactory( "neutral-fill-focus", @@ -201,6 +222,7 @@ export const neutralFillFocusBehavior = cssCustomPropertyBehaviorFactory( ); /** * Behavior to resolve and make available the neutral-fill-selected CSS custom property. + * @public */ export const neutralFillSelectedBehavior = cssCustomPropertyBehaviorFactory( "neutral-fill-selected", @@ -209,6 +231,7 @@ export const neutralFillSelectedBehavior = cssCustomPropertyBehaviorFactory( ); /** * Behavior to resolve and make available the neutral-fill-stealth-rest CSS custom property. + * @public */ export const neutralFillStealthRestBehavior = cssCustomPropertyBehaviorFactory( "neutral-fill-stealth-rest", @@ -217,6 +240,7 @@ export const neutralFillStealthRestBehavior = cssCustomPropertyBehaviorFactory( ); /** * Behavior to resolve and make available the neutral-fill-stealth-hover CSS custom property. + * @public */ export const neutralFillStealthHoverBehavior = cssCustomPropertyBehaviorFactory( "neutral-fill-stealth-hover", @@ -225,6 +249,7 @@ export const neutralFillStealthHoverBehavior = cssCustomPropertyBehaviorFactory( ); /** * Behavior to resolve and make available the neutral-fill-stealth-active CSS custom property. + * @public */ export const neutralFillStealthActiveBehavior = cssCustomPropertyBehaviorFactory( "neutral-fill-stealth-active", @@ -233,6 +258,7 @@ export const neutralFillStealthActiveBehavior = cssCustomPropertyBehaviorFactory ); /** * Behavior to resolve and make available the neutral-fill-stealth-focus CSS custom property. + * @public */ export const neutralFillStealthFocusBehavior = cssCustomPropertyBehaviorFactory( "neutral-fill-stealth-focus", @@ -241,6 +267,7 @@ export const neutralFillStealthFocusBehavior = cssCustomPropertyBehaviorFactory( ); /** * Behavior to resolve and make available the neutral-fill-stealth-selected CSS custom property. + * @public */ export const neutralFillStealthSelectedBehavior = cssCustomPropertyBehaviorFactory( "neutral-fill-stealth-selected", @@ -249,6 +276,7 @@ export const neutralFillStealthSelectedBehavior = cssCustomPropertyBehaviorFacto ); /** * Behavior to resolve and make available the neutral-fill-toggle-rest CSS custom property. + * @public */ export const neutralFillToggleRestBehavior = cssCustomPropertyBehaviorFactory( "neutral-fill-toggle-rest", @@ -257,6 +285,7 @@ export const neutralFillToggleRestBehavior = cssCustomPropertyBehaviorFactory( ); /** * Behavior to resolve and make available the neutral-fill-toggle-hover CSS custom property. + * @public */ export const neutralFillToggleHoverBehavior = cssCustomPropertyBehaviorFactory( "neutral-fill-toggle-hover", @@ -265,6 +294,7 @@ export const neutralFillToggleHoverBehavior = cssCustomPropertyBehaviorFactory( ); /** * Behavior to resolve and make available the neutral-fill-toggle-active CSS custom property. + * @public */ export const neutralFillToggleActiveBehavior = cssCustomPropertyBehaviorFactory( "neutral-fill-toggle-active", @@ -273,6 +303,7 @@ export const neutralFillToggleActiveBehavior = cssCustomPropertyBehaviorFactory( ); /** * Behavior to resolve and make available the neutral-fill-toggle-focus CSS custom property. + * @public */ export const neutralFillToggleFocusBehavior = cssCustomPropertyBehaviorFactory( "neutral-fill-toggle-focus", @@ -281,6 +312,7 @@ export const neutralFillToggleFocusBehavior = cssCustomPropertyBehaviorFactory( ); /** * Behavior to resolve and make available the neutral-fill-input-rest CSS custom property. + * @public */ export const neutralFillInputRestBehavior = cssCustomPropertyBehaviorFactory( "neutral-fill-input-rest", @@ -289,6 +321,7 @@ export const neutralFillInputRestBehavior = cssCustomPropertyBehaviorFactory( ); /** * Behavior to resolve and make available the neutral-fill-input-hover CSS custom property. + * @public */ export const neutralFillInputHoverBehavior = cssCustomPropertyBehaviorFactory( "neutral-fill-input-hover", @@ -297,6 +330,7 @@ export const neutralFillInputHoverBehavior = cssCustomPropertyBehaviorFactory( ); /** * Behavior to resolve and make available the neutral-fill-input-active CSS custom property. + * @public */ export const neutralFillInputActiveBehavior = cssCustomPropertyBehaviorFactory( "neutral-fill-input-active", @@ -305,6 +339,7 @@ export const neutralFillInputActiveBehavior = cssCustomPropertyBehaviorFactory( ); /** * Behavior to resolve and make available the neutral-fill-input-focus CSS custom property. + * @public */ export const neutralFillInputFocusBehavior = cssCustomPropertyBehaviorFactory( "neutral-fill-input-focus", @@ -313,6 +348,7 @@ export const neutralFillInputFocusBehavior = cssCustomPropertyBehaviorFactory( ); /** * Behavior to resolve and make available the accent-fill-rest CSS custom property. + * @public */ export const accentFillRestBehavior = cssCustomPropertyBehaviorFactory( "accent-fill-rest", @@ -321,6 +357,7 @@ export const accentFillRestBehavior = cssCustomPropertyBehaviorFactory( ); /** * Behavior to resolve and make available the accent-fill-hover CSS custom property. + * @public */ export const accentFillHoverBehavior = cssCustomPropertyBehaviorFactory( "accent-fill-hover", @@ -329,6 +366,7 @@ export const accentFillHoverBehavior = cssCustomPropertyBehaviorFactory( ); /** * Behavior to resolve and make available the accent-fill-active CSS custom property. + * @public */ export const accentFillActiveBehavior = cssCustomPropertyBehaviorFactory( "accent-fill-active", @@ -337,6 +375,7 @@ export const accentFillActiveBehavior = cssCustomPropertyBehaviorFactory( ); /** * Behavior to resolve and make available the accent-fill-focus CSS custom property. + * @public */ export const accentFillFocusBehavior = cssCustomPropertyBehaviorFactory( "accent-fill-focus", @@ -345,6 +384,7 @@ export const accentFillFocusBehavior = cssCustomPropertyBehaviorFactory( ); /** * Behavior to resolve and make available the accent-fill-selected CSS custom property. + * @public */ export const accentFillSelectedBehavior = cssCustomPropertyBehaviorFactory( "accent-fill-selected", @@ -353,6 +393,7 @@ export const accentFillSelectedBehavior = cssCustomPropertyBehaviorFactory( ); /** * Behavior to resolve and make available the accent-fill-large-rest CSS custom property. + * @public */ export const accentFillLargeRestBehavior = cssCustomPropertyBehaviorFactory( "accent-fill-large-rest", @@ -361,6 +402,7 @@ export const accentFillLargeRestBehavior = cssCustomPropertyBehaviorFactory( ); /** * Behavior to resolve and make available the accent-fill-large-hover CSS custom property. + * @public */ export const accentFillLargeHoverBehavior = cssCustomPropertyBehaviorFactory( "accent-fill-large-hover", @@ -369,6 +411,7 @@ export const accentFillLargeHoverBehavior = cssCustomPropertyBehaviorFactory( ); /** * Behavior to resolve and make available the accent-fill-large-active CSS custom property. + * @public */ export const accentFillLargeActiveBehavior = cssCustomPropertyBehaviorFactory( "accent-fill-large-active", @@ -377,6 +420,7 @@ export const accentFillLargeActiveBehavior = cssCustomPropertyBehaviorFactory( ); /** * Behavior to resolve and make available the accent-fill-large-focus CSS custom property. + * @public */ export const accentFillLargeFocusBehavior = cssCustomPropertyBehaviorFactory( "accent-fill-large-focus", @@ -385,6 +429,7 @@ export const accentFillLargeFocusBehavior = cssCustomPropertyBehaviorFactory( ); /** * Behavior to resolve and make available the accent-fill-large-selected CSS custom property. + * @public */ export const accentFillLargeSelectedBehavior = cssCustomPropertyBehaviorFactory( "accent-fill-large-selected", @@ -393,6 +438,7 @@ export const accentFillLargeSelectedBehavior = cssCustomPropertyBehaviorFactory( ); /** * Behavior to resolve and make available the neutral-fill-card-rest CSS custom property. + * @public */ export const neutralFillCardRestBehavior = cssCustomPropertyBehaviorFactory( "neutral-fill-card-rest", @@ -401,6 +447,7 @@ export const neutralFillCardRestBehavior = cssCustomPropertyBehaviorFactory( ); /** * Behavior to resolve and make available the neutral-outline-rest CSS custom property. + * @public */ export const neutralOutlineRestBehavior = cssCustomPropertyBehaviorFactory( "neutral-outline-rest", @@ -409,6 +456,7 @@ export const neutralOutlineRestBehavior = cssCustomPropertyBehaviorFactory( ); /** * Behavior to resolve and make available the neutral-outline-hover CSS custom property. + * @public */ export const neutralOutlineHoverBehavior = cssCustomPropertyBehaviorFactory( "neutral-outline-hover", @@ -417,6 +465,7 @@ export const neutralOutlineHoverBehavior = cssCustomPropertyBehaviorFactory( ); /** * Behavior to resolve and make available the neutral-outline-active CSS custom property. + * @public */ export const neutralOutlineActiveBehavior = cssCustomPropertyBehaviorFactory( "neutral-outline-active", @@ -425,6 +474,7 @@ export const neutralOutlineActiveBehavior = cssCustomPropertyBehaviorFactory( ); /** * Behavior to resolve and make available the neutral-outline-focus CSS custom property. + * @public */ export const neutralOutlineFocusBehavior = cssCustomPropertyBehaviorFactory( "neutral-outline-focus", @@ -433,6 +483,7 @@ export const neutralOutlineFocusBehavior = cssCustomPropertyBehaviorFactory( ); /** * Behavior to resolve and make available the neutral-divider-rest CSS custom property. + * @public */ export const neutralDividerRestBehavior = cssCustomPropertyBehaviorFactory( "neutral-divider-rest", @@ -441,6 +492,7 @@ export const neutralDividerRestBehavior = cssCustomPropertyBehaviorFactory( ); /** * Behavior to resolve and make available the neutral-layer-floating CSS custom property. + * @public */ export const neutralLayerFloatingBehavior = cssCustomPropertyBehaviorFactory( "neutral-layer-floating", @@ -449,6 +501,7 @@ export const neutralLayerFloatingBehavior = cssCustomPropertyBehaviorFactory( ); /** * Behavior to resolve and make available the neutral-layer-card CSS custom property. + * @public */ export const neutralLayerCardBehavior = cssCustomPropertyBehaviorFactory( "neutral-layer-card", @@ -457,6 +510,7 @@ export const neutralLayerCardBehavior = cssCustomPropertyBehaviorFactory( ); /** * Behavior to resolve and make available the neutral-layer-card-container CSS custom property. + * @public */ export const neutralLayerCardContainerBehavior = cssCustomPropertyBehaviorFactory( "neutral-layer-card-container", @@ -465,6 +519,7 @@ export const neutralLayerCardContainerBehavior = cssCustomPropertyBehaviorFactor ); /** * Behavior to resolve and make available the neutral-layer-l1 CSS custom property. + * @public */ export const neutralLayerL1Behavior = cssCustomPropertyBehaviorFactory( "neutral-layer-l1", @@ -473,6 +528,7 @@ export const neutralLayerL1Behavior = cssCustomPropertyBehaviorFactory( ); /** * Behavior to resolve and make available the neutral-layer-l1-alt CSS custom property. + * @public */ export const neutralLayerL1AltBehavior = cssCustomPropertyBehaviorFactory( "neutral-layer-l1-alt", @@ -481,6 +537,7 @@ export const neutralLayerL1AltBehavior = cssCustomPropertyBehaviorFactory( ); /** * Behavior to resolve and make available the neutral-layer-l2 CSS custom property. + * @public */ export const neutralLayerL2Behavior = cssCustomPropertyBehaviorFactory( "neutral-layer-l2", @@ -489,6 +546,7 @@ export const neutralLayerL2Behavior = cssCustomPropertyBehaviorFactory( ); /** * Behavior to resolve and make available the neutral-layer-l3 CSS custom property. + * @public */ export const neutralLayerL3Behavior = cssCustomPropertyBehaviorFactory( "neutral-layer-l3", @@ -497,6 +555,7 @@ export const neutralLayerL3Behavior = cssCustomPropertyBehaviorFactory( ); /** * Behavior to resolve and make available the neutral-layer-l4 CSS custom property. + * @public */ export const neutralLayerL4Behavior = cssCustomPropertyBehaviorFactory( "neutral-layer-l4", @@ -505,6 +564,7 @@ export const neutralLayerL4Behavior = cssCustomPropertyBehaviorFactory( ); /** * Behavior to resolve and make available the neutral-focus CSS custom property. + * @public */ export const neutralFocusBehavior = cssCustomPropertyBehaviorFactory( "neutral-focus", @@ -513,6 +573,7 @@ export const neutralFocusBehavior = cssCustomPropertyBehaviorFactory( ); /** * Behavior to resolve and make available the neutral-focus-inner-accent CSS custom property. + * @public */ export const neutralFocusInnerAccentBehavior = cssCustomPropertyBehaviorFactory( "neutral-focus-inner-accent", diff --git a/packages/web-components/fast-components/src/switch/index.ts b/packages/web-components/fast-components/src/switch/index.ts index a88348c7af1..870cf7a7703 100644 --- a/packages/web-components/fast-components/src/switch/index.ts +++ b/packages/web-components/fast-components/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/src/tabs/index.ts b/packages/web-components/fast-components/src/tabs/index.ts index f0d1a4b26c8..6c40ff58119 100644 --- a/packages/web-components/fast-components/src/tabs/index.ts +++ b/packages/web-components/fast-components/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/src/tabs/tab-panel/index.ts b/packages/web-components/fast-components/src/tabs/tab-panel/index.ts index 021baa40986..e1a3d585e37 100644 --- a/packages/web-components/fast-components/src/tabs/tab-panel/index.ts +++ b/packages/web-components/fast-components/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/src/tabs/tab/index.ts b/packages/web-components/fast-components/src/tabs/tab/index.ts index d19777c7797..51d67ddab03 100644 --- a/packages/web-components/fast-components/src/tabs/tab/index.ts +++ b/packages/web-components/fast-components/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/src/text-area/index.ts b/packages/web-components/fast-components/src/text-area/index.ts index c39a4060a4a..75a621a37b7 100644 --- a/packages/web-components/fast-components/src/text-area/index.ts +++ b/packages/web-components/fast-components/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/src/text-field/index.ts b/packages/web-components/fast-components/src/text-field/index.ts index 0efecfcb240..01613ae9305 100644 --- a/packages/web-components/fast-components/src/text-field/index.ts +++ b/packages/web-components/fast-components/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/temp/api-report.md b/packages/web-components/fast-components/temp/api-report.md index 42a8e2707e2..23218565aae 100644 --- a/packages/web-components/fast-components/temp/api-report.md +++ b/packages/web-components/fast-components/temp/api-report.md @@ -192,37 +192,153 @@ export const accentForegroundRestBehavior: import("@microsoft/fast-foundation"). // @public export function createColorPalette(baseColor: any): 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 { } -// @public (undocumented) +// @public export class FASTButton extends Button { } -// @public (undocumented) +// @public export class FASTCard extends Card { } -// @public (undocumented) +// @public export class FASTCheckbox extends Checkbox { } -// Warning: (ae-forgotten-export) The symbol "FASTDesignSystem" needs to be exported by the entry point index.d.ts -// -// @public (undocumented) +// @public +export interface FASTDesignSystem { + accentBaseColor: string; + // (undocumented) + accentFillActiveDelta: number; + // (undocumented) + accentFillFocusDelta: number; + // (undocumented) + accentFillHoverDelta: number; + accentFillRestDelta: number; + // (undocumented) + accentFillSelectedDelta: number; + // (undocumented) + accentForegroundActiveDelta: number; + // (undocumented) + accentForegroundFocusDelta: number; + // (undocumented) + accentForegroundHoverDelta: number; + accentForegroundRestDelta: number; + accentPalette: string[]; + backgroundColor: string; + baseHeightMultiplier: number; + baseHorizontalSpacingMultiplier: number; + baseLayerLuminance: number; + cornerRadius: number; + density: number; + designUnit: number; + disabledOpacity: number; + focusOutlineWidth: number; + neutralDividerRestDelta: number; + // (undocumented) + neutralFillActiveDelta: number; + neutralFillCardDelta: number; + // (undocumented) + neutralFillFocusDelta: number; + // (undocumented) + neutralFillHoverDelta: number; + // (undocumented) + neutralFillInputActiveDelta: number; + // (undocumented) + neutralFillInputFocusDelta: number; + // (undocumented) + neutralFillInputHoverDelta: number; + neutralFillInputRestDelta: number; + // (undocumented) + neutralFillInputSelectedDelta: number; + // (undocumented) + neutralFillRestDelta: number; + // (undocumented) + neutralFillSelectedDelta: number; + // (undocumented) + neutralFillStealthActiveDelta: number; + // (undocumented) + neutralFillStealthFocusDelta: number; + // (undocumented) + neutralFillStealthHoverDelta: number; + neutralFillStealthRestDelta: number; + // (undocumented) + neutralFillStealthSelectedDelta: number; + // (undocumented) + neutralFillToggleActiveDelta: number; + // (undocumented) + neutralFillToggleFocusDelta: number; + neutralFillToggleHoverDelta: number; + // (undocumented) + neutralForegroundActiveDelta: number; + // (undocumented) + neutralForegroundFocusDelta: number; + neutralForegroundHoverDelta: number; + // (undocumented) + neutralOutlineActiveDelta: number; + // (undocumented) + neutralOutlineFocusDelta: number; + // (undocumented) + neutralOutlineHoverDelta: number; + neutralOutlineRestDelta: number; + neutralPalette: string[]; + outlineWidth: number; + // (undocumented) + typeRampBaseFontSize: string; + // (undocumented) + typeRampBaseLineHeight: string; + // (undocumented) + typeRampMinus1FontSize: string; + // (undocumented) + typeRampMinus1LineHeight: string; + typeRampMinus2FontSize: string; + // (undocumented) + typeRampMinus2LineHeight: string; + // (undocumented) + typeRampPlus1FontSize: string; + // (undocumented) + typeRampPlus1LineHeight: string; + // (undocumented) + typeRampPlus2FontSize: string; + // (undocumented) + typeRampPlus2LineHeight: string; + // (undocumented) + typeRampPlus3FontSize: string; + // (undocumented) + typeRampPlus3LineHeight: string; + // (undocumented) + typeRampPlus4FontSize: string; + // (undocumented) + typeRampPlus4LineHeight: string; + // (undocumented) + typeRampPlus5FontSize: string; + // (undocumented) + typeRampPlus5LineHeight: string; + // (undocumented) + typeRampPlus6FontSize: string; + // (undocumented) + typeRampPlus6LineHeight: string; +} + +// @public +export const fastDesignSystemDefaults: FASTDesignSystem; + +// @public export class FASTDesignSystemProvider extends DesignSystemProvider implements FASTDesignSystem { accentBaseColor: string; // (undocumented) @@ -357,71 +473,71 @@ export class FASTDesignSystemProvider extends DesignSystemProvider implements FA 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 FASTMenu extends Menu { } -// @public (undocumented) +// @public export class FASTMenuItem extends MenuItem { } -// @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 { } @@ -451,14 +567,14 @@ export const neutralFillActive: SwatchRecipe; export const neutralFillActiveBehavior: import("@microsoft/fast-foundation").CSSCustomPropertyBehavior; // Warning: (ae-forgotten-export) The symbol "Swatch" needs to be exported by the entry point index.d.ts -// Warning: (ae-internal-mixed-release-tag) Mixed release tags are not allowed for "neutralFillCard" because one of its declarations is marked as @internal +// Warning: (ae-internal-missing-underscore) The name "neutralFillCard" should be prefixed with an underscore because the declaration is marked as @internal // // @internal (undocumented) export function neutralFillCard(designSystem: FASTDesignSystem): Swatch; // Warning: (ae-forgotten-export) The symbol "SwatchResolver" needs to be exported by the entry point index.d.ts // -// @public (undocumented) +// @internal (undocumented) export function neutralFillCard(backgroundResolver: SwatchResolver): SwatchResolver; // @public 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 9ea0dfd5386..8711c746401 100644 --- a/sites/website/src/docs/api/fast-components-msft.api.json +++ b/sites/website/src/docs/api/fast-components-msft.api.json @@ -16,310 +16,698 @@ "name": "", "members": [ { - "kind": "TypeAlias", - "canonicalReference": "@microsoft/fast-components-msft!BadgeAppearance:type", + "kind": "Variable", + "canonicalReference": "@microsoft/fast-components-msft!accentFillActiveBehavior:var", "docComment": "", "excerptTokens": [ { "kind": "Content", - "text": "export declare type BadgeAppearance = " + "text": "accentFillActiveBehavior: " }, { "kind": "Content", - "text": "\"accent\" | \"lightweight\" | \"neutral\" | string" + "text": "import(\"@microsoft/fast-foundation\")." }, { - "kind": "Content", - "text": ";" + "kind": "Reference", + "text": "CSSCustomPropertyBehavior", + "canonicalReference": "@microsoft/fast-foundation!CSSCustomPropertyBehavior:class" } ], "releaseTag": "Public", - "name": "BadgeAppearance", - "typeTokenRange": { + "name": "accentFillActiveBehavior", + "variableTypeTokenRange": { "startIndex": 1, - "endIndex": 2 + "endIndex": 3 } }, { - "kind": "Class", - "canonicalReference": "@microsoft/fast-components-msft!FASTAccordion:class", + "kind": "Variable", + "canonicalReference": "@microsoft/fast-components-msft!accentFillFocusBehavior:var", "docComment": "", "excerptTokens": [ { "kind": "Content", - "text": "export declare class FASTAccordion extends " + "text": "accentFillFocusBehavior: " }, { - "kind": "Reference", - "text": "Accordion", - "canonicalReference": "@microsoft/fast-foundation!Accordion:class" + "kind": "Content", + "text": "import(\"@microsoft/fast-foundation\")." }, { - "kind": "Content", - "text": " " + "kind": "Reference", + "text": "CSSCustomPropertyBehavior", + "canonicalReference": "@microsoft/fast-foundation!CSSCustomPropertyBehavior:class" } ], "releaseTag": "Public", - "name": "FASTAccordion", - "members": [], - "extendsTokenRange": { + "name": "accentFillFocusBehavior", + "variableTypeTokenRange": { "startIndex": 1, "endIndex": 3 - }, - "implementsTokenRanges": [] + } }, { - "kind": "Class", - "canonicalReference": "@microsoft/fast-components-msft!FASTAccordionItem:class", + "kind": "Variable", + "canonicalReference": "@microsoft/fast-components-msft!accentFillHoverBehavior:var", "docComment": "", "excerptTokens": [ { "kind": "Content", - "text": "export declare class FASTAccordionItem extends " + "text": "accentFillHoverBehavior: " }, { - "kind": "Reference", - "text": "AccordionItem", - "canonicalReference": "@microsoft/fast-foundation!AccordionItem:class" + "kind": "Content", + "text": "import(\"@microsoft/fast-foundation\")." }, { - "kind": "Content", - "text": " " + "kind": "Reference", + "text": "CSSCustomPropertyBehavior", + "canonicalReference": "@microsoft/fast-foundation!CSSCustomPropertyBehavior:class" } ], "releaseTag": "Public", - "name": "FASTAccordionItem", - "members": [], - "extendsTokenRange": { + "name": "accentFillHoverBehavior", + "variableTypeTokenRange": { "startIndex": 1, "endIndex": 3 - }, - "implementsTokenRanges": [] + } }, { - "kind": "Class", - "canonicalReference": "@microsoft/fast-components-msft!FASTAnchor:class", + "kind": "Variable", + "canonicalReference": "@microsoft/fast-components-msft!accentFillLargeActiveBehavior:var", "docComment": "", "excerptTokens": [ { "kind": "Content", - "text": "export declare class FASTAnchor extends " + "text": "accentFillLargeActiveBehavior: " }, { - "kind": "Reference", - "text": "Anchor", - "canonicalReference": "@microsoft/fast-foundation!Anchor:class" + "kind": "Content", + "text": "import(\"@microsoft/fast-foundation\")." }, { - "kind": "Content", - "text": " " + "kind": "Reference", + "text": "CSSCustomPropertyBehavior", + "canonicalReference": "@microsoft/fast-foundation!CSSCustomPropertyBehavior:class" } ], "releaseTag": "Public", - "name": "FASTAnchor", - "members": [], - "extendsTokenRange": { + "name": "accentFillLargeActiveBehavior", + "variableTypeTokenRange": { "startIndex": 1, "endIndex": 3 - }, - "implementsTokenRanges": [] + } }, { - "kind": "Class", - "canonicalReference": "@microsoft/fast-components-msft!FASTBadge:class", + "kind": "Variable", + "canonicalReference": "@microsoft/fast-components-msft!accentFillLargeFocusBehavior:var", "docComment": "", "excerptTokens": [ { "kind": "Content", - "text": "export declare class FASTBadge extends " + "text": "accentFillLargeFocusBehavior: " }, { - "kind": "Reference", - "text": "Badge", - "canonicalReference": "@microsoft/fast-foundation!Badge:class" + "kind": "Content", + "text": "import(\"@microsoft/fast-foundation\")." }, { - "kind": "Content", - "text": " " + "kind": "Reference", + "text": "CSSCustomPropertyBehavior", + "canonicalReference": "@microsoft/fast-foundation!CSSCustomPropertyBehavior:class" } ], "releaseTag": "Public", - "name": "FASTBadge", - "members": [ + "name": "accentFillLargeFocusBehavior", + "variableTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + }, + { + "kind": "Variable", + "canonicalReference": "@microsoft/fast-components-msft!accentFillLargeHoverBehavior:var", + "docComment": "", + "excerptTokens": [ { - "kind": "Property", - "canonicalReference": "@microsoft/fast-components-msft!FASTBadge#appearance:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "appearance: " - }, - { - "kind": "Reference", - "text": "BadgeAppearance", - "canonicalReference": "@microsoft/fast-components-msft!BadgeAppearance:type" - }, - { - "kind": "Content", - "text": ";" - } - ], - "releaseTag": "Public", - "name": "appearance", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isStatic": false + "kind": "Content", + "text": "accentFillLargeHoverBehavior: " + }, + { + "kind": "Content", + "text": "import(\"@microsoft/fast-foundation\")." + }, + { + "kind": "Reference", + "text": "CSSCustomPropertyBehavior", + "canonicalReference": "@microsoft/fast-foundation!CSSCustomPropertyBehavior:class" } ], - "extendsTokenRange": { + "releaseTag": "Public", + "name": "accentFillLargeHoverBehavior", + "variableTypeTokenRange": { "startIndex": 1, "endIndex": 3 - }, - "implementsTokenRanges": [] + } }, { - "kind": "Class", - "canonicalReference": "@microsoft/fast-components-msft!FASTButton:class", + "kind": "Variable", + "canonicalReference": "@microsoft/fast-components-msft!accentFillLargeRestBehavior:var", "docComment": "", "excerptTokens": [ { "kind": "Content", - "text": "export declare class FASTButton extends " + "text": "accentFillLargeRestBehavior: " }, { - "kind": "Reference", - "text": "Button", - "canonicalReference": "@microsoft/fast-foundation!Button:class" + "kind": "Content", + "text": "import(\"@microsoft/fast-foundation\")." }, { - "kind": "Content", - "text": " " + "kind": "Reference", + "text": "CSSCustomPropertyBehavior", + "canonicalReference": "@microsoft/fast-foundation!CSSCustomPropertyBehavior:class" } ], "releaseTag": "Public", - "name": "FASTButton", - "members": [], - "extendsTokenRange": { + "name": "accentFillLargeRestBehavior", + "variableTypeTokenRange": { "startIndex": 1, "endIndex": 3 - }, - "implementsTokenRanges": [] + } }, { - "kind": "Class", - "canonicalReference": "@microsoft/fast-components-msft!FASTCard:class", + "kind": "Variable", + "canonicalReference": "@microsoft/fast-components-msft!accentFillLargeSelectedBehavior:var", "docComment": "", "excerptTokens": [ { "kind": "Content", - "text": "export declare class FASTCard extends " + "text": "accentFillLargeSelectedBehavior: " + }, + { + "kind": "Content", + "text": "import(\"@microsoft/fast-foundation\")." }, { "kind": "Reference", - "text": "Card", - "canonicalReference": "@microsoft/fast-foundation!Card:class" + "text": "CSSCustomPropertyBehavior", + "canonicalReference": "@microsoft/fast-foundation!CSSCustomPropertyBehavior:class" + } + ], + "releaseTag": "Public", + "name": "accentFillLargeSelectedBehavior", + "variableTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + }, + { + "kind": "Variable", + "canonicalReference": "@microsoft/fast-components-msft!accentFillRestBehavior:var", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "accentFillRestBehavior: " }, { "kind": "Content", - "text": " " + "text": "import(\"@microsoft/fast-foundation\")." + }, + { + "kind": "Reference", + "text": "CSSCustomPropertyBehavior", + "canonicalReference": "@microsoft/fast-foundation!CSSCustomPropertyBehavior:class" } ], "releaseTag": "Public", - "name": "FASTCard", - "members": [], - "extendsTokenRange": { + "name": "accentFillRestBehavior", + "variableTypeTokenRange": { "startIndex": 1, "endIndex": 3 - }, - "implementsTokenRanges": [] + } }, { - "kind": "Class", - "canonicalReference": "@microsoft/fast-components-msft!FASTCheckbox:class", + "kind": "Variable", + "canonicalReference": "@microsoft/fast-components-msft!accentFillSelectedBehavior:var", "docComment": "", "excerptTokens": [ { "kind": "Content", - "text": "export declare class FASTCheckbox extends " + "text": "accentFillSelectedBehavior: " + }, + { + "kind": "Content", + "text": "import(\"@microsoft/fast-foundation\")." }, { "kind": "Reference", - "text": "Checkbox", - "canonicalReference": "@microsoft/fast-foundation!Checkbox:class" + "text": "CSSCustomPropertyBehavior", + "canonicalReference": "@microsoft/fast-foundation!CSSCustomPropertyBehavior:class" + } + ], + "releaseTag": "Public", + "name": "accentFillSelectedBehavior", + "variableTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + }, + { + "kind": "Variable", + "canonicalReference": "@microsoft/fast-components-msft!accentForegroundActiveBehavior:var", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "accentForegroundActiveBehavior: " }, { "kind": "Content", - "text": " " + "text": "import(\"@microsoft/fast-foundation\")." + }, + { + "kind": "Reference", + "text": "CSSCustomPropertyBehavior", + "canonicalReference": "@microsoft/fast-foundation!CSSCustomPropertyBehavior:class" } ], "releaseTag": "Public", - "name": "FASTCheckbox", - "members": [], - "extendsTokenRange": { + "name": "accentForegroundActiveBehavior", + "variableTypeTokenRange": { "startIndex": 1, "endIndex": 3 - }, - "implementsTokenRanges": [] + } }, { - "kind": "Class", - "canonicalReference": "@microsoft/fast-components-msft!FASTDesignSystemProvider:class", + "kind": "Variable", + "canonicalReference": "@microsoft/fast-components-msft!accentForegroundCutRestBehavior:var", "docComment": "", "excerptTokens": [ { "kind": "Content", - "text": "export declare class FASTDesignSystemProvider extends " + "text": "accentForegroundCutRestBehavior: " }, { - "kind": "Reference", - "text": "DesignSystemProvider", - "canonicalReference": "@microsoft/fast-foundation!DesignSystemProvider:class" + "kind": "Content", + "text": "import(\"@microsoft/fast-foundation\")." }, + { + "kind": "Reference", + "text": "CSSCustomPropertyBehavior", + "canonicalReference": "@microsoft/fast-foundation!CSSCustomPropertyBehavior:class" + } + ], + "releaseTag": "Public", + "name": "accentForegroundCutRestBehavior", + "variableTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + }, + { + "kind": "Variable", + "canonicalReference": "@microsoft/fast-components-msft!accentForegroundFocusBehavior:var", + "docComment": "", + "excerptTokens": [ { "kind": "Content", - "text": " " + "text": "accentForegroundFocusBehavior: " }, { "kind": "Content", - "text": "implements " + "text": "import(\"@microsoft/fast-foundation\")." }, { "kind": "Reference", - "text": "Omit", - "canonicalReference": "!Omit:type" + "text": "CSSCustomPropertyBehavior", + "canonicalReference": "@microsoft/fast-foundation!CSSCustomPropertyBehavior:class" + } + ], + "releaseTag": "Public", + "name": "accentForegroundFocusBehavior", + "variableTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + }, + { + "kind": "Variable", + "canonicalReference": "@microsoft/fast-components-msft!accentForegroundHoverBehavior:var", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "accentForegroundHoverBehavior: " }, { "kind": "Content", - "text": "<" + "text": "import(\"@microsoft/fast-foundation\")." }, { "kind": "Reference", - "text": "DesignSystem", - "canonicalReference": "@microsoft/fast-components-styles-msft!DesignSystem:interface" + "text": "CSSCustomPropertyBehavior", + "canonicalReference": "@microsoft/fast-foundation!CSSCustomPropertyBehavior:class" + } + ], + "releaseTag": "Public", + "name": "accentForegroundHoverBehavior", + "variableTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + }, + { + "kind": "Variable", + "canonicalReference": "@microsoft/fast-components-msft!accentForegroundLargeActiveBehavior:var", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "accentForegroundLargeActiveBehavior: " }, { "kind": "Content", - "text": ", \"contrast\" | \"direction\" | \"fontWeight\" | \"neutralForegroundDarkIndex\" | \"neutralForegroundLightIndex\"> " + "text": "import(\"@microsoft/fast-foundation\")." + }, + { + "kind": "Reference", + "text": "CSSCustomPropertyBehavior", + "canonicalReference": "@microsoft/fast-foundation!CSSCustomPropertyBehavior:class" } ], "releaseTag": "Public", - "name": "FASTDesignSystemProvider", - "members": [ + "name": "accentForegroundLargeActiveBehavior", + "variableTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + }, + { + "kind": "Variable", + "canonicalReference": "@microsoft/fast-components-msft!accentForegroundLargeFocusBehavior:var", + "docComment": "", + "excerptTokens": [ { - "kind": "Property", - "canonicalReference": "@microsoft/fast-components-msft!FASTDesignSystemProvider#accentBaseColor:member", + "kind": "Content", + "text": "accentForegroundLargeFocusBehavior: " + }, + { + "kind": "Content", + "text": "import(\"@microsoft/fast-foundation\")." + }, + { + "kind": "Reference", + "text": "CSSCustomPropertyBehavior", + "canonicalReference": "@microsoft/fast-foundation!CSSCustomPropertyBehavior:class" + } + ], + "releaseTag": "Public", + "name": "accentForegroundLargeFocusBehavior", + "variableTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + }, + { + "kind": "Variable", + "canonicalReference": "@microsoft/fast-components-msft!accentForegroundLargeHoverBehavior:var", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "accentForegroundLargeHoverBehavior: " + }, + { + "kind": "Content", + "text": "import(\"@microsoft/fast-foundation\")." + }, + { + "kind": "Reference", + "text": "CSSCustomPropertyBehavior", + "canonicalReference": "@microsoft/fast-foundation!CSSCustomPropertyBehavior:class" + } + ], + "releaseTag": "Public", + "name": "accentForegroundLargeHoverBehavior", + "variableTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + }, + { + "kind": "Variable", + "canonicalReference": "@microsoft/fast-components-msft!accentForegroundLargeRestBehavior:var", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "accentForegroundLargeRestBehavior: " + }, + { + "kind": "Content", + "text": "import(\"@microsoft/fast-foundation\")." + }, + { + "kind": "Reference", + "text": "CSSCustomPropertyBehavior", + "canonicalReference": "@microsoft/fast-foundation!CSSCustomPropertyBehavior:class" + } + ], + "releaseTag": "Public", + "name": "accentForegroundLargeRestBehavior", + "variableTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + }, + { + "kind": "Variable", + "canonicalReference": "@microsoft/fast-components-msft!accentForegroundRestBehavior:var", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "accentForegroundRestBehavior: " + }, + { + "kind": "Content", + "text": "import(\"@microsoft/fast-foundation\")." + }, + { + "kind": "Reference", + "text": "CSSCustomPropertyBehavior", + "canonicalReference": "@microsoft/fast-foundation!CSSCustomPropertyBehavior:class" + } + ], + "releaseTag": "Public", + "name": "accentForegroundRestBehavior", + "variableTypeTokenRange": { + "startIndex": 1, + "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": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare type BadgeAppearance = " + }, + { + "kind": "Content", + "text": "\"accent\" | \"lightweight\" | \"neutral\" | string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "BadgeAppearance", + "typeTokenRange": { + "startIndex": 1, + "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": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "elevation: " + }, + { + "kind": "Content", + "text": "string" + } + ], + "releaseTag": "Public", + "name": "elevation", + "variableTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "Class", + "canonicalReference": "@microsoft/fast-components-msft!FASTAccordion:class", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare class FASTAccordion extends " + }, + { + "kind": "Reference", + "text": "Accordion", + "canonicalReference": "@microsoft/fast-foundation!Accordion:class" + }, + { + "kind": "Content", + "text": " " + } + ], + "releaseTag": "Public", + "name": "FASTAccordion", + "members": [], + "extendsTokenRange": { + "startIndex": 1, + "endIndex": 3 + }, + "implementsTokenRanges": [] + }, + { + "kind": "Class", + "canonicalReference": "@microsoft/fast-components-msft!FASTAccordionItem:class", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare class FASTAccordionItem extends " + }, + { + "kind": "Reference", + "text": "AccordionItem", + "canonicalReference": "@microsoft/fast-foundation!AccordionItem:class" + }, + { + "kind": "Content", + "text": " " + } + ], + "releaseTag": "Public", + "name": "FASTAccordionItem", + "members": [], + "extendsTokenRange": { + "startIndex": 1, + "endIndex": 3 + }, + "implementsTokenRanges": [] + }, + { + "kind": "Class", + "canonicalReference": "@microsoft/fast-components-msft!FASTAnchor:class", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare class FASTAnchor extends " + }, + { + "kind": "Reference", + "text": "Anchor", + "canonicalReference": "@microsoft/fast-foundation!Anchor:class" + }, + { + "kind": "Content", + "text": " " + } + ], + "releaseTag": "Public", + "name": "FASTAnchor", + "members": [], + "extendsTokenRange": { + "startIndex": 1, + "endIndex": 3 + }, + "implementsTokenRanges": [] + }, + { + "kind": "Class", + "canonicalReference": "@microsoft/fast-components-msft!FASTBadge:class", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare class FASTBadge extends " + }, + { + "kind": "Reference", + "text": "Badge", + "canonicalReference": "@microsoft/fast-foundation!Badge:class" + }, + { + "kind": "Content", + "text": " " + } + ], + "releaseTag": "Public", + "name": "FASTBadge", + "members": [ + { + "kind": "Property", + "canonicalReference": "@microsoft/fast-components-msft!FASTBadge#appearance:member", "docComment": "", "excerptTokens": [ { "kind": "Content", - "text": "accentBaseColor: " + "text": "appearance: " }, { - "kind": "Content", - "text": "string" + "kind": "Reference", + "text": "BadgeAppearance", + "canonicalReference": "@microsoft/fast-components-msft!BadgeAppearance:type" }, { "kind": "Content", @@ -327,23 +715,184 @@ } ], "releaseTag": "Public", - "name": "accentBaseColor", + "name": "appearance", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false - }, - { - "kind": "Property", - "canonicalReference": "@microsoft/fast-components-msft!FASTDesignSystemProvider#accentFillActiveDelta:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "accentFillActiveDelta: " - }, - { + } + ], + "extendsTokenRange": { + "startIndex": 1, + "endIndex": 3 + }, + "implementsTokenRanges": [] + }, + { + "kind": "Class", + "canonicalReference": "@microsoft/fast-components-msft!FASTButton:class", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare class FASTButton extends " + }, + { + "kind": "Reference", + "text": "Button", + "canonicalReference": "@microsoft/fast-foundation!Button:class" + }, + { + "kind": "Content", + "text": " " + } + ], + "releaseTag": "Public", + "name": "FASTButton", + "members": [], + "extendsTokenRange": { + "startIndex": 1, + "endIndex": 3 + }, + "implementsTokenRanges": [] + }, + { + "kind": "Class", + "canonicalReference": "@microsoft/fast-components-msft!FASTCard:class", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare class FASTCard extends " + }, + { + "kind": "Reference", + "text": "Card", + "canonicalReference": "@microsoft/fast-foundation!Card:class" + }, + { + "kind": "Content", + "text": " " + } + ], + "releaseTag": "Public", + "name": "FASTCard", + "members": [], + "extendsTokenRange": { + "startIndex": 1, + "endIndex": 3 + }, + "implementsTokenRanges": [] + }, + { + "kind": "Class", + "canonicalReference": "@microsoft/fast-components-msft!FASTCheckbox:class", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare class FASTCheckbox extends " + }, + { + "kind": "Reference", + "text": "Checkbox", + "canonicalReference": "@microsoft/fast-foundation!Checkbox:class" + }, + { + "kind": "Content", + "text": " " + } + ], + "releaseTag": "Public", + "name": "FASTCheckbox", + "members": [], + "extendsTokenRange": { + "startIndex": 1, + "endIndex": 3 + }, + "implementsTokenRanges": [] + }, + { + "kind": "Class", + "canonicalReference": "@microsoft/fast-components-msft!FASTDesignSystemProvider:class", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare class FASTDesignSystemProvider extends " + }, + { + "kind": "Reference", + "text": "DesignSystemProvider", + "canonicalReference": "@microsoft/fast-foundation!DesignSystemProvider:class" + }, + { + "kind": "Content", + "text": " " + }, + { + "kind": "Content", + "text": "implements " + }, + { + "kind": "Reference", + "text": "Omit", + "canonicalReference": "!Omit:type" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "DesignSystem", + "canonicalReference": "@microsoft/fast-components-styles-msft!DesignSystem:interface" + }, + { + "kind": "Content", + "text": ", \"contrast\" | \"direction\" | \"fontWeight\" | \"neutralForegroundDarkIndex\" | \"neutralForegroundLightIndex\"> " + } + ], + "releaseTag": "Public", + "name": "FASTDesignSystemProvider", + "members": [ + { + "kind": "Property", + "canonicalReference": "@microsoft/fast-components-msft!FASTDesignSystemProvider#accentBaseColor:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "accentBaseColor: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "accentBaseColor", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Property", + "canonicalReference": "@microsoft/fast-components-msft!FASTDesignSystemProvider#accentFillActiveDelta:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "accentFillActiveDelta: " + }, + { "kind": "Content", "text": "number" }, @@ -2104,436 +2653,1545 @@ "isStatic": false } ], - "extendsTokenRange": { + "extendsTokenRange": { + "startIndex": 1, + "endIndex": 3 + }, + "implementsTokenRanges": [ + { + "startIndex": 4, + "endIndex": 8 + } + ] + }, + { + "kind": "Class", + "canonicalReference": "@microsoft/fast-components-msft!FASTDialog:class", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare class FASTDialog extends " + }, + { + "kind": "Reference", + "text": "Dialog", + "canonicalReference": "@microsoft/fast-foundation!Dialog:class" + }, + { + "kind": "Content", + "text": " " + } + ], + "releaseTag": "Public", + "name": "FASTDialog", + "members": [], + "extendsTokenRange": { + "startIndex": 1, + "endIndex": 3 + }, + "implementsTokenRanges": [] + }, + { + "kind": "Class", + "canonicalReference": "@microsoft/fast-components-msft!FASTDivider:class", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare class FASTDivider extends " + }, + { + "kind": "Reference", + "text": "Divider", + "canonicalReference": "@microsoft/fast-foundation!Divider:class" + }, + { + "kind": "Content", + "text": " " + } + ], + "releaseTag": "Public", + "name": "FASTDivider", + "members": [], + "extendsTokenRange": { + "startIndex": 1, + "endIndex": 3 + }, + "implementsTokenRanges": [] + }, + { + "kind": "Class", + "canonicalReference": "@microsoft/fast-components-msft!FASTFlipper:class", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare class FASTFlipper extends " + }, + { + "kind": "Reference", + "text": "Flipper", + "canonicalReference": "@microsoft/fast-foundation!Flipper:class" + }, + { + "kind": "Content", + "text": " " + } + ], + "releaseTag": "Public", + "name": "FASTFlipper", + "members": [], + "extendsTokenRange": { + "startIndex": 1, + "endIndex": 3 + }, + "implementsTokenRanges": [] + }, + { + "kind": "Class", + "canonicalReference": "@microsoft/fast-components-msft!FASTProgress:class", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare class FASTProgress extends " + }, + { + "kind": "Reference", + "text": "BaseProgress", + "canonicalReference": "@microsoft/fast-foundation!BaseProgress:class" + }, + { + "kind": "Content", + "text": " " + } + ], + "releaseTag": "Public", + "name": "FASTProgress", + "members": [], + "extendsTokenRange": { + "startIndex": 1, + "endIndex": 3 + }, + "implementsTokenRanges": [] + }, + { + "kind": "Class", + "canonicalReference": "@microsoft/fast-components-msft!FASTProgressRing:class", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare class FASTProgressRing extends " + }, + { + "kind": "Reference", + "text": "BaseProgress", + "canonicalReference": "@microsoft/fast-foundation!BaseProgress:class" + }, + { + "kind": "Content", + "text": " " + } + ], + "releaseTag": "Public", + "name": "FASTProgressRing", + "members": [], + "extendsTokenRange": { + "startIndex": 1, + "endIndex": 3 + }, + "implementsTokenRanges": [] + }, + { + "kind": "Class", + "canonicalReference": "@microsoft/fast-components-msft!FASTRadio:class", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare class FASTRadio extends " + }, + { + "kind": "Reference", + "text": "Radio", + "canonicalReference": "@microsoft/fast-foundation!Radio:class" + }, + { + "kind": "Content", + "text": " " + } + ], + "releaseTag": "Public", + "name": "FASTRadio", + "members": [], + "extendsTokenRange": { + "startIndex": 1, + "endIndex": 3 + }, + "implementsTokenRanges": [] + }, + { + "kind": "Class", + "canonicalReference": "@microsoft/fast-components-msft!FASTRadioGroup:class", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare class FASTRadioGroup extends " + }, + { + "kind": "Reference", + "text": "RadioGroup", + "canonicalReference": "@microsoft/fast-foundation!RadioGroup:class" + }, + { + "kind": "Content", + "text": " " + } + ], + "releaseTag": "Public", + "name": "FASTRadioGroup", + "members": [], + "extendsTokenRange": { + "startIndex": 1, + "endIndex": 3 + }, + "implementsTokenRanges": [] + }, + { + "kind": "Class", + "canonicalReference": "@microsoft/fast-components-msft!FASTSlider:class", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare class FASTSlider extends " + }, + { + "kind": "Reference", + "text": "Slider", + "canonicalReference": "@microsoft/fast-foundation!Slider:class" + }, + { + "kind": "Content", + "text": " " + } + ], + "releaseTag": "Public", + "name": "FASTSlider", + "members": [], + "extendsTokenRange": { + "startIndex": 1, + "endIndex": 3 + }, + "implementsTokenRanges": [] + }, + { + "kind": "Class", + "canonicalReference": "@microsoft/fast-components-msft!FASTSliderLabel:class", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare class FASTSliderLabel extends " + }, + { + "kind": "Reference", + "text": "SliderLabel", + "canonicalReference": "@microsoft/fast-foundation!SliderLabel:class" + }, + { + "kind": "Content", + "text": " " + } + ], + "releaseTag": "Public", + "name": "FASTSliderLabel", + "members": [], + "extendsTokenRange": { + "startIndex": 1, + "endIndex": 3 + }, + "implementsTokenRanges": [] + }, + { + "kind": "Class", + "canonicalReference": "@microsoft/fast-components-msft!FASTSwitch:class", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare class FASTSwitch extends " + }, + { + "kind": "Reference", + "text": "Switch", + "canonicalReference": "@microsoft/fast-foundation!Switch:class" + }, + { + "kind": "Content", + "text": " " + } + ], + "releaseTag": "Public", + "name": "FASTSwitch", + "members": [], + "extendsTokenRange": { + "startIndex": 1, + "endIndex": 3 + }, + "implementsTokenRanges": [] + }, + { + "kind": "Class", + "canonicalReference": "@microsoft/fast-components-msft!FASTTab:class", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare class FASTTab extends " + }, + { + "kind": "Reference", + "text": "Tab", + "canonicalReference": "@microsoft/fast-foundation!Tab:class" + }, + { + "kind": "Content", + "text": " " + } + ], + "releaseTag": "Public", + "name": "FASTTab", + "members": [], + "extendsTokenRange": { + "startIndex": 1, + "endIndex": 3 + }, + "implementsTokenRanges": [] + }, + { + "kind": "Class", + "canonicalReference": "@microsoft/fast-components-msft!FASTTabPanel:class", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare class FASTTabPanel extends " + }, + { + "kind": "Reference", + "text": "TabPanel", + "canonicalReference": "@microsoft/fast-foundation!TabPanel:class" + }, + { + "kind": "Content", + "text": " " + } + ], + "releaseTag": "Public", + "name": "FASTTabPanel", + "members": [], + "extendsTokenRange": { + "startIndex": 1, + "endIndex": 3 + }, + "implementsTokenRanges": [] + }, + { + "kind": "Class", + "canonicalReference": "@microsoft/fast-components-msft!FASTTabs:class", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare class FASTTabs extends " + }, + { + "kind": "Reference", + "text": "Tabs", + "canonicalReference": "@microsoft/fast-foundation!Tabs:class" + }, + { + "kind": "Content", + "text": " " + } + ], + "releaseTag": "Public", + "name": "FASTTabs", + "members": [], + "extendsTokenRange": { + "startIndex": 1, + "endIndex": 3 + }, + "implementsTokenRanges": [] + }, + { + "kind": "Class", + "canonicalReference": "@microsoft/fast-components-msft!FASTTextArea:class", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare class FASTTextArea extends " + }, + { + "kind": "Reference", + "text": "TextArea", + "canonicalReference": "@microsoft/fast-foundation!TextArea:class" + }, + { + "kind": "Content", + "text": " " + } + ], + "releaseTag": "Public", + "name": "FASTTextArea", + "members": [], + "extendsTokenRange": { + "startIndex": 1, + "endIndex": 3 + }, + "implementsTokenRanges": [] + }, + { + "kind": "Class", + "canonicalReference": "@microsoft/fast-components-msft!FASTTextField:class", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare class FASTTextField extends " + }, + { + "kind": "Reference", + "text": "TextField", + "canonicalReference": "@microsoft/fast-foundation!TextField:class" + }, + { + "kind": "Content", + "text": " " + } + ], + "releaseTag": "Public", + "name": "FASTTextField", + "members": [], + "extendsTokenRange": { + "startIndex": 1, + "endIndex": 3 + }, + "implementsTokenRanges": [] + }, + { + "kind": "Variable", + "canonicalReference": "@microsoft/fast-components-msft!heightNumber:var", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "heightNumber = \"(var(--base-height-multiplier) + var(--density)) * var(--design-unit)\"" + } + ], + "releaseTag": "Public", + "name": "heightNumber", + "variableTypeTokenRange": { + "startIndex": 0, + "endIndex": 0 + } + }, + { + "kind": "Variable", + "canonicalReference": "@microsoft/fast-components-msft!neutralDividerRestBehavior:var", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "neutralDividerRestBehavior: " + }, + { + "kind": "Content", + "text": "import(\"@microsoft/fast-foundation\")." + }, + { + "kind": "Reference", + "text": "CSSCustomPropertyBehavior", + "canonicalReference": "@microsoft/fast-foundation!CSSCustomPropertyBehavior:class" + } + ], + "releaseTag": "Public", + "name": "neutralDividerRestBehavior", + "variableTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + }, + { + "kind": "Variable", + "canonicalReference": "@microsoft/fast-components-msft!neutralFillActiveBehavior:var", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "neutralFillActiveBehavior: " + }, + { + "kind": "Content", + "text": "import(\"@microsoft/fast-foundation\")." + }, + { + "kind": "Reference", + "text": "CSSCustomPropertyBehavior", + "canonicalReference": "@microsoft/fast-foundation!CSSCustomPropertyBehavior:class" + } + ], + "releaseTag": "Public", + "name": "neutralFillActiveBehavior", + "variableTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + }, + { + "kind": "Variable", + "canonicalReference": "@microsoft/fast-components-msft!neutralFillCardRestBehavior:var", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "neutralFillCardRestBehavior: " + }, + { + "kind": "Content", + "text": "import(\"@microsoft/fast-foundation\")." + }, + { + "kind": "Reference", + "text": "CSSCustomPropertyBehavior", + "canonicalReference": "@microsoft/fast-foundation!CSSCustomPropertyBehavior:class" + } + ], + "releaseTag": "Public", + "name": "neutralFillCardRestBehavior", + "variableTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + }, + { + "kind": "Variable", + "canonicalReference": "@microsoft/fast-components-msft!neutralFillFocusBehavior:var", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "neutralFillFocusBehavior: " + }, + { + "kind": "Content", + "text": "import(\"@microsoft/fast-foundation\")." + }, + { + "kind": "Reference", + "text": "CSSCustomPropertyBehavior", + "canonicalReference": "@microsoft/fast-foundation!CSSCustomPropertyBehavior:class" + } + ], + "releaseTag": "Public", + "name": "neutralFillFocusBehavior", + "variableTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + }, + { + "kind": "Variable", + "canonicalReference": "@microsoft/fast-components-msft!neutralFillHoverBehavior:var", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "neutralFillHoverBehavior: " + }, + { + "kind": "Content", + "text": "import(\"@microsoft/fast-foundation\")." + }, + { + "kind": "Reference", + "text": "CSSCustomPropertyBehavior", + "canonicalReference": "@microsoft/fast-foundation!CSSCustomPropertyBehavior:class" + } + ], + "releaseTag": "Public", + "name": "neutralFillHoverBehavior", + "variableTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + }, + { + "kind": "Variable", + "canonicalReference": "@microsoft/fast-components-msft!neutralFillInputActiveBehavior:var", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "neutralFillInputActiveBehavior: " + }, + { + "kind": "Content", + "text": "import(\"@microsoft/fast-foundation\")." + }, + { + "kind": "Reference", + "text": "CSSCustomPropertyBehavior", + "canonicalReference": "@microsoft/fast-foundation!CSSCustomPropertyBehavior:class" + } + ], + "releaseTag": "Public", + "name": "neutralFillInputActiveBehavior", + "variableTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + }, + { + "kind": "Variable", + "canonicalReference": "@microsoft/fast-components-msft!neutralFillInputFocusBehavior:var", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "neutralFillInputFocusBehavior: " + }, + { + "kind": "Content", + "text": "import(\"@microsoft/fast-foundation\")." + }, + { + "kind": "Reference", + "text": "CSSCustomPropertyBehavior", + "canonicalReference": "@microsoft/fast-foundation!CSSCustomPropertyBehavior:class" + } + ], + "releaseTag": "Public", + "name": "neutralFillInputFocusBehavior", + "variableTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + }, + { + "kind": "Variable", + "canonicalReference": "@microsoft/fast-components-msft!neutralFillInputHoverBehavior:var", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "neutralFillInputHoverBehavior: " + }, + { + "kind": "Content", + "text": "import(\"@microsoft/fast-foundation\")." + }, + { + "kind": "Reference", + "text": "CSSCustomPropertyBehavior", + "canonicalReference": "@microsoft/fast-foundation!CSSCustomPropertyBehavior:class" + } + ], + "releaseTag": "Public", + "name": "neutralFillInputHoverBehavior", + "variableTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + }, + { + "kind": "Variable", + "canonicalReference": "@microsoft/fast-components-msft!neutralFillInputRestBehavior:var", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "neutralFillInputRestBehavior: " + }, + { + "kind": "Content", + "text": "import(\"@microsoft/fast-foundation\")." + }, + { + "kind": "Reference", + "text": "CSSCustomPropertyBehavior", + "canonicalReference": "@microsoft/fast-foundation!CSSCustomPropertyBehavior:class" + } + ], + "releaseTag": "Public", + "name": "neutralFillInputRestBehavior", + "variableTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + }, + { + "kind": "Variable", + "canonicalReference": "@microsoft/fast-components-msft!neutralFillRestBehavior:var", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "neutralFillRestBehavior: " + }, + { + "kind": "Content", + "text": "import(\"@microsoft/fast-foundation\")." + }, + { + "kind": "Reference", + "text": "CSSCustomPropertyBehavior", + "canonicalReference": "@microsoft/fast-foundation!CSSCustomPropertyBehavior:class" + } + ], + "releaseTag": "Public", + "name": "neutralFillRestBehavior", + "variableTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + }, + { + "kind": "Variable", + "canonicalReference": "@microsoft/fast-components-msft!neutralFillSelectedBehavior:var", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "neutralFillSelectedBehavior: " + }, + { + "kind": "Content", + "text": "import(\"@microsoft/fast-foundation\")." + }, + { + "kind": "Reference", + "text": "CSSCustomPropertyBehavior", + "canonicalReference": "@microsoft/fast-foundation!CSSCustomPropertyBehavior:class" + } + ], + "releaseTag": "Public", + "name": "neutralFillSelectedBehavior", + "variableTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + }, + { + "kind": "Variable", + "canonicalReference": "@microsoft/fast-components-msft!neutralFillStealthActiveBehavior:var", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "neutralFillStealthActiveBehavior: " + }, + { + "kind": "Content", + "text": "import(\"@microsoft/fast-foundation\")." + }, + { + "kind": "Reference", + "text": "CSSCustomPropertyBehavior", + "canonicalReference": "@microsoft/fast-foundation!CSSCustomPropertyBehavior:class" + } + ], + "releaseTag": "Public", + "name": "neutralFillStealthActiveBehavior", + "variableTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + }, + { + "kind": "Variable", + "canonicalReference": "@microsoft/fast-components-msft!neutralFillStealthFocusBehavior:var", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "neutralFillStealthFocusBehavior: " + }, + { + "kind": "Content", + "text": "import(\"@microsoft/fast-foundation\")." + }, + { + "kind": "Reference", + "text": "CSSCustomPropertyBehavior", + "canonicalReference": "@microsoft/fast-foundation!CSSCustomPropertyBehavior:class" + } + ], + "releaseTag": "Public", + "name": "neutralFillStealthFocusBehavior", + "variableTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + }, + { + "kind": "Variable", + "canonicalReference": "@microsoft/fast-components-msft!neutralFillStealthHoverBehavior:var", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "neutralFillStealthHoverBehavior: " + }, + { + "kind": "Content", + "text": "import(\"@microsoft/fast-foundation\")." + }, + { + "kind": "Reference", + "text": "CSSCustomPropertyBehavior", + "canonicalReference": "@microsoft/fast-foundation!CSSCustomPropertyBehavior:class" + } + ], + "releaseTag": "Public", + "name": "neutralFillStealthHoverBehavior", + "variableTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + }, + { + "kind": "Variable", + "canonicalReference": "@microsoft/fast-components-msft!neutralFillStealthRestBehavior:var", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "neutralFillStealthRestBehavior: " + }, + { + "kind": "Content", + "text": "import(\"@microsoft/fast-foundation\")." + }, + { + "kind": "Reference", + "text": "CSSCustomPropertyBehavior", + "canonicalReference": "@microsoft/fast-foundation!CSSCustomPropertyBehavior:class" + } + ], + "releaseTag": "Public", + "name": "neutralFillStealthRestBehavior", + "variableTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + }, + { + "kind": "Variable", + "canonicalReference": "@microsoft/fast-components-msft!neutralFillStealthSelectedBehavior:var", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "neutralFillStealthSelectedBehavior: " + }, + { + "kind": "Content", + "text": "import(\"@microsoft/fast-foundation\")." + }, + { + "kind": "Reference", + "text": "CSSCustomPropertyBehavior", + "canonicalReference": "@microsoft/fast-foundation!CSSCustomPropertyBehavior:class" + } + ], + "releaseTag": "Public", + "name": "neutralFillStealthSelectedBehavior", + "variableTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + }, + { + "kind": "Variable", + "canonicalReference": "@microsoft/fast-components-msft!neutralFillToggleActiveBehavior:var", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "neutralFillToggleActiveBehavior: " + }, + { + "kind": "Content", + "text": "import(\"@microsoft/fast-foundation\")." + }, + { + "kind": "Reference", + "text": "CSSCustomPropertyBehavior", + "canonicalReference": "@microsoft/fast-foundation!CSSCustomPropertyBehavior:class" + } + ], + "releaseTag": "Public", + "name": "neutralFillToggleActiveBehavior", + "variableTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + }, + { + "kind": "Variable", + "canonicalReference": "@microsoft/fast-components-msft!neutralFillToggleFocusBehavior:var", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "neutralFillToggleFocusBehavior: " + }, + { + "kind": "Content", + "text": "import(\"@microsoft/fast-foundation\")." + }, + { + "kind": "Reference", + "text": "CSSCustomPropertyBehavior", + "canonicalReference": "@microsoft/fast-foundation!CSSCustomPropertyBehavior:class" + } + ], + "releaseTag": "Public", + "name": "neutralFillToggleFocusBehavior", + "variableTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + }, + { + "kind": "Variable", + "canonicalReference": "@microsoft/fast-components-msft!neutralFillToggleHoverBehavior:var", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "neutralFillToggleHoverBehavior: " + }, + { + "kind": "Content", + "text": "import(\"@microsoft/fast-foundation\")." + }, + { + "kind": "Reference", + "text": "CSSCustomPropertyBehavior", + "canonicalReference": "@microsoft/fast-foundation!CSSCustomPropertyBehavior:class" + } + ], + "releaseTag": "Public", + "name": "neutralFillToggleHoverBehavior", + "variableTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + }, + { + "kind": "Variable", + "canonicalReference": "@microsoft/fast-components-msft!neutralFillToggleRestBehavior:var", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "neutralFillToggleRestBehavior: " + }, + { + "kind": "Content", + "text": "import(\"@microsoft/fast-foundation\")." + }, + { + "kind": "Reference", + "text": "CSSCustomPropertyBehavior", + "canonicalReference": "@microsoft/fast-foundation!CSSCustomPropertyBehavior:class" + } + ], + "releaseTag": "Public", + "name": "neutralFillToggleRestBehavior", + "variableTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + }, + { + "kind": "Variable", + "canonicalReference": "@microsoft/fast-components-msft!neutralFocusBehavior:var", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "neutralFocusBehavior: " + }, + { + "kind": "Content", + "text": "import(\"@microsoft/fast-foundation\")." + }, + { + "kind": "Reference", + "text": "CSSCustomPropertyBehavior", + "canonicalReference": "@microsoft/fast-foundation!CSSCustomPropertyBehavior:class" + } + ], + "releaseTag": "Public", + "name": "neutralFocusBehavior", + "variableTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + }, + { + "kind": "Variable", + "canonicalReference": "@microsoft/fast-components-msft!neutralFocusInnerAccentBehavior:var", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "neutralFocusInnerAccentBehavior: " + }, + { + "kind": "Content", + "text": "import(\"@microsoft/fast-foundation\")." + }, + { + "kind": "Reference", + "text": "CSSCustomPropertyBehavior", + "canonicalReference": "@microsoft/fast-foundation!CSSCustomPropertyBehavior:class" + } + ], + "releaseTag": "Public", + "name": "neutralFocusInnerAccentBehavior", + "variableTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + }, + { + "kind": "Variable", + "canonicalReference": "@microsoft/fast-components-msft!neutralForegroundActiveBehavior:var", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "neutralForegroundActiveBehavior: " + }, + { + "kind": "Content", + "text": "import(\"@microsoft/fast-foundation\")." + }, + { + "kind": "Reference", + "text": "CSSCustomPropertyBehavior", + "canonicalReference": "@microsoft/fast-foundation!CSSCustomPropertyBehavior:class" + } + ], + "releaseTag": "Public", + "name": "neutralForegroundActiveBehavior", + "variableTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + }, + { + "kind": "Variable", + "canonicalReference": "@microsoft/fast-components-msft!neutralForegroundFocusBehavior:var", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "neutralForegroundFocusBehavior: " + }, + { + "kind": "Content", + "text": "import(\"@microsoft/fast-foundation\")." + }, + { + "kind": "Reference", + "text": "CSSCustomPropertyBehavior", + "canonicalReference": "@microsoft/fast-foundation!CSSCustomPropertyBehavior:class" + } + ], + "releaseTag": "Public", + "name": "neutralForegroundFocusBehavior", + "variableTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + }, + { + "kind": "Variable", + "canonicalReference": "@microsoft/fast-components-msft!neutralForegroundHintBehavior:var", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "neutralForegroundHintBehavior: " + }, + { + "kind": "Content", + "text": "import(\"@microsoft/fast-foundation\")." + }, + { + "kind": "Reference", + "text": "CSSCustomPropertyBehavior", + "canonicalReference": "@microsoft/fast-foundation!CSSCustomPropertyBehavior:class" + } + ], + "releaseTag": "Public", + "name": "neutralForegroundHintBehavior", + "variableTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + }, + { + "kind": "Variable", + "canonicalReference": "@microsoft/fast-components-msft!neutralForegroundHintLargeBehavior:var", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "neutralForegroundHintLargeBehavior: " + }, + { + "kind": "Content", + "text": "import(\"@microsoft/fast-foundation\")." + }, + { + "kind": "Reference", + "text": "CSSCustomPropertyBehavior", + "canonicalReference": "@microsoft/fast-foundation!CSSCustomPropertyBehavior:class" + } + ], + "releaseTag": "Public", + "name": "neutralForegroundHintLargeBehavior", + "variableTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + }, + { + "kind": "Variable", + "canonicalReference": "@microsoft/fast-components-msft!neutralForegroundHoverBehavior:var", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "neutralForegroundHoverBehavior: " + }, + { + "kind": "Content", + "text": "import(\"@microsoft/fast-foundation\")." + }, + { + "kind": "Reference", + "text": "CSSCustomPropertyBehavior", + "canonicalReference": "@microsoft/fast-foundation!CSSCustomPropertyBehavior:class" + } + ], + "releaseTag": "Public", + "name": "neutralForegroundHoverBehavior", + "variableTypeTokenRange": { "startIndex": 1, "endIndex": 3 - }, - "implementsTokenRanges": [ - { - "startIndex": 4, - "endIndex": 8 - } - ] + } }, { - "kind": "Class", - "canonicalReference": "@microsoft/fast-components-msft!FASTDialog:class", + "kind": "Variable", + "canonicalReference": "@microsoft/fast-components-msft!neutralForegroundRestBehavior:var", "docComment": "", "excerptTokens": [ { "kind": "Content", - "text": "export declare class FASTDialog extends " + "text": "neutralForegroundRestBehavior: " }, { - "kind": "Reference", - "text": "Dialog", - "canonicalReference": "@microsoft/fast-foundation!Dialog:class" + "kind": "Content", + "text": "import(\"@microsoft/fast-foundation\")." }, { - "kind": "Content", - "text": " " + "kind": "Reference", + "text": "CSSCustomPropertyBehavior", + "canonicalReference": "@microsoft/fast-foundation!CSSCustomPropertyBehavior:class" } ], "releaseTag": "Public", - "name": "FASTDialog", - "members": [], - "extendsTokenRange": { + "name": "neutralForegroundRestBehavior", + "variableTypeTokenRange": { "startIndex": 1, "endIndex": 3 - }, - "implementsTokenRanges": [] + } }, { - "kind": "Class", - "canonicalReference": "@microsoft/fast-components-msft!FASTDivider:class", + "kind": "Variable", + "canonicalReference": "@microsoft/fast-components-msft!neutralForegroundToggleBehavior:var", "docComment": "", "excerptTokens": [ { "kind": "Content", - "text": "export declare class FASTDivider extends " + "text": "neutralForegroundToggleBehavior: " }, { - "kind": "Reference", - "text": "Divider", - "canonicalReference": "@microsoft/fast-foundation!Divider:class" + "kind": "Content", + "text": "import(\"@microsoft/fast-foundation\")." }, { - "kind": "Content", - "text": " " + "kind": "Reference", + "text": "CSSCustomPropertyBehavior", + "canonicalReference": "@microsoft/fast-foundation!CSSCustomPropertyBehavior:class" } ], "releaseTag": "Public", - "name": "FASTDivider", - "members": [], - "extendsTokenRange": { + "name": "neutralForegroundToggleBehavior", + "variableTypeTokenRange": { "startIndex": 1, "endIndex": 3 - }, - "implementsTokenRanges": [] + } }, { - "kind": "Class", - "canonicalReference": "@microsoft/fast-components-msft!FASTFlipper:class", + "kind": "Variable", + "canonicalReference": "@microsoft/fast-components-msft!neutralForegroundToggleLargeBehavior:var", "docComment": "", "excerptTokens": [ { "kind": "Content", - "text": "export declare class FASTFlipper extends " + "text": "neutralForegroundToggleLargeBehavior: " }, { - "kind": "Reference", - "text": "Flipper", - "canonicalReference": "@microsoft/fast-foundation!Flipper:class" + "kind": "Content", + "text": "import(\"@microsoft/fast-foundation\")." }, { - "kind": "Content", - "text": " " + "kind": "Reference", + "text": "CSSCustomPropertyBehavior", + "canonicalReference": "@microsoft/fast-foundation!CSSCustomPropertyBehavior:class" } ], "releaseTag": "Public", - "name": "FASTFlipper", - "members": [], - "extendsTokenRange": { + "name": "neutralForegroundToggleLargeBehavior", + "variableTypeTokenRange": { "startIndex": 1, "endIndex": 3 - }, - "implementsTokenRanges": [] + } }, { - "kind": "Class", - "canonicalReference": "@microsoft/fast-components-msft!FASTProgress:class", + "kind": "Variable", + "canonicalReference": "@microsoft/fast-components-msft!neutralLayerCardBehavior:var", "docComment": "", "excerptTokens": [ { "kind": "Content", - "text": "export declare class FASTProgress extends " + "text": "neutralLayerCardBehavior: " }, { - "kind": "Reference", - "text": "BaseProgress", - "canonicalReference": "@microsoft/fast-foundation!BaseProgress:class" + "kind": "Content", + "text": "import(\"@microsoft/fast-foundation\")." }, { - "kind": "Content", - "text": " " + "kind": "Reference", + "text": "CSSCustomPropertyBehavior", + "canonicalReference": "@microsoft/fast-foundation!CSSCustomPropertyBehavior:class" } ], "releaseTag": "Public", - "name": "FASTProgress", - "members": [], - "extendsTokenRange": { + "name": "neutralLayerCardBehavior", + "variableTypeTokenRange": { "startIndex": 1, "endIndex": 3 - }, - "implementsTokenRanges": [] + } }, { - "kind": "Class", - "canonicalReference": "@microsoft/fast-components-msft!FASTProgressRing:class", + "kind": "Variable", + "canonicalReference": "@microsoft/fast-components-msft!neutralLayerCardContainerBehavior:var", "docComment": "", "excerptTokens": [ { "kind": "Content", - "text": "export declare class FASTProgressRing extends " + "text": "neutralLayerCardContainerBehavior: " }, { - "kind": "Reference", - "text": "BaseProgress", - "canonicalReference": "@microsoft/fast-foundation!BaseProgress:class" + "kind": "Content", + "text": "import(\"@microsoft/fast-foundation\")." }, { - "kind": "Content", - "text": " " + "kind": "Reference", + "text": "CSSCustomPropertyBehavior", + "canonicalReference": "@microsoft/fast-foundation!CSSCustomPropertyBehavior:class" } ], "releaseTag": "Public", - "name": "FASTProgressRing", - "members": [], - "extendsTokenRange": { + "name": "neutralLayerCardContainerBehavior", + "variableTypeTokenRange": { "startIndex": 1, "endIndex": 3 - }, - "implementsTokenRanges": [] + } }, { - "kind": "Class", - "canonicalReference": "@microsoft/fast-components-msft!FASTRadio:class", + "kind": "Variable", + "canonicalReference": "@microsoft/fast-components-msft!neutralLayerFloatingBehavior:var", "docComment": "", "excerptTokens": [ { "kind": "Content", - "text": "export declare class FASTRadio extends " + "text": "neutralLayerFloatingBehavior: " }, { - "kind": "Reference", - "text": "Radio", - "canonicalReference": "@microsoft/fast-foundation!Radio:class" + "kind": "Content", + "text": "import(\"@microsoft/fast-foundation\")." }, { - "kind": "Content", - "text": " " + "kind": "Reference", + "text": "CSSCustomPropertyBehavior", + "canonicalReference": "@microsoft/fast-foundation!CSSCustomPropertyBehavior:class" } ], "releaseTag": "Public", - "name": "FASTRadio", - "members": [], - "extendsTokenRange": { + "name": "neutralLayerFloatingBehavior", + "variableTypeTokenRange": { "startIndex": 1, "endIndex": 3 - }, - "implementsTokenRanges": [] + } }, { - "kind": "Class", - "canonicalReference": "@microsoft/fast-components-msft!FASTRadioGroup:class", + "kind": "Variable", + "canonicalReference": "@microsoft/fast-components-msft!neutralLayerL1AltBehavior:var", "docComment": "", "excerptTokens": [ { "kind": "Content", - "text": "export declare class FASTRadioGroup extends " + "text": "neutralLayerL1AltBehavior: " }, { - "kind": "Reference", - "text": "RadioGroup", - "canonicalReference": "@microsoft/fast-foundation!RadioGroup:class" + "kind": "Content", + "text": "import(\"@microsoft/fast-foundation\")." }, { - "kind": "Content", - "text": " " + "kind": "Reference", + "text": "CSSCustomPropertyBehavior", + "canonicalReference": "@microsoft/fast-foundation!CSSCustomPropertyBehavior:class" } ], "releaseTag": "Public", - "name": "FASTRadioGroup", - "members": [], - "extendsTokenRange": { + "name": "neutralLayerL1AltBehavior", + "variableTypeTokenRange": { "startIndex": 1, "endIndex": 3 - }, - "implementsTokenRanges": [] + } }, { - "kind": "Class", - "canonicalReference": "@microsoft/fast-components-msft!FASTSlider:class", + "kind": "Variable", + "canonicalReference": "@microsoft/fast-components-msft!neutralLayerL1Behavior:var", "docComment": "", "excerptTokens": [ { "kind": "Content", - "text": "export declare class FASTSlider extends " + "text": "neutralLayerL1Behavior: " }, { - "kind": "Reference", - "text": "Slider", - "canonicalReference": "@microsoft/fast-foundation!Slider:class" + "kind": "Content", + "text": "import(\"@microsoft/fast-foundation\")." }, { - "kind": "Content", - "text": " " + "kind": "Reference", + "text": "CSSCustomPropertyBehavior", + "canonicalReference": "@microsoft/fast-foundation!CSSCustomPropertyBehavior:class" } ], "releaseTag": "Public", - "name": "FASTSlider", - "members": [], - "extendsTokenRange": { + "name": "neutralLayerL1Behavior", + "variableTypeTokenRange": { "startIndex": 1, "endIndex": 3 - }, - "implementsTokenRanges": [] + } }, { - "kind": "Class", - "canonicalReference": "@microsoft/fast-components-msft!FASTSliderLabel:class", + "kind": "Variable", + "canonicalReference": "@microsoft/fast-components-msft!neutralLayerL2Behavior:var", "docComment": "", "excerptTokens": [ { "kind": "Content", - "text": "export declare class FASTSliderLabel extends " + "text": "neutralLayerL2Behavior: " }, { - "kind": "Reference", - "text": "SliderLabel", - "canonicalReference": "@microsoft/fast-foundation!SliderLabel:class" + "kind": "Content", + "text": "import(\"@microsoft/fast-foundation\")." }, { - "kind": "Content", - "text": " " + "kind": "Reference", + "text": "CSSCustomPropertyBehavior", + "canonicalReference": "@microsoft/fast-foundation!CSSCustomPropertyBehavior:class" } ], "releaseTag": "Public", - "name": "FASTSliderLabel", - "members": [], - "extendsTokenRange": { + "name": "neutralLayerL2Behavior", + "variableTypeTokenRange": { "startIndex": 1, "endIndex": 3 - }, - "implementsTokenRanges": [] + } }, { - "kind": "Class", - "canonicalReference": "@microsoft/fast-components-msft!FASTSwitch:class", + "kind": "Variable", + "canonicalReference": "@microsoft/fast-components-msft!neutralLayerL3Behavior:var", "docComment": "", "excerptTokens": [ { "kind": "Content", - "text": "export declare class FASTSwitch extends " + "text": "neutralLayerL3Behavior: " }, { - "kind": "Reference", - "text": "Switch", - "canonicalReference": "@microsoft/fast-foundation!Switch:class" + "kind": "Content", + "text": "import(\"@microsoft/fast-foundation\")." }, { - "kind": "Content", - "text": " " + "kind": "Reference", + "text": "CSSCustomPropertyBehavior", + "canonicalReference": "@microsoft/fast-foundation!CSSCustomPropertyBehavior:class" } ], "releaseTag": "Public", - "name": "FASTSwitch", - "members": [], - "extendsTokenRange": { + "name": "neutralLayerL3Behavior", + "variableTypeTokenRange": { "startIndex": 1, "endIndex": 3 - }, - "implementsTokenRanges": [] + } }, { - "kind": "Class", - "canonicalReference": "@microsoft/fast-components-msft!FASTTab:class", + "kind": "Variable", + "canonicalReference": "@microsoft/fast-components-msft!neutralLayerL4Behavior:var", "docComment": "", "excerptTokens": [ { "kind": "Content", - "text": "export declare class FASTTab extends " + "text": "neutralLayerL4Behavior: " }, { - "kind": "Reference", - "text": "Tab", - "canonicalReference": "@microsoft/fast-foundation!Tab:class" + "kind": "Content", + "text": "import(\"@microsoft/fast-foundation\")." }, { - "kind": "Content", - "text": " " + "kind": "Reference", + "text": "CSSCustomPropertyBehavior", + "canonicalReference": "@microsoft/fast-foundation!CSSCustomPropertyBehavior:class" } ], "releaseTag": "Public", - "name": "FASTTab", - "members": [], - "extendsTokenRange": { + "name": "neutralLayerL4Behavior", + "variableTypeTokenRange": { "startIndex": 1, "endIndex": 3 - }, - "implementsTokenRanges": [] + } }, { - "kind": "Class", - "canonicalReference": "@microsoft/fast-components-msft!FASTTabPanel:class", + "kind": "Variable", + "canonicalReference": "@microsoft/fast-components-msft!neutralOutlineActiveBehavior:var", "docComment": "", "excerptTokens": [ { "kind": "Content", - "text": "export declare class FASTTabPanel extends " + "text": "neutralOutlineActiveBehavior: " }, { - "kind": "Reference", - "text": "TabPanel", - "canonicalReference": "@microsoft/fast-foundation!TabPanel:class" + "kind": "Content", + "text": "import(\"@microsoft/fast-foundation\")." }, { - "kind": "Content", - "text": " " + "kind": "Reference", + "text": "CSSCustomPropertyBehavior", + "canonicalReference": "@microsoft/fast-foundation!CSSCustomPropertyBehavior:class" } ], "releaseTag": "Public", - "name": "FASTTabPanel", - "members": [], - "extendsTokenRange": { + "name": "neutralOutlineActiveBehavior", + "variableTypeTokenRange": { "startIndex": 1, "endIndex": 3 - }, - "implementsTokenRanges": [] + } }, { - "kind": "Class", - "canonicalReference": "@microsoft/fast-components-msft!FASTTabs:class", + "kind": "Variable", + "canonicalReference": "@microsoft/fast-components-msft!neutralOutlineFocusBehavior:var", "docComment": "", "excerptTokens": [ { "kind": "Content", - "text": "export declare class FASTTabs extends " + "text": "neutralOutlineFocusBehavior: " }, { - "kind": "Reference", - "text": "Tabs", - "canonicalReference": "@microsoft/fast-foundation!Tabs:class" + "kind": "Content", + "text": "import(\"@microsoft/fast-foundation\")." }, { - "kind": "Content", - "text": " " + "kind": "Reference", + "text": "CSSCustomPropertyBehavior", + "canonicalReference": "@microsoft/fast-foundation!CSSCustomPropertyBehavior:class" } ], "releaseTag": "Public", - "name": "FASTTabs", - "members": [], - "extendsTokenRange": { + "name": "neutralOutlineFocusBehavior", + "variableTypeTokenRange": { "startIndex": 1, "endIndex": 3 - }, - "implementsTokenRanges": [] + } }, { - "kind": "Class", - "canonicalReference": "@microsoft/fast-components-msft!FASTTextArea:class", + "kind": "Variable", + "canonicalReference": "@microsoft/fast-components-msft!neutralOutlineHoverBehavior:var", "docComment": "", "excerptTokens": [ { "kind": "Content", - "text": "export declare class FASTTextArea extends " + "text": "neutralOutlineHoverBehavior: " }, { - "kind": "Reference", - "text": "TextArea", - "canonicalReference": "@microsoft/fast-foundation!TextArea:class" + "kind": "Content", + "text": "import(\"@microsoft/fast-foundation\")." }, { - "kind": "Content", - "text": " " + "kind": "Reference", + "text": "CSSCustomPropertyBehavior", + "canonicalReference": "@microsoft/fast-foundation!CSSCustomPropertyBehavior:class" } ], "releaseTag": "Public", - "name": "FASTTextArea", - "members": [], - "extendsTokenRange": { + "name": "neutralOutlineHoverBehavior", + "variableTypeTokenRange": { "startIndex": 1, "endIndex": 3 - }, - "implementsTokenRanges": [] + } }, { - "kind": "Class", - "canonicalReference": "@microsoft/fast-components-msft!FASTTextField:class", + "kind": "Variable", + "canonicalReference": "@microsoft/fast-components-msft!neutralOutlineRestBehavior:var", "docComment": "", "excerptTokens": [ { "kind": "Content", - "text": "export declare class FASTTextField extends " + "text": "neutralOutlineRestBehavior: " }, { - "kind": "Reference", - "text": "TextField", - "canonicalReference": "@microsoft/fast-foundation!TextField:class" + "kind": "Content", + "text": "import(\"@microsoft/fast-foundation\")." }, { - "kind": "Content", - "text": " " + "kind": "Reference", + "text": "CSSCustomPropertyBehavior", + "canonicalReference": "@microsoft/fast-foundation!CSSCustomPropertyBehavior:class" } ], "releaseTag": "Public", - "name": "FASTTextField", - "members": [], - "extendsTokenRange": { + "name": "neutralOutlineRestBehavior", + "variableTypeTokenRange": { "startIndex": 1, "endIndex": 3 - }, - "implementsTokenRanges": [] + } } ] } diff --git a/sites/website/src/docs/api/fast-components.api.json b/sites/website/src/docs/api/fast-components.api.json index 431771e6620..7a2fd069613 100644 --- a/sites/website/src/docs/api/fast-components.api.json +++ b/sites/website/src/docs/api/fast-components.api.json @@ -18,7 +18,7 @@ { "kind": "Variable", "canonicalReference": "@microsoft/fast-components!accentFillActiveBehavior:var", - "docComment": "/**\n * Behavior to resolve and make available the accent-fill-active CSS custom property.\n */\n", + "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!accentFillFocusBehavior:var", - "docComment": "/**\n * Behavior to resolve and make available the accent-fill-focus CSS custom property.\n */\n", + "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!accentFillHoverBehavior:var", - "docComment": "/**\n * Behavior to resolve and make available the accent-fill-hover CSS custom property.\n */\n", + "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!accentFillLargeActiveBehavior:var", - "docComment": "/**\n * Behavior to resolve and make available the accent-fill-large-active CSS custom property.\n */\n", + "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!accentFillLargeFocusBehavior:var", - "docComment": "/**\n * Behavior to resolve and make available the accent-fill-large-focus CSS custom property.\n */\n", + "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!accentFillLargeHoverBehavior:var", - "docComment": "/**\n * Behavior to resolve and make available the accent-fill-large-hover CSS custom property.\n */\n", + "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!accentFillLargeRestBehavior:var", - "docComment": "/**\n * Behavior to resolve and make available the accent-fill-large-rest CSS custom property.\n */\n", + "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!accentFillLargeSelectedBehavior:var", - "docComment": "/**\n * Behavior to resolve and make available the accent-fill-large-selected CSS custom property.\n */\n", + "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!accentFillRestBehavior:var", - "docComment": "/**\n * Behavior to resolve and make available the accent-fill-rest CSS custom property.\n */\n", + "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!accentFillSelectedBehavior:var", - "docComment": "/**\n * Behavior to resolve and make available the accent-fill-selected CSS custom property.\n */\n", + "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!accentForegroundActiveBehavior:var", - "docComment": "/**\n * Behavior to resolve and make available the accent-foreground-active CSS custom property.\n */\n", + "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!accentForegroundCutRestBehavior:var", - "docComment": "/**\n * Behavior to resolve and make available the accent-foreground-cut-rest CSS custom property.\n */\n", + "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!accentForegroundFocusBehavior:var", - "docComment": "/**\n * Behavior to resolve and make available the accent-foreground-focus CSS custom property.\n */\n", + "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!accentForegroundHoverBehavior:var", - "docComment": "/**\n * Behavior to resolve and make available the accent-foreground-hover CSS custom property.\n */\n", + "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!accentForegroundLargeActiveBehavior:var", - "docComment": "/**\n * Behavior to resolve and make available the accent-foreground-large-active CSS custom property.\n */\n", + "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!accentForegroundLargeFocusBehavior:var", - "docComment": "/**\n * Behavior to resolve and make available the accent-foreground-large-focus CSS custom property.\n */\n", + "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!accentForegroundLargeHoverBehavior:var", - "docComment": "/**\n * Behavior to resolve and make available the accent-foreground-large-hover CSS custom property.\n */\n", + "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!accentForegroundLargeRestBehavior:var", - "docComment": "/**\n * Behavior to resolve and make available the accent-foreground-large-rest CSS custom property.\n */\n", + "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!accentForegroundRestBehavior:var", - "docComment": "/**\n * Behavior to resolve and make available the accent-foreground-rest CSS custom property.\n */\n", + "docComment": "/**\n * Behavior to resolve and make available the accent-foreground-rest CSS custom property.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", @@ -512,7 +512,7 @@ { "kind": "Function", "canonicalReference": "@microsoft/fast-components!createColorPalette:function(1)", - "docComment": "/**\n * Creates a color palette from a provided source color\n *\n * @param baseColor - \n *\n * @returns {string[]}\n */\n", + "docComment": "/**\n * Creates a color palette from a provided source color\n *\n * @param baseColor - ColorRGBA64\n *\n * @returns string[]\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", @@ -555,7 +555,7 @@ { "kind": "Class", "canonicalReference": "@microsoft/fast-components!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", @@ -583,7 +583,7 @@ { "kind": "Class", "canonicalReference": "@microsoft/fast-components!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", @@ -611,7 +611,7 @@ { "kind": "Class", "canonicalReference": "@microsoft/fast-components!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 * @public\n */\n", "excerptTokens": [ { "kind": "Content", @@ -639,7 +639,7 @@ { "kind": "Class", "canonicalReference": "@microsoft/fast-components!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", @@ -667,7 +667,7 @@ { "kind": "Class", "canonicalReference": "@microsoft/fast-components!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 * @public\n */\n", "excerptTokens": [ { "kind": "Content", @@ -695,7 +695,7 @@ { "kind": "Class", "canonicalReference": "@microsoft/fast-components!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", @@ -723,7 +723,7 @@ { "kind": "Class", "canonicalReference": "@microsoft/fast-components!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", @@ -748,10 +748,1723 @@ }, "implementsTokenRanges": [] }, + { + "kind": "Interface", + "canonicalReference": "@microsoft/fast-components!FASTDesignSystem:interface", + "docComment": "/**\n * Defines the properties in the FAST Design System\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface FASTDesignSystem " + } + ], + "releaseTag": "Public", + "name": "FASTDesignSystem", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/fast-components!FASTDesignSystem#accentBaseColor:member", + "docComment": "/**\n * The accent color, which the accent palette is based on. Keep this value in sync with accentPalette.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "accentBaseColor: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "accentBaseColor", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/fast-components!FASTDesignSystem#accentFillActiveDelta:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "accentFillActiveDelta: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "accentFillActiveDelta", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/fast-components!FASTDesignSystem#accentFillFocusDelta:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "accentFillFocusDelta: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "accentFillFocusDelta", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/fast-components!FASTDesignSystem#accentFillHoverDelta:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "accentFillHoverDelta: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "accentFillHoverDelta", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/fast-components!FASTDesignSystem#accentFillRestDelta:member", + "docComment": "/**\n * Color swatch deltas for the accent-fill recipe.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "accentFillRestDelta: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "accentFillRestDelta", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/fast-components!FASTDesignSystem#accentFillSelectedDelta:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "accentFillSelectedDelta: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "accentFillSelectedDelta", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/fast-components!FASTDesignSystem#accentForegroundActiveDelta:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "accentForegroundActiveDelta: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "accentForegroundActiveDelta", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/fast-components!FASTDesignSystem#accentForegroundFocusDelta:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "accentForegroundFocusDelta: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "accentForegroundFocusDelta", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/fast-components!FASTDesignSystem#accentForegroundHoverDelta:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "accentForegroundHoverDelta: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "accentForegroundHoverDelta", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/fast-components!FASTDesignSystem#accentForegroundRestDelta:member", + "docComment": "/**\n * Color swatch deltas for the accent-foreground recipe.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "accentForegroundRestDelta: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "accentForegroundRestDelta", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/fast-components!FASTDesignSystem#accentPalette:member", + "docComment": "/**\n * An array of colors in a ramp from light to dark, used to lookup values for accent color recipes. Keep this value in sync with accentBaseColor. Generate by calling createColorPalette.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "accentPalette: " + }, + { + "kind": "Content", + "text": "string[]" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "accentPalette", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/fast-components!FASTDesignSystem#backgroundColor:member", + "docComment": "/**\n * The background color of the current context. May be used to draw an actual background or not. Color recipes evaluated within this context will use this as their basis.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "backgroundColor: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "backgroundColor", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/fast-components!FASTDesignSystem#baseHeightMultiplier:member", + "docComment": "/**\n * The number of designUnits used for component height at the base density.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "baseHeightMultiplier: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "baseHeightMultiplier", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/fast-components!FASTDesignSystem#baseHorizontalSpacingMultiplier:member", + "docComment": "/**\n * The number of designUnits used for horizontal spacing at the base density.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "baseHorizontalSpacingMultiplier: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "baseHorizontalSpacingMultiplier", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/fast-components!FASTDesignSystem#baseLayerLuminance:member", + "docComment": "/**\n * The luminance value to base layer recipes on. Sets the luminance value for the L1 layer recipe in a manner that can adjust to variable contrast.\n *\n * Currently defaults to -1 to turn the feature off and use backgroundColor for layer colors instead.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "baseLayerLuminance: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "baseLayerLuminance", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/fast-components!FASTDesignSystem#cornerRadius:member", + "docComment": "/**\n * The corner radius applied to controls.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "cornerRadius: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "cornerRadius", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/fast-components!FASTDesignSystem#density:member", + "docComment": "/**\n * The density offset, used with designUnit to calculate height and spacing.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "density: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "density", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/fast-components!FASTDesignSystem#designUnit:member", + "docComment": "/**\n * The grid-unit that UI dimensions are derived from in pixels.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "designUnit: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "designUnit", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/fast-components!FASTDesignSystem#disabledOpacity:member", + "docComment": "/**\n * The opacity to use for disabled component state.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "disabledOpacity: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "disabledOpacity", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/fast-components!FASTDesignSystem#focusOutlineWidth:member", + "docComment": "/**\n * The width of the outline for focus state in pixels.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "focusOutlineWidth: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "focusOutlineWidth", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/fast-components!FASTDesignSystem#neutralDividerRestDelta:member", + "docComment": "/**\n * Color swatch delta for the neutral-divider recipe.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "neutralDividerRestDelta: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "neutralDividerRestDelta", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/fast-components!FASTDesignSystem#neutralFillActiveDelta:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "neutralFillActiveDelta: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "neutralFillActiveDelta", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/fast-components!FASTDesignSystem#neutralFillCardDelta:member", + "docComment": "/**\n * Color swatch deltas for the neutral-fill-card recipe.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "neutralFillCardDelta: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "neutralFillCardDelta", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/fast-components!FASTDesignSystem#neutralFillFocusDelta:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "neutralFillFocusDelta: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "neutralFillFocusDelta", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/fast-components!FASTDesignSystem#neutralFillHoverDelta:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "neutralFillHoverDelta: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "neutralFillHoverDelta", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/fast-components!FASTDesignSystem#neutralFillInputActiveDelta:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "neutralFillInputActiveDelta: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "neutralFillInputActiveDelta", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/fast-components!FASTDesignSystem#neutralFillInputFocusDelta:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "neutralFillInputFocusDelta: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "neutralFillInputFocusDelta", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/fast-components!FASTDesignSystem#neutralFillInputHoverDelta:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "neutralFillInputHoverDelta: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "neutralFillInputHoverDelta", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/fast-components!FASTDesignSystem#neutralFillInputRestDelta:member", + "docComment": "/**\n * Color swatch deltas for the neutral-fill-input recipe.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "neutralFillInputRestDelta: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "neutralFillInputRestDelta", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/fast-components!FASTDesignSystem#neutralFillInputSelectedDelta:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "neutralFillInputSelectedDelta: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "neutralFillInputSelectedDelta", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/fast-components!FASTDesignSystem#neutralFillRestDelta:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "neutralFillRestDelta: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "neutralFillRestDelta", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/fast-components!FASTDesignSystem#neutralFillSelectedDelta:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "neutralFillSelectedDelta: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "neutralFillSelectedDelta", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/fast-components!FASTDesignSystem#neutralFillStealthActiveDelta:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "neutralFillStealthActiveDelta: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "neutralFillStealthActiveDelta", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/fast-components!FASTDesignSystem#neutralFillStealthFocusDelta:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "neutralFillStealthFocusDelta: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "neutralFillStealthFocusDelta", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/fast-components!FASTDesignSystem#neutralFillStealthHoverDelta:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "neutralFillStealthHoverDelta: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "neutralFillStealthHoverDelta", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/fast-components!FASTDesignSystem#neutralFillStealthRestDelta:member", + "docComment": "/**\n * Color swatch deltas for the neutral-fill-stealth recipe.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "neutralFillStealthRestDelta: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "neutralFillStealthRestDelta", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/fast-components!FASTDesignSystem#neutralFillStealthSelectedDelta:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "neutralFillStealthSelectedDelta: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "neutralFillStealthSelectedDelta", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/fast-components!FASTDesignSystem#neutralFillToggleActiveDelta:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "neutralFillToggleActiveDelta: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "neutralFillToggleActiveDelta", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/fast-components!FASTDesignSystem#neutralFillToggleFocusDelta:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "neutralFillToggleFocusDelta: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "neutralFillToggleFocusDelta", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/fast-components!FASTDesignSystem#neutralFillToggleHoverDelta:member", + "docComment": "/**\n * Configuration for the neutral-fill-toggle recipe.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "neutralFillToggleHoverDelta: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "neutralFillToggleHoverDelta", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/fast-components!FASTDesignSystem#neutralForegroundActiveDelta:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "neutralForegroundActiveDelta: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "neutralForegroundActiveDelta", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/fast-components!FASTDesignSystem#neutralForegroundFocusDelta:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "neutralForegroundFocusDelta: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "neutralForegroundFocusDelta", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/fast-components!FASTDesignSystem#neutralForegroundHoverDelta:member", + "docComment": "/**\n * Color swatch delta for neutral-foreground recipe.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "neutralForegroundHoverDelta: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "neutralForegroundHoverDelta", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/fast-components!FASTDesignSystem#neutralOutlineActiveDelta:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "neutralOutlineActiveDelta: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "neutralOutlineActiveDelta", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/fast-components!FASTDesignSystem#neutralOutlineFocusDelta:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "neutralOutlineFocusDelta: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "neutralOutlineFocusDelta", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/fast-components!FASTDesignSystem#neutralOutlineHoverDelta:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "neutralOutlineHoverDelta: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "neutralOutlineHoverDelta", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/fast-components!FASTDesignSystem#neutralOutlineRestDelta:member", + "docComment": "/**\n * Color swatch deltas for the neutral-outline recipe.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "neutralOutlineRestDelta: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "neutralOutlineRestDelta", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/fast-components!FASTDesignSystem#neutralPalette:member", + "docComment": "/**\n * An array of colors in a ramp from light to dark, used to look up values for neutral color recipes. Generate by calling createColorPalette.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "neutralPalette: " + }, + { + "kind": "Content", + "text": "string[]" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "neutralPalette", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/fast-components!FASTDesignSystem#outlineWidth:member", + "docComment": "/**\n * The width of the outline applied to outline components in pixels.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "outlineWidth: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "outlineWidth", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/fast-components!FASTDesignSystem#typeRampBaseFontSize:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "typeRampBaseFontSize: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "typeRampBaseFontSize", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/fast-components!FASTDesignSystem#typeRampBaseLineHeight:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "typeRampBaseLineHeight: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "typeRampBaseLineHeight", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/fast-components!FASTDesignSystem#typeRampMinus1FontSize:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "typeRampMinus1FontSize: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "typeRampMinus1FontSize", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/fast-components!FASTDesignSystem#typeRampMinus1LineHeight:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "typeRampMinus1LineHeight: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "typeRampMinus1LineHeight", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/fast-components!FASTDesignSystem#typeRampMinus2FontSize:member", + "docComment": "/**\n * Type-ramp font-size and line-height values\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "typeRampMinus2FontSize: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "typeRampMinus2FontSize", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/fast-components!FASTDesignSystem#typeRampMinus2LineHeight:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "typeRampMinus2LineHeight: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "typeRampMinus2LineHeight", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/fast-components!FASTDesignSystem#typeRampPlus1FontSize:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "typeRampPlus1FontSize: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "typeRampPlus1FontSize", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/fast-components!FASTDesignSystem#typeRampPlus1LineHeight:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "typeRampPlus1LineHeight: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "typeRampPlus1LineHeight", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/fast-components!FASTDesignSystem#typeRampPlus2FontSize:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "typeRampPlus2FontSize: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "typeRampPlus2FontSize", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/fast-components!FASTDesignSystem#typeRampPlus2LineHeight:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "typeRampPlus2LineHeight: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "typeRampPlus2LineHeight", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/fast-components!FASTDesignSystem#typeRampPlus3FontSize:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "typeRampPlus3FontSize: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "typeRampPlus3FontSize", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/fast-components!FASTDesignSystem#typeRampPlus3LineHeight:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "typeRampPlus3LineHeight: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "typeRampPlus3LineHeight", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/fast-components!FASTDesignSystem#typeRampPlus4FontSize:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "typeRampPlus4FontSize: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "typeRampPlus4FontSize", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/fast-components!FASTDesignSystem#typeRampPlus4LineHeight:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "typeRampPlus4LineHeight: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "typeRampPlus4LineHeight", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/fast-components!FASTDesignSystem#typeRampPlus5FontSize:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "typeRampPlus5FontSize: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "typeRampPlus5FontSize", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/fast-components!FASTDesignSystem#typeRampPlus5LineHeight:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "typeRampPlus5LineHeight: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "typeRampPlus5LineHeight", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/fast-components!FASTDesignSystem#typeRampPlus6FontSize:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "typeRampPlus6FontSize: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "typeRampPlus6FontSize", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/fast-components!FASTDesignSystem#typeRampPlus6LineHeight:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "typeRampPlus6LineHeight: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "typeRampPlus6LineHeight", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "Variable", + "canonicalReference": "@microsoft/fast-components!fastDesignSystemDefaults:var", + "docComment": "/**\n * The default values for {@link FASTDesignSystem}\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "fastDesignSystemDefaults: " + }, + { + "kind": "Reference", + "text": "FASTDesignSystem", + "canonicalReference": "@microsoft/fast-components!FASTDesignSystem:interface" + } + ], + "releaseTag": "Public", + "name": "fastDesignSystemDefaults", + "variableTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, { "kind": "Class", "canonicalReference": "@microsoft/fast-components!FASTDesignSystemProvider:class", - "docComment": "", + "docComment": "/**\n * The FAST DesignSystemProvider Element. Implements {@link @microsoft/fast-foundation#DesignSystemProvider}, {@link @microsoft/fast-foundation#DesignSystemProviderTemplate} and {@link @microsoft/fast-components#FASTDesignSystem}\n *\n * @remarks\n *\n * HTML Element: \\\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", @@ -2566,7 +4279,7 @@ { "kind": "Class", "canonicalReference": "@microsoft/fast-components!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", @@ -2594,7 +4307,7 @@ { "kind": "Class", "canonicalReference": "@microsoft/fast-components!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", @@ -2622,7 +4335,7 @@ { "kind": "Class", "canonicalReference": "@microsoft/fast-components!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", @@ -2650,7 +4363,7 @@ { "kind": "Class", "canonicalReference": "@microsoft/fast-components!FASTMenu:class", - "docComment": "", + "docComment": "/**\n * The FAST Menu Element. Implements {@link @microsoft/fast-foundation#Menu}, {@link @microsoft/fast-foundation#MenuTemplate}\n *\n * @remarks\n *\n * HTML Element: \\\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", @@ -2678,7 +4391,7 @@ { "kind": "Class", "canonicalReference": "@microsoft/fast-components!FASTMenuItem:class", - "docComment": "", + "docComment": "/**\n * The FAST Menu Item Element. Implements {@link @microsoft/fast-foundation#MenuItem}, {@link @microsoft/fast-foundation#MenuItemTemplate}\n *\n * @remarks\n *\n * HTML Element: \\\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", @@ -2706,7 +4419,7 @@ { "kind": "Class", "canonicalReference": "@microsoft/fast-components!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", @@ -2734,7 +4447,7 @@ { "kind": "Class", "canonicalReference": "@microsoft/fast-components!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", @@ -2762,7 +4475,7 @@ { "kind": "Class", "canonicalReference": "@microsoft/fast-components!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", @@ -2790,7 +4503,7 @@ { "kind": "Class", "canonicalReference": "@microsoft/fast-components!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", @@ -2818,7 +4531,7 @@ { "kind": "Class", "canonicalReference": "@microsoft/fast-components!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", @@ -2846,7 +4559,7 @@ { "kind": "Class", "canonicalReference": "@microsoft/fast-components!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", @@ -2874,7 +4587,7 @@ { "kind": "Class", "canonicalReference": "@microsoft/fast-components!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", @@ -2902,7 +4615,7 @@ { "kind": "Class", "canonicalReference": "@microsoft/fast-components!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", @@ -2930,7 +4643,7 @@ { "kind": "Class", "canonicalReference": "@microsoft/fast-components!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", @@ -2958,7 +4671,7 @@ { "kind": "Class", "canonicalReference": "@microsoft/fast-components!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", @@ -2986,7 +4699,7 @@ { "kind": "Class", "canonicalReference": "@microsoft/fast-components!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", @@ -3014,7 +4727,7 @@ { "kind": "Class", "canonicalReference": "@microsoft/fast-components!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", @@ -3042,7 +4755,7 @@ { "kind": "Function", "canonicalReference": "@microsoft/fast-components!isDarkMode:function(1)", - "docComment": "/**\n * Determines if the design-system should be considered in \"dark mode\". We're in dark mode if we have more contrast between #000000 and our background color than #FFFFFF and our background color. That threshold can be expressed as a relative luminance using the contrast formula as (1 + 0.5) / (bg + 0.05) === (bg + 0.05) / (0 + 0.05), which reduces to the following, where bg is the relative luminance of the background color\n */\n", + "docComment": "/**\n * Determines if the design-system should be considered in \"dark mode\".\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", @@ -3086,7 +4799,7 @@ { "kind": "Variable", "canonicalReference": "@microsoft/fast-components!neutralDividerRestBehavior:var", - "docComment": "/**\n * Behavior to resolve and make available the neutral-divider-rest CSS custom property.\n */\n", + "docComment": "/**\n * Behavior to resolve and make available the neutral-divider-rest CSS custom property.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", @@ -3112,7 +4825,7 @@ { "kind": "Variable", "canonicalReference": "@microsoft/fast-components!neutralFillActiveBehavior:var", - "docComment": "/**\n * Behavior to resolve and make available the neutral-fill-active CSS custom property.\n */\n", + "docComment": "/**\n * Behavior to resolve and make available the neutral-fill-active CSS custom property.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", @@ -3135,55 +4848,10 @@ "endIndex": 3 } }, - { - "kind": "Function", - "canonicalReference": "@microsoft/fast-components!neutralFillCard:function(2)", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare function neutralFillCard(backgroundResolver: " - }, - { - "kind": "Reference", - "text": "SwatchResolver", - "canonicalReference": "@microsoft/fast-components!SwatchResolver:type" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Reference", - "text": "SwatchResolver", - "canonicalReference": "@microsoft/fast-components!SwatchResolver:type" - }, - { - "kind": "Content", - "text": ";" - } - ], - "returnTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 - }, - "releaseTag": "Public", - "overloadIndex": 2, - "parameters": [ - { - "parameterName": "backgroundResolver", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - } - ], - "name": "neutralFillCard" - }, { "kind": "Variable", "canonicalReference": "@microsoft/fast-components!neutralFillCardRestBehavior:var", - "docComment": "/**\n * Behavior to resolve and make available the neutral-fill-card-rest CSS custom property.\n */\n", + "docComment": "/**\n * Behavior to resolve and make available the neutral-fill-card-rest CSS custom property.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", @@ -3209,7 +4877,7 @@ { "kind": "Variable", "canonicalReference": "@microsoft/fast-components!neutralFillFocusBehavior:var", - "docComment": "/**\n * Behavior to resolve and make available the neutral-fill-focus CSS custom property.\n */\n", + "docComment": "/**\n * Behavior to resolve and make available the neutral-fill-focus CSS custom property.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", @@ -3235,7 +4903,7 @@ { "kind": "Variable", "canonicalReference": "@microsoft/fast-components!neutralFillHoverBehavior:var", - "docComment": "/**\n * Behavior to resolve and make available the neutral-fill-hover CSS custom property.\n */\n", + "docComment": "/**\n * Behavior to resolve and make available the neutral-fill-hover CSS custom property.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", @@ -3261,7 +4929,7 @@ { "kind": "Variable", "canonicalReference": "@microsoft/fast-components!neutralFillInputActiveBehavior:var", - "docComment": "/**\n * Behavior to resolve and make available the neutral-fill-input-active CSS custom property.\n */\n", + "docComment": "/**\n * Behavior to resolve and make available the neutral-fill-input-active CSS custom property.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", @@ -3287,7 +4955,7 @@ { "kind": "Variable", "canonicalReference": "@microsoft/fast-components!neutralFillInputFocusBehavior:var", - "docComment": "/**\n * Behavior to resolve and make available the neutral-fill-input-focus CSS custom property.\n */\n", + "docComment": "/**\n * Behavior to resolve and make available the neutral-fill-input-focus CSS custom property.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", @@ -3313,7 +4981,7 @@ { "kind": "Variable", "canonicalReference": "@microsoft/fast-components!neutralFillInputHoverBehavior:var", - "docComment": "/**\n * Behavior to resolve and make available the neutral-fill-input-hover CSS custom property.\n */\n", + "docComment": "/**\n * Behavior to resolve and make available the neutral-fill-input-hover CSS custom property.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", @@ -3339,7 +5007,7 @@ { "kind": "Variable", "canonicalReference": "@microsoft/fast-components!neutralFillInputRestBehavior:var", - "docComment": "/**\n * Behavior to resolve and make available the neutral-fill-input-rest CSS custom property.\n */\n", + "docComment": "/**\n * Behavior to resolve and make available the neutral-fill-input-rest CSS custom property.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", @@ -3365,7 +5033,7 @@ { "kind": "Variable", "canonicalReference": "@microsoft/fast-components!neutralFillRestBehavior:var", - "docComment": "/**\n * Behavior to resolve and make available the neutral-fill-rest CSS custom property.\n */\n", + "docComment": "/**\n * Behavior to resolve and make available the neutral-fill-rest CSS custom property.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", @@ -3391,7 +5059,7 @@ { "kind": "Variable", "canonicalReference": "@microsoft/fast-components!neutralFillSelectedBehavior:var", - "docComment": "/**\n * Behavior to resolve and make available the neutral-fill-selected CSS custom property.\n */\n", + "docComment": "/**\n * Behavior to resolve and make available the neutral-fill-selected CSS custom property.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", @@ -3417,7 +5085,7 @@ { "kind": "Variable", "canonicalReference": "@microsoft/fast-components!neutralFillStealthActiveBehavior:var", - "docComment": "/**\n * Behavior to resolve and make available the neutral-fill-stealth-active CSS custom property.\n */\n", + "docComment": "/**\n * Behavior to resolve and make available the neutral-fill-stealth-active CSS custom property.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", @@ -3443,7 +5111,7 @@ { "kind": "Variable", "canonicalReference": "@microsoft/fast-components!neutralFillStealthFocusBehavior:var", - "docComment": "/**\n * Behavior to resolve and make available the neutral-fill-stealth-focus CSS custom property.\n */\n", + "docComment": "/**\n * Behavior to resolve and make available the neutral-fill-stealth-focus CSS custom property.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", @@ -3469,7 +5137,7 @@ { "kind": "Variable", "canonicalReference": "@microsoft/fast-components!neutralFillStealthHoverBehavior:var", - "docComment": "/**\n * Behavior to resolve and make available the neutral-fill-stealth-hover CSS custom property.\n */\n", + "docComment": "/**\n * Behavior to resolve and make available the neutral-fill-stealth-hover CSS custom property.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", @@ -3495,7 +5163,7 @@ { "kind": "Variable", "canonicalReference": "@microsoft/fast-components!neutralFillStealthRestBehavior:var", - "docComment": "/**\n * Behavior to resolve and make available the neutral-fill-stealth-rest CSS custom property.\n */\n", + "docComment": "/**\n * Behavior to resolve and make available the neutral-fill-stealth-rest CSS custom property.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", @@ -3521,7 +5189,7 @@ { "kind": "Variable", "canonicalReference": "@microsoft/fast-components!neutralFillStealthSelectedBehavior:var", - "docComment": "/**\n * Behavior to resolve and make available the neutral-fill-stealth-selected CSS custom property.\n */\n", + "docComment": "/**\n * Behavior to resolve and make available the neutral-fill-stealth-selected CSS custom property.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", @@ -3547,7 +5215,7 @@ { "kind": "Variable", "canonicalReference": "@microsoft/fast-components!neutralFillToggleActiveBehavior:var", - "docComment": "/**\n * Behavior to resolve and make available the neutral-fill-toggle-active CSS custom property.\n */\n", + "docComment": "/**\n * Behavior to resolve and make available the neutral-fill-toggle-active CSS custom property.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", @@ -3573,7 +5241,7 @@ { "kind": "Variable", "canonicalReference": "@microsoft/fast-components!neutralFillToggleFocusBehavior:var", - "docComment": "/**\n * Behavior to resolve and make available the neutral-fill-toggle-focus CSS custom property.\n */\n", + "docComment": "/**\n * Behavior to resolve and make available the neutral-fill-toggle-focus CSS custom property.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", @@ -3599,7 +5267,7 @@ { "kind": "Variable", "canonicalReference": "@microsoft/fast-components!neutralFillToggleHoverBehavior:var", - "docComment": "/**\n * Behavior to resolve and make available the neutral-fill-toggle-hover CSS custom property.\n */\n", + "docComment": "/**\n * Behavior to resolve and make available the neutral-fill-toggle-hover CSS custom property.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", @@ -3625,7 +5293,7 @@ { "kind": "Variable", "canonicalReference": "@microsoft/fast-components!neutralFillToggleRestBehavior:var", - "docComment": "/**\n * Behavior to resolve and make available the neutral-fill-toggle-rest CSS custom property.\n */\n", + "docComment": "/**\n * Behavior to resolve and make available the neutral-fill-toggle-rest CSS custom property.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", @@ -3651,7 +5319,7 @@ { "kind": "Variable", "canonicalReference": "@microsoft/fast-components!neutralFocusBehavior:var", - "docComment": "/**\n * Behavior to resolve and make available the neutral-focus CSS custom property.\n */\n", + "docComment": "/**\n * Behavior to resolve and make available the neutral-focus CSS custom property.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", @@ -3677,7 +5345,7 @@ { "kind": "Variable", "canonicalReference": "@microsoft/fast-components!neutralFocusInnerAccentBehavior:var", - "docComment": "/**\n * Behavior to resolve and make available the neutral-focus-inner-accent CSS custom property.\n */\n", + "docComment": "/**\n * Behavior to resolve and make available the neutral-focus-inner-accent CSS custom property.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", @@ -3703,7 +5371,7 @@ { "kind": "Variable", "canonicalReference": "@microsoft/fast-components!neutralForegroundActiveBehavior:var", - "docComment": "/**\n * Behavior to resolve and make available the neutral-foreground-active CSS custom property.\n */\n", + "docComment": "/**\n * Behavior to resolve and make available the neutral-foreground-active CSS custom property.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", @@ -3729,7 +5397,7 @@ { "kind": "Variable", "canonicalReference": "@microsoft/fast-components!neutralForegroundFocusBehavior:var", - "docComment": "/**\n * Behavior to resolve and make available the neutral-foreground-focus CSS custom property.\n */\n", + "docComment": "/**\n * Behavior to resolve and make available the neutral-foreground-focus CSS custom property.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", @@ -3755,7 +5423,7 @@ { "kind": "Variable", "canonicalReference": "@microsoft/fast-components!neutralForegroundHintBehavior:var", - "docComment": "/**\n * Behavior to resolve and make available the neutral-foreground-hint CSS custom property.\n */\n", + "docComment": "/**\n * Behavior to resolve and make available the neutral-foreground-hint CSS custom property.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", @@ -3781,7 +5449,7 @@ { "kind": "Variable", "canonicalReference": "@microsoft/fast-components!neutralForegroundHintLargeBehavior:var", - "docComment": "/**\n * Behavior to resolve and make available the neutral-foreground-hint-large CSS custom property.\n */\n", + "docComment": "/**\n * Behavior to resolve and make available the neutral-foreground-hint-large CSS custom property.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", @@ -3807,7 +5475,7 @@ { "kind": "Variable", "canonicalReference": "@microsoft/fast-components!neutralForegroundHoverBehavior:var", - "docComment": "/**\n * Behavior to resolve and make available the neutral-foreground-hover CSS custom property.\n */\n", + "docComment": "/**\n * Behavior to resolve and make available the neutral-foreground-hover CSS custom property.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", @@ -3833,7 +5501,7 @@ { "kind": "Variable", "canonicalReference": "@microsoft/fast-components!neutralForegroundRestBehavior:var", - "docComment": "/**\n * Behavior to resolve and make available the neutral-foreground-rest CSS custom property.\n */\n", + "docComment": "/**\n * Behavior to resolve and make available the neutral-foreground-rest CSS custom property.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", @@ -3859,7 +5527,7 @@ { "kind": "Variable", "canonicalReference": "@microsoft/fast-components!neutralForegroundToggleBehavior:var", - "docComment": "/**\n * Behavior to resolve and make available the neutral-foreground-toggle CSS custom property.\n */\n", + "docComment": "/**\n * Behavior to resolve and make available the neutral-foreground-toggle CSS custom property.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", @@ -3885,7 +5553,7 @@ { "kind": "Variable", "canonicalReference": "@microsoft/fast-components!neutralForegroundToggleLargeBehavior:var", - "docComment": "/**\n * Behavior to resolve and make available the neutral-foreground-toggle-large CSS custom property.\n */\n", + "docComment": "/**\n * Behavior to resolve and make available the neutral-foreground-toggle-large CSS custom property.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", @@ -3911,7 +5579,7 @@ { "kind": "Variable", "canonicalReference": "@microsoft/fast-components!neutralLayerCardBehavior:var", - "docComment": "/**\n * Behavior to resolve and make available the neutral-layer-card CSS custom property.\n */\n", + "docComment": "/**\n * Behavior to resolve and make available the neutral-layer-card CSS custom property.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", @@ -3937,7 +5605,7 @@ { "kind": "Variable", "canonicalReference": "@microsoft/fast-components!neutralLayerCardContainerBehavior:var", - "docComment": "/**\n * Behavior to resolve and make available the neutral-layer-card-container CSS custom property.\n */\n", + "docComment": "/**\n * Behavior to resolve and make available the neutral-layer-card-container CSS custom property.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", @@ -3963,7 +5631,7 @@ { "kind": "Variable", "canonicalReference": "@microsoft/fast-components!neutralLayerFloatingBehavior:var", - "docComment": "/**\n * Behavior to resolve and make available the neutral-layer-floating CSS custom property.\n */\n", + "docComment": "/**\n * Behavior to resolve and make available the neutral-layer-floating CSS custom property.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", @@ -3989,7 +5657,7 @@ { "kind": "Variable", "canonicalReference": "@microsoft/fast-components!neutralLayerL1AltBehavior:var", - "docComment": "/**\n * Behavior to resolve and make available the neutral-layer-l1-alt CSS custom property.\n */\n", + "docComment": "/**\n * Behavior to resolve and make available the neutral-layer-l1-alt CSS custom property.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", @@ -4015,7 +5683,7 @@ { "kind": "Variable", "canonicalReference": "@microsoft/fast-components!neutralLayerL1Behavior:var", - "docComment": "/**\n * Behavior to resolve and make available the neutral-layer-l1 CSS custom property.\n */\n", + "docComment": "/**\n * Behavior to resolve and make available the neutral-layer-l1 CSS custom property.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", @@ -4041,7 +5709,7 @@ { "kind": "Variable", "canonicalReference": "@microsoft/fast-components!neutralLayerL2Behavior:var", - "docComment": "/**\n * Behavior to resolve and make available the neutral-layer-l2 CSS custom property.\n */\n", + "docComment": "/**\n * Behavior to resolve and make available the neutral-layer-l2 CSS custom property.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", @@ -4067,7 +5735,7 @@ { "kind": "Variable", "canonicalReference": "@microsoft/fast-components!neutralLayerL3Behavior:var", - "docComment": "/**\n * Behavior to resolve and make available the neutral-layer-l3 CSS custom property.\n */\n", + "docComment": "/**\n * Behavior to resolve and make available the neutral-layer-l3 CSS custom property.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", @@ -4093,7 +5761,7 @@ { "kind": "Variable", "canonicalReference": "@microsoft/fast-components!neutralLayerL4Behavior:var", - "docComment": "/**\n * Behavior to resolve and make available the neutral-layer-l4 CSS custom property.\n */\n", + "docComment": "/**\n * Behavior to resolve and make available the neutral-layer-l4 CSS custom property.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", @@ -4119,7 +5787,7 @@ { "kind": "Variable", "canonicalReference": "@microsoft/fast-components!neutralOutlineActiveBehavior:var", - "docComment": "/**\n * Behavior to resolve and make available the neutral-outline-active CSS custom property.\n */\n", + "docComment": "/**\n * Behavior to resolve and make available the neutral-outline-active CSS custom property.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", @@ -4145,7 +5813,7 @@ { "kind": "Variable", "canonicalReference": "@microsoft/fast-components!neutralOutlineFocusBehavior:var", - "docComment": "/**\n * Behavior to resolve and make available the neutral-outline-focus CSS custom property.\n */\n", + "docComment": "/**\n * Behavior to resolve and make available the neutral-outline-focus CSS custom property.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", @@ -4171,7 +5839,7 @@ { "kind": "Variable", "canonicalReference": "@microsoft/fast-components!neutralOutlineHoverBehavior:var", - "docComment": "/**\n * Behavior to resolve and make available the neutral-outline-hover CSS custom property.\n */\n", + "docComment": "/**\n * Behavior to resolve and make available the neutral-outline-hover CSS custom property.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", @@ -4197,7 +5865,7 @@ { "kind": "Variable", "canonicalReference": "@microsoft/fast-components!neutralOutlineRestBehavior:var", - "docComment": "/**\n * Behavior to resolve and make available the neutral-outline-rest CSS custom property.\n */\n", + "docComment": "/**\n * Behavior to resolve and make available the neutral-outline-rest CSS custom property.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", @@ -4223,7 +5891,7 @@ { "kind": "TypeAlias", "canonicalReference": "@microsoft/fast-components!Palette:type", - "docComment": "/**\n * The structure of a color palette\n */\n", + "docComment": "/**\n * The structure of a color palette\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", @@ -4253,7 +5921,7 @@ { "kind": "Enum", "canonicalReference": "@microsoft/fast-components!PaletteType:enum", - "docComment": "/**\n * The named palettes of the MSFT design system\n *\n * @deprecated\n *\n * - use neutralPalette and accentPalette functions instead\n */\n", + "docComment": "/**\n * The named palettes of the MSFT design system\n *\n * @deprecated\n *\n * - use neutralPalette and accentPalette functions instead\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", @@ -4310,7 +5978,7 @@ { "kind": "Enum", "canonicalReference": "@microsoft/fast-components!StandardLuminance:enum", - "docComment": "/**\n * Recommended values for light and dark mode for `baseLayerLuminance` in the design system.\n */\n", + "docComment": "/**\n * Recommended values for light and dark mode for {@link @microsoft/fast-components#FASTDesignSystem.baseLayerLuminance}.\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 e642557992f..b206ee65689 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": "", + "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", @@ -37,100 +37,10 @@ "releaseTag": "Public", "name": "Accordion", "members": [ - { - "kind": "Property", - "canonicalReference": "@microsoft/fast-foundation!Accordion#accordionItems:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "accordionItems: " - }, - { - "kind": "Reference", - "text": "HTMLElement", - "canonicalReference": "!HTMLElement:interface" - }, - { - "kind": "Content", - "text": "[]" - }, - { - "kind": "Content", - "text": ";" - } - ], - "releaseTag": "Public", - "name": "accordionItems", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 3 - }, - "isStatic": false - }, - { - "kind": "Method", - "canonicalReference": "@microsoft/fast-foundation!Accordion#accordionItemsChanged:member(1)", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "accordionItemsChanged(oldValue: " - }, - { - "kind": "Content", - "text": "any" - }, - { - "kind": "Content", - "text": ", newValue: " - }, - { - "kind": "Content", - "text": "any" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Content", - "text": "void" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isStatic": false, - "returnTypeTokenRange": { - "startIndex": 5, - "endIndex": 6 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "oldValue", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "parameterName": "newValue", - "parameterTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 - } - } - ], - "name": "accordionItemsChanged" - }, { "kind": "Property", "canonicalReference": "@microsoft/fast-foundation!Accordion#expandmode:member", - "docComment": "", + "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", @@ -164,7 +74,7 @@ { "kind": "Enum", "canonicalReference": "@microsoft/fast-foundation!AccordionExpandMode:enum", - "docComment": "", + "docComment": "/**\n * Expand mode for {@link Accordion}\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", @@ -177,7 +87,7 @@ { "kind": "EnumMember", "canonicalReference": "@microsoft/fast-foundation!AccordionExpandMode.multi:member", - "docComment": "", + "docComment": "/**\n * Designates multiple {@link @microsoft/fast-foundation#(AccordionItem:class) | AccordionItems} can be open simultaneously.\n */\n", "excerptTokens": [ { "kind": "Content", @@ -198,7 +108,7 @@ { "kind": "EnumMember", "canonicalReference": "@microsoft/fast-foundation!AccordionExpandMode.single:member", - "docComment": "", + "docComment": "/**\n * Designates only a single {@link @microsoft/fast-foundation#(AccordionItem:class)} can be open a time.\n */\n", "excerptTokens": [ { "kind": "Content", @@ -221,7 +131,7 @@ { "kind": "Class", "canonicalReference": "@microsoft/fast-foundation!AccordionItem:class", - "docComment": "", + "docComment": "/**\n * An individual item in an {@link @microsoft/fast-foundation#(Accordion:class)}.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", @@ -240,72 +150,10 @@ "releaseTag": "Public", "name": "AccordionItem", "members": [ - { - "kind": "Property", - "canonicalReference": "@microsoft/fast-foundation!AccordionItem#clickHandler:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "clickHandler: " - }, - { - "kind": "Content", - "text": "(e: " - }, - { - "kind": "Reference", - "text": "MouseEvent", - "canonicalReference": "!MouseEvent:interface" - }, - { - "kind": "Content", - "text": ") => void" - }, - { - "kind": "Content", - "text": ";" - } - ], - "releaseTag": "Public", - "name": "clickHandler", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 4 - }, - "isStatic": false - }, - { - "kind": "Property", - "canonicalReference": "@microsoft/fast-foundation!AccordionItem#expandbutton:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "expandbutton: " - }, - { - "kind": "Reference", - "text": "HTMLElement", - "canonicalReference": "!HTMLElement:interface" - }, - { - "kind": "Content", - "text": ";" - } - ], - "releaseTag": "Public", - "name": "expandbutton", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isStatic": false - }, { "kind": "Property", "canonicalReference": "@microsoft/fast-foundation!AccordionItem#expanded:member", - "docComment": "", + "docComment": "/**\n * Expands or collapses the item.\n *\n * @remarks\n *\n * HTML attribute: expanded\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", @@ -331,7 +179,7 @@ { "kind": "Property", "canonicalReference": "@microsoft/fast-foundation!AccordionItem#headinglevel:member", - "docComment": "", + "docComment": "/**\n * Configures the {@link https://www.w3.org/TR/wai-aria-1.1/#aria-level | level} of the heading element.\n *\n * @remarks\n *\n * HTML attribute: heading-level\n *\n * @defaultValue\n *\n * 2\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", @@ -357,7 +205,7 @@ { "kind": "Property", "canonicalReference": "@microsoft/fast-foundation!AccordionItem#id:member", - "docComment": "", + "docComment": "/**\n * The item ID\n *\n * @remarks\n *\n * HTML Attribute: id\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", @@ -387,39 +235,10 @@ }, "implementsTokenRanges": [] }, - { - "kind": "Interface", - "canonicalReference": "@microsoft/fast-foundation!AccordionItem:interface", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "export interface AccordionItem extends " - }, - { - "kind": "Reference", - "text": "StartEnd", - "canonicalReference": "@microsoft/fast-foundation!StartEnd:class" - }, - { - "kind": "Content", - "text": " " - } - ], - "releaseTag": "Public", - "name": "AccordionItem", - "members": [], - "extendsTokenRanges": [ - { - "startIndex": 1, - "endIndex": 3 - } - ] - }, { "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", @@ -458,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", @@ -497,7 +316,7 @@ { "kind": "Class", "canonicalReference": "@microsoft/fast-foundation!Anchor:class", - "docComment": "", + "docComment": "/**\n * An Anchor Custom HTML Element. Based largely on the {@link https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a | element}.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", @@ -519,7 +338,7 @@ { "kind": "Property", "canonicalReference": "@microsoft/fast-foundation!Anchor#appearance:member", - "docComment": "", + "docComment": "/**\n * The appearance the anchor should have.\n *\n * @remarks\n *\n * HTML Attribute: appearance\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", @@ -546,7 +365,7 @@ { "kind": "Property", "canonicalReference": "@microsoft/fast-foundation!Anchor#download:member", - "docComment": "", + "docComment": "/**\n * Prompts the user to save the linked URL. See {@link https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a | element} for more information.\n *\n * @remarks\n *\n * HTML Attribute: download\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", @@ -572,7 +391,7 @@ { "kind": "Property", "canonicalReference": "@microsoft/fast-foundation!Anchor#href:member", - "docComment": "", + "docComment": "/**\n * The URL the hyperlink references. See {@link https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a | element} for more information.\n *\n * @remarks\n *\n * HTML Attribute: href\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", @@ -598,7 +417,7 @@ { "kind": "Property", "canonicalReference": "@microsoft/fast-foundation!Anchor#hreflang:member", - "docComment": "", + "docComment": "/**\n * Hints at the language of the referenced resource. See {@link https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a | element} for more information.\n *\n * @remarks\n *\n * HTML Attribute: hreflang\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", @@ -624,7 +443,7 @@ { "kind": "Property", "canonicalReference": "@microsoft/fast-foundation!Anchor#ping:member", - "docComment": "", + "docComment": "/**\n * See {@link https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a | element} for more information.\n *\n * @remarks\n *\n * HTML Attribute: ping\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", @@ -650,7 +469,7 @@ { "kind": "Property", "canonicalReference": "@microsoft/fast-foundation!Anchor#referrerpolicy:member", - "docComment": "", + "docComment": "/**\n * See {@link https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a | element} for more information.\n *\n * @remarks\n *\n * HTML Attribute: referrerpolicy\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", @@ -676,7 +495,7 @@ { "kind": "Property", "canonicalReference": "@microsoft/fast-foundation!Anchor#rel:member", - "docComment": "", + "docComment": "/**\n * See {@link https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a | element} for more information.\n *\n * @remarks\n *\n * HTML Attribute: rel\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", @@ -702,7 +521,7 @@ { "kind": "Property", "canonicalReference": "@microsoft/fast-foundation!Anchor#target:member", - "docComment": "", + "docComment": "/**\n * See {@link https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a | element} for more information.\n *\n * @remarks\n *\n * HTML Attribute: target\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", @@ -728,7 +547,7 @@ { "kind": "Property", "canonicalReference": "@microsoft/fast-foundation!Anchor#type:member", - "docComment": "", + "docComment": "/**\n * See {@link https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a | element} for more information.\n *\n * @remarks\n *\n * HTML Attribute: type\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", @@ -758,39 +577,10 @@ }, "implementsTokenRanges": [] }, - { - "kind": "Interface", - "canonicalReference": "@microsoft/fast-foundation!Anchor:interface", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "export interface Anchor extends " - }, - { - "kind": "Reference", - "text": "StartEnd", - "canonicalReference": "@microsoft/fast-foundation!StartEnd:class" - }, - { - "kind": "Content", - "text": " " - } - ], - "releaseTag": "Public", - "name": "Anchor", - "members": [], - "extendsTokenRanges": [ - { - "startIndex": 1, - "endIndex": 3 - } - ] - }, { "kind": "TypeAlias", "canonicalReference": "@microsoft/fast-foundation!AnchorAppearance:type", - "docComment": "", + "docComment": "/**\n * Types of anchor appearance.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", @@ -820,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", @@ -859,7 +649,7 @@ { "kind": "Function", "canonicalReference": "@microsoft/fast-foundation!applyMixins:function(1)", - "docComment": "/**\n * Apply mixins to a constructor.\n *\n * https://www.typescriptlang.org/docs/handbook/mixins.html\n */\n", + "docComment": "/**\n * Apply mixins to a constructor. Sourced from {@link https://www.typescriptlang.org/docs/handbook/mixins.html | TypeScript Documentation}.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", @@ -917,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", @@ -939,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", @@ -965,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: fill\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", @@ -991,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", @@ -1024,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", @@ -1063,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", @@ -1085,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", @@ -1111,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", @@ -1137,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", @@ -1163,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", @@ -1196,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 |