@fluentui/web-components 3.0.0-rc.29 → 3.0.0-rc.30

package/dist/web-components.d.ts

@@ -3,8 +3,8 @@ import { CSSDirective } from '@microsoft/fast-element';
 import { ElementStyles } from '@microsoft/fast-element';
 import { ElementViewTemplate } from '@microsoft/fast-element';
 import { FASTElement } from '@microsoft/fast-element';
-import { FASTElementDefinition } from '@microsoft/fast-element';
 import { HTMLDirective } from '@microsoft/fast-element';
+import type { PartialFASTElementDefinition } from '@microsoft/fast-element';
 import { SyntheticViewTemplate } from '@microsoft/fast-element';
 import { ViewTemplate } from '@microsoft/fast-element';
 
@@ -87,11 +87,11 @@ export declare class Accordion extends FASTElement {
 }
 
 /**
+ * The definition configuration for the `<fluent-accordion>` element.
+ *
  * @public
- * @remarks
- * HTML Element: \<fluent-accordion\>
  */
-export declare const accordionDefinition: FASTElementDefinition<typeof Accordion>;
+export declare const accordionDefinition: PartialFASTElementDefinition;
 
 /**
  * Expand mode for {@link Accordion}
@@ -153,12 +153,11 @@ export declare interface AccordionItem extends StartEnd {
 }
 
 /**
+ * The definition configuration for the `<fluent-accordion-item>` element.
  *
  * @public
- * @remarks
- * HTML Element: \<fluent-accordion-item\>
  */
-export declare const accordionItemDefinition: FASTElementDefinition<typeof AccordionItem>;
+export declare const accordionItemDefinition: PartialFASTElementDefinition;
 
 /**
  * An Accordion Item expand/collapse icon can appear at the start or end of the accordion
@@ -306,11 +305,11 @@ export declare const AnchorButtonAppearance: {
 export declare type AnchorButtonAppearance = ValuesOf<typeof AnchorButtonAppearance>;
 
 /**
+ * The definition for the `<fluent-anchor-button>` element.
+ *
  * @public
- * @remarks
- * HTML Element: \<fluent-anchor-button\>
  */
-export declare const AnchorButtonDefinition: FASTElementDefinition<typeof AnchorButton>;
+export declare const AnchorButtonDefinition: PartialFASTElementDefinition;
 
 /**
  * An Anchor Button can be square, circular or rounded.
@@ -540,13 +539,11 @@ export declare const AvatarColor: {
 export declare type AvatarColor = ValuesOf<typeof AvatarColor>;
 
 /**
- * The Fluent Avatar Element.
+ * The definition for the `<fluent-avatar>` element.
  *
  * @public
- * @remarks
- * HTML Element: \<fluent-badge\>
  */
-export declare const AvatarDefinition: FASTElementDefinition<typeof Avatar>;
+export declare const AvatarDefinition: PartialFASTElementDefinition;
 
 /**
  * A specific named color for the Avatar
@@ -731,12 +728,11 @@ export declare const BadgeColor: {
 export declare type BadgeColor = ValuesOf<typeof BadgeColor>;
 
 /**
+ * The definition for the `<fluent-badge>` element.
  *
  * @public
- * @remarks
- * HTML Element: \<fluent-badge\>
  */
-export declare const BadgeDefinition: FASTElementDefinition<typeof Badge>;
+export declare const BadgeDefinition: PartialFASTElementDefinition;
 
 /**
  * A Badge can be square, circular or rounded.
@@ -3999,13 +3995,11 @@ export declare const ButtonAppearance: {
 export declare type ButtonAppearance = ValuesOf<typeof ButtonAppearance>;
 
 /**
- * The definition for the Fluent Button component.
+ * The definition for the `<fluent-button>` element.
  *
  * @public
- * @remarks
- * HTML Element: `<fluent-button>`
  */
