@fluentui/web-components 3.0.0-beta.20 → 3.0.0-beta.22

package/dist/dts/progress-bar/index.d.ts

@@ -1,5 +1,6 @@
-export { ProgressBar } from './progress-bar.js';
-export { ProgressOptions, ProgressBarShape, ProgressBarThickness, ProgressBarValidationState, } from './progress-bar.options.js';
 export { definition as ProgressBarDefinition } from './progress-bar.definition.js';
+export { ProgressBar } from './progress-bar.js';
+export { ProgressBarShape, ProgressBarThickness, ProgressBarValidationState } from './progress-bar.options.js';
+export type { ProgressOptions } from './progress-bar.options.js';
 export { styles as ProgressBarStyles } from './progress-bar.styles.js';
 export { template as ProgressBarTemplate } from './progress-bar.template.js';

package/dist/dts/radio/index.d.ts

@@ -1,4 +1,5 @@
-export { Radio, RadioControl, RadioOptions } from './radio.js';
 export { definition as RadioDefinition } from './radio.definition.js';
+export { Radio } from './radio.js';
+export type { RadioControl, RadioOptions } from './radio.js';
 export { styles as RadioStyles } from './radio.styles.js';
 export { template as RadioTemplate } from './radio.template.js';

package/dist/dts/slider/index.d.ts

@@ -1,5 +1,6 @@
-export { Slider } from './slider.js';
-export { SliderConfiguration, SliderMode, SliderOptions, SliderOrientation, SliderSize } from './slider.options.js';
 export { definition as SliderDefinition } from './slider.definition.js';
+export { Slider } from './slider.js';
+export { SliderMode, SliderOrientation, SliderSize } from './slider.options.js';
+export type { SliderConfiguration, SliderOptions } from './slider.options.js';
 export { styles as SliderStyles } from './slider.styles.js';
 export { template as SliderTemplate } from './slider.template.js';

package/dist/dts/spinner/spinner.d.ts

