@fluentui/web-components 3.0.0-beta.11 → 3.0.0-beta.111

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

@@ -1,194 +0,0 @@
-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.template.d.ts

@@ -1,4 +0,0 @@
-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/index.d.ts

@@ -1,5 +0,0 @@
-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

@@ -1,7 +0,0 @@
-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.options.d.ts

@@ -1,47 +0,0 @@
-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

@@ -1,7 +0,0 @@
-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/index.d.ts

@@ -1,4 +0,0 @@
-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';

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

@@ -1,166 +0,0 @@
-import { FASTElement } from '@microsoft/fast-element';
-import type { StaticallyComposableHTML } from '../utils/template-helpers.js';
-import type { StartEndOptions } from '../patterns/start-end.js';
-import { StartEnd } from '../patterns/start-end.js';
-import { MenuItemRole, roleForMenuItem } from './menu-item.options.js';
-export declare type MenuItemColumnCount = 0 | 1 | 2;
-export { MenuItemRole, roleForMenuItem };
-/**
- * Menu Item configuration options
- * @public
- */
-export declare type MenuItemOptions = StartEndOptions<MenuItem> & {
-    checkboxIndicator?: StaticallyComposableHTML<MenuItem>;
-    expandCollapseGlyph?: StaticallyComposableHTML<MenuItem>;
-    radioIndicator?: StaticallyComposableHTML<MenuItem>;
-};
-/**
- * A Switch Custom HTML Element.
- * Implements {@link https://www.w3.org/TR/wai-aria-1.1/#menuitem | ARIA menuitem }, {@link https://www.w3.org/TR/wai-aria-1.1/#menuitemcheckbox | ARIA menuitemcheckbox}, or {@link https://www.w3.org/TR/wai-aria-1.1/#menuitemradio | ARIA menuitemradio }.
- *
- * @slot checked-indicator - The checked indicator
- * @slot radio-indicator - The radio indicator
- * @slot start - Content which can be provided before the menu item content
- * @slot end - Content which can be provided after the menu item content
- * @slot - The default slot for menu item content
- * @slot expand-collapse-indicator - The expand/collapse indicator
- * @slot submenu - Used to nest menu's within menu items
- * @csspart input-container - The element representing the visual checked or radio indicator
- * @csspart checkbox - The element wrapping the `menuitemcheckbox` indicator
- * @csspart radio - The element wrapping the `menuitemradio` indicator
- * @csspart content - The element wrapping the menu item content
- * @csspart expand-collapse-glyph-container - The element wrapping the expand collapse element
- * @csspart expand-collapse - The expand/collapse element
- * @csspart submenu-region - The container for the submenu, used for positioning
- * @fires expanded-change - Fires a custom 'expanded-change' event when the expanded state changes
- * @fires change - Fires a custom 'change' event when a non-submenu item with a role of `menuitemcheckbox`, `menuitemradio`, or `menuitem` is invoked
- *
- * @public
- */
-export declare class MenuItem extends FASTElement {
-    /**
-     * The disabled state of the element.
-     *
-     * @public
-     * @remarks
-     * HTML Attribute: disabled
-     */
-    disabled: boolean;
-    /**
-     * The expanded state of the element.
-     *
-     * @public
-     * @remarks
-     * HTML Attribute: expanded
-     */
-    expanded: boolean;
-    protected expandedChanged(prev: boolean | undefined, next: boolean): void;
-    /**
-     * The role of the element.
-     *
-     * @public
-     * @remarks
-     * HTML Attribute: role
-     */
-    role: MenuItemRole;
-    /**
-     * Cleanup function for the submenu positioner.
-     *
-     * @public
-     */
-    cleanup: () => void;
-    /**
-     * The checked value of the element.
-     *
-     * @public
-     * @remarks
-     * HTML Attribute: checked
-     */
-    checked: boolean;
-    protected checkedChanged(oldValue: boolean, newValue: boolean): void;
-    /**
-     * The hidden attribute.
-     *
-     * @public
-     * @remarks
-     * HTML Attribute: hidden
-     */
-    hidden: boolean;
-    /**
-     * The submenu slotted content.
-     *
-     * @internal
-     */
-    slottedSubmenu: HTMLElement[];
-    /**
-     * @internal
-     */
-    get hasSubmenu(): boolean;
-    /**
-     * Sets the submenu and updates its position.
-     *
-     * @internal
-     */
-    protected slottedSubmenuChanged(prev: HTMLElement[] | undefined, next: HTMLElement[]): void;
-    /**
-     * The container for the submenu.
-     *
-     * @internal
-     */
-    submenuContainer: HTMLDivElement;
-    /**
-     * @internal
-     */
-    submenu: HTMLElement | undefined;
-    private focusSubmenuOnLoad;
-    /**
-     * @internal
-     */
-    disconnectedCallback(): void;
-    /**
-     * @internal
-     */
-    handleMenuItemKeyDown: (e: KeyboardEvent) => boolean;
-    /**
-     * @internal
-     */
-    handleMenuItemClick: (e: MouseEvent) => boolean;
-    /**
-     * @internal
-     */
-    submenuLoaded: () => void;
-    /**
-     * @internal
-     */
-    handleMouseOver: (e: MouseEvent) => boolean;
-    /**
-     * @internal
-     */
-    handleMouseOut: (e: MouseEvent) => boolean;
-    /**
-     * @internal
-     */
-    private closeSubMenu;
-    /**
-     * @internal
-     */
-    private expandAndFocus;
-    /**
-     * @internal
-     */
-    private invoke;
-    /**
-     * Calculate and apply submenu positioning.
-     *
-     * @public
-     */
-    updateSubmenu(): void;
-}
-/**
- * Mark internal because exporting class and interface of the same name
- * confuses API documenter.
- * TODO: https://github.com/microsoft/fast/issues/3317
- * @internal
- */
-export interface MenuItem extends StartEnd {
-}

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

