@fluentui/web-components 3.0.0-beta.1 → 3.0.0-beta.100

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

@@ -1,26 +1,38 @@
-import { FASTTextField } from '@microsoft/fast-foundation/text-field.js';
+import { StartEnd } from '../patterns/start-end.js';
+import { BaseTextInput } from './text-input.base.js';
 import { TextInputAppearance, TextInputControlSize } from './text-input.options.js';
 /**
- * The base class used for constructing a fluent-text-input custom element
+ * A Text Input Custom HTML Element.
+ * Based on BaseTextInput and includes style and layout specific attributes
+ *
+ * @tag fluent-text-input
+ *
  * @public
  */
-export declare class TextInput extends FASTTextField {
+export declare class TextInput extends BaseTextInput {
     /**
-     * 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.
+     * Sets the size of the control.
      *
      * @public
-     * @default 'outline'
      * @remarks
-     * HTML Attribute: appearance
+     * HTML Attribute: `control-size`
      */
-    appearance?: TextInputAppearance;
+    controlSize?: TextInputControlSize;
+}
+/**
+ * @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 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>;

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

@@ -1,6 +1,15 @@
-import type { ValuesOf } from '@microsoft/fast-foundation/utilities.js';
+import type { StartEndOptions } from '../patterns/start-end.js';
+import type { ValuesOf } from '../utils/typings.js';
+import type { TextInput } from './text-input.js';
 /**
- * TextInput size constants
+ * TextInput configuration options.
+ *
+ * @public
+ */
+export type TextInputOptions = StartEndOptions<TextInput>;
+/**
+ * Values for the `control-size` attribute on TextInput elements.
+ *
  * @public
  */
 export declare const TextInputControlSize: {
@@ -8,13 +17,10 @@ export declare const TextInputControlSize: {
     readonly medium: "medium";
     readonly large: "large";
 };
+export type TextInputControlSize = ValuesOf<typeof TextInputControlSize>;
 /**
- * Applies size styling to TextInput
- * @public
- */
-export declare type TextInputControlSize = ValuesOf<typeof TextInputControlSize>;
-/**
- * TextInput appearance constants
+ * Values for the `appearance` attribute on TextInput elements.
+ *
  * @public
  */
 export declare const TextInputAppearance: {
@@ -23,8 +29,23 @@ export declare const TextInputAppearance: {
     readonly filledLighter: "filled-lighter";
     readonly filledDarker: "filled-darker";
 };
+export type TextInputAppearance = ValuesOf<typeof TextInputAppearance>;
+/**
+ * Values for the `type` attribute on TextInput elements.
+ *
+ * @public
+ */
+export declare const TextInputType: {
+    readonly email: "email";
+    readonly password: "password";
+    readonly tel: "tel";
+    readonly text: "text";
+    readonly url: "url";
+};
+export type TextInputType = ValuesOf<typeof TextInputType>;
 /**
- * Applies appearance styling to TextInput
+ * Input types that block implicit form submission.
+ *
  * @public
  */
-export declare type TextInputAppearance = ValuesOf<typeof TextInputAppearance>;
+export declare const ImplicitSubmissionBlockingTypes: string[];

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

@@ -1,4 +1,7 @@
-/** TextInput styles
+import type { ElementStyles } from '@microsoft/fast-element';
+/**
+ * Styles for the TextInput component.
+ *
  * @public
  */
-export declare const styles: import("@microsoft/fast-element").ElementStyles;
+export declare const styles: ElementStyles;

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

@@ -1,5 +1,12 @@
-import { ElementViewTemplate } from '@microsoft/fast-element';
+import type { ElementViewTemplate } from '@microsoft/fast-element';
 import type { TextInput } from './text-input.js';
+import type { TextInputOptions } from './text-input.options.js';
+/**
+ * Generates a template for the TextInput component.
+ *
+ * @public
+ */
+export declare function textInputTemplate<T extends TextInput>(options?: TextInputOptions): ElementViewTemplate<T>;
 /**
  * @internal
  */

package/dist/dts/textarea/define.d.ts

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1,6 @@
+export { definition as TextAreaDefinition } from './textarea.definition.js';
+export { BaseTextArea } from './textarea.base.js';
+export { TextArea } from './textarea.js';
+export { TextAreaAppearance, TextAreaAppearancesForDisplayShadow, TextAreaAutocomplete, TextAreaResize, TextAreaSize, } from './textarea.options.js';
+export { styles as TextAreaStyles } from './textarea.styles.js';
+export { template as TextAreaTemplate } from './textarea.template.js';

package/dist/dts/textarea/textarea.base.d.ts

@@ -0,0 +1,347 @@
+import { FASTElement } from '@microsoft/fast-element';
+import type { Label } from '../label/label.js';
+import { TextAreaAutocomplete, TextAreaResize } from './textarea.options.js';
+/**
+ * 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;
+}

package/dist/dts/textarea/textarea.bench.d.ts

@@ -0,0 +1,3 @@
+declare const itemRenderer: () => HTMLElement;
+export default itemRenderer;
+export { tests } from '../utils/benchmark-wrapper.js';

package/dist/dts/textarea/textarea.d.ts

@@ -0,0 +1,47 @@
+import { BaseTextArea } from './textarea.base.js';
+import { TextAreaAppearance, TextAreaSize } from './textarea.options.js';
+/**
+ * The Fluent TextArea Element.
+ *
+ * @tag fluent-text-area
+ *
+ */
+export declare class TextArea extends BaseTextArea {
+    protected labelSlottedNodesChanged(): void;
+    /**
+     * Indicates the visual appearance of the element.
+     *
+     * @public
+     * @remarks
+     * HTML Attribute: `appearance`
+     */
+    appearance: TextAreaAppearance;
+    /**
+     * Indicates whether the textarea should be a block-level element.
+     *
+     * @public
+     * @remarks
+     * HTML Attribute: `block`
+     */
+    block: boolean;
+    /**
+     * Sets the size of the control.
+     *
+     * @public
+     * @remarks
+     * HTML Attribute: `size`
+     */
+    size?: TextAreaSize;
+    /**
+     * @internal
+     */
+    handleChange(_: any, propertyName: string): void;
+    /**
+     * @internal
+     */
+    connectedCallback(): void;
+    /**
+     * @internal
+     */
+    disconnectedCallback(): void;
+}

package/dist/dts/textarea/textarea.definition.d.ts

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

package/dist/dts/textarea/textarea.options.d.ts

@@ -0,0 +1,49 @@
+import type { ValuesOf } from '../utils/typings.js';
+/**
+ * Values for the `size` attribute on TextArea elements.
+ *
+ * @public
+ */
+export declare const TextAreaSize: {
+    readonly small: "small";
+    readonly medium: "medium";
+    readonly large: "large";
+};
+export type TextAreaSize = ValuesOf<typeof TextAreaSize>;
+/**
+ * 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 type TextAreaAppearance = ValuesOf<typeof TextAreaAppearance>;
+/**
+ * Allowed values for `appearance` when `display-shadow` is set to true.
+ *
+ * @public
+ */
+export declare const TextAreaAppearancesForDisplayShadow: Partial<TextAreaAppearance[]>;
+/**
+ * Values for the `autocomplete` attribute on TextArea elements.
+ *
+ * @public
+ */
+export declare const TextAreaAutocomplete: {
+    readonly on: "on";
+    readonly off: "off";
+};
+export type TextAreaAutocomplete = ValuesOf<typeof TextAreaAutocomplete>;
+/**
+ * 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 type TextAreaResize = ValuesOf<typeof TextAreaResize>;

package/dist/dts/textarea/textarea.styles.d.ts

@@ -0,0 +1,7 @@
+import type { ElementStyles } from '@microsoft/fast-element';
+/**
+ * Styles for the TextArea component.
+ *
+ * @public
+ */
+export declare const styles: ElementStyles;

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

@@ -0,0 +1,12 @@
+import { type ElementViewTemplate } from '@microsoft/fast-element';
+import type { TextArea } from './textarea.js';
+/**
+ * Generates a template for the TextArea component.
+ *
+ * @public
+ */
+export declare function textAreaTemplate<T extends TextArea>(): ElementViewTemplate<T>;
+/**
+ * @internal
+ */
+export declare const template: ElementViewTemplate<TextArea>;