-export declare const ButtonDefinition: FASTElementDefinition<typeof Button>;
+export declare const ButtonDefinition: PartialFASTElementDefinition;
 
 /**
  * Button `formtarget` attribute values.
@@ -4152,13 +4146,11 @@ export declare class Checkbox extends BaseCheckbox {
 }
 
 /**
- * The Fluent Checkbox Element
+ * The definition for the `<fluent-checkbox>` element.
  *
  * @public
- * @remarks
- * HTML Element: \<fluent-checkbox\>
  */
-export declare const CheckboxDefinition: FASTElementDefinition<typeof Checkbox>;
+export declare const CheckboxDefinition: PartialFASTElementDefinition;
 
 /**
  * Checkbox configuration options
@@ -6432,11 +6424,11 @@ export declare const CompoundButtonAppearance: {
 export declare type CompoundButtonAppearance = ValuesOf<typeof CompoundButtonAppearance>;
 
 /**
+ * The definition for the `<fluent-compound-button>` element.
+ *
  * @public
- * @remarks
- * HTML Element: \<fluent-comopund-button\>
  */
-export declare const CompoundButtonDefinition: FASTElementDefinition<typeof CompoundButton>;
+export declare const CompoundButtonDefinition: PartialFASTElementDefinition;
 
 /**
  * A Compound Button can be square, circular or rounded.
@@ -6567,11 +6559,11 @@ export declare const CounterBadgeColor: {
 export declare type CounterBadgeColor = ValuesOf<typeof CounterBadgeColor>;
 
 /**
+ * The definition for the `<fluent-counter-badge>` element.
+ *
  * @public
- * @remarks
- * HTML Element: \<fluent-counter-badge\>
  */
-export declare const CounterBadgeDefinition: FASTElementDefinition<typeof CounterBadge>;
+export declare const CounterBadgeDefinition: PartialFASTElementDefinition;
 
 /**
  * Values for the `shape` attribute on CounterBadge elements.
@@ -6832,13 +6824,11 @@ export declare class DialogBody extends FASTElement {
 }
 
 /**
- * The Fluent Dialog Body Element
+ * The definition for the `<fluent-dialog-body>` element.
  *
  * @public
- * @remarks
- * HTML Element: \<fluent-dialog-body\>
  */
-export declare const DialogBodyDefinition: FASTElementDefinition<typeof DialogBody>;
+export declare const DialogBodyDefinition: PartialFASTElementDefinition;
 
 /** Dialog Body styles
  * @public
@@ -6852,13 +6842,11 @@ export declare const DialogBodyStyles: ElementStyles;
 export declare const DialogBodyTemplate: ElementViewTemplate;
 
 /**
- * The Fluent Dialog Element
+ * The definition for the `<fluent-dialog>` element.
  *
  * @public
- * @remarks
- * HTML Element: \<fluent-dialog\>
  */
-export declare const DialogDefinition: FASTElementDefinition<typeof Dialog>;
+export declare const DialogDefinition: PartialFASTElementDefinition;
 
 /** Dialog styles
  * @public
@@ -6973,13 +6961,11 @@ export declare const DividerAppearance: {
 export declare type DividerAppearance = ValuesOf<typeof DividerAppearance>;
 
 /**
- * The Fluent Divider Element
+ * The definition for the `<fluent-divider>` element.
  *
  * @public
- * @remarks
- * HTML Element: \<fluent-divider\>
  */
-export declare const DividerDefinition: FASTElementDefinition<typeof Divider>;
+export declare const DividerDefinition: PartialFASTElementDefinition;
 
 /**
  * Divider orientation
@@ -7206,12 +7192,11 @@ export declare class DrawerBody extends FASTElement {
 }
 
 /**
+ * The definition for the `<fluent-drawer-body>` element.
  *
  * @public
- * @remarks
- * HTML Element: <fluent-drawer>
  */
