@fluentui/web-components 3.0.0-beta.55 → 3.0.0-beta.57

package/dist/web-components.d.ts

@@ -1,5 +1,3 @@
-/// <reference types="web" />
-
 import { CaptureType } from '@microsoft/fast-element';
 import { CSSDirective } from '@microsoft/fast-element';
 import { Direction } from '@microsoft/fast-web-utilities';
@@ -885,7 +883,7 @@ export declare class BaseAccordionItem extends FASTElement {
  *
  * @public
  */
-declare class BaseAnchor extends FASTElement {
+export declare class BaseAnchor extends FASTElement {
     /**
      * Holds a reference to the platform to manage ctrl+click on Windows and cmd+click on Mac
      * @internal
@@ -1303,7 +1301,7 @@ export declare class BaseButton extends FASTElement {
  *
  * @public
  */
-declare class BaseCheckbox extends FASTElement {
+export declare class BaseCheckbox extends FASTElement {
     /**
      * 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
@@ -2086,6 +2084,351 @@ declare class BaseTabs extends FASTElement {
     connectedCallback(): void;
 }
 
+/**
+ * A Text Area Custom HTML Element.
+ * Based largely on the {@link https://developer.mozilla.org/en-US/docs/Web/HTML/Element/textarea | `<textarea>`} element.
+ *
+ * @slot - The default content/value of the component.
+ * @slot label - The content for the `<label>`, it should be a `<fluent-label>` element.
+ * @csspart label - The `<label>` element.
+ * @csspart root - The container element of the `<textarea>` element.
+ * @csspart control - The internal `<textarea>` element.
+ * @fires change - Fires after the control loses focus, if the content has changed.
+ * @fires select - Fires when the `select()` method is called.
+ *
+ * @public
+ */
+export declare class BaseTextArea extends FASTElement {
+    /**
+     * 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 internal {@link https://developer.mozilla.org/docs/Web/API/ElementInternals | `ElementInternals`} instance for the component.
+     *
+     * @internal
+     */
+    elementInternals: ElementInternals;
+    /**
+     * The `<label>` element.
+     * @internal
+     */
+    labelEl: HTMLLabelElement;
+    /**
+     * The `<textarea>` element.
+     * @internal
+     */
+    controlEl: HTMLTextAreaElement;
+    /**
+     * @internal
+     */
+    autoSizerEl?: HTMLDivElement;
+    /**
+     * The list of nodes that are assigned to the default slot.
+     * @internal
+     */
+    defaultSlottedNodes: Node[];
+    protected defaultSlottedNodesChanged(): void;
+    /**
+     * The list of nodes that are assigned to the `label` slot.
+     * @internal
+     */
+    labelSlottedNodes: Label[];
+    protected labelSlottedNodesChanged(): void;
+    private userInteracted;
+    private autoSizerObserver?;
+    private controlElAttrObserver;
+    private preConnectControlEl;
+    /**
+     * Indicates the element's autocomplete state.
+     * @see The {@link https://developer.mozilla.org/docs/Web/HTML/Attributes/autocomplete | `autocomplete`} attribute
+     *
+     * @public
+     * @remarks
+     * HTML Attribute: `autocomplete`
+     */
+    autocomplete?: TextAreaAutocomplete;
+    /**
+     * Indicates whether the element’s block size (height) should be automatically changed based on the content.
+     * Note: When this property’s value is set to be `true`, the element should not have a fixed block-size
+     * defined in CSS. Instead, use `min-height` or `min-block-size`.
+     *
+     * @public
+     * @remarks
+     * HTML Attribute: `auto-resize`
+     */
+    autoResize: boolean;
+    protected autoResizeChanged(): void;
+    /**
+     * Sets the name of the value directionality to be submitted with form data.
+     * @see The {@link https://developer.mozilla.org/docs/Web/HTML/Attributes/dirname | `dirname`} attribute
+     *
+     * @public
+     * @remarks
+     * HTML Attribute: `dirname`
+     */
+    dirName?: string;
+    /**
+     * Sets the element's disabled state.
+     * @see The {@link https://developer.mozilla.org/docs/Web/HTML/Attributes/disabled | `disabled`} attribute
+     *
+     * @public
+     * @remarks
+     * HTML Attribute: `disabled`
+     */
+    disabled: boolean;
+    protected disabledChanged(): void;
+    /**
+     * Indicates whether the element displays a box shadow. This only has effect when `appearance` is set to be `filled-darker` or `filled-lighter`.
+     *
+     * @public
+     * @remarks
+     * HTML Attribute: `display-shadow`
+     */
+    displayShadow: boolean;
+    /**
+     * The id of a form to associate the element to.
+     *
+     * @public
+     * @remarks
+     * HTML Attribute: `form`
+     */
+    initialForm?: string;
+    /**
+     * The form element that’s associated to the element, or `null` if no form is associated.
+     *
+     * @public
+     */
+    get form(): HTMLFormElement | null;
+    /**
+     * A `NodeList` of `<label>` element associated with the element.
+     * @see The {@link https://developer.mozilla.org/en-US/docs/Web/API/HTMLTextAreaElement/labels | `labels`} property
+     *
+     * @public
+     */
+    get labels(): NodeList;
+    /**
+     * The maximum number of characters a user can enter.
+     *
+     * @public
+     * @remarks
+     * HTML Attribute: `maxlength`
+     */
+    maxLength?: number;
+    /**
+     * 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
+     * HTML Attribute: `minlength`
+     */
+    minLength?: number;
+    /**
+     * 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;
+    /**
+     * 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;
+    protected readOnlyChanged(): void;
+    /**
+     * The element's required attribute.
+     *
+     * @public
+     * @remarks
+     * HTML Attribute: `required`
+     */
+    required: boolean;
+    protected requiredChanged(): void;
+    /**
+     * Indicates whether the element can be resized by end users.
+     *
+     * @public
+     * @remarks
+     * HTML Attribute: `resize`
+     */
+    resize: TextAreaResize;
+    protected resizeChanged(prev: TextAreaResize | undefined, next: TextAreaResize | undefined): 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
+     * HTML Attribute: `spellcheck`
+     */
+    spellcheck: boolean;
+    /**
+     * The length of the current value.
+     * @see The {@link https://developer.mozilla.org/en-US/docs/Web/API/HTMLTextAreaElement#textLength | 'textLength'} property
+     *
+     * @public
+     */
+    get textLength(): number;
+    /**
+     * The type of the element, which is always "textarea".
+     * @see The {@link https://developer.mozilla.org/en-US/docs/Web/API/HTMLTextAreaElement/type | `type`} property
+     *
+     * @public
+     */
+    get type(): 'textarea';
+    /**
+     * 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;
+    /**
+     * 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 text content of the element before user interaction.
+     * @see The {@link https://developer.mozilla.org/en-US/docs/Web/API/HTMLTextAreaElement#defaultvalue | `defaultValue`} property
+     *
+     * @public
+     * @remarks
+     * In order to set the initial/default value, an author should either add the default value in the HTML as the children
+     * of the component, or setting this property in JavaScript. Setting `innerHTML`, `innerText`, or `textContent` on this
+     * component will not change the default value or the content displayed inside the component.
+     */
+    get defaultValue(): string;
+    set defaultValue(next: string);
+    /**
+     * The value of the element.
+     *
+     * @public
+     * @remarks
+     * Reflects the `value` property.
+     */
+    get value(): string;
+    set value(next: string);
+    constructor();
+    /**
+     * @internal
+     */
+    connectedCallback(): void;
+    /**
+     * @internal
+     */
+    disconnectedCallback(): void;
+    /**
+     * Resets the value to its initial value when the form is reset.
+     *
+     * @internal
+     */
+    formResetCallback(): void;
+    /**
+     * @internal
+     */
+    formDisabledCallback(disabled: boolean): void;
+    /**
+     * Reflects the {@link https://developer.mozilla.org/docs/Web/API/ElementInternals/setFormValue | `ElementInternals.setFormValue()`} method.
+     *
+     * @internal
+     */
+    setFormValue(value: File | string | FormData | null, state?: File | string | FormData | null): void;
+    /**
+     * Checks the validity of the element and returns the result.
+     *
+     * @public
+     * @remarks
+     * Reflects the {@link https://developer.mozilla.org/docs/Web/API/ElementInternals/checkValidity | `HTMLInputElement.checkValidity()`} method.
+     */
+    checkValidity(): boolean;
+    /**
+     * Reports the validity of the element.
+     *
+     * @public
+     * @remarks
+     * Reflects the {@link https://developer.mozilla.org/docs/Web/API/ElementInternals/reportValidity | `HTMLInputElement.reportValidity()`} method.
+     */
+    reportValidity(): boolean;
+    /**
+     * Sets the custom validity message.
+     * @param message - The message to set
+     *
+     * @public
+     */
+    setCustomValidity(message: string | null): void;
+    /**
+     * 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
+     */
+    setValidity(flags?: Partial<ValidityState>, message?: string, anchor?: HTMLElement): void;
+    /**
+     * Selects the content in the element.
+     *
+     * @public
+     */
+    select(): void;
+    private setDefaultValue;
+    private bindEvents;
+    /**
+     * Gets the content inside the light DOM, if any HTML element is present, use its `outerHTML` value.
+     */
+    private getContent;
+    private observeControlElAttrs;
+    private setDisabledSideEffect;
+    private toggleUserValidityState;
+    private maybeCreateAutoSizerEl;
+    /**
+     * @internal
+     */
+    handleControlInput(): void;
+    /**
+     * @internal
+     */
+    handleControlChange(): void;
+    /**
+     * @internal
+     */
+    handleControlSelect(): void;
+}
+
 /**
  * A Text Input Custom HTML Element.
  * Based largely on the {@link https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input | `<input>`} element.
@@ -6594,7 +6937,7 @@ export declare class Menu extends FASTElement {
      * @param e - the event
      * @returns void
      */
-    toggleHandler: (e: Event | ToggleEvent) => void;
+    toggleHandler: (e: Event) => void;
     /**
      * Called whenever the 'openOnHover' property changes.
      * Adds or removes a 'mouseover' event listener to the trigger based on the new value.
@@ -6857,7 +7200,7 @@ export declare class MenuItem extends FASTElement {
      * Setup required ARIA on open/close
      * @internal
      */
-    toggleHandler: (e: ToggleEvent | Event) => void;
+    toggleHandler: (e: Event) => void;
     /**
      * @internal
      */
@@ -7033,7 +7376,7 @@ export declare const MenuTemplate: ElementViewTemplate<Menu>;
  *
  * @public
  */
-export declare class ProgressBar extends BaseProgressBar {
+declare class ProgressBar_2 extends BaseProgressBar {
     /**
      * The thickness of the progress bar
      *
@@ -7060,6 +7403,7 @@ export declare class ProgressBar extends BaseProgressBar {
      */
     shapeChanged(prev: ProgressBarShape | undefined, next: ProgressBarShape | undefined): void;
 }
+export { ProgressBar_2 as ProgressBar }
 
 /**
  * The Fluent ProgressBar Element.
@@ -7069,7 +7413,7 @@ export declare class ProgressBar extends BaseProgressBar {
  * @remarks
  * HTML Element: \<fluent-progress-bar\>
  */
-export declare const ProgressBarDefinition: FASTElementDefinition<typeof ProgressBar>;
+export declare const ProgressBarDefinition: FASTElementDefinition<typeof ProgressBar_2>;
 
 /**
  * ProgressBarShape Constants
@@ -7091,7 +7435,7 @@ export declare type ProgressBarShape = ValuesOf<typeof ProgressBarShape>;
  */
 export declare const ProgressBarStyles: ElementStyles;
 
-export declare const ProgressBarTemplate: ElementViewTemplate<ProgressBar>;
+export declare const ProgressBarTemplate: ElementViewTemplate<ProgressBar_2>;
 
 /**
  * ProgressBarThickness Constants
@@ -7744,7 +8088,7 @@ export declare const shadow8Brand = "var(--shadow8Brand)";
  * @slot thumb - The slot for a custom thumb element.
  * @csspart thumb-container - The container element of the thumb.
  * @csspart track-container - The container element of the track.
- * @fire change - Fires a custom 'change' event when the value changes.
+ * @fires change - Fires a custom 'change' event when the value changes.
  *
  * @public
  */
@@ -8992,6 +9336,121 @@ export declare const TextAlign: {
  */
 export declare type TextAlign = ValuesOf<typeof TextAlign>;
 
+export declare class TextArea extends BaseTextArea {
+    protected labelSlottedNodesChanged(): void;
+    /**
+     * Indicates the visual appearance of the element.
+     *
+     * @public
+     * @remarks
+     * HTML Attribute: `appearance`
+     */
+    appearance: TextAreaAppearance;
+    protected appearanceChanged(prev: TextAreaAppearance | undefined, next: TextAreaAppearance | undefined): void;
+    /**
+     * Indicates whether the textarea should be a block-level element.
+     *
+     * @public
+     * @remarks
+     * HTML Attribute: `block`
+     */
+    block: boolean;
+    protected blockChanged(): void;
+    /**
+     * Sets the size of the control.
+     *
+     * @public
+     * @remarks
+     * HTML Attribute: `size`
+     */
+    size?: TextAreaSize;
+    protected sizeChanged(prev: TextAreaSize | undefined, next: TextAreaSize | undefined): void;
+    /**
+     * @internal
+     */
+    handleChange(_: any, propertyName: string): void;
+    /**
+     * @internal
+     */
+    connectedCallback(): void;
+    /**
+     * @internal
+     */
+    disconnectedCallback(): void;
+    private maybeDisplayShadow;
+}
+
+/**
+ * Values for the `appearance` attribute on TextArea elements.
+ *
+ * @public
+ */
+export declare const TextAreaAppearance: {
+    readonly outline: "outline";
+    readonly filledLighter: "filled-lighter";
+    readonly filledDarker: "filled-darker";
+};
+
+export declare type TextAreaAppearance = ValuesOf<typeof TextAreaAppearance>;
+
+/**
+ * Values for the `autocomplete` attribute on TextArea elements.
+ *
+ * @public
+ */
+export declare const TextAreaAutocomplete: {
+    readonly on: "on";
+    readonly off: "off";
+};
+
+export declare type TextAreaAutocomplete = ValuesOf<typeof TextAreaAutocomplete>;
+
+/**
+ * The Fluent Textarea Element definition.
+ *
+ * @public
+ * @remarks
+ * HTML Element: `<fluent-textarea>`
+ */
+export declare const TextAreaDefinition: FASTElementDefinition<typeof TextArea>;
+
+/**
+ * Values for the `resize` attribute on TextArea elements.
+ */
+export declare const TextAreaResize: {
+    readonly none: "none";
+    readonly both: "both";
+    readonly horizontal: "horizontal";
+    readonly vertical: "vertical";
+};
+
+export declare type TextAreaResize = ValuesOf<typeof TextAreaResize>;
+
+/**
+ * Values for the `size` attribute on TextArea elements.
+ *
+ * @public
+ */
+export declare const TextAreaSize: {
+    readonly small: "small";
+    readonly medium: "medium";
+    readonly large: "large";
+};
+
+export declare type TextAreaSize = ValuesOf<typeof TextAreaSize>;
+
+/**
+ * Styles for the TextArea component.
+ *
+ * @public
+ */
+export declare const TextAreaStyles: ElementStyles;
+
+/**
+ * @internal
+ */
+export declare const TextAreaTemplate: ElementViewTemplate<TextArea>;
+
 /**
  * The Fluent Text Element.
  *