@fluentui/web-components 3.0.0-alpha.9 → 3.0.0-beta.10

package/dist/dts/form-associated/form-associated.d.ts

@@ -0,0 +1,178 @@
+import type { Constructable, FASTElement } from '@microsoft/fast-element';
+/**
+ * This file enables typing support for ElementInternals APIs.
+ * It is largely taken from https://github.com/microsoft/TSJS-lib-generator/pull/818/files.
+ *
+ * When TypeScript adds support for these APIs we can delete this file.
+ */
+interface ValidityStateFlags {
+    badInput?: boolean;
+    customError?: boolean;
+    patternMismatch?: boolean;
+    rangeOverflow?: boolean;
+    rangeUnderflow?: boolean;
+    stepMismatch?: boolean;
+    tooLong?: boolean;
+    tooShort?: boolean;
+    typeMismatch?: boolean;
+    valueMissing?: boolean;
+}
+/**
+ * Source:
+ * https://html.spec.whatwg.org/multipage/custom-elements.html#elementinternals
+ */
+interface ElementInternals {
+    /**
+     * Returns the form owner of internals target element.
+     */
+    readonly form: HTMLFormElement | null;
+    /**
+     * Returns a NodeList of all the label elements that internals target element is associated with.
+     */
+    readonly labels: NodeList;
+    /**
+     * Returns the error message that would be shown to the user if internals target element was to be checked for validity.
+     */
+    readonly validationMessage: string;
+    /**
+     * Returns the ValidityState object for internals target element.
+     */
+    readonly validity: ValidityState;
+    /**
+     * Returns true if internals target element will be validated when the form is submitted; false otherwise.
+     */
+    readonly willValidate: boolean;
+    /**
+     * Returns true if internals target element has no validity problems; false otherwise. Fires an invalid event at the element in the latter case.
+     */
+    checkValidity(): boolean;
+    /**
+     * Returns true if internals target element has no validity problems; otherwise,
+     * returns false, fires an invalid event at the element, and (if the event isn't canceled) reports the problem to the user.
+     */
+    reportValidity(): boolean;
+    /**
+     * Sets both the state and submission value of internals target element to value.
+     *
+     * While "null" isn't enumerated as a argument type (here)[https://html.spec.whatwg.org/multipage/custom-elements.html#the-elementinternals-interface],
+     * In practice it appears to remove the value from the form data on submission. Adding it as a valid type here
+     * becuase that capability is required for checkbox and radio types
+     */
+    setFormValue(value: File | string | FormData | null, state?: File | string | FormData | null): void;
+    /**
+     * Marks internals target element as suffering from the constraints indicated by the flags argument,
+     * and sets the element's validation message to message.
+     * If anchor is specified, the user agent might use
+     * it to indicate problems with the constraints of internals target
+     * element when the form owner is validated interactively or reportValidity() is called.
+     */
+    setValidity(flags: ValidityStateFlags, message?: string, anchor?: HTMLElement): void;
+}
+declare let ElementInternals: {
+    prototype: ElementInternals;
+    new (): ElementInternals;
+};
+/**
+ * @alpha
+ */
+export declare const supportsElementInternals: boolean;
+/**
+ * Base class for providing Custom Element Form Association.
+ *
+ * @beta
+ */
+export interface FormAssociated extends Omit<ElementInternals, 'labels'> {
+    dirtyValue: boolean;
+    disabled: boolean;
+    readonly elementInternals: ElementInternals | null;
+    readonly formAssociated: boolean;
+    initialValue: string;
+    readonly labels: ReadonlyArray<Node[]>;
+    name: string;
+    required: boolean;
+    value: string;
+    currentValue: string;
+    attachProxy(): void;
+    detachProxy(): void;
+    disabledChanged?(previous: boolean, next: boolean): void;
+    formDisabledCallback?(disabled: boolean): void;
+    formResetCallback(): void;
+    initialValueChanged?(previous: string, next: string): void;
+    nameChanged?(previous: string, next: string): void;
+    requiredChanged(prev: boolean, next: boolean): void;
+    stopPropagation(e: Event): void;
+    /**
+     * Sets the validity of the custom element. By default this uses the proxy element to determine
+     * validity, but this can be extended or replaced in implementation.
+     *
+     * @param anchor - The anchor element to provide to ElementInternals.setValidity for surfacing the browser's constraint validation UI
+     */
+    validate(anchor?: HTMLElement): void;
+    valueChanged(previous: string, next: string): void;
+}
+/**
+ * Base class for providing Custom Element Form Association with checkable features.
+ *
+ * @beta
+ */
+export interface CheckableFormAssociated extends FormAssociated {
+    currentChecked: boolean;
+    dirtyChecked: boolean;
+    checkedAttribute: boolean;
+    defaultChecked: boolean;
+    defaultCheckedChanged(oldValue: boolean | undefined, newValue: boolean): void;
+    checked: boolean;
+    checkedChanged(oldValue: boolean | undefined, newValue: boolean): void;
+}
+/**
+ * Avaiable types for the `proxy` property.
+ * @beta
+ */
+export declare type ProxyElement = HTMLSelectElement | HTMLTextAreaElement | HTMLInputElement;
+/**
+ * Identifies a class as having a proxy element and optional submethods related
+ * to the proxy element.
+ *
+ * @beta
+ */
+export interface FormAssociatedProxy {
+    proxy: ProxyElement;
+    disabledChanged?(previous: boolean, next: boolean): void;
+    formDisabledCallback?(disabled: boolean): void;
+    formResetCallback?(): void;
+    initialValueChanged?(previous: string, next: string): void;
+    valueChanged?(previous: string, next: string): void;
+    nameChanged?(previous: string, next: string): void;
+}
+/**
+ * Combined type to describe a Form-associated element.
+ *
+ * @beta
+ */
+export declare type FormAssociatedElement = FormAssociated & FASTElement & HTMLElement & FormAssociatedProxy;
+/**
+ * Combined type to describe a checkable Form-associated element.
+ *
+ * @beta
+ */
+export declare type CheckableFormAssociatedElement = FormAssociatedElement & CheckableFormAssociated & {
+    proxy: HTMLInputElement;
+};
+/**
+ * Combined type to describe a Constructable Form-Associated type.
+ *
+ * @beta
+ */
+export declare type ConstructableFormAssociated = Constructable<HTMLElement & FASTElement>;
+/**
+ * Base function for providing Custom Element Form Association.
+ *
+ * @beta
+ */
+export declare function FormAssociated<T extends ConstructableFormAssociated>(BaseCtor: T): T;
+/**
+ * Creates a checkable form associated component.
+ * @beta
+ */
+export declare function CheckableFormAssociated<T extends ConstructableFormAssociated>(BaseCtor: T): T;
+export {};