-export declare const DrawerBodyDefinition: FASTElementDefinition<typeof DrawerBody>;
+export declare const DrawerBodyDefinition: PartialFASTElementDefinition;
 
 /** Drawer styles
  * @public
@@ -7221,12 +7206,11 @@ export declare const DrawerBodyStyles: ElementStyles;
 export declare const DrawerBodyTemplate: ElementViewTemplate<DrawerBody>;
 
 /**
+ * The definition for the `<fluent-drawer>` element.
  *
  * @public
- * @remarks
- * HTML Element: <fluent-drawer>
  */
-export declare const DrawerDefinition: FASTElementDefinition<typeof Drawer>;
+export declare const DrawerDefinition: PartialFASTElementDefinition;
 
 /**
  * A drawer can be positioned on the left or right side of the viewport.
@@ -7335,13 +7319,11 @@ export declare type DropdownAppearance = ValuesOf<typeof DropdownAppearance>;
 export declare const dropdownButtonTemplate: ViewTemplate<BaseDropdown, any>;
 
 /**
- * The Fluent Dropdown Element.
+ * The definition for the `<fluent-dropdown>` element.
  *
  * @public
- * @remarks
- * HTML Element: `<fluent-dropdown>`
  */
-export declare const DropdownDefinition: FASTElementDefinition<typeof Dropdown>;
+export declare const DropdownDefinition: PartialFASTElementDefinition;
 
 /**
  * The template partial for the dropdown input element. This template is used when the `type` property is set to "combobox".
@@ -7619,13 +7601,11 @@ export declare class DropdownOption extends FASTElement implements Start {
 }
 
 /**
- * The Fluent Option Element.
+ * The definition for the `<fluent-option>` element.
  *
  * @public
- * @remarks
- * HTML Element: `<fluent-option>`
  */
-export declare const DropdownOptionDefinition: FASTElementDefinition<typeof DropdownOption>;
+export declare const DropdownOptionDefinition: PartialFASTElementDefinition;
 
 /**
  * The options for the {@link DropdownOption} component.
@@ -7796,13 +7776,11 @@ export declare class Field extends BaseField {
 }
 
 /**
- * The Fluent Field Element
+ * The definition for the `<fluent-field>` element.
  *
  * @public
- * @remarks
- * HTML Element: `<fluent-field>`
  */
-export declare const FieldDefinition: FASTElementDefinition<typeof Field>;
+export declare const FieldDefinition: PartialFASTElementDefinition;
 
 /**
  * Label position values
@@ -8002,13 +7980,11 @@ declare class Image_2 extends FASTElement {
 export { Image_2 as Image }
 
 /**
- * The Fluent Image Element
+ * The definition for the `<fluent-image>` element.
  *
  * @public
- * @remarks
- * HTML Element: \<fluent-image\>
  */
-export declare const ImageDefinition: FASTElementDefinition<typeof Image_2>;
+export declare const ImageDefinition: PartialFASTElementDefinition;
 
 /**
  * Image fit
@@ -8157,14 +8133,11 @@ export declare class Label extends FASTElement {
 }
 
 /**
- * The Fluent Label Element.
- *
+ * The definition for the `<fluent-label>` element.
  *
  * @public
- * @remarks
- * HTML Element: \<fluent-label\>
  */
-export declare const LabelDefinition: FASTElementDefinition<typeof Label>;
+export declare const LabelDefinition: PartialFASTElementDefinition;
 
 /**
  * A Labels font size can be small, medium, or large
@@ -8311,11 +8284,11 @@ export declare const LinkAppearance: {
 export declare type LinkAppearance = ValuesOf<typeof LinkAppearance>;
 
 /**
+ * The definition for the `<fluent-link>` element.
+ *
  * @public
- * @remarks
- * HTML Element: \<fluent-link\>
  */
-export declare const LinkDefinition: FASTElementDefinition<typeof Link>;
+export declare const LinkDefinition: PartialFASTElementDefinition;
 
 export declare const LinkStyles: ElementStyles;
 
@@ -8472,13 +8445,11 @@ export declare class Listbox extends FASTElement {
 }
 
 /**
- * The Fluent Listbox Element
+ * The definition for the `<fluent-listbox>` element.
  *
  * @public
- * @remarks
- * HTML Element: `<fluent-listbox>`
  */