@@ -1,30 +0,0 @@
-import type { ValuesOf } from '../utils/index.js';
-/**
- * Menu items roles.
- * @public
- */
-export declare const MenuItemRole: {
-    /**
-     * The menu item has a "menuitem" role
-     */
-    readonly menuitem: "menuitem";
-    /**
-     * The menu item has a "menuitemcheckbox" role
-     */
-    readonly menuitemcheckbox: "menuitemcheckbox";
-    /**
-     * The menu item has a "menuitemradio" role
-     */
-    readonly menuitemradio: "menuitemradio";
-};
-/**
- * The types for menu item roles
- * @public
- */
-export declare type MenuItemRole = ValuesOf<typeof MenuItemRole>;
-/**
- * @internal
- */
-export declare const roleForMenuItem: {
-    [value in keyof typeof MenuItemRole]: typeof MenuItemRole[value];
-};

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

@@ -1,4 +0,0 @@
-export * from './menu-list.js';
-export { template as MenuListTemplate } from './menu-list.template.js';
-export { styles as MenuListStyles } from './menu-list.styles.js';
-export { definition as MenuListDefinition } from './menu-list.definition.js';

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

@@ -1,76 +0,0 @@
-import { FASTElement } from '@microsoft/fast-element';
-/**
- * A Menu Custom HTML Element.
- * Implements the {@link https://www.w3.org/TR/wai-aria-1.1/#menu | ARIA menu }.
- *
- * @slot - The default slot for the menu items
- *
- * @public
- */
-export declare class MenuList extends FASTElement {
-    /**
-     * @internal
-     */
-    items: HTMLElement[];
-    protected itemsChanged(oldValue: HTMLElement[], newValue: HTMLElement[]): void;
-    protected menuItems: Element[] | undefined;
-    private expandedItem;
-    /**
-     * The index of the focusable element in the items array
-     * defaults to -1
-     */
-    private focusIndex;
-    private static focusableElementRoles;
-    /**
-     * @internal
-     */
-    connectedCallback(): void;
-    /**
-     * @internal
-     */
-    disconnectedCallback(): void;
-    /**
-     * @internal
-     */
-    readonly isNestedMenu: () => boolean;
-    /**
-     * Focuses the first item in the menu.
-     *
-     * @public
-     */
-    focus(): void;
-    /**
-     * Collapses any expanded menu items.
-     *
-     * @public
-     */
-    collapseExpandedItem(): void;
-    /**
-     * @internal
-     */
-    handleMenuKeyDown(e: KeyboardEvent): void | boolean;
-    /**
-     * if focus is moving out of the menu, reset to a stable initial state
-     * @internal
-     */
-    handleFocusOut: (e: FocusEvent) => void;
-    private handleItemFocus;
-    private handleExpandedChanged;
-    private removeItemListeners;
-    private static elementIndent;
-    protected setItems(): void;
-    handleChange(source: any, propertyName: string): void;
-    /**
-     * handle change from child element
-     */
-    private changeHandler;
-    /**
-     * check if the item is a menu item
-     */
-    protected isMenuItemElement: (el: Element) => el is HTMLElement;
-    /**
-     * check if the item is focusable
-     */
-    private isFocusableElement;
-    private setFocus;
-}

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

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