package/dist/dts/helpers.tests.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Returns a formatted URL for a given Storybook fixture.
+ *
+ * @param id - the Storybook fixture ID
+ * @param args - Story args
+ * @returns - the local URL for the Storybook fixture iframe
+ */
+export declare function fixtureURL(id?: string, args?: Record<string, any>): string;

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

@@ -1,4 +1,4 @@
-import { ValuesOf } from '@microsoft/fast-foundation';
+import type { ValuesOf } from '../utils/index.js';
 /**
  * Image fit
  * @public

package/dist/dts/index.d.ts

@@ -1,12 +1,31 @@
 export * from './accordion/index.js';
 export * from './accordion-item/index.js';
+export * from './anchor-button/index.js';
 export * from './avatar/index.js';
 export * from './badge/index.js';
+export * from './button/index.js';
+export * from './checkbox/index.js';
+export * from './compound-button/index.js';
 export * from './counter-badge/index.js';
+export * from './dialog/index.js';
 export * from './divider/index.js';
 export * from './image/index.js';
+export * from './label/index.js';
+export * from './menu/index.js';
+export * from './menu-button/index.js';
+export * from './menu-item/index.js';
+export * from './menu-list/index.js';
 export * from './progress-bar/index.js';
+export * from './radio/index.js';
+export * from './radio-group/index.js';
+export * from './slider/index.js';
 export * from './spinner/index.js';
 export * from './switch/index.js';
+export * from './tabs/index.js';
+export * from './tab/index.js';
+export * from './tab-panel/index.js';
 export * from './text/index.js';
+export * from './text-input/index.js';
+export * from './toggle-button/index.js';
+export * from './fluent-design-system.js';
 export * from './theme/index.js';

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

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

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

@@ -0,0 +1,4 @@
+export * from './label.js';
+export { definition as LabelDefinition } from './label.definition.js';
+export { styles as LabelStyles } from './label.styles.js';
+export { template as LabelTemplate } from './label.template.js';

package/dist/dts/label/label.d.ts

@@ -0,0 +1,42 @@
+import { FASTElement } from '@microsoft/fast-element';
+import { LabelSize, LabelWeight } from './label.options.js';
+/**
+ * The base class used for constructing a fluent-label custom element
+ * @public
+ */
+export declare class Label extends FASTElement {
+    /**
+     * 	Specifies font size of a label
+     *
+     * @public
+     * @default 'medium'
+     * @remarks
+     * HTML Attribute: size
+     */
+    size?: LabelSize;
+    /**
+     * 	Specifies font weight of a label
+     *
+     * @public
+     * @default 'regular'
+     * @remarks
+     * HTML Attribute: weight
+     */
+    weight?: LabelWeight;
+    /**
+     * 	Specifies styles for label when associated input is disabled
+     *
+     * @public
+     * @remarks
+     * HTML Attribute: disabled
+     */
+    disabled: boolean;
+    /**
+     * 	Specifies styles for label when associated input is a required field
+     *
+     * @public
+     * @remarks
+     * HTML Attribute: required
+     */
+    required: boolean;
+}

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

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

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