-export declare const ListboxDefinition: FASTElementDefinition<typeof Listbox>;
+export declare const ListboxDefinition: PartialFASTElementDefinition;
 
 /**
  * Styles for the {@link (Listbox:class)} component.
@@ -8773,11 +8744,11 @@ export declare const MenuButtonAppearance: {
 export declare type MenuButtonAppearance = ValuesOf<typeof MenuButtonAppearance>;
 
 /**
+ * The definition for the `<fluent-menu-button>` element.
+ *
  * @public
- * @remarks
- * HTML Element: \<fluent-button\>
  */
-export declare const MenuButtonDefinition: FASTElementDefinition<typeof MenuButton>;
+export declare const MenuButtonDefinition: PartialFASTElementDefinition;
 
 /**
  * A Menu Button can be square, circular or rounded.
@@ -8818,13 +8789,11 @@ export declare type MenuButtonSize = ValuesOf<typeof MenuButtonSize>;
 export declare const MenuButtonTemplate: ElementViewTemplate<MenuButton>;
 
 /**
- * The Fluent Menu Element.
+ * The definition for the `<fluent-menu>` element.
  *
  * @public
- * @remarks
- * HTML Element: <fluent-menu>
  */
-export declare const MenuDefinition: FASTElementDefinition<typeof Menu>;
+export declare const MenuDefinition: PartialFASTElementDefinition;
 
 /**
  * A Switch Custom HTML Element.
@@ -8963,11 +8932,11 @@ export declare interface MenuItem extends StartEnd {
 export declare type MenuItemColumnCount = 0 | 1 | 2;
 
 /**
+ * The definition for the `<fluent-menu-item>` element.
+ *
  * @public
- * @remarks
- * HTML Element: <fluent-menu-item>
  */
-export declare const MenuItemDefinition: FASTElementDefinition<typeof MenuItem>;
+export declare const MenuItemDefinition: PartialFASTElementDefinition;
 
 /**
  * Menu Item configuration options
@@ -9028,11 +8997,11 @@ export declare class MenuList extends BaseMenuList {
 }
 
 /**
+ * The definition for the `<fluent-menu-list>` element.
+ *
  * @public
- * @remarks
- * HTML Element: <fluent-menu-list>
  */
-export declare const MenuListDefinition: FASTElementDefinition<typeof MenuList>;
+export declare const MenuListDefinition: PartialFASTElementDefinition;
 
 /** MenuList styles
  * @public
@@ -9101,13 +9070,11 @@ export declare class MessageBar extends FASTElement {
 }
 
 /**
- * The Fluent MessageBar Element definition.
+ * The definition for the `<fluent-message-bar>` element.
  *
  * @public
- * @remarks
- * HTML Element: `<fluent-message-bar>`
  */
-export declare const MessageBarDefinition: FASTElementDefinition<typeof MessageBar>;
+export declare const MessageBarDefinition: PartialFASTElementDefinition;
 
 /**
  * The `intent` variations for the MessageBar component.
@@ -9207,14 +9174,11 @@ export declare class ProgressBar extends BaseProgressBar {
 }
 
 /**
- * The Fluent ProgressBar Element.
- *
+ * The definition for the `<fluent-progress-bar>` element.
  *
  * @public
- * @remarks
- * HTML Element: \<fluent-progress-bar\>
  */
-export declare const ProgressBarDefinition: FASTElementDefinition<typeof ProgressBar>;
+export declare const ProgressBarDefinition: PartialFASTElementDefinition;
 
 /**
  * ProgressBarShape Constants
@@ -9340,14 +9304,11 @@ export declare class Radio extends BaseCheckbox {
 export declare type RadioControl = Pick<HTMLInputElement, 'checked' | 'disabled' | 'focus' | 'setAttribute' | 'getAttribute'>;
 
 /**
- * The Fluent Radio Element.
- *
+ * The definition for the `<fluent-radio>` element.
  *
  * @public
- * @remarks
- * HTML Element: \<fluent-radio\>
  */