package/dist/dts/patterns/start-end.d.ts

@@ -1,44 +0,0 @@
-import { CaptureType } from '@microsoft/fast-element';
-import type { StaticallyComposableHTML } from '../utils/index.js';
-/**
- * Start configuration options
- * @public
- */
-export declare type StartOptions<TSource = any, TParent = any> = {
-    start?: StaticallyComposableHTML<TSource, TParent>;
-};
-/**
- * End configuration options
- * @public
- */
-export declare type EndOptions<TSource = any, TParent = any> = {
-    end?: StaticallyComposableHTML<TSource, TParent>;
-};
-/**
- * Start/End configuration options
- * @public
- */
-export declare type StartEndOptions<TSource = any, TParent = any> = StartOptions<TSource, TParent> & EndOptions<TSource, TParent>;
-/**
- * A mixin class implementing start and end slots.
- * These are generally used to decorate text elements with icons or other visual indicators.
- * @public
- */
-export declare class StartEnd {
-    start: HTMLSlotElement;
-    end: HTMLSlotElement;
-}
-/**
- * The template for the end slot.
- * For use with {@link StartEnd}
- *
- * @public
- */
-export declare function endSlotTemplate<TSource extends StartEnd = StartEnd, TParent = any>(options: EndOptions<TSource, TParent>): CaptureType<TSource, TParent>;
-/**
- * The template for the start slots.
- * For use with {@link StartEnd}
- *
- * @public
- */
-export declare function startSlotTemplate<TSource extends StartEnd = StartEnd, TParent = any>(options: StartOptions<TSource, TParent>): CaptureType<TSource, TParent>;

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

@@ -1,41 +0,0 @@
-import { FASTElement } from '@microsoft/fast-element';
-/**
- * A base class for progress components.
- * @public
- */
-export declare class BaseProgress extends FASTElement {
-    /**
-     * The value of the progress
-     * @public
-     * @remarks
-     * HTML Attribute: value
-     */
-    value: number | null;
-    protected valueChanged(): void;
-    /**
-     * The minimum value
-     * @public
-     * @remarks
-     * HTML Attribute: min
-     */
-    min: number;
-    protected minChanged(): void;
-    /**
-     * The maximum value
-     * @public
-     * @remarks
-     * HTML Attribute: max
-     */
-    max: number;
-    protected maxChanged(): void;
-    /**
-     * Indicates progress in %
-     * @internal
-     */
-    percentComplete: number;
-    /**
-     * @internal
-     */
-    connectedCallback(): void;
-    private updatePercentComplete;
-}

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

@@ -1,5 +0,0 @@
-export * from './progress-bar.js';
-export * from './progress-bar.options.js';
-export { definition as ProgressBarDefinition } from './progress-bar.definition.js';
-export { styles as ProgressBarStyles } from './progress-bar.styles.js';
-export { template as ProgressBarTemplate } from './progress-bar.template.js';

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

@@ -1,37 +0,0 @@
-import { BaseProgress } from './base-progress.js';
-import { ProgressBarShape, ProgressBarThickness, ProgressBarValidationState } from './progress-bar.options.js';
-/**
- * An Progress HTML Element.
- * Implements the {@link https://www.w3.org/TR/wai-aria-1.1/#progressbar | ARIA progressbar }.
- *
- * @slot indeterminate - The slot for a custom indeterminate indicator
- * @csspart progress - Represents the progress element
- * @csspart determinate - The determinate indicator
- * @csspart indeterminate - The indeterminate indicator
- *
- * @public
- */
-export declare class ProgressBar extends BaseProgress {
-    /**
-     * The thickness of the progress bar
-     *
-     * @public
-     * @remarks
-     * HTML Attribute: thickness
-     */
-    thickness?: ProgressBarThickness;
-    /**
-     * The shape of the progress bar
-     * @public
-     * @remarks
-     * HTML Attribute: shape
-     */
-    shape?: ProgressBarShape;
-    /**
-     * The validation state of the progress bar
-     * @public
-     * @remarks
-     * HTML Attribute: validation-state
-     */
-    validationState: ProgressBarValidationState | null;
-}