@fluentui/web-components 3.0.0-beta.2 → 3.0.0-beta.21

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/index.d.ts

@@ -1,5 +1,5 @@
-export * from './menu-button.js';
-export * from './menu-button.options.js';
+export { MenuButton } from './menu-button.js';
+export { MenuButtonAppearance, MenuButtonShape, MenuButtonSize, MenuButtonOptions } 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.definition.d.ts

@@ -1,8 +1,5 @@
 import { MenuButton } from './menu-button.js';
 /**
- * The Fluent Menu Button Element. Implements {@link @microsoft/fast-foundation#Button },
- * {@link @microsoft/fast-foundation#buttonTemplate}
- *
  * @public
  * @remarks
  * HTML Element: \<fluent-button\>

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

@@ -1,5 +1,5 @@
-import type { ButtonOptions } from '@microsoft/fast-foundation/button.js';
-import type { ValuesOf } from '@microsoft/fast-foundation/utilities.js';
+import type { ButtonOptions } from '../button/button.options.js';
+import type { ValuesOf } from '../utils/index.js';
 /**
  * Menu Button Appearance constants
  * @public

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

@@ -1,4 +1,5 @@
-export * from './menu-item.js';
+export { MenuItem, MenuItemColumnCount, MenuItemOptions } from './menu-item.js';
+export { MenuItemRole, roleForMenuItem } from './menu-item.options.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,9 +1,166 @@
-import { FASTMenuItem, MenuItemRole } from '@microsoft/fast-foundation/menu-item.js';
+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 };
+export { MenuItemRole, roleForMenuItem };
 /**
- * The base class used for constructing a fluent-menu-item custom element
+ * Menu Item configuration options
  * @public
  */
-export declare class MenuItem extends FASTMenuItem {
+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.definition.d.ts

@@ -1,9 +1,5 @@
 import { MenuItem } from './menu-item.js';
 /**
- * The Fluent Menu Item Element. Implements {@link @microsoft/fast-foundation#MenuItem },
- * {@link @microsoft/fast-foundation#menuItemTemplate}
- *
- *
  * @public
  * @remarks
  * HTML Element: <fluent-menu-item>

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

@@ -0,0 +1,30 @@
+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-item/menu-item.template.d.ts

@@ -1,3 +1,4 @@
 import type { ElementViewTemplate } from '@microsoft/fast-element';
-import type { MenuItem } from './menu-item.js';
+import type { MenuItem, MenuItemOptions } from './menu-item.js';
+export declare function menuItemTemplate<T extends MenuItem>(options?: MenuItemOptions): ElementViewTemplate<T>;
 export declare const template: ElementViewTemplate<MenuItem>;

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

@@ -1,4 +1,4 @@
-export * from './menu-list.js';
+export { MenuList } 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,9 +1,76 @@
-import { FASTMenu } from '@microsoft/fast-foundation/menu.js';
+import { FASTElement } from '@microsoft/fast-element';
 /**
- * The base class used for constructing a fluent-menu-list custom 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 FASTMenu {
-    protected setItems(): void;
+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.definition.d.ts

@@ -1,9 +1,5 @@
 import { MenuList } from './menu-list.js';
 /**
- * The Fluent MenuList Element. Implements {@link @microsoft/fast-foundation#Menu },
- * {@link @microsoft/fast-foundation#menuTemplate}
- *
- *
  * @public
  * @remarks
  * HTML Element: <fluent-menu-list>

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

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