@@ -0,0 +1,26 @@
+import type { ValuesOf } from '../utils/index.js';
+/**
+ * A Labels font size can be small, medium, or large
+ */
+export declare const LabelSize: {
+    readonly small: "small";
+    readonly medium: "medium";
+    readonly large: "large";
+};
+/**
+ * Applies font size to label
+ * @public
+ */
+export declare type LabelSize = ValuesOf<typeof LabelSize>;
+/**
+ * A label can have a font weight of regular or strong
+ */
+export declare const LabelWeight: {
+    readonly regular: "regular";
+    readonly semibold: "semibold";
+};
+/**
+ * Applies font weight to label
+ * @public
+ */
+export declare type LabelWeight = ValuesOf<typeof LabelWeight>;

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

@@ -0,0 +1,4 @@
+/** Label styles
+ * @public
+ */
+export declare const styles: import("@microsoft/fast-element").ElementStyles;

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

@@ -0,0 +1,8 @@
+import { ElementViewTemplate } from '@microsoft/fast-element';
+import { Label } from './label.js';
+/**
+ * The template for the Fluent label web-component.
+ * @public
+ */
+export declare function labelTemplate<T extends Label>(): ElementViewTemplate<T>;
+export declare const template: ElementViewTemplate<Label>;

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

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

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

@@ -0,0 +1,4 @@
+export * from './menu.js';
+export { template as MenuTemplate } from './menu.template.js';
+export { styles as MenuStyles } from './menu.styles.js';
+export { definition as MenuDefinition } from './menu.definition.js';

package/dist/dts/menu/menu.d.ts