-export declare const RadioDefinition: FASTElementDefinition<typeof Radio>;
+export declare const RadioDefinition: PartialFASTElementDefinition;
 
 /**
  * A Radio Group Custom HTML Element.
@@ -9368,14 +9329,11 @@ export declare class RadioGroup extends BaseRadioGroup {
 }
 
 /**
- * The Fluent RadioGroup Element.
- *
+ * The definition for the `<fluent-radio-group>` element.
  *
  * @public
- * @remarks
- * HTML Element: \<fluent-radio-group\>
  */
-export declare const RadioGroupDefinition: FASTElementDefinition<typeof RadioGroup>;
+export declare const RadioGroupDefinition: PartialFASTElementDefinition;
 
 /**
  * Radio Group orientation
@@ -9475,13 +9433,11 @@ export declare const RatingDisplayColor: {
 export declare type RatingDisplayColor = ValuesOf<typeof RatingDisplayColor>;
 
 /**
- * The definition for the Fluent Rating Display component.
+ * The definition for the `<fluent-rating-display>` element.
  *
  * @public
- * @remarks
- * HTML Element: `<fluent-rating-display>`
  */
-export declare const RatingDisplayDefinition: FASTElementDefinition<typeof RatingDisplay>;
+export declare const RatingDisplayDefinition: PartialFASTElementDefinition;
 
 /**
  * The size of a Rating Display can be `small`, `medium`, or `large`.
@@ -9983,14 +9939,11 @@ export declare interface SliderConfiguration {
 }
 
 /**
- * The Fluent Slider Element.
- *
+ * The definition for the `<fluent-slider>` element.
  *
  * @public
- * @remarks
- * HTML Element: \<fluent-slider\>
  */
-export declare const SliderDefinition: FASTElementDefinition<typeof Slider>;
+export declare const SliderDefinition: PartialFASTElementDefinition;
 
 /**
  * @public
@@ -10236,11 +10189,11 @@ export declare const SpinnerAppearance: {
 export declare type SpinnerAppearance = ValuesOf<typeof SpinnerAppearance>;
 
 /**
+ * The definition for the `<fluent-spinner>` element.
+ *
  * @public
- * @remarks
- * HTML Element: \<fluent-spinner\>
  */
-export declare const SpinnerDefinition: FASTElementDefinition<typeof Spinner>;
+export declare const SpinnerDefinition: PartialFASTElementDefinition;
 
 /**
  * SpinnerSize constants
@@ -10362,13 +10315,11 @@ export declare class Switch extends BaseCheckbox {
 }
 
 /**
- * The Fluent Switch Element.
+ * The definition for the `<fluent-switch>` element.
  *
  * @public
- * @remarks
- * HTML Element: \<fluent-switch\>
  */
-export declare const SwitchDefinition: FASTElementDefinition<typeof Switch>;
+export declare const SwitchDefinition: PartialFASTElementDefinition;
 
 /**
  * SwitchLabelPosition Constants
@@ -10428,7 +10379,12 @@ export declare class Tab extends FASTElement {
 export declare interface Tab extends StartEnd {
 }
 
-export declare const TabDefinition: FASTElementDefinition<typeof Tab>;
+/**
+ * The definition for the `<fluent-tab>` element.
+ *
+ * @public
+ */
+export declare const TabDefinition: PartialFASTElementDefinition;
 
 /**
  * A Tablist component.
@@ -10472,11 +10428,11 @@ export declare const TablistAppearance: {
 export declare type TablistAppearance = ValuesOf<typeof TablistAppearance>;
 
 /**
+ * The definition for the `<fluent-tablist>` element.
+ *
  * @public
- * @remarks
- * HTML Element: \<fluent-tablist\>
  */
