{ "schemaVersion": "1.0.0", "readme": "", "modules": [ { "kind": "javascript-module", "path": "src/base-components.ts", "declarations": [ { "kind": "variable", "name": "baseComponents", "type": { "text": "object" }, "default": "{\n foundationAccordion,\n foundationAiCriteriaSearch,\n foundationAiIndicator,\n foundationAccordionItem,\n foundationActionsMenu,\n foundationAnchor,\n foundationAnchoredRegion,\n foundationAvatar,\n foundationBadge,\n foundationBanner,\n foundationBreadcrumb,\n foundationBreadcrumbItem,\n foundationButton,\n foundationCalendar,\n foundationCard,\n foundationCategorizedMultiselect,\n foundationCheckbox,\n foundationCombobox,\n foundationConnectionIndicator,\n foundationDataGrid,\n foundationDataGridCell,\n foundationDataGridRow,\n foundationDatePicker,\n foundationDesignSystemProvider,\n foundationDialog,\n foundationDisclosure,\n foundationDivider,\n foundationDropdownMenu,\n foundationErrorBanner,\n foundationErrorBoundary,\n foundationErrorDialog,\n foundationFileReader,\n foundationFileUpload,\n foundationFilter,\n foundationFilterBar,\n foundationFlexLayout,\n foundationFlipper,\n foundationFlyout,\n foundationGridLayout,\n foundationGridLayoutItem,\n foundationHorizontalScroll,\n foundationIcon,\n foundationListbox,\n foundationListboxOption,\n foundationMenu,\n foundationMenuItem,\n foundationModal,\n foundationMultiselect,\n foundationNumberField,\n foundationOptgroup,\n foundationPopper,\n foundationProgress,\n foundationProgressRing,\n foundationRadio,\n foundationRadioGroup,\n foundationScheduler,\n foundationSchedulerCronBuilder,\n foundationSchedulerTimezone,\n foundationSearchBar,\n foundationSearchBarCombobox,\n foundationSegmentedControl,\n foundationSegmentedItem,\n foundationSelect,\n foundationSkeleton,\n foundationSlider,\n foundationSliderLabel,\n foundationSnackbar,\n foundationStackingIcons,\n foundationStatusPill,\n foundationEnvironmentIndicator,\n foundationStepperTab,\n foundationStepperTabPanel,\n foundationSwitch,\n foundationSystemHealthOverlay,\n foundationTab,\n foundationTabPanel,\n foundationTabs,\n foundationTextArea,\n foundationTextField,\n foundationToast,\n foundationToolbar,\n foundationTooltip,\n foundationTreeItem,\n foundationTreeView,\n foundationUrlInput,\n foundationSectionNavigator,\n register(container?: Container, ...rest: any[]) {\n if (!container) {\n // preserve backward compatibility with code that loops through\n // the values of this object and calls them as funcs with no args\n return;\n }\n\n for (const key in this) {\n if (key === 'register') {\n continue;\n }\n\n this[key]().register(container, ...rest);\n }\n },\n}" } ], "exports": [ { "kind": "js", "name": "baseComponents", "declaration": { "name": "baseComponents", "module": "src/base-components.ts" } } ] }, { "kind": "javascript-module", "path": "src/index.ts", "declarations": [ { "kind": "function", "name": "registerFoundationDesignSystem" } ], "exports": [ { "kind": "js", "name": "baseComponents", "declaration": { "name": "baseComponents", "module": "src/index.ts" } }, { "kind": "js", "name": "createDesignSystemProxy", "declaration": { "name": "createDesignSystemProxy", "module": "src/index.ts" } }, { "kind": "js", "name": "provideDesignSystem", "declaration": { "name": "provideDesignSystem", "module": "src/index.ts" } }, { "kind": "js", "name": "registerFoundationDesignSystem", "declaration": { "name": "registerFoundationDesignSystem", "module": "src/index.ts" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./_common" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./_config" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./accordion" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./ai-criteria-search" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./ai-indicator" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./accordion-item" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./actions-menu" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./anchor" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./anchored-region" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./avatar" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./badge" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./banner" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./breadcrumb" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./breadcrumb-item" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./button" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./calendar" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./card" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./categorized-multiselect" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./checkbox" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./combobox" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./connection-indicator" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./context" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./data-grid" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./data-grid-cell" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./data-grid-datasource" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./data-grid-row" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./date-picker" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./design-system-provider" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./dialog" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./disclosure" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./divider" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./dropdown-menu" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./environment-indicator" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./error-banner" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./error-boundary" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./error-dialog" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./expression-builder" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./file-reader" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./file-upload" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./filter" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./filter-bar" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./flex-layout" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./flipper" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./flyout" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./grid-layout" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./grid-layout-item" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./horizontal-scroll" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./icon" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./listbox" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./listbox-option" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./menu" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./menu-item" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./modal" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./multiselect" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./notification-listener" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./number-field" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./optgroup" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./options-datasource" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./overlays" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./patterns" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./popper" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./progress" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./progress-ring" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./radio" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./radio-group" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./router" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./scheduler" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./scheduler-cron-builder" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./scheduler-timezone" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./search-bar" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./section-navigator" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./segmented-control" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./segmented-item" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./select" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./skeleton" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./slider" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./slider-label" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./snackbar" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./stacking-icons" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./status-pill" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./stepper" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./stepper-tab" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./stepper-tab-panel" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./switch" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./tab" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./tab-panel" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./tabs" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./text-area" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./text-field" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./toast" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./toolbar" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./tooltip" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./tree-item" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./tree-view" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./url-input" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./utils/base-datasource" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./utils/editable-elements" } }, { "kind": "js", "name": "getDesignSystemPrefix", "declaration": { "name": "getPrefix", "module": "./utils/dom" } } ] }, { "kind": "javascript-module", "path": "src/provide-design-system.ts", "declarations": [ { "kind": "function", "name": "createDesignSystemProxy", "parameters": [ { "name": "designSystem", "type": { "text": "DesignSystem" } } ] }, { "kind": "function", "name": "provideDesignSystem", "return": { "type": { "text": "" } }, "parameters": [ { "name": "element", "optional": true, "type": { "text": "HTMLElement" }, "description": "The element to root the design system at. By default, this is the body." }, { "name": "prefix", "default": "'foundation'", "description": "The prefix for the design system. By default, this is 'foundation'." }, { "name": "tokens", "optional": true, "type": { "text": "any" }, "description": "The tokens for the design system. By default, this is the foundation tokens." }, { "name": "values", "optional": true, "type": { "text": "any" }, "description": "The values for the design system. By default, this is the foundation values." } ], "description": "Provides a design system for the specified element either by returning one that was\nalready created for that element or creating one.", "privacy": "public" } ], "exports": [ { "kind": "js", "name": "createDesignSystemProxy", "declaration": { "name": "createDesignSystemProxy", "module": "src/provide-design-system.ts" } }, { "kind": "js", "name": "provideDesignSystem", "declaration": { "name": "provideDesignSystem", "module": "src/provide-design-system.ts" } } ] }, { "kind": "javascript-module", "path": "src/_common/affix-mixin.ts", "declarations": [ { "kind": "mixin", "description": "Mixin that adds prefix/suffix affix support with screen-reader handling to an input field component.\nShared between TextField and NumberField to keep the behaviour consistent and avoid duplication.", "name": "AffixMixin", "members": [ { "kind": "field", "name": "prefix", "type": { "text": "string" }, "description": "Optional non-editable label shown on the left inside the field, before the input." }, { "kind": "field", "name": "suffix", "type": { "text": "string" }, "description": "Optional non-editable suffix (e.g. unit label) shown on the right inside the field." }, { "kind": "field", "name": "hideAffixFromScreenReader", "type": { "text": "boolean" }, "default": "false", "description": "When true, prefix/suffix are not exposed to assistive technology (`aria-hidden` on affixes,\nand their ids are omitted from the control's `aria-describedby`).\nUse only when the unit or symbol is redundant with the visible label or other text." } ], "parameters": [ { "name": "Base", "type": { "text": "TBase" } } ] } ], "exports": [ { "kind": "js", "name": "AffixMixin", "declaration": { "name": "AffixMixin", "module": "src/_common/affix-mixin.ts" } } ] }, { "kind": "javascript-module", "path": "src/_common/base-file-component.ts", "declarations": [ { "kind": "class", "description": "Abstract base class for file handling components\nProvides common functionality for file selection, validation, and UI state management", "name": "BaseFileComponent", "members": [ { "kind": "field", "name": "fileInput", "type": { "text": "HTMLInputElement" }, "privacy": "public" }, { "kind": "field", "name": "selectedFile", "type": { "text": "File | null" }, "privacy": "protected", "default": "null" }, { "kind": "field", "name": "label", "type": { "text": "string" } }, { "kind": "field", "name": "accept", "type": { "text": "string" }, "default": "''" }, { "kind": "field", "name": "fileSizeLimitBytes", "default": "10_485_760", "type": { "text": "number" } }, { "kind": "field", "name": "fileName", "type": { "text": "string" }, "default": "''" }, { "kind": "field", "name": "isProcessing", "type": { "text": "boolean" }, "default": "false" }, { "kind": "method", "name": "handleClick", "privacy": "public", "description": "Opens the file picker dialog\nClears any previous file selection before opening" }, { "kind": "method", "name": "onInputChange", "privacy": "public", "parameters": [ { "name": "e", "type": { "text": "Event" }, "description": "The change event from the file input" } ], "description": "Handles file selection from the file input\nValidates file size and sets up for processing" }, { "kind": "method", "name": "clearSelection", "privacy": "public", "description": "Clears all file selection and processing state\nResets the component to its initial state" }, { "kind": "method", "name": "getSelectedFile", "privacy": "public", "description": "Gets the currently selected file object", "return": { "type": { "text": "" } } }, { "kind": "method", "name": "showError", "privacy": "protected", "parameters": [ { "name": "title", "type": { "text": "string" }, "description": "The error title" }, { "name": "message", "type": { "text": "string" }, "description": "The error message" } ], "description": "Shows an error notification using the unified error handling system" }, { "kind": "method", "name": "onFileSelected", "privacy": "protected", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "files", "type": { "text": "File[]" }, "description": "The selected file" } ], "description": "Abstract method called when a file is selected" }, { "kind": "method", "name": "onFileCleared", "privacy": "protected", "return": { "type": { "text": "void" } }, "description": "Abstract method called when file selection is cleared" }, { "kind": "field", "name": "_presentation", "type": { "text": "ComponentPresentation | null | undefined" }, "privacy": "private", "default": "void 0", "inheritedFrom": { "name": "FoundationElement", "module": "src/foundation-element/foundation-element.ts" } }, { "kind": "field", "name": "$presentation", "type": { "text": "ComponentPresentation | null" }, "privacy": "public", "description": "A property which resolves the ComponentPresentation instance\nfor the current component.", "inheritedFrom": { "name": "FoundationElement", "module": "src/foundation-element/foundation-element.ts" } }, { "kind": "field", "name": "template", "type": { "text": "ElementViewTemplate | void | null" }, "privacy": "public", "description": "Sets the template of the element instance. When undefined,\nthe element will attempt to resolve the template from\nthe associated presentation or custom element definition.", "inheritedFrom": { "name": "FoundationElement", "module": "src/foundation-element/foundation-element.ts" } }, { "kind": "method", "name": "templateChanged", "privacy": "protected", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "FoundationElement", "module": "src/foundation-element/foundation-element.ts" } }, { "kind": "field", "name": "styles", "type": { "text": "ElementStyles | void | null" }, "privacy": "public", "description": "Sets the default styles for the element instance. When undefined,\nthe element will attempt to resolve default styles from\nthe associated presentation or custom element definition.", "inheritedFrom": { "name": "FoundationElement", "module": "src/foundation-element/foundation-element.ts" } }, { "kind": "method", "name": "stylesChanged", "privacy": "protected", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "FoundationElement", "module": "src/foundation-element/foundation-element.ts" } }, { "kind": "method", "name": "compose", "privacy": "public", "static": true, "return": { "type": { "text": "(\n overrideDefinition?: OverrideFoundationElementDefinition\n ) => FoundationElementRegistry" } }, "parameters": [ { "name": "this", "type": { "text": "K" } }, { "name": "elementDefinition", "type": { "text": "T" }, "description": "The definition of the element to create the registry\nfunction for." } ], "description": "Defines an element registry function with a set of element definition defaults.", "inheritedFrom": { "name": "FoundationElement", "module": "src/foundation-element/foundation-element.ts" } } ], "events": [ { "description": "Fired when file size validation fails", "name": "error" }, { "description": "Fired when selection is cleared", "name": "clear" } ], "attributes": [ { "name": "label", "type": { "text": "string" }, "fieldName": "label" }, { "name": "accept", "type": { "text": "string" }, "default": "''", "fieldName": "accept" }, { "name": "file-size-limit-bytes", "default": "DEFAULT_FILE_SIZE_LIMIT", "resolveInitializer": { "module": "src/_common/base-file-component.ts" }, "fieldName": "fileSizeLimitBytes" } ], "superclass": { "name": "FoundationElement", "package": "@microsoft/fast-foundation" } } ], "exports": [ { "kind": "js", "name": "BaseFileComponent", "declaration": { "name": "BaseFileComponent", "module": "src/_common/base-file-component.ts" } } ] }, { "kind": "javascript-module", "path": "src/_common/field-styles.ts", "declarations": [ { "kind": "variable", "name": "sharedFieldStyles", "default": "css`\n .label-hidden {\n margin: 0;\n }\n\n .control-field {\n display: flex;\n flex: 1 1 0%;\n min-width: 0;\n align-self: stretch;\n align-items: stretch;\n }\n\n .control-field .control {\n flex: 1 1 auto;\n min-width: 0;\n width: auto;\n }\n\n .prefix,\n .suffix {\n display: flex;\n align-items: center;\n flex-shrink: 0;\n box-sizing: border-box;\n padding: 0 calc(var(--design-unit) * 2px);\n user-select: none;\n white-space: nowrap;\n background-color: var(--neutral-fill-rest);\n color: var(--neutral-foreground-hint);\n font-size: var(--type-ramp-base-font-size);\n font-family: inherit;\n line-height: 1;\n }\n\n .prefix {\n border-right: 1px solid var(--neutral-stroke-divider-rest);\n border-radius: calc(var(--control-corner-radius) * 1px) 0 0\n calc(var(--control-corner-radius) * 1px);\n }\n\n .suffix {\n border-left: 1px solid var(--neutral-stroke-divider-rest);\n border-radius: 0 calc(var(--control-corner-radius) * 1px)\n calc(var(--control-corner-radius) * 1px) 0;\n }\n\n :host(.has-prefix:not(.has-suffix)) .control-field .control {\n border-radius: 0 calc(var(--control-corner-radius) * 1px)\n calc(var(--control-corner-radius) * 1px) 0;\n }\n\n :host(.has-suffix:not(.has-prefix)) .control-field .control {\n border-radius: calc(var(--control-corner-radius) * 1px) 0 0\n calc(var(--control-corner-radius) * 1px);\n }\n\n :host(.has-prefix.has-suffix) .control-field .control {\n border-radius: 0;\n }\n`" } ], "exports": [ { "kind": "js", "name": "sharedFieldStyles", "declaration": { "name": "sharedFieldStyles", "module": "src/_common/field-styles.ts" } } ] }, { "kind": "javascript-module", "path": "src/_common/icons.ts", "declarations": [ { "kind": "function", "name": "closeIcon", "parameters": [ { "name": "slot", "default": "'start'" }, { "name": "fill", "default": "'#879ba6'" } ] } ], "exports": [ { "kind": "js", "name": "closeIcon", "declaration": { "name": "closeIcon", "module": "src/_common/icons.ts" } } ] }, { "kind": "javascript-module", "path": "src/_common/index.ts", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./affix-mixin" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./base-file-component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./field-styles" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./icons" } } ] }, { "kind": "javascript-module", "path": "src/_config/index.ts", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./styles" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./tokens" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./values" } } ] }, { "kind": "javascript-module", "path": "src/accordion-item/accordion-item.styles.ts", "declarations": [ { "kind": "function", "name": "foundationAccordionItemStyles", "return": { "type": { "text": "ElementStyles" } }, "parameters": [ { "name": "context", "type": { "text": "ElementDefinitionContext" } }, { "name": "definition", "type": { "text": "FoundationElementDefinition" } } ] } ], "exports": [ { "kind": "js", "name": "foundationAccordionItemStyles", "declaration": { "name": "foundationAccordionItemStyles", "module": "src/accordion-item/accordion-item.styles.ts" } } ] }, { "kind": "javascript-module", "path": "src/accordion-item/accordion-item.template.ts", "declarations": [ { "kind": "function", "name": "foundationAccordionItemTemplate", "return": { "type": { "text": "ViewTemplate" } }, "parameters": [ { "name": "context", "type": { "text": "ElementDefinitionContext" } }, { "name": "definition", "type": { "text": "FoundationElementDefinition" } } ] } ], "exports": [ { "kind": "js", "name": "foundationAccordionItemTemplate", "declaration": { "name": "foundationAccordionItemTemplate", "module": "src/accordion-item/accordion-item.template.ts" } } ] }, { "kind": "javascript-module", "path": "src/accordion-item/accordion-item.ts", "declarations": [ { "kind": "class", "description": "", "name": "AccordionItem", "superclass": { "name": "FASTAccordionItem", "package": "@microsoft/fast-components" }, "tagName": "%%prefix%%-accordion-item", "customElement": true, "attributes": [ { "name": "heading-level", "type": { "text": "1 | 2 | 3 | 4 | 5 | 6" }, "default": "2", "description": "Configures the https://www.w3.org/TR/wai-aria-1.1/#aria-level | level of the\nheading element.", "fieldName": "headinglevel", "inheritedFrom": { "name": "AccordionItem", "module": "src/accordion-item/accordion-item.ts" } }, { "type": { "text": "boolean" }, "default": "false", "description": "Expands or collapses the item.", "fieldName": "expanded", "inheritedFrom": { "name": "AccordionItem", "module": "src/accordion-item/accordion-item.ts" } }, { "name": "id", "type": { "text": "string" }, "description": "The item ID", "fieldName": "id", "inheritedFrom": { "name": "AccordionItem", "module": "src/accordion-item/accordion-item.ts" } } ], "members": [ { "kind": "field", "name": "headinglevel", "type": { "text": "1 | 2 | 3 | 4 | 5 | 6" }, "privacy": "public", "default": "2", "description": "Configures the {@link https://www.w3.org/TR/wai-aria-1.1/#aria-level | level} of the heading element.", "inheritedFrom": { "name": "AccordionItem", "module": "src/accordion-item/accordion-item.ts" } }, { "kind": "field", "name": "expanded", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "description": "Expands or collapses the item.", "inheritedFrom": { "name": "AccordionItem", "module": "src/accordion-item/accordion-item.ts" } }, { "kind": "field", "name": "id", "type": { "text": "string" }, "privacy": "public", "description": "The item ID", "inheritedFrom": { "name": "AccordionItem", "module": "src/accordion-item/accordion-item.ts" } }, { "kind": "field", "name": "change", "privacy": "private", "inheritedFrom": { "name": "AccordionItem", "module": "src/accordion-item/accordion-item.ts" } }, { "kind": "field", "name": "_presentation", "type": { "text": "ComponentPresentation | null | undefined" }, "privacy": "private", "default": "void 0", "inheritedFrom": { "name": "FoundationElement", "module": "src/foundation-element/foundation-element.ts" } }, { "kind": "field", "name": "$presentation", "type": { "text": "ComponentPresentation | null" }, "privacy": "public", "description": "A property which resolves the ComponentPresentation instance\nfor the current component.", "inheritedFrom": { "name": "FoundationElement", "module": "src/foundation-element/foundation-element.ts" } }, { "kind": "field", "name": "template", "type": { "text": "ElementViewTemplate | void | null" }, "privacy": "public", "description": "Sets the template of the element instance. When undefined,\nthe element will attempt to resolve the template from\nthe associated presentation or custom element definition.", "inheritedFrom": { "name": "FoundationElement", "module": "src/foundation-element/foundation-element.ts" } }, { "kind": "method", "name": "templateChanged", "privacy": "protected", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "FoundationElement", "module": "src/foundation-element/foundation-element.ts" } }, { "kind": "field", "name": "styles", "type": { "text": "ElementStyles | void | null" }, "privacy": "public", "description": "Sets the default styles for the element instance. When undefined,\nthe element will attempt to resolve default styles from\nthe associated presentation or custom element definition.", "inheritedFrom": { "name": "FoundationElement", "module": "src/foundation-element/foundation-element.ts" } }, { "kind": "method", "name": "stylesChanged", "privacy": "protected", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "FoundationElement", "module": "src/foundation-element/foundation-element.ts" } }, { "kind": "method", "name": "compose", "privacy": "public", "static": true, "return": { "type": { "text": "(\n overrideDefinition?: OverrideFoundationElementDefinition\n ) => FoundationElementRegistry" } }, "parameters": [ { "name": "this", "type": { "text": "K" } }, { "name": "elementDefinition", "type": { "text": "T" }, "description": "The definition of the element to create the registry\nfunction for." } ], "description": "Defines an element registry function with a set of element definition defaults.", "inheritedFrom": { "name": "FoundationElement", "module": "src/foundation-element/foundation-element.ts" } } ], "events": [ { "description": "Fires a custom 'change' event when the button is invoked", "name": "change", "inheritedFrom": { "name": "AccordionItem", "module": "src/accordion-item/accordion-item.ts" } } ] }, { "kind": "variable", "name": "foundationAccordionItemShadowOptions", "type": { "text": "ShadowRootInit" }, "default": "{\n delegatesFocus: true,\n mode: 'open',\n}" }, { "kind": "variable", "name": "defaultAccordionItemConfig", "type": { "text": "object" }, "default": "{\n collapsedIcon: `\n \n \n \n `,\n expandedIcon: `\n \n \n `,\n}" }, { "kind": "variable", "name": "foundationAccordionItem", "description": "The Foundation Accordion Item", "privacy": "public" } ], "exports": [ { "kind": "js", "name": "AccordionItem", "declaration": { "name": "AccordionItem", "module": "src/accordion-item/accordion-item.ts" } }, { "kind": "js", "name": "foundationAccordionItemShadowOptions", "declaration": { "name": "foundationAccordionItemShadowOptions", "module": "src/accordion-item/accordion-item.ts" } }, { "kind": "js", "name": "defaultAccordionItemConfig", "declaration": { "name": "defaultAccordionItemConfig", "module": "src/accordion-item/accordion-item.ts" } }, { "kind": "js", "name": "foundationAccordionItem", "declaration": { "name": "foundationAccordionItem", "module": "src/accordion-item/accordion-item.ts" } } ] }, { "kind": "javascript-module", "path": "src/accordion-item/index.ts", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./accordion-item.template" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./accordion-item.styles" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./accordion-item" } } ] }, { "kind": "javascript-module", "path": "src/accordion/accordion.styles.ts", "declarations": [ { "kind": "function", "name": "foundationAccordionStyles", "return": { "type": { "text": "ElementStyles" } }, "parameters": [ { "name": "context", "type": { "text": "ElementDefinitionContext" } }, { "name": "definition", "type": { "text": "FoundationElementDefinition" } } ] } ], "exports": [ { "kind": "js", "name": "foundationAccordionStyles", "declaration": { "name": "foundationAccordionStyles", "module": "src/accordion/accordion.styles.ts" } } ] }, { "kind": "javascript-module", "path": "src/accordion/accordion.template.ts", "declarations": [ { "kind": "function", "name": "foundationAccordionTemplate", "return": { "type": { "text": "ViewTemplate" } }, "parameters": [ { "name": "context", "type": { "text": "ElementDefinitionContext" } }, { "name": "definition", "type": { "text": "FoundationElementDefinition" } } ] } ], "exports": [ { "kind": "js", "name": "foundationAccordionTemplate", "declaration": { "name": "foundationAccordionTemplate", "module": "src/accordion/accordion.template.ts" } } ] }, { "kind": "javascript-module", "path": "src/accordion/accordion.ts", "declarations": [ { "kind": "class", "description": "", "name": "Accordion", "superclass": { "name": "FASTAccordion", "package": "@microsoft/fast-foundation" }, "tagName": "%%prefix%%-accordion", "customElement": true, "attributes": [ { "name": "expand-mode", "type": { "text": "AccordionExpandMode" }, "description": "Controls the expand mode of the Accordion, either allowing\nsingle or multiple item expansion.", "fieldName": "expandmode", "inheritedFrom": { "name": "Accordion", "module": "src/accordion/accordion.ts" } } ], "members": [ { "kind": "field", "name": "expandmode", "type": { "text": "AccordionExpandMode" }, "privacy": "public", "description": "Controls the expand mode of the Accordion, either allowing\nsingle or multiple item expansion.", "inheritedFrom": { "name": "Accordion", "module": "src/accordion/accordion.ts" } }, { "kind": "field", "name": "activeid", "type": { "text": "string | null" }, "privacy": "private", "inheritedFrom": { "name": "Accordion", "module": "src/accordion/accordion.ts" } }, { "kind": "field", "name": "activeItemIndex", "type": { "text": "number" }, "privacy": "private", "default": "0", "inheritedFrom": { "name": "Accordion", "module": "src/accordion/accordion.ts" } }, { "kind": "field", "name": "accordionIds", "type": { "text": "Array" }, "privacy": "private", "inheritedFrom": { "name": "Accordion", "module": "src/accordion/accordion.ts" } }, { "kind": "field", "name": "change", "privacy": "private", "inheritedFrom": { "name": "Accordion", "module": "src/accordion/accordion.ts" } }, { "kind": "method", "name": "findExpandedItem", "privacy": "private", "return": { "type": { "text": "AccordionItem | null" } }, "inheritedFrom": { "name": "Accordion", "module": "src/accordion/accordion.ts" } }, { "kind": "field", "name": "setItems", "privacy": "private", "inheritedFrom": { "name": "Accordion", "module": "src/accordion/accordion.ts" } }, { "kind": "method", "name": "resetItems", "privacy": "private", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "Accordion", "module": "src/accordion/accordion.ts" } }, { "kind": "field", "name": "removeItemListeners", "privacy": "private", "inheritedFrom": { "name": "Accordion", "module": "src/accordion/accordion.ts" } }, { "kind": "field", "name": "activeItemChange", "privacy": "private", "inheritedFrom": { "name": "Accordion", "module": "src/accordion/accordion.ts" } }, { "kind": "method", "name": "getItemIds", "privacy": "private", "return": { "type": { "text": "Array" } }, "inheritedFrom": { "name": "Accordion", "module": "src/accordion/accordion.ts" } }, { "kind": "method", "name": "isSingleExpandMode", "privacy": "private", "return": { "type": { "text": "boolean" } }, "inheritedFrom": { "name": "Accordion", "module": "src/accordion/accordion.ts" } }, { "kind": "field", "name": "handleItemKeyDown", "privacy": "private", "inheritedFrom": { "name": "Accordion", "module": "src/accordion/accordion.ts" } }, { "kind": "field", "name": "handleItemFocus", "privacy": "private", "inheritedFrom": { "name": "Accordion", "module": "src/accordion/accordion.ts" } }, { "kind": "method", "name": "adjust", "privacy": "private", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "adjustment", "type": { "text": "number" } } ], "inheritedFrom": { "name": "Accordion", "module": "src/accordion/accordion.ts" } }, { "kind": "method", "name": "focusItem", "privacy": "private", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "Accordion", "module": "src/accordion/accordion.ts" } }, { "kind": "field", "name": "_presentation", "type": { "text": "ComponentPresentation | null | undefined" }, "privacy": "private", "default": "void 0", "inheritedFrom": { "name": "FoundationElement", "module": "src/foundation-element/foundation-element.ts" } }, { "kind": "field", "name": "$presentation", "type": { "text": "ComponentPresentation | null" }, "privacy": "public", "description": "A property which resolves the ComponentPresentation instance\nfor the current component.", "inheritedFrom": { "name": "FoundationElement", "module": "src/foundation-element/foundation-element.ts" } }, { "kind": "field", "name": "template", "type": { "text": "ElementViewTemplate | void | null" }, "privacy": "public", "description": "Sets the template of the element instance. When undefined,\nthe element will attempt to resolve the template from\nthe associated presentation or custom element definition.", "inheritedFrom": { "name": "FoundationElement", "module": "src/foundation-element/foundation-element.ts" } }, { "kind": "method", "name": "templateChanged", "privacy": "protected", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "FoundationElement", "module": "src/foundation-element/foundation-element.ts" } }, { "kind": "field", "name": "styles", "type": { "text": "ElementStyles | void | null" }, "privacy": "public", "description": "Sets the default styles for the element instance. When undefined,\nthe element will attempt to resolve default styles from\nthe associated presentation or custom element definition.", "inheritedFrom": { "name": "FoundationElement", "module": "src/foundation-element/foundation-element.ts" } }, { "kind": "method", "name": "stylesChanged", "privacy": "protected", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "FoundationElement", "module": "src/foundation-element/foundation-element.ts" } }, { "kind": "method", "name": "compose", "privacy": "public", "static": true, "return": { "type": { "text": "(\n overrideDefinition?: OverrideFoundationElementDefinition\n ) => FoundationElementRegistry" } }, "parameters": [ { "name": "this", "type": { "text": "K" } }, { "name": "elementDefinition", "type": { "text": "T" }, "description": "The definition of the element to create the registry\nfunction for." } ], "description": "Defines an element registry function with a set of element definition defaults.", "inheritedFrom": { "name": "FoundationElement", "module": "src/foundation-element/foundation-element.ts" } } ], "events": [ { "description": "Fires a custom 'change' event when the active item changes", "name": "change", "inheritedFrom": { "name": "Accordion", "module": "src/accordion/accordion.ts" } } ] }, { "kind": "variable", "name": "foundationAccordionShadowOptions", "type": { "text": "ShadowRootInit" }, "default": "{\n delegatesFocus: true,\n mode: 'open',\n}" }, { "kind": "variable", "name": "defaultAccordionConfig", "type": { "text": "object" }, "default": "{}" }, { "kind": "variable", "name": "foundationAccordion", "description": "The Foundation Accordion", "privacy": "public" } ], "exports": [ { "kind": "js", "name": "Accordion", "declaration": { "name": "Accordion", "module": "src/accordion/accordion.ts" } }, { "kind": "js", "name": "foundationAccordionShadowOptions", "declaration": { "name": "foundationAccordionShadowOptions", "module": "src/accordion/accordion.ts" } }, { "kind": "js", "name": "defaultAccordionConfig", "declaration": { "name": "defaultAccordionConfig", "module": "src/accordion/accordion.ts" } }, { "kind": "js", "name": "foundationAccordion", "declaration": { "name": "foundationAccordion", "module": "src/accordion/accordion.ts" } } ] }, { "kind": "javascript-module", "path": "src/accordion/index.ts", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./accordion.template" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./accordion.styles" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./accordion" } } ] }, { "kind": "javascript-module", "path": "src/actions-menu/actions-menu.styles.ts", "declarations": [ { "kind": "function", "name": "actionsMenuBaseStyles", "return": { "type": { "text": "ElementStyles" } }, "parameters": [ { "name": "context", "type": { "text": "ElementDefinitionContext" } }, { "name": "definition", "type": { "text": "FoundationElementDefinition" } } ] }, { "kind": "function", "name": "foundationActionsMenuStyles", "return": { "type": { "text": "ElementStyles" } }, "parameters": [ { "name": "context", "type": { "text": "ElementDefinitionContext" } }, { "name": "definition", "type": { "text": "FoundationElementDefinition" } } ] } ], "exports": [ { "kind": "js", "name": "actionsMenuBaseStyles", "declaration": { "name": "actionsMenuBaseStyles", "module": "src/actions-menu/actions-menu.styles.ts" } }, { "kind": "js", "name": "foundationActionsMenuStyles", "declaration": { "name": "foundationActionsMenuStyles", "module": "src/actions-menu/actions-menu.styles.ts" } } ] }, { "kind": "javascript-module", "path": "src/actions-menu/actions-menu.template.ts", "declarations": [ { "kind": "function", "name": "menuTemplate", "parameters": [ { "name": "prefix", "type": { "text": "string" } } ] }, { "kind": "function", "name": "singleOptionTemplate", "parameters": [ { "name": "prefix", "type": { "text": "string" } } ] }, { "kind": "variable", "name": "foundationActionsMenuTemplate", "type": { "text": "ViewTemplate" }, "default": "html`\n (x.isVertical ? ' actions-vertical' : '')}\"\n part=\"actions-container\"\n >\n ${(x) => x.getTemplate(getPrefix(x))}\n \n`" } ], "exports": [ { "kind": "js", "name": "menuTemplate", "declaration": { "name": "menuTemplate", "module": "src/actions-menu/actions-menu.template.ts" } }, { "kind": "js", "name": "singleOptionTemplate", "declaration": { "name": "singleOptionTemplate", "module": "src/actions-menu/actions-menu.template.ts" } }, { "kind": "js", "name": "foundationActionsMenuTemplate", "declaration": { "name": "foundationActionsMenuTemplate", "module": "src/actions-menu/actions-menu.template.ts" } } ] }, { "kind": "javascript-module", "path": "src/actions-menu/actions-menu.ts", "declarations": [ { "kind": "class", "description": "", "name": "ActionsMenu", "members": [ { "kind": "field", "name": "actions", "type": { "text": "ActionMenuItem[]" } }, { "kind": "field", "name": "isVertical", "type": { "text": "boolean" }, "default": "false" }, { "kind": "field", "name": "addDefaultActions", "type": { "text": "boolean" }, "default": "true" }, { "kind": "field", "name": "autoCloseOnAction", "type": { "text": "boolean" }, "default": "true" }, { "kind": "field", "name": "classNames", "type": { "text": "string" } }, { "kind": "field", "name": "definition", "type": { "text": "any" } }, { "kind": "field", "name": "name", "type": { "text": "string" }, "default": "'Actions'" }, { "kind": "field", "name": "open", "type": { "text": "boolean" }, "default": "false" }, { "kind": "field", "name": "buttonAppearance", "type": { "text": "string" } }, { "kind": "field", "name": "hideDisabled", "type": { "text": "boolean" }, "default": "false" }, { "kind": "field", "name": "hideMenuSingleOption", "type": { "text": "boolean" }, "default": "false" }, { "kind": "field", "name": "singleOption", "type": { "text": "ActionMenuItem" } }, { "kind": "field", "name": "actionsMenu", "type": { "text": "HTMLElement" } }, { "kind": "method", "name": "definitionChanged", "privacy": "protected", "parameters": [ { "name": "oldValue", "type": { "text": "any" } }, { "name": "newValue", "type": { "text": "any" } } ] }, { "kind": "method", "name": "openChanged", "privacy": "protected" }, { "kind": "method", "name": "toggleActionsMenuVisibility" }, { "kind": "method", "name": "onActionMenuItemClick", "parameters": [ { "name": "callback", "type": { "text": "(rowData) => void | any" } } ] }, { "kind": "field", "name": "allActions", "type": { "text": "ActionMenuItem[]" }, "readonly": true }, { "kind": "field", "name": "rowData", "readonly": true }, { "kind": "method", "name": "getLabel", "parameters": [ { "name": "name", "type": { "text": "string | ((rowData: any) => string)" } } ] }, { "kind": "method", "name": "getTemplate", "parameters": [ { "name": "prefix", "type": { "text": "string" } } ] }, { "kind": "field", "name": "_presentation", "type": { "text": "ComponentPresentation | null | undefined" }, "privacy": "private", "default": "void 0", "inheritedFrom": { "name": "FoundationElement", "module": "src/foundation-element/foundation-element.ts" } }, { "kind": "field", "name": "$presentation", "type": { "text": "ComponentPresentation | null" }, "privacy": "public", "description": "A property which resolves the ComponentPresentation instance\nfor the current component.", "inheritedFrom": { "name": "FoundationElement", "module": "src/foundation-element/foundation-element.ts" } }, { "kind": "field", "name": "template", "type": { "text": "ElementViewTemplate | void | null" }, "privacy": "public", "description": "Sets the template of the element instance. When undefined,\nthe element will attempt to resolve the template from\nthe associated presentation or custom element definition.", "inheritedFrom": { "name": "FoundationElement", "module": "src/foundation-element/foundation-element.ts" } }, { "kind": "method", "name": "templateChanged", "privacy": "protected", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "FoundationElement", "module": "src/foundation-element/foundation-element.ts" } }, { "kind": "field", "name": "styles", "type": { "text": "ElementStyles | void | null" }, "privacy": "public", "description": "Sets the default styles for the element instance. When undefined,\nthe element will attempt to resolve default styles from\nthe associated presentation or custom element definition.", "inheritedFrom": { "name": "FoundationElement", "module": "src/foundation-element/foundation-element.ts" } }, { "kind": "method", "name": "stylesChanged", "privacy": "protected", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "FoundationElement", "module": "src/foundation-element/foundation-element.ts" } }, { "kind": "method", "name": "compose", "privacy": "public", "static": true, "return": { "type": { "text": "(\n overrideDefinition?: OverrideFoundationElementDefinition\n ) => FoundationElementRegistry" } }, "parameters": [ { "name": "this", "type": { "text": "K" } }, { "name": "elementDefinition", "type": { "text": "T" }, "description": "The definition of the element to create the registry\nfunction for." } ], "description": "Defines an element registry function with a set of element definition defaults.", "inheritedFrom": { "name": "FoundationElement", "module": "src/foundation-element/foundation-element.ts" } } ], "attributes": [ { "name": "is-vertical", "type": { "text": "boolean" }, "default": "false", "fieldName": "isVertical" }, { "name": "add-default-actions", "type": { "text": "boolean" }, "default": "true", "fieldName": "addDefaultActions" }, { "name": "auto-close-on-action", "type": { "text": "boolean" }, "default": "true", "fieldName": "autoCloseOnAction" }, { "name": "name", "type": { "text": "string" }, "default": "'Actions'", "fieldName": "name" }, { "name": "open", "type": { "text": "boolean" }, "default": "false", "fieldName": "open" }, { "name": "buttonAppearance", "type": { "text": "string" }, "fieldName": "buttonAppearance" }, { "name": "hide-disabled", "type": { "text": "boolean" }, "default": "false", "fieldName": "hideDisabled" }, { "name": "hide-menu-single-option", "type": { "text": "boolean" }, "default": "false", "fieldName": "hideMenuSingleOption" } ], "superclass": { "name": "FoundationElement", "package": "@microsoft/fast-foundation" }, "tagName": "%%prefix%%-actions-menu", "customElement": true }, { "kind": "variable", "name": "foundationActionsMenu", "description": "The Foundation Actions Menu", "privacy": "public" } ], "exports": [ { "kind": "js", "name": "ActionsMenu", "declaration": { "name": "ActionsMenu", "module": "src/actions-menu/actions-menu.ts" } }, { "kind": "js", "name": "foundationActionsMenu", "declaration": { "name": "foundationActionsMenu", "module": "src/actions-menu/actions-menu.ts" } } ] }, { "kind": "javascript-module", "path": "src/actions-menu/index.ts", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./actions-menu.styles" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./actions-menu.template" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./actions-menu" } } ] }, { "kind": "javascript-module", "path": "src/ai-criteria-search/ai-criteria-search.styles.ts", "declarations": [ { "kind": "variable", "name": "foundationAiCriteriaSearchStyles", "default": "css`\n :host {\n display: block;\n width: 800px;\n }\n\n .ai-criteria-search {\n display: flex;\n flex-direction: column;\n gap: calc(${designUnit} * 2px);\n }\n\n .ai-criteria-search-row {\n display: flex;\n flex-direction: row;\n gap: calc(${designUnit} * 2px);\n align-items: center;\n }\n\n .criteria-input {\n height: calc(((var(--base-height-multiplier) + var(--density)) * var(--design-unit) - 4) * 1px);\n flex: 1;\n min-width: 0;\n }\n\n .mic-icon {\n color: var(--neutral-foreground-rest);\n fill: currentColor;\n }\n\n .mode-control {\n flex-shrink: 0;\n }\n`" } ], "exports": [ { "kind": "js", "name": "foundationAiCriteriaSearchStyles", "declaration": { "name": "foundationAiCriteriaSearchStyles", "module": "src/ai-criteria-search/ai-criteria-search.styles.ts" } } ] }, { "kind": "javascript-module", "path": "src/ai-criteria-search/ai-criteria-search.template.ts", "declarations": [ { "kind": "variable", "name": "foundationAiCriteriaSearchTemplate", "type": { "text": "ViewTemplate" }, "default": "html`\n ${(x) => aiCriteriaSearchTemplate(getPrefix(x))}\n`" } ], "exports": [ { "kind": "js", "name": "foundationAiCriteriaSearchTemplate", "declaration": { "name": "foundationAiCriteriaSearchTemplate", "module": "src/ai-criteria-search/ai-criteria-search.template.ts" } } ] }, { "kind": "javascript-module", "path": "src/ai-criteria-search/ai-criteria-search.ts", "declarations": [ { "kind": "class", "description": "Natural-language criteria search input with AI interpretation.", "name": "AiCriteriaSearch", "members": [ { "kind": "field", "name": "aiProvider", "type": { "text": "AIProvider" } }, { "kind": "field", "name": "placeholder", "type": { "text": "string" }, "default": "'Describe your search criteria in natural language...'" }, { "kind": "field", "name": "disabled", "type": { "text": "boolean" } }, { "kind": "field", "name": "mode", "type": { "text": "'append' | 'replace'" }, "default": "'replace'" }, { "kind": "field", "name": "inputValue", "type": { "text": "string" }, "default": "''" }, { "kind": "field", "name": "isInterpreting", "type": { "text": "boolean" }, "default": "false" }, { "kind": "field", "name": "lastValidCriteria", "type": { "text": "string | null" }, "default": "null" }, { "kind": "field", "name": "fieldMetadata", "type": { "text": "MetadataDetail[] | string[]" }, "default": "[]" }, { "kind": "field", "name": "isRecording", "type": { "text": "boolean" }, "default": "false" }, { "kind": "field", "name": "textAreaRef", "type": { "text": "HTMLTextAreaElement" }, "privacy": "public" }, { "kind": "field", "name": "stopRecording", "type": { "text": "(() => void) | null" }, "privacy": "private", "default": "null" }, { "kind": "field", "name": "speechApplyDebounceTimer", "type": { "text": "ReturnType | null" }, "privacy": "private", "default": "null" }, { "kind": "field", "name": "baseInputForAppend", "type": { "text": "string" }, "privacy": "private", "default": "''" }, { "kind": "field", "name": "speechAvailable", "type": { "text": "boolean" }, "readonly": true }, { "kind": "method", "name": "handleSubmit" }, { "kind": "method", "name": "handleBlur" }, { "kind": "method", "name": "clear" }, { "kind": "method", "name": "toggleSpeechInput" }, { "kind": "method", "name": "clearSpeechApplyDebounce", "privacy": "private" }, { "kind": "field", "name": "_presentation", "type": { "text": "ComponentPresentation | null | undefined" }, "privacy": "private", "default": "void 0", "inheritedFrom": { "name": "FoundationElement", "module": "src/foundation-element/foundation-element.ts" } }, { "kind": "field", "name": "$presentation", "type": { "text": "ComponentPresentation | null" }, "privacy": "public", "description": "A property which resolves the ComponentPresentation instance\nfor the current component.", "inheritedFrom": { "name": "FoundationElement", "module": "src/foundation-element/foundation-element.ts" } }, { "kind": "field", "name": "template", "type": { "text": "ElementViewTemplate | void | null" }, "privacy": "public", "description": "Sets the template of the element instance. When undefined,\nthe element will attempt to resolve the template from\nthe associated presentation or custom element definition.", "inheritedFrom": { "name": "FoundationElement", "module": "src/foundation-element/foundation-element.ts" } }, { "kind": "method", "name": "templateChanged", "privacy": "protected", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "FoundationElement", "module": "src/foundation-element/foundation-element.ts" } }, { "kind": "field", "name": "styles", "type": { "text": "ElementStyles | void | null" }, "privacy": "public", "description": "Sets the default styles for the element instance. When undefined,\nthe element will attempt to resolve default styles from\nthe associated presentation or custom element definition.", "inheritedFrom": { "name": "FoundationElement", "module": "src/foundation-element/foundation-element.ts" } }, { "kind": "method", "name": "stylesChanged", "privacy": "protected", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "FoundationElement", "module": "src/foundation-element/foundation-element.ts" } }, { "kind": "method", "name": "compose", "privacy": "public", "static": true, "return": { "type": { "text": "(\n overrideDefinition?: OverrideFoundationElementDefinition\n ) => FoundationElementRegistry" } }, "parameters": [ { "name": "this", "type": { "text": "K" } }, { "name": "elementDefinition", "type": { "text": "T" }, "description": "The definition of the element to create the registry\nfunction for." } ], "description": "Defines an element registry function with a set of element definition defaults.", "inheritedFrom": { "name": "FoundationElement", "module": "src/foundation-element/foundation-element.ts" } } ], "events": [ { "description": "Fired when interpreted criteria is applied or cleared", "name": "criteria-changed" }, { "description": "Fired when interpreted criteria contains invalid clauses", "name": "validation-errors" } ], "attributes": [ { "name": "placeholder", "type": { "text": "string" }, "default": "'Describe your search criteria in natural language...'", "fieldName": "placeholder" }, { "type": { "text": "boolean" }, "fieldName": "disabled" }, { "name": "mode", "type": { "text": "'append' | 'replace'" }, "default": "'replace'", "fieldName": "mode" } ], "superclass": { "name": "FoundationElement", "package": "@microsoft/fast-foundation" }, "tagName": "%%prefix%%-ai-criteria-search", "customElement": true }, { "kind": "variable", "name": "foundationAiCriteriaSearchShadowOptions", "type": { "text": "ShadowRootInit" }, "default": "undefined" }, { "kind": "variable", "name": "defaultAiCriteriaSearchConfig", "type": { "text": "object" }, "default": "{}" }, { "kind": "variable", "name": "foundationAiCriteriaSearch" } ], "exports": [ { "kind": "js", "name": "AiCriteriaSearch", "declaration": { "name": "AiCriteriaSearch", "module": "src/ai-criteria-search/ai-criteria-search.ts" } }, { "kind": "js", "name": "foundationAiCriteriaSearchShadowOptions", "declaration": { "name": "foundationAiCriteriaSearchShadowOptions", "module": "src/ai-criteria-search/ai-criteria-search.ts" } }, { "kind": "js", "name": "defaultAiCriteriaSearchConfig", "declaration": { "name": "defaultAiCriteriaSearchConfig", "module": "src/ai-criteria-search/ai-criteria-search.ts" } }, { "kind": "js", "name": "foundationAiCriteriaSearch", "declaration": { "name": "foundationAiCriteriaSearch", "module": "src/ai-criteria-search/ai-criteria-search.ts" } } ] }, { "kind": "javascript-module", "path": "src/ai-criteria-search/index.ts", "declarations": [], "exports": [ { "kind": "js", "name": "AiCriteriaSearch", "declaration": { "name": "AiCriteriaSearch", "module": "./ai-criteria-search" } }, { "kind": "js", "name": "defaultAiCriteriaSearchConfig", "declaration": { "name": "defaultAiCriteriaSearchConfig", "module": "./ai-criteria-search" } }, { "kind": "js", "name": "foundationAiCriteriaSearch", "declaration": { "name": "foundationAiCriteriaSearch", "module": "./ai-criteria-search" } }, { "kind": "js", "name": "foundationAiCriteriaSearchShadowOptions", "declaration": { "name": "foundationAiCriteriaSearchShadowOptions", "module": "./ai-criteria-search" } }, { "kind": "js", "name": "foundationAiCriteriaSearchStyles", "declaration": { "name": "foundationAiCriteriaSearchStyles", "module": "./ai-criteria-search.styles" } }, { "kind": "js", "name": "foundationAiCriteriaSearchTemplate", "declaration": { "name": "foundationAiCriteriaSearchTemplate", "module": "./ai-criteria-search.template" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./validation/criteria-ir" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./validation/operator-map" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./validation/schema-validator" } } ] }, { "kind": "javascript-module", "path": "src/ai-criteria-search/validation-error-notification.ts", "declarations": [ { "kind": "function", "name": "formatValidationErrors", "return": { "type": { "text": "string" } }, "parameters": [ { "name": "errors", "type": { "text": "ValidationError[]" } } ], "description": "Formats validation errors into a user-friendly message." }, { "kind": "function", "name": "showCriteriaError", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "title", "type": { "text": "string" }, "description": "Notification title (e.g. \"Criteria validation error\")" }, { "name": "body", "type": { "text": "string" }, "description": "Error message to display" }, { "name": "tagName", "type": { "text": "string" }, "description": "Design system prefix (e.g. \"rapid\", \"foundation\")" } ], "description": "Shows a criteria error as a toast notification." } ], "exports": [ { "kind": "js", "name": "formatValidationErrors", "declaration": { "name": "formatValidationErrors", "module": "src/ai-criteria-search/validation-error-notification.ts" } }, { "kind": "js", "name": "showCriteriaError", "declaration": { "name": "showCriteriaError", "module": "src/ai-criteria-search/validation-error-notification.ts" } } ] }, { "kind": "javascript-module", "path": "src/ai-indicator/ai-indicator.styles.ts", "declarations": [ { "kind": "function", "name": "foundationAiIndicatorStyles", "return": { "type": { "text": "ElementStyles" } }, "parameters": [ { "name": "context", "type": { "text": "ElementDefinitionContext" } }, { "name": "definition", "type": { "text": "FoundationElementDefinition" } } ] } ], "exports": [ { "kind": "js", "name": "foundationAiIndicatorStyles", "declaration": { "name": "foundationAiIndicatorStyles", "module": "src/ai-indicator/ai-indicator.styles.ts" } } ] }, { "kind": "javascript-module", "path": "src/ai-indicator/ai-indicator.template.ts", "declarations": [ { "kind": "variable", "name": "foundationAiIndicatorTemplate", "type": { "text": "ViewTemplate" }, "default": "html`\n ${(x) => aiIndicatorTemplate(getPrefix(x))}\n`" } ], "exports": [ { "kind": "js", "name": "foundationAiIndicatorTemplate", "declaration": { "name": "foundationAiIndicatorTemplate", "module": "src/ai-indicator/ai-indicator.template.ts" } } ] }, { "kind": "javascript-module", "path": "src/ai-indicator/ai-indicator.ts", "declarations": [ { "kind": "class", "description": "", "name": "AiIndicator", "members": [ { "kind": "field", "name": "aiProvider", "type": { "text": "AIProvider" } }, { "kind": "field", "name": "status", "type": { "text": "AIStatus | null" }, "default": "null" }, { "kind": "field", "name": "open", "type": { "text": "boolean" }, "default": "false" }, { "kind": "field", "name": "state", "type": { "text": "AIIndicatorState" }, "default": "'none'" }, { "kind": "field", "name": "isInstalling", "type": { "text": "boolean" }, "default": "false" }, { "kind": "field", "name": "pollTimer", "type": { "text": "ReturnType | null" }, "privacy": "private", "default": "null" }, { "kind": "field", "name": "clickOutside", "privacy": "private" }, { "kind": "field", "name": "chromeStatusLabel", "type": { "text": "string | null" }, "readonly": true }, { "kind": "field", "name": "canInstall", "type": { "text": "boolean" }, "readonly": true }, { "kind": "field", "name": "isDownloading", "type": { "text": "boolean" }, "readonly": true }, { "kind": "method", "name": "openChanged", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "handleClickOutside", "privacy": "private", "parameters": [ { "name": "event", "type": { "text": "MouseEvent" } } ] }, { "kind": "method", "name": "toggleDropdown" }, { "kind": "method", "name": "refreshStatus", "return": { "type": { "text": "Promise" } } }, { "kind": "method", "name": "deriveState", "privacy": "private", "return": { "type": { "text": "AIIndicatorState" } }, "parameters": [ { "name": "s", "type": { "text": "AIStatus | null" } } ] }, { "kind": "method", "name": "maybeStartPolling", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "startPolling", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "stopPolling", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "onInstall", "return": { "type": { "text": "Promise" } } }, { "kind": "field", "name": "_presentation", "type": { "text": "ComponentPresentation | null | undefined" }, "privacy": "private", "default": "void 0", "inheritedFrom": { "name": "FoundationElement", "module": "src/foundation-element/foundation-element.ts" } }, { "kind": "field", "name": "$presentation", "type": { "text": "ComponentPresentation | null" }, "privacy": "public", "description": "A property which resolves the ComponentPresentation instance\nfor the current component.", "inheritedFrom": { "name": "FoundationElement", "module": "src/foundation-element/foundation-element.ts" } }, { "kind": "field", "name": "template", "type": { "text": "ElementViewTemplate | void | null" }, "privacy": "public", "description": "Sets the template of the element instance. When undefined,\nthe element will attempt to resolve the template from\nthe associated presentation or custom element definition.", "inheritedFrom": { "name": "FoundationElement", "module": "src/foundation-element/foundation-element.ts" } }, { "kind": "method", "name": "templateChanged", "privacy": "protected", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "FoundationElement", "module": "src/foundation-element/foundation-element.ts" } }, { "kind": "field", "name": "styles", "type": { "text": "ElementStyles | void | null" }, "privacy": "public", "description": "Sets the default styles for the element instance. When undefined,\nthe element will attempt to resolve default styles from\nthe associated presentation or custom element definition.", "inheritedFrom": { "name": "FoundationElement", "module": "src/foundation-element/foundation-element.ts" } }, { "kind": "method", "name": "stylesChanged", "privacy": "protected", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "FoundationElement", "module": "src/foundation-element/foundation-element.ts" } }, { "kind": "method", "name": "compose", "privacy": "public", "static": true, "return": { "type": { "text": "(\n overrideDefinition?: OverrideFoundationElementDefinition\n ) => FoundationElementRegistry" } }, "parameters": [ { "name": "this", "type": { "text": "K" } }, { "name": "elementDefinition", "type": { "text": "T" }, "description": "The definition of the element to create the registry\nfunction for." } ], "description": "Defines an element registry function with a set of element definition defaults.", "inheritedFrom": { "name": "FoundationElement", "module": "src/foundation-element/foundation-element.ts" } } ], "superclass": { "name": "FoundationElement", "package": "@microsoft/fast-foundation" }, "tagName": "%%prefix%%-ai-indicator", "customElement": true }, { "kind": "variable", "name": "foundationAiIndicator" } ], "exports": [ { "kind": "js", "name": "AiIndicator", "declaration": { "name": "AiIndicator", "module": "src/ai-indicator/ai-indicator.ts" } }, { "kind": "js", "name": "foundationAiIndicator", "declaration": { "name": "foundationAiIndicator", "module": "src/ai-indicator/ai-indicator.ts" } } ] }, { "kind": "javascript-module", "path": "src/ai-indicator/index.ts", "declarations": [], "exports": [ { "kind": "js", "name": "AiIndicator", "declaration": { "name": "AiIndicator", "module": "./ai-indicator" } }, { "kind": "js", "name": "foundationAiIndicator", "declaration": { "name": "foundationAiIndicator", "module": "./ai-indicator" } }, { "kind": "js", "name": "type", "declaration": { "name": "type", "module": "./ai-indicator" } }, { "kind": "js", "name": "AIIndicatorState", "declaration": { "name": "AIIndicatorState", "module": "./ai-indicator" } }, { "kind": "js", "name": "foundationAiIndicatorTemplate", "declaration": { "name": "foundationAiIndicatorTemplate", "module": "./ai-indicator.template" } }, { "kind": "js", "name": "foundationAiIndicatorStyles", "declaration": { "name": "foundationAiIndicatorStyles", "module": "./ai-indicator.styles" } } ] }, { "kind": "javascript-module", "path": "src/anchor/anchor.styles.ts", "declarations": [ { "kind": "function", "name": "foundationAnchorStyles", "return": { "type": { "text": "ElementStyles" } }, "parameters": [ { "name": "context", "type": { "text": "ElementDefinitionContext" } }, { "name": "definition", "type": { "text": "FoundationElementDefinition" } } ] } ], "exports": [ { "kind": "js", "name": "foundationAnchorStyles", "declaration": { "name": "foundationAnchorStyles", "module": "src/anchor/anchor.styles.ts" } } ] }, { "kind": "javascript-module", "path": "src/anchor/anchor.template.ts", "declarations": [ { "kind": "function", "name": "foundationAnchorTemplate", "return": { "type": { "text": "ViewTemplate" } }, "parameters": [ { "name": "context", "type": { "text": "ElementDefinitionContext" } }, { "name": "definition", "type": { "text": "FoundationElementDefinition" } } ] } ], "exports": [ { "kind": "js", "name": "foundationAnchorTemplate", "declaration": { "name": "foundationAnchorTemplate", "module": "src/anchor/anchor.template.ts" } } ] }, { "kind": "javascript-module", "path": "src/anchor/anchor.ts", "declarations": [ { "kind": "class", "description": "", "name": "Anchor", "superclass": { "name": "FASTAnchor", "package": "@microsoft/fast-components" }, "tagName": "%%prefix%%-anchor", "customElement": true, "attributes": [ { "name": "download", "type": { "text": "string" }, "description": "Prompts the user to save the linked URL. See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a | element for more information.", "fieldName": "download", "inheritedFrom": { "name": "Anchor", "module": "src/anchor/anchor.ts" } }, { "name": "href", "type": { "text": "string" }, "description": "The URL the hyperlink references. See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a | element for more information.", "fieldName": "href", "inheritedFrom": { "name": "Anchor", "module": "src/anchor/anchor.ts" } }, { "name": "hreflang", "type": { "text": "string" }, "description": "Hints at the language of the referenced resource. See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a | element for more information.", "fieldName": "hreflang", "inheritedFrom": { "name": "Anchor", "module": "src/anchor/anchor.ts" } }, { "name": "ping", "type": { "text": "string" }, "description": "See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a | element for more information.", "fieldName": "ping", "inheritedFrom": { "name": "Anchor", "module": "src/anchor/anchor.ts" } }, { "name": "referrerpolicy", "type": { "text": "string" }, "description": "See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a | element for more information.", "fieldName": "referrerpolicy", "inheritedFrom": { "name": "Anchor", "module": "src/anchor/anchor.ts" } }, { "name": "rel", "type": { "text": "string" }, "description": "See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a | element for more information.", "fieldName": "rel", "inheritedFrom": { "name": "Anchor", "module": "src/anchor/anchor.ts" } }, { "name": "target", "type": { "text": "\"_self\" | \"_blank\" | \"_parent\" | \"_top\"" }, "description": "See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a | element for more information.", "fieldName": "target", "inheritedFrom": { "name": "Anchor", "module": "src/anchor/anchor.ts" } }, { "name": "type", "type": { "text": "string" }, "description": "See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a | element for more information.", "fieldName": "type", "inheritedFrom": { "name": "Anchor", "module": "src/anchor/anchor.ts" } } ], "members": [ { "kind": "field", "name": "download", "type": { "text": "string" }, "privacy": "public", "description": "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.", "inheritedFrom": { "name": "Anchor", "module": "src/anchor/anchor.ts" } }, { "kind": "field", "name": "href", "type": { "text": "string" }, "privacy": "public", "description": "The URL the hyperlink references. See {@link https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a | element } for more information.", "inheritedFrom": { "name": "Anchor", "module": "src/anchor/anchor.ts" } }, { "kind": "field", "name": "hreflang", "type": { "text": "string" }, "privacy": "public", "description": "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.", "inheritedFrom": { "name": "Anchor", "module": "src/anchor/anchor.ts" } }, { "kind": "field", "name": "ping", "type": { "text": "string" }, "privacy": "public", "description": "See {@link https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a | element } for more information.", "inheritedFrom": { "name": "Anchor", "module": "src/anchor/anchor.ts" } }, { "kind": "field", "name": "referrerpolicy", "type": { "text": "string" }, "privacy": "public", "description": "See {@link https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a | element } for more information.", "inheritedFrom": { "name": "Anchor", "module": "src/anchor/anchor.ts" } }, { "kind": "field", "name": "rel", "type": { "text": "string" }, "privacy": "public", "description": "See {@link https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a | element } for more information.", "inheritedFrom": { "name": "Anchor", "module": "src/anchor/anchor.ts" } }, { "kind": "field", "name": "target", "type": { "text": "\"_self\" | \"_blank\" | \"_parent\" | \"_top\"" }, "privacy": "public", "description": "See {@link https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a | element } for more information.", "inheritedFrom": { "name": "Anchor", "module": "src/anchor/anchor.ts" } }, { "kind": "field", "name": "type", "type": { "text": "string" }, "privacy": "public", "description": "See {@link https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a | element } for more information.", "inheritedFrom": { "name": "Anchor", "module": "src/anchor/anchor.ts" } }, { "kind": "field", "name": "control", "type": { "text": "HTMLAnchorElement | undefined" }, "privacy": "public", "description": "References the root element", "inheritedFrom": { "name": "Anchor", "module": "src/anchor/anchor.ts" } }, { "kind": "field", "name": "handleUnsupportedDelegatesFocus", "privacy": "private", "description": "Overrides the focus call for where delegatesFocus is unsupported.\nThis check works for Chrome, Edge Chromium, FireFox, and Safari\nRelevant PR on the Firefox browser: https://phabricator.services.mozilla.com/D123858", "inheritedFrom": { "name": "Anchor", "module": "src/anchor/anchor.ts" } }, { "kind": "field", "name": "_presentation", "type": { "text": "ComponentPresentation | null | undefined" }, "privacy": "private", "default": "void 0", "inheritedFrom": { "name": "FoundationElement", "module": "src/foundation-element/foundation-element.ts" } }, { "kind": "field", "name": "$presentation", "type": { "text": "ComponentPresentation | null" }, "privacy": "public", "description": "A property which resolves the ComponentPresentation instance\nfor the current component.", "inheritedFrom": { "name": "FoundationElement", "module": "src/foundation-element/foundation-element.ts" } }, { "kind": "field", "name": "template", "type": { "text": "ElementViewTemplate | void | null" }, "privacy": "public", "description": "Sets the template of the element instance. When undefined,\nthe element will attempt to resolve the template from\nthe associated presentation or custom element definition.", "inheritedFrom": { "name": "FoundationElement", "module": "src/foundation-element/foundation-element.ts" } }, { "kind": "method", "name": "templateChanged", "privacy": "protected", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "FoundationElement", "module": "src/foundation-element/foundation-element.ts" } }, { "kind": "field", "name": "styles", "type": { "text": "ElementStyles | void | null" }, "privacy": "public", "description": "Sets the default styles for the element instance. When undefined,\nthe element will attempt to resolve default styles from\nthe associated presentation or custom element definition.", "inheritedFrom": { "name": "FoundationElement", "module": "src/foundation-element/foundation-element.ts" } }, { "kind": "method", "name": "stylesChanged", "privacy": "protected", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "FoundationElement", "module": "src/foundation-element/foundation-element.ts" } }, { "kind": "method", "name": "compose", "privacy": "public", "static": true, "return": { "type": { "text": "(\n overrideDefinition?: OverrideFoundationElementDefinition\n ) => FoundationElementRegistry" } }, "parameters": [ { "name": "this", "type": { "text": "K" } }, { "name": "elementDefinition", "type": { "text": "T" }, "description": "The definition of the element to create the registry\nfunction for." } ], "description": "Defines an element registry function with a set of element definition defaults.", "inheritedFrom": { "name": "FoundationElement", "module": "src/foundation-element/foundation-element.ts" } } ] }, { "kind": "variable", "name": "foundationAnchorShadowOptions", "type": { "text": "ShadowRootInit" }, "default": "{\n delegatesFocus: true,\n mode: 'open',\n}" }, { "kind": "variable", "name": "defaultAnchorConfig", "type": { "text": "object" }, "default": "{}" }, { "kind": "variable", "name": "foundationAnchor", "description": "The Foundation Anchor", "privacy": "public" } ], "exports": [ { "kind": "js", "name": "Anchor", "declaration": { "name": "Anchor", "module": "src/anchor/anchor.ts" } }, { "kind": "js", "name": "foundationAnchorShadowOptions", "declaration": { "name": "foundationAnchorShadowOptions", "module": "src/anchor/anchor.ts" } }, { "kind": "js", "name": "defaultAnchorConfig", "declaration": { "name": "defaultAnchorConfig", "module": "src/anchor/anchor.ts" } }, { "kind": "js", "name": "foundationAnchor", "declaration": { "name": "foundationAnchor", "module": "src/anchor/anchor.ts" } } ] }, { "kind": "javascript-module", "path": "src/anchor/index.ts", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./anchor.template" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./anchor.styles" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./anchor" } } ] }, { "kind": "javascript-module", "path": "src/anchored-region/anchor-region.template.ts", "declarations": [ { "kind": "function", "name": "foundationAnchoredRegionTemplate", "return": { "type": { "text": "ViewTemplate" } }, "parameters": [ { "name": "context", "type": { "text": "ElementDefinitionContext" } }, { "name": "definition", "type": { "text": "FoundationElementDefinition" } } ] } ], "exports": [ { "kind": "js", "name": "foundationAnchoredRegionTemplate", "declaration": { "name": "foundationAnchoredRegionTemplate", "module": "src/anchored-region/anchor-region.template.ts" } } ] }, { "kind": "javascript-module", "path": "src/anchored-region/anchored-region.styles.ts", "declarations": [ { "kind": "function", "name": "foundationAnchoredRegionStyles", "return": { "type": { "text": "ElementStyles" } }, "parameters": [ { "name": "context", "type": { "text": "ElementDefinitionContext" } }, { "name": "definition", "type": { "text": "FoundationElementDefinition" } } ] } ], "exports": [ { "kind": "js", "name": "foundationAnchoredRegionStyles", "declaration": { "name": "foundationAnchoredRegionStyles", "module": "src/anchored-region/anchored-region.styles.ts" } } ] }, { "kind": "javascript-module", "path": "src/anchored-region/anchored-region.ts", "declarations": [ { "kind": "class", "description": "", "name": "AnchoredRegion", "superclass": { "name": "FASTAnchoredRegion", "package": "@microsoft/fast-components" }, "tagName": "%%prefix%%-anchored-region", "customElement": true, "attributes": [ { "name": "anchor", "type": { "text": "string" }, "default": "\"\"", "description": "The HTML ID of the anchor element this region is positioned relative to", "fieldName": "anchor", "inheritedFrom": { "name": "AnchoredRegion", "module": "src/anchored-region/anchored-region.ts" } }, { "name": "viewport", "type": { "text": "string" }, "default": "\"\"", "description": "The HTML ID of the viewport element this region is positioned relative to", "fieldName": "viewport", "inheritedFrom": { "name": "AnchoredRegion", "module": "src/anchored-region/anchored-region.ts" } }, { "name": "horizontal-positioning-mode", "type": { "text": "AxisPositioningMode" }, "default": "\"uncontrolled\"", "description": "Sets what logic the component uses to determine horizontal placement.\n'locktodefault' forces the default position\n'dynamic' decides placement based on available space\n'uncontrolled' does not control placement on the horizontal axis", "fieldName": "horizontalPositioningMode", "inheritedFrom": { "name": "AnchoredRegion", "module": "src/anchored-region/anchored-region.ts" } }, { "name": "horizontal-default-position", "type": { "text": "HorizontalPosition" }, "default": "\"unset\"", "description": "The default horizontal position of the region relative to the anchor element", "fieldName": "horizontalDefaultPosition", "inheritedFrom": { "name": "AnchoredRegion", "module": "src/anchored-region/anchored-region.ts" } }, { "name": "horizontal-viewport-lock", "type": { "text": "boolean" }, "default": "false", "description": "Whether the region remains in the viewport (ie. detaches from the anchor) on the horizontal axis", "fieldName": "horizontalViewportLock", "inheritedFrom": { "name": "AnchoredRegion", "module": "src/anchored-region/anchored-region.ts" } }, { "name": "horizontal-inset", "type": { "text": "boolean" }, "default": "false", "description": "Whether the region overlaps the anchor on the horizontal axis", "fieldName": "horizontalInset", "inheritedFrom": { "name": "AnchoredRegion", "module": "src/anchored-region/anchored-region.ts" } }, { "name": "horizontal-threshold", "type": { "text": "number" }, "description": "How narrow the space allocated to the default position has to be before the widest area\nis selected for layout", "fieldName": "horizontalThreshold", "inheritedFrom": { "name": "AnchoredRegion", "module": "src/anchored-region/anchored-region.ts" } }, { "name": "horizontal-scaling", "type": { "text": "AxisScalingMode" }, "default": "\"content\"", "description": "Defines how the width of the region is calculated", "fieldName": "horizontalScaling", "inheritedFrom": { "name": "AnchoredRegion", "module": "src/anchored-region/anchored-region.ts" } }, { "name": "vertical-positioning-mode", "type": { "text": "AxisPositioningMode" }, "default": "\"uncontrolled\"", "description": "Sets what logic the component uses to determine vertical placement.\n'locktodefault' forces the default position\n'dynamic' decides placement based on available space\n'uncontrolled' does not control placement on the vertical axis", "fieldName": "verticalPositioningMode", "inheritedFrom": { "name": "AnchoredRegion", "module": "src/anchored-region/anchored-region.ts" } }, { "name": "vertical-default-position", "type": { "text": "VerticalPosition" }, "default": "\"unset\"", "description": "The default vertical position of the region relative to the anchor element", "fieldName": "verticalDefaultPosition", "inheritedFrom": { "name": "AnchoredRegion", "module": "src/anchored-region/anchored-region.ts" } }, { "name": "vertical-viewport-lock", "type": { "text": "boolean" }, "default": "false", "description": "Whether the region remains in the viewport (ie. detaches from the anchor) on the vertical axis", "fieldName": "verticalViewportLock", "inheritedFrom": { "name": "AnchoredRegion", "module": "src/anchored-region/anchored-region.ts" } }, { "name": "vertical-inset", "type": { "text": "boolean" }, "default": "false", "description": "Whether the region overlaps the anchor on the vertical axis", "fieldName": "verticalInset", "inheritedFrom": { "name": "AnchoredRegion", "module": "src/anchored-region/anchored-region.ts" } }, { "name": "vertical-threshold", "type": { "text": "number" }, "description": "How short the space allocated to the default position has to be before the tallest area\nis selected for layout", "fieldName": "verticalThreshold", "inheritedFrom": { "name": "AnchoredRegion", "module": "src/anchored-region/anchored-region.ts" } }, { "name": "vertical-scaling", "type": { "text": "AxisScalingMode" }, "default": "\"content\"", "description": "Defines how the height of the region is calculated", "fieldName": "verticalScaling", "inheritedFrom": { "name": "AnchoredRegion", "module": "src/anchored-region/anchored-region.ts" } }, { "name": "fixed-placement", "type": { "text": "boolean" }, "default": "false", "description": "Whether the region is positioned using css \"position: fixed\".\nOtherwise the region uses \"position: absolute\".\nFixed placement allows the region to break out of parent containers,", "fieldName": "fixedPlacement", "inheritedFrom": { "name": "AnchoredRegion", "module": "src/anchored-region/anchored-region.ts" } }, { "name": "auto-update-mode", "type": { "text": "AutoUpdateMode" }, "default": "\"anchor\"", "description": "Defines what triggers the anchored region to revaluate positioning", "fieldName": "autoUpdateMode", "inheritedFrom": { "name": "AnchoredRegion", "module": "src/anchored-region/anchored-region.ts" } } ], "members": [ { "kind": "field", "name": "anchor", "type": { "text": "string" }, "privacy": "public", "default": "\"\"", "description": "The HTML ID of the anchor element this region is positioned relative to", "inheritedFrom": { "name": "AnchoredRegion", "module": "src/anchored-region/anchored-region.ts" } }, { "kind": "method", "name": "anchorChanged", "privacy": "private", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "AnchoredRegion", "module": "src/anchored-region/anchored-region.ts" } }, { "kind": "field", "name": "viewport", "type": { "text": "string" }, "privacy": "public", "default": "\"\"", "description": "The HTML ID of the viewport element this region is positioned relative to", "inheritedFrom": { "name": "AnchoredRegion", "module": "src/anchored-region/anchored-region.ts" } }, { "kind": "method", "name": "viewportChanged", "privacy": "private", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "AnchoredRegion", "module": "src/anchored-region/anchored-region.ts" } }, { "kind": "field", "name": "horizontalPositioningMode", "type": { "text": "AxisPositioningMode" }, "privacy": "public", "default": "\"uncontrolled\"", "description": "Sets what logic the component uses to determine horizontal placement.\n'locktodefault' forces the default position\n'dynamic' decides placement based on available space\n'uncontrolled' does not control placement on the horizontal axis", "inheritedFrom": { "name": "AnchoredRegion", "module": "src/anchored-region/anchored-region.ts" } }, { "kind": "method", "name": "horizontalPositioningModeChanged", "privacy": "private", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "AnchoredRegion", "module": "src/anchored-region/anchored-region.ts" } }, { "kind": "field", "name": "horizontalDefaultPosition", "type": { "text": "HorizontalPosition" }, "privacy": "public", "default": "\"unset\"", "description": "The default horizontal position of the region relative to the anchor element", "inheritedFrom": { "name": "AnchoredRegion", "module": "src/anchored-region/anchored-region.ts" } }, { "kind": "method", "name": "horizontalDefaultPositionChanged", "privacy": "private", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "AnchoredRegion", "module": "src/anchored-region/anchored-region.ts" } }, { "kind": "field", "name": "horizontalViewportLock", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "description": "Whether the region remains in the viewport (ie. detaches from the anchor) on the horizontal axis", "inheritedFrom": { "name": "AnchoredRegion", "module": "src/anchored-region/anchored-region.ts" } }, { "kind": "method", "name": "horizontalViewportLockChanged", "privacy": "private", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "AnchoredRegion", "module": "src/anchored-region/anchored-region.ts" } }, { "kind": "field", "name": "horizontalInset", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "description": "Whether the region overlaps the anchor on the horizontal axis", "inheritedFrom": { "name": "AnchoredRegion", "module": "src/anchored-region/anchored-region.ts" } }, { "kind": "method", "name": "horizontalInsetChanged", "privacy": "private", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "AnchoredRegion", "module": "src/anchored-region/anchored-region.ts" } }, { "kind": "field", "name": "horizontalThreshold", "type": { "text": "number" }, "privacy": "public", "description": "How narrow the space allocated to the default position has to be before the widest area\nis selected for layout", "inheritedFrom": { "name": "AnchoredRegion", "module": "src/anchored-region/anchored-region.ts" } }, { "kind": "method", "name": "horizontalThresholdChanged", "privacy": "private", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "AnchoredRegion", "module": "src/anchored-region/anchored-region.ts" } }, { "kind": "field", "name": "horizontalScaling", "type": { "text": "AxisScalingMode" }, "privacy": "public", "default": "\"content\"", "description": "Defines how the width of the region is calculated", "inheritedFrom": { "name": "AnchoredRegion", "module": "src/anchored-region/anchored-region.ts" } }, { "kind": "method", "name": "horizontalScalingChanged", "privacy": "private", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "AnchoredRegion", "module": "src/anchored-region/anchored-region.ts" } }, { "kind": "field", "name": "verticalPositioningMode", "type": { "text": "AxisPositioningMode" }, "privacy": "public", "default": "\"uncontrolled\"", "description": "Sets what logic the component uses to determine vertical placement.\n'locktodefault' forces the default position\n'dynamic' decides placement based on available space\n'uncontrolled' does not control placement on the vertical axis", "inheritedFrom": { "name": "AnchoredRegion", "module": "src/anchored-region/anchored-region.ts" } }, { "kind": "method", "name": "verticalPositioningModeChanged", "privacy": "private", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "AnchoredRegion", "module": "src/anchored-region/anchored-region.ts" } }, { "kind": "field", "name": "verticalDefaultPosition", "type": { "text": "VerticalPosition" }, "privacy": "public", "default": "\"unset\"", "description": "The default vertical position of the region relative to the anchor element", "inheritedFrom": { "name": "AnchoredRegion", "module": "src/anchored-region/anchored-region.ts" } }, { "kind": "method", "name": "verticalDefaultPositionChanged", "privacy": "private", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "AnchoredRegion", "module": "src/anchored-region/anchored-region.ts" } }, { "kind": "field", "name": "verticalViewportLock", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "description": "Whether the region remains in the viewport (ie. detaches from the anchor) on the vertical axis", "inheritedFrom": { "name": "AnchoredRegion", "module": "src/anchored-region/anchored-region.ts" } }, { "kind": "method", "name": "verticalViewportLockChanged", "privacy": "private", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "AnchoredRegion", "module": "src/anchored-region/anchored-region.ts" } }, { "kind": "field", "name": "verticalInset", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "description": "Whether the region overlaps the anchor on the vertical axis", "inheritedFrom": { "name": "AnchoredRegion", "module": "src/anchored-region/anchored-region.ts" } }, { "kind": "method", "name": "verticalInsetChanged", "privacy": "private", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "AnchoredRegion", "module": "src/anchored-region/anchored-region.ts" } }, { "kind": "field", "name": "verticalThreshold", "type": { "text": "number" }, "privacy": "public", "description": "How short the space allocated to the default position has to be before the tallest area\nis selected for layout", "inheritedFrom": { "name": "AnchoredRegion", "module": "src/anchored-region/anchored-region.ts" } }, { "kind": "method", "name": "verticalThresholdChanged", "privacy": "private", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "AnchoredRegion", "module": "src/anchored-region/anchored-region.ts" } }, { "kind": "field", "name": "verticalScaling", "type": { "text": "AxisScalingMode" }, "privacy": "public", "default": "\"content\"", "description": "Defines how the height of the region is calculated", "inheritedFrom": { "name": "AnchoredRegion", "module": "src/anchored-region/anchored-region.ts" } }, { "kind": "method", "name": "verticalScalingChanged", "privacy": "private", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "AnchoredRegion", "module": "src/anchored-region/anchored-region.ts" } }, { "kind": "field", "name": "fixedPlacement", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "description": "Whether the region is positioned using css \"position: fixed\".\nOtherwise the region uses \"position: absolute\".\nFixed placement allows the region to break out of parent containers,", "inheritedFrom": { "name": "AnchoredRegion", "module": "src/anchored-region/anchored-region.ts" } }, { "kind": "method", "name": "fixedPlacementChanged", "privacy": "private", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "AnchoredRegion", "module": "src/anchored-region/anchored-region.ts" } }, { "kind": "field", "name": "autoUpdateMode", "type": { "text": "AutoUpdateMode" }, "privacy": "public", "default": "\"anchor\"", "description": "Defines what triggers the anchored region to revaluate positioning", "inheritedFrom": { "name": "AnchoredRegion", "module": "src/anchored-region/anchored-region.ts" } }, { "kind": "method", "name": "autoUpdateModeChanged", "privacy": "private", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "prevMode", "type": { "text": "AutoUpdateMode" } }, { "name": "newMode", "type": { "text": "AutoUpdateMode" } } ], "inheritedFrom": { "name": "AnchoredRegion", "module": "src/anchored-region/anchored-region.ts" } }, { "kind": "field", "name": "anchorElement", "type": { "text": "HTMLElement | null" }, "privacy": "public", "default": "null", "description": "The HTML element being used as the anchor", "inheritedFrom": { "name": "AnchoredRegion", "module": "src/anchored-region/anchored-region.ts" } }, { "kind": "method", "name": "anchorElementChanged", "privacy": "private", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "AnchoredRegion", "module": "src/anchored-region/anchored-region.ts" } }, { "kind": "field", "name": "viewportElement", "type": { "text": "HTMLElement | null" }, "privacy": "public", "default": "null", "description": "The HTML element being used as the viewport", "inheritedFrom": { "name": "AnchoredRegion", "module": "src/anchored-region/anchored-region.ts" } }, { "kind": "method", "name": "viewportElementChanged", "privacy": "private", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "AnchoredRegion", "module": "src/anchored-region/anchored-region.ts" } }, { "kind": "field", "name": "verticalPosition", "type": { "text": "AnchoredRegionPositionLabel | undefined" }, "privacy": "public", "description": "indicates the current horizontal position of the region", "inheritedFrom": { "name": "AnchoredRegion", "module": "src/anchored-region/anchored-region.ts" } }, { "kind": "field", "name": "horizontalPosition", "type": { "text": "AnchoredRegionPositionLabel | undefined" }, "privacy": "public", "description": "indicates the current vertical position of the region", "inheritedFrom": { "name": "AnchoredRegion", "module": "src/anchored-region/anchored-region.ts" } }, { "kind": "field", "name": "translateX", "type": { "text": "number" }, "privacy": "private", "description": "values to be applied to the component's transform on render", "inheritedFrom": { "name": "AnchoredRegion", "module": "src/anchored-region/anchored-region.ts" } }, { "kind": "field", "name": "translateY", "type": { "text": "number" }, "privacy": "private", "inheritedFrom": { "name": "AnchoredRegion", "module": "src/anchored-region/anchored-region.ts" } }, { "kind": "field", "name": "regionWidth", "type": { "text": "string" }, "privacy": "private", "description": "the span to be applied to the region on each axis", "inheritedFrom": { "name": "AnchoredRegion", "module": "src/anchored-region/anchored-region.ts" } }, { "kind": "field", "name": "regionHeight", "type": { "text": "string" }, "privacy": "private", "inheritedFrom": { "name": "AnchoredRegion", "module": "src/anchored-region/anchored-region.ts" } }, { "kind": "field", "name": "resizeDetector", "type": { "text": "ResizeObserverClassDefinition | null" }, "privacy": "private", "default": "null", "inheritedFrom": { "name": "AnchoredRegion", "module": "src/anchored-region/anchored-region.ts" } }, { "kind": "field", "name": "viewportRect", "type": { "text": "ClientRect | DOMRect | undefined" }, "privacy": "private", "inheritedFrom": { "name": "AnchoredRegion", "module": "src/anchored-region/anchored-region.ts" } }, { "kind": "field", "name": "anchorRect", "type": { "text": "ClientRect | DOMRect | undefined" }, "privacy": "private", "inheritedFrom": { "name": "AnchoredRegion", "module": "src/anchored-region/anchored-region.ts" } }, { "kind": "field", "name": "regionRect", "type": { "text": "ClientRect | DOMRect | undefined" }, "privacy": "private", "inheritedFrom": { "name": "AnchoredRegion", "module": "src/anchored-region/anchored-region.ts" } }, { "kind": "field", "name": "baseHorizontalOffset", "type": { "text": "number" }, "privacy": "private", "default": "0", "description": "base offsets between the positioner's base position and the anchor's", "inheritedFrom": { "name": "AnchoredRegion", "module": "src/anchored-region/anchored-region.ts" } }, { "kind": "field", "name": "baseVerticalOffset", "type": { "text": "number" }, "privacy": "private", "default": "0", "inheritedFrom": { "name": "AnchoredRegion", "module": "src/anchored-region/anchored-region.ts" } }, { "kind": "field", "name": "pendingPositioningUpdate", "type": { "text": "boolean" }, "privacy": "private", "default": "false", "inheritedFrom": { "name": "AnchoredRegion", "module": "src/anchored-region/anchored-region.ts" } }, { "kind": "field", "name": "pendingReset", "type": { "text": "boolean" }, "privacy": "private", "default": "false", "inheritedFrom": { "name": "AnchoredRegion", "module": "src/anchored-region/anchored-region.ts" } }, { "kind": "field", "name": "currentDirection", "type": { "text": "Direction" }, "privacy": "private", "inheritedFrom": { "name": "AnchoredRegion", "module": "src/anchored-region/anchored-region.ts" } }, { "kind": "field", "name": "regionVisible", "type": { "text": "boolean" }, "privacy": "private", "default": "false", "inheritedFrom": { "name": "AnchoredRegion", "module": "src/anchored-region/anchored-region.ts" } }, { "kind": "field", "name": "forceUpdate", "type": { "text": "boolean" }, "privacy": "private", "default": "false", "inheritedFrom": { "name": "AnchoredRegion", "module": "src/anchored-region/anchored-region.ts" } }, { "kind": "field", "name": "updateThreshold", "type": { "text": "number" }, "privacy": "private", "default": "0.5", "inheritedFrom": { "name": "AnchoredRegion", "module": "src/anchored-region/anchored-region.ts" } }, { "kind": "field", "name": "intersectionService", "type": { "text": "IntersectionService" }, "privacy": "private", "static": true, "default": "new IntersectionService()", "inheritedFrom": { "name": "AnchoredRegion", "module": "src/anchored-region/anchored-region.ts" } }, { "kind": "field", "name": "update", "privacy": "public", "description": "update position", "inheritedFrom": { "name": "AnchoredRegion", "module": "src/anchored-region/anchored-region.ts" } }, { "kind": "method", "name": "disconnectResizeDetector", "privacy": "private", "return": { "type": { "text": "void" } }, "description": "destroys the instance's resize observer", "inheritedFrom": { "name": "AnchoredRegion", "module": "src/anchored-region/anchored-region.ts" } }, { "kind": "method", "name": "initializeResizeDetector", "privacy": "private", "return": { "type": { "text": "void" } }, "description": "initializes the instance's resize observer", "inheritedFrom": { "name": "AnchoredRegion", "module": "src/anchored-region/anchored-region.ts" } }, { "kind": "method", "name": "updateForAttributeChange", "privacy": "private", "return": { "type": { "text": "void" } }, "description": "react to attribute changes that don't require a reset", "inheritedFrom": { "name": "AnchoredRegion", "module": "src/anchored-region/anchored-region.ts" } }, { "kind": "method", "name": "initialize", "privacy": "private", "return": { "type": { "text": "void" } }, "description": "fully initializes the component", "inheritedFrom": { "name": "AnchoredRegion", "module": "src/anchored-region/anchored-region.ts" } }, { "kind": "method", "name": "requestReset", "privacy": "private", "return": { "type": { "text": "void" } }, "description": "Request a reset if there are currently no open requests", "inheritedFrom": { "name": "AnchoredRegion", "module": "src/anchored-region/anchored-region.ts" } }, { "kind": "method", "name": "setInitialState", "privacy": "private", "return": { "type": { "text": "void" } }, "description": "sets the starting configuration for component internal values", "inheritedFrom": { "name": "AnchoredRegion", "module": "src/anchored-region/anchored-region.ts" } }, { "kind": "field", "name": "startObservers", "privacy": "private", "description": "starts observers", "inheritedFrom": { "name": "AnchoredRegion", "module": "src/anchored-region/anchored-region.ts" } }, { "kind": "field", "name": "requestPositionUpdates", "privacy": "private", "description": "get position updates", "inheritedFrom": { "name": "AnchoredRegion", "module": "src/anchored-region/anchored-region.ts" } }, { "kind": "field", "name": "stopObservers", "privacy": "private", "description": "stops observers", "inheritedFrom": { "name": "AnchoredRegion", "module": "src/anchored-region/anchored-region.ts" } }, { "kind": "field", "name": "getViewport", "privacy": "private", "description": "Gets the viewport element by id, or defaults to document root", "inheritedFrom": { "name": "AnchoredRegion", "module": "src/anchored-region/anchored-region.ts" } }, { "kind": "field", "name": "getAnchor", "privacy": "private", "description": "Gets the anchor element by id", "inheritedFrom": { "name": "AnchoredRegion", "module": "src/anchored-region/anchored-region.ts" } }, { "kind": "field", "name": "handleIntersection", "privacy": "private", "description": "Handle intersections", "inheritedFrom": { "name": "AnchoredRegion", "module": "src/anchored-region/anchored-region.ts" } }, { "kind": "field", "name": "applyIntersectionEntries", "privacy": "private", "description": "iterate through intersection entries and apply data", "inheritedFrom": { "name": "AnchoredRegion", "module": "src/anchored-region/anchored-region.ts" } }, { "kind": "field", "name": "updateRegionOffset", "privacy": "private", "description": "Update the offset values", "inheritedFrom": { "name": "AnchoredRegion", "module": "src/anchored-region/anchored-region.ts" } }, { "kind": "field", "name": "isRectDifferent", "privacy": "private", "description": "compare rects to see if there is enough change to justify a DOM update", "inheritedFrom": { "name": "AnchoredRegion", "module": "src/anchored-region/anchored-region.ts" } }, { "kind": "field", "name": "handleResize", "privacy": "private", "description": "Handle resize events", "inheritedFrom": { "name": "AnchoredRegion", "module": "src/anchored-region/anchored-region.ts" } }, { "kind": "field", "name": "reset", "privacy": "private", "description": "resets the component", "inheritedFrom": { "name": "AnchoredRegion", "module": "src/anchored-region/anchored-region.ts" } }, { "kind": "field", "name": "updateLayout", "privacy": "private", "description": "Recalculate layout related state values", "inheritedFrom": { "name": "AnchoredRegion", "module": "src/anchored-region/anchored-region.ts" } }, { "kind": "field", "name": "updateRegionStyle", "privacy": "private", "description": "Updates the style string applied to the region element as well as the css classes attached\nto the root element", "inheritedFrom": { "name": "AnchoredRegion", "module": "src/anchored-region/anchored-region.ts" } }, { "kind": "field", "name": "updatePositionClasses", "privacy": "private", "description": "Updates the css classes that reflect the current position of the element", "inheritedFrom": { "name": "AnchoredRegion", "module": "src/anchored-region/anchored-region.ts" } }, { "kind": "field", "name": "setHorizontalPosition", "privacy": "private", "description": "Get horizontal positioning state based on desired position", "inheritedFrom": { "name": "AnchoredRegion", "module": "src/anchored-region/anchored-region.ts" } }, { "kind": "field", "name": "setVerticalPosition", "privacy": "private", "description": "Set vertical positioning state based on desired position", "inheritedFrom": { "name": "AnchoredRegion", "module": "src/anchored-region/anchored-region.ts" } }, { "kind": "field", "name": "getPositioningOptions", "privacy": "private", "description": "Get available positions based on positioning mode", "inheritedFrom": { "name": "AnchoredRegion", "module": "src/anchored-region/anchored-region.ts" } }, { "kind": "field", "name": "getAvailableSpace", "privacy": "private", "description": "Get the space available for a particular relative position", "inheritedFrom": { "name": "AnchoredRegion", "module": "src/anchored-region/anchored-region.ts" } }, { "kind": "field", "name": "getNextRegionDimension", "privacy": "private", "description": "Get region dimensions", "inheritedFrom": { "name": "AnchoredRegion", "module": "src/anchored-region/anchored-region.ts" } }, { "kind": "field", "name": "startAutoUpdateEventListeners", "privacy": "private", "description": "starts event listeners that can trigger auto updating", "inheritedFrom": { "name": "AnchoredRegion", "module": "src/anchored-region/anchored-region.ts" } }, { "kind": "field", "name": "stopAutoUpdateEventListeners", "privacy": "private", "description": "stops event listeners that can trigger auto updating", "inheritedFrom": { "name": "AnchoredRegion", "module": "src/anchored-region/anchored-region.ts" } }, { "kind": "field", "name": "_presentation", "type": { "text": "ComponentPresentation | null | undefined" }, "privacy": "private", "default": "void 0", "inheritedFrom": { "name": "FoundationElement", "module": "src/foundation-element/foundation-element.ts" } }, { "kind": "field", "name": "$presentation", "type": { "text": "ComponentPresentation | null" }, "privacy": "public", "description": "A property which resolves the ComponentPresentation instance\nfor the current component.", "inheritedFrom": { "name": "FoundationElement", "module": "src/foundation-element/foundation-element.ts" } }, { "kind": "field", "name": "template", "type": { "text": "ElementViewTemplate | void | null" }, "privacy": "public", "description": "Sets the template of the element instance. When undefined,\nthe element will attempt to resolve the template from\nthe associated presentation or custom element definition.", "inheritedFrom": { "name": "FoundationElement", "module": "src/foundation-element/foundation-element.ts" } }, { "kind": "method", "name": "templateChanged", "privacy": "protected", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "FoundationElement", "module": "src/foundation-element/foundation-element.ts" } }, { "kind": "field", "name": "styles", "type": { "text": "ElementStyles | void | null" }, "privacy": "public", "description": "Sets the default styles for the element instance. When undefined,\nthe element will attempt to resolve default styles from\nthe associated presentation or custom element definition.", "inheritedFrom": { "name": "FoundationElement", "module": "src/foundation-element/foundation-element.ts" } }, { "kind": "method", "name": "stylesChanged", "privacy": "protected", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "FoundationElement", "module": "src/foundation-element/foundation-element.ts" } }, { "kind": "method", "name": "compose", "privacy": "public", "static": true, "return": { "type": { "text": "(\n overrideDefinition?: OverrideFoundationElementDefinition\n ) => FoundationElementRegistry" } }, "parameters": [ { "name": "this", "type": { "text": "K" } }, { "name": "elementDefinition", "type": { "text": "T" }, "description": "The definition of the element to create the registry\nfunction for." } ], "description": "Defines an element registry function with a set of element definition defaults.", "inheritedFrom": { "name": "FoundationElement", "module": "src/foundation-element/foundation-element.ts" } } ], "events": [ { "description": "Fires a custom 'loaded' event when the region is loaded and visible", "name": "loaded", "inheritedFrom": { "name": "AnchoredRegion", "module": "src/anchored-region/anchored-region.ts" } }, { "description": "Fires a custom 'positionchange' event when the position has changed", "name": "positionchange", "inheritedFrom": { "name": "AnchoredRegion", "module": "src/anchored-region/anchored-region.ts" } } ] }, { "kind": "variable", "name": "foundationAnchoredRegionShadowOptions", "type": { "text": "ShadowRootInit" }, "default": "{\n delegatesFocus: true,\n mode: 'open',\n}" }, { "kind": "variable", "name": "defaultAnchoredRegionConfig", "type": { "text": "object" }, "default": "{}" }, { "kind": "variable", "name": "foundationAnchoredRegion", "description": "The Foundation Anchored Region", "privacy": "public" } ], "exports": [ { "kind": "js", "name": "AnchoredRegion", "declaration": { "name": "AnchoredRegion", "module": "src/anchored-region/anchored-region.ts" } }, { "kind": "js", "name": "foundationAnchoredRegionShadowOptions", "declaration": { "name": "foundationAnchoredRegionShadowOptions", "module": "src/anchored-region/anchored-region.ts" } }, { "kind": "js", "name": "defaultAnchoredRegionConfig", "declaration": { "name": "defaultAnchoredRegionConfig", "module": "src/anchored-region/anchored-region.ts" } }, { "kind": "js", "name": "foundationAnchoredRegion", "declaration": { "name": "foundationAnchoredRegion", "module": "src/anchored-region/anchored-region.ts" } } ] }, { "kind": "javascript-module", "path": "src/anchored-region/index.ts", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./anchor-region.template" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./anchored-region.styles" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./anchored-region" } } ] }, { "kind": "javascript-module", "path": "src/avatar/avatar.styles.ts", "declarations": [ { "kind": "function", "name": "foundationAvatarStyles", "return": { "type": { "text": "ElementStyles" } }, "parameters": [ { "name": "context", "type": { "text": "ElementDefinitionContext" } }, { "name": "definition", "type": { "text": "FoundationElementDefinition" } } ] } ], "exports": [ { "kind": "js", "name": "foundationAvatarStyles", "declaration": { "name": "foundationAvatarStyles", "module": "src/avatar/avatar.styles.ts" } } ] }, { "kind": "javascript-module", "path": "src/avatar/avatar.template.ts", "declarations": [ { "kind": "function", "name": "foundationAvatarTemplate", "return": { "type": { "text": "ViewTemplate" } }, "parameters": [ { "name": "context", "type": { "text": "ElementDefinitionContext" } }, { "name": "definition", "type": { "text": "FoundationElementDefinition" } } ] }, { "kind": "variable", "name": "media", "default": "html`\n ${when(\n (x) => x.imgSrc,\n html`\n x.imgSrc}\" alt=\"${(x) => x.alt}\" slot=\"media\" class=\"media\" part=\"media\" />\n `,\n )}\n`" } ], "exports": [ { "kind": "js", "name": "foundationAvatarTemplate", "declaration": { "name": "foundationAvatarTemplate", "module": "src/avatar/avatar.template.ts" } }, { "kind": "js", "name": "media", "declaration": { "name": "media", "module": "src/avatar/avatar.template.ts" } } ] }, { "kind": "javascript-module", "path": "src/avatar/avatar.ts", "declarations": [ { "kind": "class", "description": "", "name": "Avatar", "superclass": { "name": "FASTAvatar", "package": "@microsoft/fast-components" }, "tagName": "%%prefix%%-avatar", "customElement": true, "attributes": [ { "name": "fill", "type": { "text": "string" }, "description": "Indicates the Avatar should have a color fill.", "fieldName": "fill", "inheritedFrom": { "name": "Avatar", "module": "src/avatar/avatar.ts" } }, { "name": "color", "type": { "text": "string" }, "description": "Indicates the Avatar should have a text color.", "fieldName": "color", "inheritedFrom": { "name": "Avatar", "module": "src/avatar/avatar.ts" } }, { "name": "link", "type": { "text": "string" }, "description": "Indicates the Avatar should have url link", "fieldName": "link", "inheritedFrom": { "name": "Avatar", "module": "src/avatar/avatar.ts" } }, { "name": "shape", "type": { "text": "AvatarShape" }, "description": "Indicates the Avatar shape should be. By default it will be set to \"circle\".", "fieldName": "shape", "inheritedFrom": { "name": "Avatar", "module": "src/avatar/avatar.ts" } } ], "members": [ { "kind": "field", "name": "fill", "type": { "text": "string" }, "privacy": "public", "description": "Indicates the Avatar should have a color fill.", "inheritedFrom": { "name": "Avatar", "module": "src/avatar/avatar.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string" }, "privacy": "public", "description": "Indicates the Avatar should have a text color.", "inheritedFrom": { "name": "Avatar", "module": "src/avatar/avatar.ts" } }, { "kind": "field", "name": "link", "type": { "text": "string" }, "privacy": "public", "description": "Indicates the Avatar should have url link", "inheritedFrom": { "name": "Avatar", "module": "src/avatar/avatar.ts" } }, { "kind": "field", "name": "shape", "type": { "text": "AvatarShape" }, "privacy": "public", "description": "Indicates the Avatar shape should be. By default it will be set to \"circle\".", "inheritedFrom": { "name": "Avatar", "module": "src/avatar/avatar.ts" } }, { "kind": "field", "name": "_presentation", "type": { "text": "ComponentPresentation | null | undefined" }, "privacy": "private", "default": "void 0", "inheritedFrom": { "name": "FoundationElement", "module": "src/foundation-element/foundation-element.ts" } }, { "kind": "field", "name": "$presentation", "type": { "text": "ComponentPresentation | null" }, "privacy": "public", "description": "A property which resolves the ComponentPresentation instance\nfor the current component.", "inheritedFrom": { "name": "FoundationElement", "module": "src/foundation-element/foundation-element.ts" } }, { "kind": "field", "name": "template", "type": { "text": "ElementViewTemplate | void | null" }, "privacy": "public", "description": "Sets the template of the element instance. When undefined,\nthe element will attempt to resolve the template from\nthe associated presentation or custom element definition.", "inheritedFrom": { "name": "FoundationElement", "module": "src/foundation-element/foundation-element.ts" } }, { "kind": "method", "name": "templateChanged", "privacy": "protected", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "FoundationElement", "module": "src/foundation-element/foundation-element.ts" } }, { "kind": "field", "name": "styles", "type": { "text": "ElementStyles | void | null" }, "privacy": "public", "description": "Sets the default styles for the element instance. When undefined,\nthe element will attempt to resolve default styles from\nthe associated presentation or custom element definition.", "inheritedFrom": { "name": "FoundationElement", "module": "src/foundation-element/foundation-element.ts" } }, { "kind": "method", "name": "stylesChanged", "privacy": "protected", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "FoundationElement", "module": "src/foundation-element/foundation-element.ts" } }, { "kind": "method", "name": "compose", "privacy": "public", "static": true, "return": { "type": { "text": "(\n overrideDefinition?: OverrideFoundationElementDefinition\n ) => FoundationElementRegistry" } }, "parameters": [ { "name": "this", "type": { "text": "K" } }, { "name": "elementDefinition", "type": { "text": "T" }, "description": "The definition of the element to create the registry\nfunction for." } ], "description": "Defines an element registry function with a set of element definition defaults.", "inheritedFrom": { "name": "FoundationElement", "module": "src/foundation-element/foundation-element.ts" } } ] }, { "kind": "variable", "name": "foundationAvatarShadowOptions", "type": { "text": "ShadowRootInit" }, "default": "{\n delegatesFocus: true,\n mode: 'open',\n}" }, { "kind": "variable", "name": "defaultAvatarConfig", "type": { "text": "object" }, "default": "{\n media: mediaTemplate,\n}" }, { "kind": "variable", "name": "foundationAvatar", "description": "The Foundation Avatar", "privacy": "public" } ], "exports": [ { "kind": "js", "name": "Avatar", "declaration": { "name": "Avatar", "module": "src/avatar/avatar.ts" } }, { "kind": "js", "name": "foundationAvatarShadowOptions", "declaration": { "name": "foundationAvatarShadowOptions", "module": "src/avatar/avatar.ts" } }, { "kind": "js", "name": "defaultAvatarConfig", "declaration": { "name": "defaultAvatarConfig", "module": "src/avatar/avatar.ts" } }, { "kind": "js", "name": "foundationAvatar", "declaration": { "name": "foundationAvatar", "module": "src/avatar/avatar.ts" } } ] }, { "kind": "javascript-module", "path": "src/avatar/index.ts", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./avatar.template" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./avatar.styles" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./avatar" } } ] }, { "kind": "javascript-module", "path": "src/badge/badge.styles.ts", "declarations": [ { "kind": "function", "name": "foundationBadgeStyles", "return": { "type": { "text": "ElementStyles" } }, "parameters": [ { "name": "context", "type": { "text": "ElementDefinitionContext" } }, { "name": "definition", "type": { "text": "FoundationElementDefinition" } } ] } ], "exports": [ { "kind": "js", "name": "foundationBadgeStyles", "declaration": { "name": "foundationBadgeStyles", "module": "src/badge/badge.styles.ts" } } ] }, { "kind": "javascript-module", "path": "src/badge/badge.template.ts", "declarations": [ { "kind": "function", "name": "foundationBadgeTemplate", "return": { "type": { "text": "ViewTemplate" } }, "parameters": [ { "name": "context", "type": { "text": "ElementDefinitionContext" } }, { "name": "definition", "type": { "text": "FoundationElementDefinition" } } ] } ], "exports": [ { "kind": "js", "name": "foundationBadgeTemplate", "declaration": { "name": "foundationBadgeTemplate", "module": "src/badge/badge.template.ts" } } ] }, { "kind": "javascript-module", "path": "src/badge/badge.ts", "declarations": [ { "kind": "class", "description": "", "name": "Badge", "superclass": { "name": "FASTBadge", "package": "@microsoft/fast-components" }, "tagName": "%%prefix%%-badge", "customElement": true, "attributes": [ { "name": "fill", "type": { "text": "string" }, "description": "Indicates the badge should have a filled style.", "fieldName": "fill", "inheritedFrom": { "name": "Badge", "module": "src/badge/badge.ts" } }, { "name": "color", "type": { "text": "string" }, "description": "Indicates the badge should have a filled style.", "fieldName": "color", "inheritedFrom": { "name": "Badge", "module": "src/badge/badge.ts" } }, { "type": { "text": "boolean" }, "description": "Indicates the element should be circular", "fieldName": "circular", "inheritedFrom": { "name": "Badge", "module": "src/badge/badge.ts" } } ], "members": [ { "kind": "field", "name": "fill", "type": { "text": "string" }, "privacy": "public", "description": "Indicates the badge should have a filled style.", "inheritedFrom": { "name": "Badge", "module": "src/badge/badge.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string" }, "privacy": "public", "description": "Indicates the badge should have a filled style.", "inheritedFrom": { "name": "Badge", "module": "src/badge/badge.ts" } }, { "kind": "field", "name": "circular", "type": { "text": "boolean" }, "privacy": "public", "description": "Indicates the element should be circular", "inheritedFrom": { "name": "Badge", "module": "src/badge/badge.ts" } }, { "kind": "field", "name": "generateBadgeStyle", "privacy": "public", "inheritedFrom": { "name": "Badge", "module": "src/badge/badge.ts" } }, { "kind": "field", "name": "_presentation", "type": { "text": "ComponentPresentation | null | undefined" }, "privacy": "private", "default": "void 0", "inheritedFrom": { "name": "FoundationElement", "module": "src/foundation-element/foundation-element.ts" } }, { "kind": "field", "name": "$presentation", "type": { "text": "ComponentPresentation | null" }, "privacy": "public", "description": "A property which resolves the ComponentPresentation instance\nfor the current component.", "inheritedFrom": { "name": "FoundationElement", "module": "src/foundation-element/foundation-element.ts" } }, { "kind": "field", "name": "template", "type": { "text": "ElementViewTemplate | void | null" }, "privacy": "public", "description": "Sets the template of the element instance. When undefined,\nthe element will attempt to resolve the template from\nthe associated presentation or custom element definition.", "inheritedFrom": { "name": "FoundationElement", "module": "src/foundation-element/foundation-element.ts" } }, { "kind": "method", "name": "templateChanged", "privacy": "protected", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "FoundationElement", "module": "src/foundation-element/foundation-element.ts" } }, { "kind": "field", "name": "styles", "type": { "text": "ElementStyles | void | null" }, "privacy": "public", "description": "Sets the default styles for the element instance. When undefined,\nthe element will attempt to resolve default styles from\nthe associated presentation or custom element definition.", "inheritedFrom": { "name": "FoundationElement", "module": "src/foundation-element/foundation-element.ts" } }, { "kind": "method", "name": "stylesChanged", "privacy": "protected", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "FoundationElement", "module": "src/foundation-element/foundation-element.ts" } }, { "kind": "method", "name": "compose", "privacy": "public", "static": true, "return": { "type": { "text": "(\n overrideDefinition?: OverrideFoundationElementDefinition\n ) => FoundationElementRegistry" } }, "parameters": [ { "name": "this", "type": { "text": "K" } }, { "name": "elementDefinition", "type": { "text": "T" }, "description": "The definition of the element to create the registry\nfunction for." } ], "description": "Defines an element registry function with a set of element definition defaults.", "inheritedFrom": { "name": "FoundationElement", "module": "src/foundation-element/foundation-element.ts" } } ] }, { "kind": "variable", "name": "foundationBadgeShadowOptions", "type": { "text": "ShadowRootInit" }, "default": "undefined" }, { "kind": "variable", "name": "defaultBadgeConfig", "type": { "text": "object" }, "default": "{}" }, { "kind": "variable", "name": "foundationBadge", "description": "The Foundation Badge", "privacy": "public" } ], "exports": [ { "kind": "js", "name": "Badge", "declaration": { "name": "Badge", "module": "src/badge/badge.ts" } }, { "kind": "js", "name": "foundationBadgeShadowOptions", "declaration": { "name": "foundationBadgeShadowOptions", "module": "src/badge/badge.ts" } }, { "kind": "js", "name": "defaultBadgeConfig", "declaration": { "name": "defaultBadgeConfig", "module": "src/badge/badge.ts" } }, { "kind": "js", "name": "foundationBadge", "declaration": { "name": "foundationBadge", "module": "src/badge/badge.ts" } } ] }, { "kind": "javascript-module", "path": "src/badge/index.ts", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./badge.template" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./badge.styles" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./badge" } } ] }, { "kind": "javascript-module", "path": "src/banner/banner.styles.ts", "declarations": [ { "kind": "variable", "name": "foundationBannerStyles", "type": { "text": "ElementStyles" }, "default": "css`\n @keyframes delete-animate {\n from {\n height: 100px;\n opacity: 100%;\n }\n\n to {\n height: 0;\n opacity: 0%;\n }\n }\n\n @keyframes append-animate {\n from {\n height: 0;\n opacity: 0%;\n }\n\n to {\n height: var(--banner-height);\n opacity: 100%;\n }\n }\n\n :host {\n --banner-width: 100%;\n --banner-height: 65px;\n --flow: row;\n }\n\n @media screen and (max-width: 640px) {\n :host {\n --flow: column;\n --banner-height: 100px;\n }\n }\n\n .banner {\n animation: append-animate 0.3s linear;\n width: var(--banner-width);\n height: var(--banner-height);\n background-color: var(--fill-color);\n display: flex;\n flex-direction: var(--flow);\n padding: 5px 8px;\n box-sizing: border-box;\n overflow: hidden;\n }\n\n .banner-delete {\n animation: delete-animate 0.3s linear;\n opacity: 0%;\n }\n\n .content {\n display: flex;\n align-items: center;\n flex: 2;\n font-size: 12px;\n overflow: hidden;\n white-space: pre-line;\n }\n\n .action {\n display: flex;\n flex-direction: row-reverse;\n align-items: center;\n gap: 10px;\n flex: 1;\n overflow: hidden;\n }\n`" } ], "exports": [ { "kind": "js", "name": "foundationBannerStyles", "declaration": { "name": "foundationBannerStyles", "module": "src/banner/banner.styles.ts" } } ] }, { "kind": "javascript-module", "path": "src/banner/banner.template.ts", "declarations": [ { "kind": "function", "name": "getBannerTemplate", "parameters": [ { "name": "prefix", "type": { "text": "string" } } ] }, { "kind": "variable", "name": "foundationBannerTemplate", "default": "html`\n ${(x) => getBannerTemplate(getPrefix(x))}\n`" } ], "exports": [ { "kind": "js", "name": "getBannerTemplate", "declaration": { "name": "getBannerTemplate", "module": "src/banner/banner.template.ts" } }, { "kind": "js", "name": "foundationBannerTemplate", "declaration": { "name": "foundationBannerTemplate", "module": "src/banner/banner.template.ts" } } ] }, { "kind": "javascript-module", "path": "src/banner/banner.ts", "declarations": [ { "kind": "variable", "name": "foundationBannerShadowOptions", "type": { "text": "ShadowRootInit" }, "default": "{\n mode: 'open',\n delegatesFocus: true,\n}" }, { "kind": "class", "description": "", "name": "Banner", "members": [ { "kind": "field", "name": "banner", "type": { "text": "HTMLElement" }, "privacy": "public" }, { "kind": "field", "name": "dismissAnimation", "type": { "text": "'banner-delete' | ''" }, "default": "''" }, { "kind": "field", "name": "notification", "type": { "text": "NotificationStructure" } }, { "kind": "method", "name": "dismiss", "privacy": "public", "return": { "type": { "text": "Promise" } }, "description": "Dismiss the Banner from display." }, { "kind": "method", "name": "dismissNotification", "privacy": "public", "description": "Dismiss the Banner (NotificationStructure) from display." }, { "kind": "field", "name": "_presentation", "type": { "text": "ComponentPresentation | null | undefined" }, "privacy": "private", "default": "void 0", "inheritedFrom": { "name": "FoundationElement", "module": "src/foundation-element/foundation-element.ts" } }, { "kind": "field", "name": "$presentation", "type": { "text": "ComponentPresentation | null" }, "privacy": "public", "description": "A property which resolves the ComponentPresentation instance\nfor the current component.", "inheritedFrom": { "name": "FoundationElement", "module": "src/foundation-element/foundation-element.ts" } }, { "kind": "field", "name": "template", "type": { "text": "ElementViewTemplate | void | null" }, "privacy": "public", "description": "Sets the template of the element instance. When undefined,\nthe element will attempt to resolve the template from\nthe associated presentation or custom element definition.", "inheritedFrom": { "name": "FoundationElement", "module": "src/foundation-element/foundation-element.ts" } }, { "kind": "method", "name": "templateChanged", "privacy": "protected", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "FoundationElement", "module": "src/foundation-element/foundation-element.ts" } }, { "kind": "field", "name": "styles", "type": { "text": "ElementStyles | void | null" }, "privacy": "public", "description": "Sets the default styles for the element instance. When undefined,\nthe element will attempt to resolve default styles from\nthe associated presentation or custom element definition.", "inheritedFrom": { "name": "FoundationElement", "module": "src/foundation-element/foundation-element.ts" } }, { "kind": "method", "name": "stylesChanged", "privacy": "protected", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "FoundationElement", "module": "src/foundation-element/foundation-element.ts" } }, { "kind": "method", "name": "compose", "privacy": "public", "static": true, "return": { "type": { "text": "(\n overrideDefinition?: OverrideFoundationElementDefinition\n ) => FoundationElementRegistry" } }, "parameters": [ { "name": "this", "type": { "text": "K" } }, { "name": "elementDefinition", "type": { "text": "T" }, "description": "The definition of the element to create the registry\nfunction for." } ], "description": "Defines an element registry function with a set of element definition defaults.", "inheritedFrom": { "name": "FoundationElement", "module": "src/foundation-element/foundation-element.ts" } } ], "superclass": { "name": "FoundationElement", "package": "@microsoft/fast-foundation" }, "tagName": "%%prefix%%-banner", "customElement": true }, { "kind": "variable", "name": "foundationBanner", "description": "The Foundation Banner", "privacy": "public" } ], "exports": [ { "kind": "js", "name": "foundationBannerShadowOptions", "declaration": { "name": "foundationBannerShadowOptions", "module": "src/banner/banner.ts" } }, { "kind": "js", "name": "Banner", "declaration": { "name": "Banner", "module": "src/banner/banner.ts" } }, { "kind": "js", "name": "foundationBanner", "declaration": { "name": "foundationBanner", "module": "src/banner/banner.ts" } } ] }, { "kind": "javascript-module", "path": "src/banner/index.ts", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./banner.styles" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./banner.template" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./banner" } } ] }, { "kind": "javascript-module", "path": "src/breadcrumb/breadcrumb.styles.ts", "declarations": [ { "kind": "function", "name": "foundationBreadcrumbStyles", "return": { "type": { "text": "ElementStyles" } }, "parameters": [ { "name": "context", "type": { "text": "ElementDefinitionContext" } }, { "name": "definition", "type": { "text": "FoundationElementDefinition" } } ] } ], "exports": [ { "kind": "js", "name": "foundationBreadcrumbStyles", "declaration": { "name": "foundationBreadcrumbStyles", "module": "src/breadcrumb/breadcrumb.styles.ts" } } ] }, { "kind": "javascript-module", "path": "src/breadcrumb/breadcrumb.template.ts", "declarations": [ { "kind": "function", "name": "foundationBreadcrumbTemplate", "return": { "type": { "text": "ViewTemplate" } }, "parameters": [ { "name": "context", "type": { "text": "ElementDefinitionContext" } }, { "name": "definition", "type": { "text": "FoundationElementDefinition" } } ] } ], "exports": [ { "kind": "js", "name": "foundationBreadcrumbTemplate", "declaration": { "name": "foundationBreadcrumbTemplate", "module": "src/breadcrumb/breadcrumb.template.ts" } } ] }, { "kind": "javascript-module", "path": "src/breadcrumb/breadcrumb.ts", "declarations": [ { "kind": "class", "description": "", "name": "Breadcrumb", "superclass": { "name": "FASTBreadcrumb", "package": "@microsoft/fast-components" }, "tagName": "%%prefix%%-breadcrumb", "customElement": true, "members": [ { "kind": "method", "name": "slottedBreadcrumbItemsChanged", "privacy": "public", "inheritedFrom": { "name": "Breadcrumb", "module": "src/breadcrumb/breadcrumb.ts" } }, { "kind": "method", "name": "setItemSeparator", "privacy": "private", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "item", "type": { "text": "HTMLElement" } }, { "name": "isLastNode", "type": { "text": "boolean" } } ], "inheritedFrom": { "name": "Breadcrumb", "module": "src/breadcrumb/breadcrumb.ts" } }, { "kind": "method", "name": "findChildWithHref", "privacy": "private", "return": { "type": { "text": "HTMLElement | null" } }, "parameters": [ { "name": "node", "type": { "text": "HTMLElement" } } ], "description": "Finds href on childnodes in the light DOM or shadow DOM.\nWe look in the shadow DOM because we insert an anchor when breadcrumb-item has an href.", "inheritedFrom": { "name": "Breadcrumb", "module": "src/breadcrumb/breadcrumb.ts" } }, { "kind": "method", "name": "setAriaCurrent", "privacy": "private", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "item", "type": { "text": "HTMLElement" } }, { "name": "isLastNode", "type": { "text": "boolean" } } ], "description": "Sets ARIA Current for the current node\nIf child node with an anchor tag and with href is found then set aria-current to correct value for the child node,\notherwise apply aria-current to the host element, with an href", "inheritedFrom": { "name": "Breadcrumb", "module": "src/breadcrumb/breadcrumb.ts" } }, { "kind": "field", "name": "_presentation", "type": { "text": "ComponentPresentation | null | undefined" }, "privacy": "private", "default": "void 0", "inheritedFrom": { "name": "FoundationElement", "module": "src/foundation-element/foundation-element.ts" } }, { "kind": "field", "name": "$presentation", "type": { "text": "ComponentPresentation | null" }, "privacy": "public", "description": "A property which resolves the ComponentPresentation instance\nfor the current component.", "inheritedFrom": { "name": "FoundationElement", "module": "src/foundation-element/foundation-element.ts" } }, { "kind": "field", "name": "template", "type": { "text": "ElementViewTemplate | void | null" }, "privacy": "public", "description": "Sets the template of the element instance. When undefined,\nthe element will attempt to resolve the template from\nthe associated presentation or custom element definition.", "inheritedFrom": { "name": "FoundationElement", "module": "src/foundation-element/foundation-element.ts" } }, { "kind": "method", "name": "templateChanged", "privacy": "protected", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "FoundationElement", "module": "src/foundation-element/foundation-element.ts" } }, { "kind": "field", "name": "styles", "type": { "text": "ElementStyles | void | null" }, "privacy": "public", "description": "Sets the default styles for the element instance. When undefined,\nthe element will attempt to resolve default styles from\nthe associated presentation or custom element definition.", "inheritedFrom": { "name": "FoundationElement", "module": "src/foundation-element/foundation-element.ts" } }, { "kind": "method", "name": "stylesChanged", "privacy": "protected", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "FoundationElement", "module": "src/foundation-element/foundation-element.ts" } }, { "kind": "method", "name": "compose", "privacy": "public", "static": true, "return": { "type": { "text": "(\n overrideDefinition?: OverrideFoundationElementDefinition\n ) => FoundationElementRegistry" } }, "parameters": [ { "name": "this", "type": { "text": "K" } }, { "name": "elementDefinition", "type": { "text": "T" }, "description": "The definition of the element to create the registry\nfunction for." } ], "description": "Defines an element registry function with a set of element definition defaults.", "inheritedFrom": { "name": "FoundationElement", "module": "src/foundation-element/foundation-element.ts" } } ] }, { "kind": "variable", "name": "foundationBreadcrumbShadowOptions", "type": { "text": "ShadowRootInit" }, "default": "undefined" }, { "kind": "variable", "name": "defaultBreadcrumbConfig", "type": { "text": "object" }, "default": "{}" }, { "kind": "variable", "name": "foundationBreadcrumb", "description": "The Foundation Breadcrumb", "privacy": "public" } ], "exports": [ { "kind": "js", "name": "Breadcrumb", "declaration": { "name": "Breadcrumb", "module": "src/breadcrumb/breadcrumb.ts" } }, { "kind": "js", "name": "foundationBreadcrumbShadowOptions", "declaration": { "name": "foundationBreadcrumbShadowOptions", "module": "src/breadcrumb/breadcrumb.ts" } }, { "kind": "js", "name": "defaultBreadcrumbConfig", "declaration": { "name": "defaultBreadcrumbConfig", "module": "src/breadcrumb/breadcrumb.ts" } }, { "kind": "js", "name": "foundationBreadcrumb", "declaration": { "name": "foundationBreadcrumb", "module": "src/breadcrumb/breadcrumb.ts" } } ] }, { "kind": "javascript-module", "path": "src/breadcrumb/index.ts", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./breadcrumb.template" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./breadcrumb.styles" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./breadcrumb" } } ] }, { "kind": "javascript-module", "path": "src/breadcrumb-item/breadcrumb-item.styles.ts", "declarations": [ { "kind": "function", "name": "foundationBreadcrumbItemStyles", "return": { "type": { "text": "ElementStyles" } }, "parameters": [ { "name": "context", "type": { "text": "ElementDefinitionContext" } }, { "name": "definition", "type": { "text": "FoundationElementDefinition" } } ] } ], "exports": [ { "kind": "js", "name": "foundationBreadcrumbItemStyles", "declaration": { "name": "foundationBreadcrumbItemStyles", "module": "src/breadcrumb-item/breadcrumb-item.styles.ts" } } ] }, { "kind": "javascript-module", "path": "src/breadcrumb-item/breadcrumb-item.template.ts", "declarations": [ { "kind": "function", "name": "foundationBreadcrumbItemTemplate", "return": { "type": { "text": "ViewTemplate" } }, "parameters": [ { "name": "context", "type": { "text": "ElementDefinitionContext" } }, { "name": "definition", "type": { "text": "FoundationElementDefinition" } } ] } ], "exports": [ { "kind": "js", "name": "foundationBreadcrumbItemTemplate", "declaration": { "name": "foundationBreadcrumbItemTemplate", "module": "src/breadcrumb-item/breadcrumb-item.template.ts" } } ] }, { "kind": "javascript-module", "path": "src/breadcrumb-item/breadcrumb-item.ts", "declarations": [ { "kind": "class", "description": "", "name": "BreadcrumbItem", "superclass": { "name": "FASTBreadcrumbItem", "package": "@microsoft/fast-components" }, "tagName": "%%prefix%%-breadcrumb-item", "customElement": true, "attributes": [ { "name": "download", "type": { "text": "string" }, "description": "Prompts the user to save the linked URL. See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a | element for more information.", "fieldName": "download", "inheritedFrom": { "name": "Anchor", "module": "src/anchor/anchor.ts" } }, { "name": "href", "type": { "text": "string" }, "description": "The URL the hyperlink references. See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a | element for more information.", "fieldName": "href", "inheritedFrom": { "name": "Anchor", "module": "src/anchor/anchor.ts" } }, { "name": "hreflang", "type": { "text": "string" }, "description": "Hints at the language of the referenced resource. See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a | element for more information.", "fieldName": "hreflang", "inheritedFrom": { "name": "Anchor", "module": "src/anchor/anchor.ts" } }, { "name": "ping", "type": { "text": "string" }, "description": "See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a | element for more information.", "fieldName": "ping", "inheritedFrom": { "name": "Anchor", "module": "src/anchor/anchor.ts" } }, { "name": "referrerpolicy", "type": { "text": "string" }, "description": "See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a | element for more information.", "fieldName": "referrerpolicy", "inheritedFrom": { "name": "Anchor", "module": "src/anchor/anchor.ts" } }, { "name": "rel", "type": { "text": "string" }, "description": "See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a | element for more information.", "fieldName": "rel", "inheritedFrom": { "name": "Anchor", "module": "src/anchor/anchor.ts" } }, { "name": "target", "type": { "text": "\"_self\" | \"_blank\" | \"_parent\" | \"_top\"" }, "description": "See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a | element for more information.", "fieldName": "target", "inheritedFrom": { "name": "Anchor", "module": "src/anchor/anchor.ts" } }, { "name": "type", "type": { "text": "string" }, "description": "See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a | element for more information.", "fieldName": "type", "inheritedFrom": { "name": "Anchor", "module": "src/anchor/anchor.ts" } } ], "members": [ { "kind": "field", "name": "download", "type": { "text": "string" }, "privacy": "public", "description": "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.", "inheritedFrom": { "name": "Anchor", "module": "src/anchor/anchor.ts" } }, { "kind": "field", "name": "href", "type": { "text": "string" }, "privacy": "public", "description": "The URL the hyperlink references. See {@link https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a | element } for more information.", "inheritedFrom": { "name": "Anchor", "module": "src/anchor/anchor.ts" } }, { "kind": "field", "name": "hreflang", "type": { "text": "string" }, "privacy": "public", "description": "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.", "inheritedFrom": { "name": "Anchor", "module": "src/anchor/anchor.ts" } }, { "kind": "field", "name": "ping", "type": { "text": "string" }, "privacy": "public", "description": "See {@link https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a | element } for more information.", "inheritedFrom": { "name": "Anchor", "module": "src/anchor/anchor.ts" } }, { "kind": "field", "name": "referrerpolicy", "type": { "text": "string" }, "privacy": "public", "description": "See {@link https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a | element } for more information.", "inheritedFrom": { "name": "Anchor", "module": "src/anchor/anchor.ts" } }, { "kind": "field", "name": "rel", "type": { "text": "string" }, "privacy": "public", "description": "See {@link https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a | element } for more information.", "inheritedFrom": { "name": "Anchor", "module": "src/anchor/anchor.ts" } }, { "kind": "field", "name": "target", "type": { "text": "\"_self\" | \"_blank\" | \"_parent\" | \"_top\"" }, "privacy": "public", "description": "See {@link https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a | element } for more information.", "inheritedFrom": { "name": "Anchor", "module": "src/anchor/anchor.ts" } }, { "kind": "field", "name": "type", "type": { "text": "string" }, "privacy": "public", "description": "See {@link https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a | element } for more information.", "inheritedFrom": { "name": "Anchor", "module": "src/anchor/anchor.ts" } }, { "kind": "field", "name": "control", "type": { "text": "HTMLAnchorElement | undefined" }, "privacy": "public", "description": "References the root element", "inheritedFrom": { "name": "Anchor", "module": "src/anchor/anchor.ts" } }, { "kind": "field", "name": "handleUnsupportedDelegatesFocus", "privacy": "private", "description": "Overrides the focus call for where delegatesFocus is unsupported.\nThis check works for Chrome, Edge Chromium, FireFox, and Safari\nRelevant PR on the Firefox browser: https://phabricator.services.mozilla.com/D123858", "inheritedFrom": { "name": "Anchor", "module": "src/anchor/anchor.ts" } }, { "kind": "field", "name": "_presentation", "type": { "text": "ComponentPresentation | null | undefined" }, "privacy": "private", "default": "void 0", "inheritedFrom": { "name": "FoundationElement", "module": "src/foundation-element/foundation-element.ts" } }, { "kind": "field", "name": "$presentation", "type": { "text": "ComponentPresentation | null" }, "privacy": "public", "description": "A property which resolves the ComponentPresentation instance\nfor the current component.", "inheritedFrom": { "name": "FoundationElement", "module": "src/foundation-element/foundation-element.ts" } }, { "kind": "field", "name": "template", "type": { "text": "ElementViewTemplate | void | null" }, "privacy": "public", "description": "Sets the template of the element instance. When undefined,\nthe element will attempt to resolve the template from\nthe associated presentation or custom element definition.", "inheritedFrom": { "name": "FoundationElement", "module": "src/foundation-element/foundation-element.ts" } }, { "kind": "method", "name": "templateChanged", "privacy": "protected", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "FoundationElement", "module": "src/foundation-element/foundation-element.ts" } }, { "kind": "field", "name": "styles", "type": { "text": "ElementStyles | void | null" }, "privacy": "public", "description": "Sets the default styles for the element instance. When undefined,\nthe element will attempt to resolve default styles from\nthe associated presentation or custom element definition.", "inheritedFrom": { "name": "FoundationElement", "module": "src/foundation-element/foundation-element.ts" } }, { "kind": "method", "name": "stylesChanged", "privacy": "protected", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "FoundationElement", "module": "src/foundation-element/foundation-element.ts" } }, { "kind": "method", "name": "compose", "privacy": "public", "static": true, "return": { "type": { "text": "(\n overrideDefinition?: OverrideFoundationElementDefinition\n ) => FoundationElementRegistry" } }, "parameters": [ { "name": "this", "type": { "text": "K" } }, { "name": "elementDefinition", "type": { "text": "T" }, "description": "The definition of the element to create the registry\nfunction for." } ], "description": "Defines an element registry function with a set of element definition defaults.", "inheritedFrom": { "name": "FoundationElement", "module": "src/foundation-element/foundation-element.ts" } } ] }, { "kind": "variable", "name": "foundationBreadcrumbItemShadowOptions", "type": { "text": "ShadowRootInit" }, "default": "undefined" }, { "kind": "variable", "name": "defaultBreadcrumbItemConfig", "type": { "text": "object" }, "default": "{\n separator: '/',\n}" }, { "kind": "variable", "name": "foundationBreadcrumbItem", "description": "The Foundation Breadcrumb Item", "privacy": "public" } ], "exports": [ { "kind": "js", "name": "BreadcrumbItem", "declaration": { "name": "BreadcrumbItem", "module": "src/breadcrumb-item/breadcrumb-item.ts" } }, { "kind": "js", "name": "foundationBreadcrumbItemShadowOptions", "declaration": { "name": "foundationBreadcrumbItemShadowOptions", "module": "src/breadcrumb-item/breadcrumb-item.ts" } }, { "kind": "js", "name": "defaultBreadcrumbItemConfig", "declaration": { "name": "defaultBreadcrumbItemConfig", "module": "src/breadcrumb-item/breadcrumb-item.ts" } }, { "kind": "js", "name": "foundationBreadcrumbItem", "declaration": { "name": "foundationBreadcrumbItem", "module": "src/breadcrumb-item/breadcrumb-item.ts" } } ] }, { "kind": "javascript-module", "path": "src/breadcrumb-item/index.ts", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./breadcrumb-item.template" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./breadcrumb-item.styles" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./breadcrumb-item" } } ] }, { "kind": "javascript-module", "path": "src/button/button.styles.ts", "declarations": [ { "kind": "function", "name": "foundationButtonStyles", "return": { "type": { "text": "ElementStyles" } }, "parameters": [ { "name": "context", "type": { "text": "ElementDefinitionContext" } }, { "name": "definition", "type": { "text": "FoundationElementDefinition" } } ] } ], "exports": [ { "kind": "js", "name": "foundationButtonStyles", "declaration": { "name": "foundationButtonStyles", "module": "src/button/button.styles.ts" } } ] }, { "kind": "javascript-module", "path": "src/button/button.template.ts", "declarations": [ { "kind": "function", "name": "foundationButtonTemplate", "return": { "type": { "text": "ViewTemplate