@@ -0,0 +1,194 @@
+import { FASTElement } from '@microsoft/fast-element';
+import { MenuList } from '../menu-list/menu-list.js';
+/**
+ * The Menu class represents a menu component.
+ * @public
+ */
+export declare class Menu extends FASTElement {
+    /**
+     * Determines if the menu should open on hover.
+     * @public
+     */
+    openOnHover?: boolean;
+    /**
+     * Determines if the menu should open on right click.
+     * @public
+     */
+    openOnContext?: boolean;
+    /**
+     * Determines if the menu should close on scroll.
+     * @public
+     */
+    closeOnScroll?: boolean;
+    /**
+     * Determines if the menu open state should persis on click of menu item
+     * @public
+     */
+    persistOnItemClick?: boolean;
+    /**
+     * Defines whether the menu is open or not.
+     * @public
+     */
+    open: boolean;
+    /**
+     * Holds the slotted menu list.
+     * @public
+     */
+    slottedMenuList: MenuList[];
+    /**
+     * Holds the slotted triggers.
+     * @public
+     */
+    slottedTriggers: HTMLElement[];
+    /**
+     * The positioning container of the menu.
+     * @internal
+     */
+    positioningContainer?: HTMLElement;
+    /**
+     * The trigger element of the menu.
+     * @private
+     */
+    private _trigger?;
+    /**
+     * The menu list element of the menu.
+     * @private
+     */
+    private _menuList?;
+    /**
+     * Holds a reference to a function that is used to cleanup resources.
+     * @public
+     */
+    cleanup?: () => void;
+    /**
+     * Called when the element is connected to the DOM.
+     * Sets up the component.
+     * @public
+     */
+    connectedCallback(): void;
+    /**
+     * Called when the element is disconnected from the DOM.
+     * Removes event listeners.
+     * @public
+     */
+    disconnectedCallback(): void;
+    /**
+     * Sets the component.
+     * Sets the trigger and menu list elements and adds event listeners.
+     * @public
+     */
+    setComponent(): void;
+    /**
+     * Toggles the open state of the menu.
+     * @public
+     */
+    toggleMenu: () => void;
+    /**
+     * Closes the menu.
+     * @public
+     */
+    closeMenu: () => void;
+    /**
+     * Opens the menu.
+     * @public
+     */
+    openMenu: (e?: Event) => void;
+    /**
+     * Focuses on the menu list.
+     * @public
+     */
+    focusMenuList(): void;
+    /**
+     * Focuses on the menu trigger.
+     * @public
+     */
+    focusTrigger(): void;
+    /**
+     * Called whenever the open state changes.
+     * Updates the 'aria-expanded' attribute and sets the positioning of the menu.
+     * Sets menu list position
+     * emits openChanged event
+     * @public
+     * @param {boolean} oldValue - The previous value of 'open'.
+     * @param {boolean} newValue - The new value of 'open'.
+     */
+    openChanged(oldValue: boolean, newValue: boolean): void;
+    /**
+     * Called whenever the 'openOnHover' property changes.
+     * Adds or removes a 'mouseover' event listener to the trigger based on the new value.
+     * @public
+     * @param {boolean} oldValue - The previous value of 'openOnHover'.
+     * @param {boolean} newValue - The new value of 'openOnHover'.
+     */
+    openOnHoverChanged(oldValue: boolean, newValue: boolean): void;
+    /**
+     * Called whenever the 'persistOnItemClick' property changes.
+     * Adds or removes a 'click' event listener to the menu list based on the new value.
+     * @public
+     * @param {boolean} oldValue - The previous value of 'persistOnItemClick'.
+     * @param {boolean} newValue - The new value of 'persistOnItemClick'.
+     */
+    persistOnItemClickChanged(oldValue: boolean, newValue: boolean): void;
+    /**
+     * Called whenever the 'openOnContext' property changes.
+     * Adds or removes a 'contextmenu' event listener to the trigger based on the new value.
+     * @public
+     * @param {boolean} oldValue - The previous value of 'openOnContext'.
+     * @param {boolean} newValue - The new value of 'openOnContext'.
+     */
+    openOnContextChanged(oldValue: boolean, newValue: boolean): void;
+    /**
+     * Called whenever the 'closeOnScroll' property changes.
+     * Adds or removes a 'closeOnScroll' event listener to the trigger based on the new value.
+     * @public
+     * @param {boolean} oldValue - The previous value of 'closeOnScroll'.
+     * @param {boolean} newValue - The new value of 'closeOnScroll'.
+     */
+    closeOnScrollChanged(oldValue: boolean, newValue: boolean): void;
+    /**
+     * The task to set the positioning of the menu.
+     * @protected
+     */
+    protected setPositioningTask: () => void;
+    /**
+     * Sets the positioning of the menu.
+     * @protected
+     */
+    protected setPositioning(): void;
+    /**
+     * Adds event listeners.
+     * Adds click and keydown event listeners to the trigger and a click event listener to the document.
+     * If 'openOnHover' is true, adds a 'mouseover' event listener to the trigger.
+     * @public
+     */
+    private addListeners;
+    /**
+     * Removes event listeners.
+     * Removes click and keydown event listeners from the trigger and a click event listener from the document.
+     * Also removes 'mouseover' event listeners from the trigger.
+     * @private
+     */
+    private removeListeners;
+    /**
+     * Handles keyboard interaction for the menu.
+     * Closes the menu and focuses on the trigger when the Escape key is pressed.
+     * Closes the menu when the Tab key is pressed.
+     * @public
+     * @param {KeyboardEvent} e - the keyboard event
+     */
+    handleMenuKeydown(e: KeyboardEvent): boolean | void;
+    /**
+     * Handles keyboard interaction for the trigger.
+     * Toggles the menu when the Space or Enter key is pressed.
+     * If the menu is open, focuses on the menu list.
+     * @public
+     * @param {KeyboardEvent} e - the keyboard event
+     */
+    handleTriggerKeydown: (e: KeyboardEvent) => boolean | void;
+    /**
+     * Handles document click events to close the menu when a click occurs outside of the menu or the trigger.
+     * @private
+     * @param {Event} e - The event triggered on document click.
+     */
+    private handleDocumentClick;
+}

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

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

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