-export declare const TablistDefinition: FASTElementDefinition<typeof Tablist>;
+export declare const TablistDefinition: PartialFASTElementDefinition;
 
 /**
  * The orientation of the component
@@ -10727,13 +10683,11 @@ export declare const TextAreaAutocomplete: {
 export declare type TextAreaAutocomplete = ValuesOf<typeof TextAreaAutocomplete>;
 
 /**
- * The Fluent Textarea Element definition.
+ * The definition for the `<fluent-textarea>` element.
  *
  * @public
- * @remarks
- * HTML Element: `<fluent-textarea>`
  */
-export declare const TextAreaDefinition: FASTElementDefinition<typeof TextArea>;
+export declare const TextAreaDefinition: PartialFASTElementDefinition;
 
 /**
  * Values for the `resize` attribute on TextArea elements.
@@ -10773,14 +10727,11 @@ export declare const TextAreaStyles: ElementStyles;
 export declare const TextAreaTemplate: ElementViewTemplate<TextArea>;
 
 /**
- * The Fluent Text Element.
- *
+ * The definition for the `<fluent-text>` element.
  *
  * @public
- * @remarks
- * HTML Element: \<fluent-text\>
  */
-export declare const TextDefinition: FASTElementDefinition<typeof Text_2>;
+export declare const TextDefinition: PartialFASTElementDefinition;
 
 /**
  * TextFont Constants
@@ -10865,13 +10816,11 @@ export declare const TextInputControlSize: {
 export declare type TextInputControlSize = ValuesOf<typeof TextInputControlSize>;
 
 /**
- * The Fluent TextInput Element definition.
+ * The definition for the `<fluent-text-input>` element.
  *
  * @public
- * @remarks
- * HTML Element: `<fluent-text-input>`
  */
-export declare const TextInputDefinition: FASTElementDefinition<typeof TextInput>;
+export declare const TextInputDefinition: PartialFASTElementDefinition;
 
 /**
  * TextInput configuration options.
@@ -11036,12 +10985,11 @@ export declare const ToggleButtonAppearance: {
 export declare type ToggleButtonAppearance = ValuesOf<typeof ToggleButtonAppearance>;
 
 /**
+ * The definition for the `<fluent-toggle-button>` element.
  *
  * @public
- * @remarks
- * HTML Element: \<fluent-toggle-button\>
  */
-export declare const ToggleButtonDefinition: FASTElementDefinition<typeof ToggleButton>;
+export declare const ToggleButtonDefinition: PartialFASTElementDefinition;
 
 /**
  * A Toggle Button can be square, circular or rounded.
@@ -11190,13 +11138,11 @@ export declare class Tooltip extends FASTElement {
 }
 
 /**
- * The {@link Tooltip } custom element definition.
+ * The definition for the `<fluent-tooltip>` element.
  *
  * @public
- * @remarks
- * HTML Element: `<fluent-tooltip>`
  */
-export declare const TooltipDefinition: FASTElementDefinition<typeof Tooltip>;
+export declare const TooltipDefinition: PartialFASTElementDefinition;
 
 /**
  * The TooltipPositioning options and their corresponding CSS values
@@ -11280,12 +11226,11 @@ export declare class Tree extends BaseTree {
 }
 
 /**
+ * The definition for the `<fluent-tree>` element.
  *
  * @public
- * @remarks
- * HTML Element: \<fluent-tree\>
  */
-export declare const TreeDefinition: FASTElementDefinition<typeof Tree>;
+export declare const TreeDefinition: PartialFASTElementDefinition;
 
 /**
  * The Fluent Tree Item Element. Implements {@link @microsoft/fast-foundation#BaseTreeItem}.
@@ -11354,12 +11299,11 @@ export declare const TreeItemAppearance: {
 export declare type TreeItemAppearance = ValuesOf<typeof TreeItemAppearance>;
 
 /**
+ * The definition for the `<fluent-tree-item>` element.
  *
  * @public
- * @remarks
- * HTML Element: \<fluent-tree-item\>
  */
-export declare const TreeItemDefinition: FASTElementDefinition<typeof TreeItem>;
+export declare const TreeItemDefinition: PartialFASTElementDefinition;
 
 export declare const TreeItemSize: {
     readonly small: "small";