@@ -15,7 +15,6 @@ export declare class Spinner extends FASTElement {
      * The size of the spinner
      *
      * @public
-     * @default 'medium'
      * @remarks
      * HTML Attribute: size
      */
@@ -23,7 +22,6 @@ export declare class Spinner extends FASTElement {
     /**
      * The appearance of the spinner
      * @public
-     * @default 'primary'
      * @remarks
      * HTML Attribute: appearance
      */

package/dist/dts/switch/index.d.ts

@@ -1,5 +1,6 @@
-export { Switch, SwitchOptions } from './switch.js';
-export { SwitchLabelPosition } from './switch.options.js';
 export { definition as SwitchDefinition } from './switch.definition.js';
+export { Switch } from './switch.js';
+export type { SwitchOptions } from './switch.js';
+export { SwitchLabelPosition } from './switch.options.js';
 export { styles as SwitchStyles } from './switch.styles.js';
 export { template as SwitchTemplate } from './switch.template.js';

package/dist/dts/switch/switch.d.ts

@@ -9,7 +9,6 @@ export declare class Switch extends FormAssociatedSwitch {
      * The label position of the switch
      *
      * @public
-     * @default 'after'
      * @remarks
      * HTML Attribute: labelposition
      */

package/dist/dts/tab/index.d.ts

@@ -1,4 +1,5 @@
-export { Tab, TabOptions } from './tab.js';
-export { template as TabTemplate } from './tab.template.js';
-export { styles as TabStyles } from './tab.styles.js';
 export { definition as TabDefinition } from './tab.definition.js';
+export { Tab } from './tab.js';
+export type { TabOptions } from './tab.js';
+export { styles as TabStyles } from './tab.styles.js';
+export { template as TabTemplate } from './tab.template.js';

package/dist/dts/tab/tab.template.d.ts

@@ -1,4 +1,4 @@
 import { ElementViewTemplate } from '@microsoft/fast-element';
-import { Tab, TabOptions } from './tab.js';
+import type { Tab, TabOptions } from './tab.js';
 export declare function tabTemplate<T extends Tab>(options?: TabOptions): ElementViewTemplate<T>;
 export declare const template: ElementViewTemplate<Tab, any>;

package/dist/dts/tabs/index.d.ts

@@ -1,5 +1,6 @@
+export { definition as TabsDefinition } from './tabs.definition.js';
 export { Tabs } from './tabs.js';
-export { TabsAppearance, TabsOptions, TabsOrientation, TabsSize } from './tabs.options.js';
-export { template as TabsTemplate } from './tabs.template.js';
+export { TabsAppearance, TabsOrientation, TabsSize } from './tabs.options.js';
+export type { TabsOptions } from './tabs.options.js';
 export { styles as TabsStyles } from './tabs.styles.js';
-export { definition as TabsDefinition } from './tabs.definition.js';
+export { template as TabsTemplate } from './tabs.template.js';

package/dist/dts/tabs/tabs.d.ts

@@ -2,8 +2,8 @@ import { FASTElement } from '@microsoft/fast-element';
 import { StartEnd } from '../patterns/index.js';
 import { TabsAppearance, TabsOrientation, TabsSize } from './tabs.options.js';
 /**
+ * A Tabs component that wraps a collection of tab and tab panel elements.
  *
- * @class TabList component
  * @public
  */
 export declare class BaseTabs extends FASTElement {
@@ -147,21 +147,25 @@ export declare class Tabs extends BaseTabs {
      */
     private getTabScale;
     /**
-     * applyUpdatedCSSValues
+     * Calculates and applies updated values to CSS variables.
      *
-     * calculates and applies updated values to CSS variables
-     * @param tab
+     * @param tab - the tab element to apply the updated values to
+     * @internal
      */
     private applyUpdatedCSSValues;
     /**
-     * animationLoop
-     * runs through all the operations required for setting the tab active indicator to its starting location, ending location, and applying the animated css class to the tab.
-     * @param tab
+     * Runs through all the operations required for setting the tab active indicator to its starting location, ending
+     * location, and applying the animated css class to the tab.
+     *
+     * @param tab - the tab element to apply the updated values to
+     * @internal
      */
     private animationLoop;
     /**
-     * setTabData
-     * sets the data from the active tab onto the class. used for making all the animation calculations for the active tab indicator.
+     * Sets the data from the active tab onto the class. used for making all the animation calculations for the active
+     * tab indicator.
+     *
+     * @internal
      */
     private setTabData;
     private setTabOffsetCSSVar;

package/dist/dts/text-input/index.d.ts

@@ -1,5 +1,6 @@
-export { TextInputOptions, TextInput } from './text-input.js';
-export { TextInputType, TextInputAppearance, TextInputControlSize } from './text-input.options.js';
-export { template as TextInputTemplate } from './text-input.template.js';
-export { styles as TextInputStyles } from './text-input.styles.js';
 export { definition as TextInputDefinition } from './text-input.definition.js';
+export { TextInput } from './text-input.js';
+export { TextInputAppearance, TextInputControlSize, TextInputType } from './text-input.options.js';
+export type { TextInputOptions } from './text-input.options.js';
+export { styles as TextInputStyles } from './text-input.styles.js';
+export { template as TextInputTemplate } from './text-input.template.js';

package/dist/dts/text-input/text-input.d.ts

@@ -1,154 +1,369 @@
-import { ARIAGlobalStatesAndProperties, StartEnd, StartEndOptions } from '../patterns/index.js';
-import { TextInputAppearance, TextInputControlSize } from './text-input.options.js';
-import { TextInputType } from './text-input.options.js';
-import { FormAssociatedTextField } from './text-field.form-associated.js';
-export { TextInputType };
-export declare type TextInputOptions = StartEndOptions<TextInput>;
-export declare class TextInput extends FormAssociatedTextField {
+/// <reference types="web" />
+import { FASTElement } from '@microsoft/fast-element';
+import { StartEnd } from '../patterns/start-end.js';
+import type { TextInputControlSize } from './text-input.options.js';
+import { TextInputAppearance, TextInputType } from './text-input.options.js';
+/**
+ * A Text Input Custom HTML Element.
+ * Based largely on the {@link https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input | `<input>`} element.
+ *
+ * @slot start - Content which can be provided before the input
+ * @slot end - Content which can be provided after the input
+ * @slot - The default slot for button content
+ * @csspart label - The internal `<label>` element
+ * @csspart root - the root container for the internal control
+ * @csspart control - The internal `<input>` control
+ * @public
+ */
+export declare class TextInput extends FASTElement {
     /**
-     * Defines TextInput control size
+     * Indicates the styled appearance of the element.
      *
      * @public
-     * @default 'medium'
      * @remarks
-     * HTML Attribute: control-size
+     * HTML Attribute: `appearance`
      */
-    controlSize?: TextInputControlSize;
+    appearance?: TextInputAppearance;
     /**
-     * Defines TextInput appearance.
+     * Indicates the element's autocomplete state.
+     * @see The {@link https://developer.mozilla.org/docs/Web/HTML/Attributes/autocomplete | `autocomplete`} attribute
      *
      * @public
-     * @default 'outline'
      * @remarks
-     * HTML Attribute: appearance
+     * HTML Attribute: `autocomplete`
      */
-    appearance?: TextInputAppearance;
+    autocomplete?: string;
     /**
-     * When true, the control will be immutable by user interaction. See {@link https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/readonly | readonly HTML attribute} for more information.
+     * Indicates that the element should get focus after the page finishes loading.
+     * @see The {@link https://developer.mozilla.org/docs/Web/HTML/Element/input#autofocus | `autofocus`} attribute
+     *
      * @public
      * @remarks
-     * HTML Attribute: readonly
+     * HTML Attribute: `autofocus`
      */
-    readOnly: boolean;
-    protected readOnlyChanged(): void;
+    autofocus: boolean;
     /**
-     * Indicates that this element should get focus after the page finishes loading. See {@link https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#htmlattrdefautofocus | autofocus HTML attribute} for more information.
+     * Sets the size of the control.
+     *
      * @public
      * @remarks
-     * HTML Attribute: autofocus
+     * HTML Attribute: `control-size`
      */
-    autofocus: boolean;
-    protected autofocusChanged(): void;
+    controlSize?: TextInputControlSize;
     /**
-     * Sets the placeholder value of the element, generally used to provide a hint to the user.
+     * The default slotted content. This is the content that appears in the text field label.
+     *
+     * @internal
+     */
+    defaultSlottedNodes: Node[];
+    /**
+     * Updates the control label visibility based on the presence of default slotted content.
+     *
+     * @internal
+     */
+    defaultSlottedNodesChanged(prev: Node[] | undefined, next: Node[] | undefined): void;
+    /**
+     * Sets the directionality of the element to be submitted with form data.
+     * @see The {@link https://developer.mozilla.org/docs/Web/HTML/Attributes/dirname | `dirname`} attribute
+     *
      * @public
      * @remarks
-     * HTML Attribute: placeholder
-     * Using this attribute does is not a valid substitute for a labeling element.
+     * HTML Attribute: `dirname`
      */
-    placeholder: string;
-    protected placeholderChanged(): void;
+    dirname?: string;
     /**
-     * Allows setting a type or mode of text.
+     * Sets the element's disabled state.
+     * @see The {@link https://developer.mozilla.org/docs/Web/HTML/Attributes/disabled | `disabled`} attribute
+     *
      * @public
      * @remarks
-     * HTML Attribute: type
+     * HTML Attribute: `disabled`
      */
-    type: TextInputType;
-    private typeChanged;
+    disabled?: boolean;
+    /**
+     * The id of a form to associate the element to.
+     * @see The {@link https://developer.mozilla.org/docs/Web/HTML/Element/input#form | `form`} attribute
+     *
+     * @public
+     * @remarks
+     * HTML Attribute: `form`
+     */
+    formAttribute?: string;
+    /**
+     * The initial value of the input.
+     *
+     * @public
+     * @remarks
+     * HTML Attribute: `value`
+     */
+    initialValue: string;
+    /**
+     * Sets the value of the element to the initial value.
+     *
+     * @internal
+     */
+    initialValueChanged(): void;
     /**
-     * Allows associating a {@link https://developer.mozilla.org/en-US/docs/Web/HTML/Element/datalist | datalist} to the element by {@link https://developer.mozilla.org/en-US/docs/Web/API/Element/id}.
+     * Allows associating a `<datalist>` to the element by ID.
+     * @see The {@link https://developer.mozilla.org/docs/Web/HTML/Element/input#list | `list`} attribute
+     *
      * @public
      * @remarks
-     * HTML Attribute: list
+     * HTML Attribute: `list`
      */
     list: string;
-    protected listChanged(): void;
     /**
      * The maximum number of characters a user can enter.
+     *
      * @public
      * @remarks
-     * HTMLAttribute: maxlength
+     * HTML Attribute: `maxlength`
      */
     maxlength: number;
-    protected maxlengthChanged(): void;
     /**
      * The minimum number of characters a user can enter.
+     * @see The {@link https://developer.mozilla.org/docs/Web/HTML/Attributes/minlength | `minlength`} attribute
+     *
      * @public
      * @remarks
-     * HTMLAttribute: minlength
+     * HTML Attribute: `minlength`
      */
     minlength: number;
-    protected minlengthChanged(): void;
+    /**
+     * Indicates that a comma-separated list of email addresses can be entered. This attribute is only valid when `type="email"`.
+     * @see The {@link https://developer.mozilla.org/docs/Web/HTML/Attributes/multiple | `multiple`} attribute
+     *
+     * @public
+     * @remarks
+     * HTML Attribute: `multiple`
+     */
+    multiple: boolean;
+    /**
+     * The name of the element. This element's value will be surfaced during form submission under the provided name.
+     *
+     * @public
+     * @remarks
+     * HTML Attribute: `name`
+     */
+    name: string;
     /**
      * A regular expression that the value must match to pass validation.
+     *
      * @public
      * @remarks
-     * HTMLAttribute: pattern
+     * HTML Attribute: `pattern`
      */
     pattern: string;
-    protected patternChanged(): void;
+    /**
+     * Sets the placeholder value of the element, generally used to provide a hint to the user.
+     * @see The {@link https://developer.mozilla.org/docs/Web/HTML/Attributes/placeholder | `placeholder`} attribute
+     *
+     * @public
+     * @remarks
+     * HTML Attribute: `placeholder`
+     * This attribute is not a valid substitute for a label.
+     */
+    placeholder: string;
+    /**
+     * When true, the control will be immutable by user interaction.
+     * @see The {@link https://developer.mozilla.org/docs/Web/HTML/Attributes/readonly | `readonly`} attribute
+     *
+     * @public
+     * @remarks
+     * HTML Attribute: `readonly`
+     */
+    readonly?: boolean;
+    /**
+     * Syncs the `ElementInternals.ariaReadOnly` property when the `readonly` property changes.
+     *
+     * @internal
+     */
+    readonlyChanged(): void;
+    /**
+     * The element's required attribute.
+     *
+     * @public
+     * @remarks
+     * HTML Attribute: `required`
+     */
+    required: boolean;
+    /**
+     * Syncs the element's internal `aria-required` state with the `required` attribute.
+     *
+     * @param previous - the previous required state
+     * @param next - the current required state
+     *
+     * @internal
+     */
+    requiredChanged(previous: boolean, next: boolean): void;
     /**
      * Sets the width of the element to a specified number of characters.
+     *
      * @public
      * @remarks
-     * HTMLAttribute: size
+     * HTML Attribute: `size`
      */
     size: number;
-    protected sizeChanged(): void;
     /**
      * Controls whether or not to enable spell checking for the input field, or if the default spell checking configuration should be used.
+     * @see The {@link https://developer.mozilla.org/docs/Web/HTML/Global_attributes/spellcheck | `spellcheck`} attribute
+     *
      * @public
      * @remarks
-     * HTMLAttribute: size
+     * HTML Attribute: `spellcheck`
      */
     spellcheck: boolean;
-    protected spellcheckChanged(): void;
     /**
+     * Allows setting a type or mode of text.
+     *
+     * @public
+     * @remarks
+     * HTML Attribute: `type`
+     */
+    type: TextInputType;
+    /**
+     * The current value of the input.
+     *
      * @internal
      */
-    defaultSlottedNodes: Node[];
+    private _value;
     /**
-     * A reference to the internal input element
+     * A reference to the internal input element.
+     *
      * @internal
      */
     control: HTMLInputElement;
     /**
+     * A reference to the internal label element.
+     *
+     * @internal
+     */
+    controlLabel: HTMLLabelElement;
+    /**
+     * Indicates that the value has been changed by the user.
+     *
+     * @internal
+     */
+    private dirtyValue;
+    /**
+     * The internal {@link https://developer.mozilla.org/docs/Web/API/ElementInternals | `ElementInternals`} instance for the component.
+     *
+     * @internal
+     */
+    protected elementInternals: ElementInternals;
+    /**
+     * The form-associated flag.
+     * @see {@link https://html.spec.whatwg.org/multipage/custom-elements.html#custom-elements-face-example | Form-associated custom elements}
+     *
+     * @public
+     */
+    static readonly formAssociated = true;
+    /**
+     * The element's validity state.
+     *
+     * @public
+     * @remarks
+     * Reflects the {@link https://developer.mozilla.org/docs/Web/API/ElementInternals/validity | `ElementInternals.validity`} property.
+     */
+    get validity(): ValidityState;
+    /**
+     * The validation message.
+     *
+     * @public
+     * @remarks
+     * Reflects the {@link https://developer.mozilla.org/docs/Web/API/ElementInternals/validationMessage | `ElementInternals.validationMessage`} property.
+     */
+    get validationMessage(): string;
+    /**
+     * The current value of the input.
+     * @public
+     */
+    get value(): string;
+    set value(value: string);
+    /**
+     * Determines if the control can be submitted for constraint validation.
+     *
+     * @public
+     * @remarks
+     * Reflects the {@link https://developer.mozilla.org/docs/Web/API/ElementInternals/willValidate | `ElementInternals.willValidate`} property.
+     */
+    get willValidate(): boolean;
+    /**
+     * The associated form element.
+     *
+     * @public
+     * @remarks
+     * Reflects the {@link https://developer.mozilla.org/docs/Web/API/ElementInternals/form | `ElementInternals.form`} property.
+     */
+    get form(): HTMLFormElement | null;
+    /**
+     * Change event handler for inner control.
+     *
      * @internal
+     * @privateRemarks
+     * "Change" events are not `composable` so they will not permeate the shadow DOM boundary. This function effectively
+     * proxies the change event, emitting a `change` event whenever the internal control emits a `change` event.
      */
+    changeHandler(e: InputEvent): void;
     connectedCallback(): void;
+    disconnectedCallback(): void;
+    /**
+     * Resets the value to its initial value when the form is reset.
+     *
+     * @internal
+     */
+    formResetCallback(): void;
+    /**
+     * Handles implicit form submission when the user presses the "Enter" key.
+     *
+     * @internal
+     */
+    private implicitSubmit;
+    /**
+     * Handles the internal control's `input` event.
+     *
+     * @internal
+     */
+    inputHandler(e: InputEvent): boolean | void;
+    /**
+     * Handles the internal control's `keypress` event.
+     *
+     * @internal
+     */
+    keypressHandler(e: KeyboardEvent): boolean | void;
     /**
-     * Selects all the text in the text field
+     * Selects all the text in the text field.
      *
      * @public
+     * @privateRemarks
+     * The `select` event does not permeate the shadow DOM boundary. This function effectively proxies the event,
+     * emitting a `select` event whenever the internal control emits a `select` event
+     *
      */
     select(): void;
     /**
-     * Handles the internal control's `input` event
+     * Reflects the {@link https://developer.mozilla.org/docs/Web/API/ElementInternals/setFormValue | `ElementInternals.setFormValue()`} method.
+     *
      * @internal
      */
-    handleTextInput(): void;
+    setFormValue(value: File | string | FormData | null, state?: File | string | FormData | null): void;
     /**
-     * Change event handler for inner control.
-     * @remarks
-     * "Change" events are not `composable` so they will not
-     * permeate the shadow DOM boundary. This fn effectively proxies
-     * the change event, emitting a `change` event whenever the internal
-     * control emits a `change` event
+     * Sets the validity of the control.
+     *
+     * @param flags - Validity flags. If not provided, the control's `validity` will be used.
+     * @param message - Optional message to supply. If not provided, the control's `validationMessage` will be used. If the control does not have a `validationMessage`, the message will be empty.
+     * @param anchor - Optional anchor to use for the validation message. If not provided, the control will be used.
+     *
      * @internal
      */
-    handleChange(): void;
-    /** {@inheritDoc (FormAssociated:interface).validate} */
-    validate(): void;
+    setValidity(flags?: ValidityStateFlags, message?: string, anchor?: HTMLElement): void;
 }
 /**
- * Includes ARIA states and properties relating to the ARIA textbox role
- *
- * @public
+ * @internal
+ * @privateRemarks
+ * Mark internal because exporting class and interface of the same name
+ * confuses API documenter.
+ * TODO: https://github.com/microsoft/rushstack/issues/1308
  */
-export declare class DelegatesARIATextbox {
-}
-export interface DelegatesARIATextbox extends ARIAGlobalStatesAndProperties {
-}
-export interface TextInput extends StartEnd, DelegatesARIATextbox {
+export interface TextInput extends StartEnd {
 }

package/dist/dts/text-input/text-input.definition.d.ts

@@ -1,10 +1,9 @@
 import { TextInput } from './text-input.js';
 /**
- * The Fluent TextInput Element.
- *
+ * The Fluent TextInput Element definition.
  *
  * @public
  * @remarks
- * HTML Element: \<fluent-text-input\>
+ * HTML Element: `<fluent-text-input>`
  */
 export declare const definition: import("@microsoft/fast-element").FASTElementDefinition<typeof TextInput>;