@@ -0,0 +1,4 @@
+/** Menu styles
+ * @public
+ */
+export declare const styles: import("@microsoft/fast-element").ElementStyles;

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

@@ -0,0 +1,4 @@
+import { ElementViewTemplate } from '@microsoft/fast-element';
+import type { Menu } from './menu.js';
+export declare function menuTemplate<T extends Menu>(): ElementViewTemplate<T>;
+export declare const template: ElementViewTemplate<Menu>;

package/dist/dts/menu-button/define.d.ts

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

package/dist/dts/menu-button/index.d.ts

@@ -0,0 +1,5 @@
+export * from './menu-button.js';
+export * from './menu-button.options.js';
+export { template as MenuButtonTemplate } from './menu-button.template.js';
+export { styles as MenuButtonStyles } from '../button/button.styles.js';
+export { definition as MenuButtonDefinition } from './menu-button.definition.js';

package/dist/dts/menu-button/menu-button.d.ts

@@ -0,0 +1,7 @@
+import { Button } from '../button/button.js';
+/**
+ * The base class used for constructing a fluent-menu-button custom element
+ * @public
+ */
+export declare class MenuButton extends Button {
+}

package/dist/dts/menu-button/menu-button.definition.d.ts

@@ -0,0 +1,7 @@
+import { MenuButton } from './menu-button.js';
+/**
+ * @public
+ * @remarks
+ * HTML Element: \<fluent-button\>
+ */
+export declare const definition: import("@microsoft/fast-element").FASTElementDefinition<typeof MenuButton>;

package/dist/dts/menu-button/menu-button.options.d.ts

@@ -0,0 +1,47 @@
+import type { ButtonOptions } from '../button/index.js';
+import type { ValuesOf } from '../utils/index.js';
+/**
+ * Menu Button Appearance constants
+ * @public
+ */
+export declare const MenuButtonAppearance: {
+    readonly primary: "primary";
+    readonly outline: "outline";
+    readonly subtle: "subtle";
+    readonly secondary: "secondary";
+    readonly transparent: "transparent";
+};
+/**
+ * A Menu Button can be secondary, primary, outline, subtle, transparent
+ * @public
+ */
+export declare type MenuButtonAppearance = ValuesOf<typeof MenuButtonAppearance>;
+/**
+ * A Menu Button can be square, circular or rounded.
+ * @public
+ */
+export declare const MenuButtonShape: {
+    readonly circular: "circular";
+    readonly rounded: "rounded";
+    readonly square: "square";
+};
+/**
+ * A Menu Button can be square, circular or rounded
+ * @public
+ */
+export declare type MenuButtonShape = ValuesOf<typeof MenuButtonShape>;
+/**
+ * A Menu Button can be a size of small, medium or large.
+ * @public
+ */
+export declare const MenuButtonSize: {
+    readonly small: "small";
+    readonly medium: "medium";
+    readonly large: "large";
+};
+/**
+ * A Menu Button can be on of several preset sizes.
+ * @public
+ */
+export declare type MenuButtonSize = ValuesOf<typeof MenuButtonSize>;
+export { ButtonOptions as MenuButtonOptions };

package/dist/dts/menu-button/menu-button.template.d.ts

@@ -0,0 +1,7 @@
+import { ElementViewTemplate } from '@microsoft/fast-element';
+import type { MenuButton } from './menu-button.js';
+/**
+ * The template for the Button component.
+ * @public
+ */
+export declare const template: ElementViewTemplate<MenuButton>;

package/dist/dts/menu-item/define.d.ts

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

package/dist/dts/menu-item/index.d.ts

@@ -0,0 +1,4 @@
+export * from './menu-item.js';
+export { template as MenuItemTemplate } from './menu-item.template.js';
+export { styles as MenuItemStyles } from './menu-item.styles.js';
+export { definition as MenuItemDefinition } from './menu-item.definition.js';