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

package/dist/dts/listbox/listbox.d.ts

@@ -0,0 +1,118 @@
+import { FASTElement } from '@microsoft/fast-element';
+import type { BaseDropdown } from '../dropdown/dropdown.base.js';
+import type { DropdownOption } from '../option/option.js';
+/**
+ * A Listbox Custom HTML Element.
+ * Implements the {@link https://w3c.github.io/aria/#listbox | ARIA listbox } role.
+ *
+ * @tag fluent-listbox
+ *
+ * @slot - The default slot for the options.
+ * @emits connected - Dispatched when the element is connected to the DOM.
+ *
+ * @remarks
+ * The listbox component represents a list of options that can be selected.
+ * It is intended to be used in conjunction with the {@link BaseDropdown | Dropdown} component.
+ *
+ * @public
+ */
+export declare class Listbox extends FASTElement {
+    /**
+     * Sets the listbox ID to a unique value if one is not provided.
+     *
+     * @override
+     * @public
+     * @remarks
+     * HTML Attribute: `id`
+     */
+    id: string;
+    /**
+     * Indicates whether the listbox allows multiple selection.
+     *
+     * @public
+     */
+    multiple?: boolean;
+    /**
+     * Updates the multiple selection state of the listbox and its options.
+     *
+     * @param prev - the previous multiple value
+     * @param next - the current multiple value
+     */
+    multipleChanged(prev: boolean | undefined, next: boolean | undefined): void;
+    /**
+     * The collection of all child options.
+     *
+     * @public
+     */
+    options: DropdownOption[];
+    /**
+     * Updates the enabled options collection when properties on the child options change.
+     *
+     * @param prev - the previous options
+     * @param next - the current options
+     *
+     * @internal
+     */
+    optionsChanged(prev: DropdownOption[] | undefined, next: DropdownOption[] | undefined): void;
+    /**
+     * The index of the first selected and enabled option.
+     * @internal
+     */
+    selectedIndex: number;
+    /**
+     * Reference to the parent dropdown element.
+     * @internal
+     */
+    dropdown?: BaseDropdown;
+    /**
+     * Handles the `beforetoggle` event on the listbox.
+     *
+     * @param e - the toggle event
+     * @returns true to allow the default popover behavior, undefined to prevent it
+     * @internal
+     */
+    beforetoggleHandler(e: ToggleEvent): boolean | undefined;
+    /**
+     * The internal {@link https://developer.mozilla.org/docs/Web/API/ElementInternals | `ElementInternals`} instance for the component.
+     *
+     * @internal
+     */
+    elementInternals: ElementInternals;
+    /**
+     * The collection of child options that are not disabled.
+     *
+     * @internal
+     */
+    get enabledOptions(): DropdownOption[];
+    /**
+     * The collection of child options that are selected.
+     *
+     * @public
+     */
+    get selectedOptions(): DropdownOption[];
+    /**
+     * Sets the `selected` state on a target option when clicked.
+     *
+     * @param e - The pointer event
+     * @public
+     */
+    clickHandler(e: PointerEvent): boolean | void;
+    constructor();
+    connectedCallback(): void;
+    /**
+     * Handles observable subscriptions for the listbox.
+     *
+     * @param source - The source of the observed change
+     * @param propertyName - The name of the property that changed
+     *
+     * @internal
+     */
+    handleChange(source: any, propertyName?: string): void;
+    /**
+     * Selects an option by index.
+     *
+     * @param index - The index of the option to select.
+     * @public
+     */
+    selectOption(index?: number): void;
+}

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

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

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

@@ -0,0 +1,10 @@
+import type { Listbox } from './listbox.js';
+/**
+ * Predicate function that determines if the element should be considered a listbox.
+ *
+ * @param element - The element to check.
+ * @param tagName - The tag name to check.
+ * @returns true if the element is a listbox.
+ * @public
+ */
+export declare function isListbox(element?: Node | null, tagName?: string): element is Listbox;

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

@@ -0,0 +1,6 @@
+/**
+ * Styles for the {@link (Listbox:class)} component.
+ *
+ * @public
+ */
+export declare const styles: import("@microsoft/fast-element").ElementStyles;

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

@@ -0,0 +1,17 @@
+import { ElementViewTemplate } from '@microsoft/fast-element';
+import type { Listbox } from './listbox.js';
+/**
+ * Generates a template for the {@link (Dropdown:class)} component.
+ *
+ * @param options - The {@link (DropdownOptions:interface)} to use for generating the template.
+ * @returns The template object.
+ *
+ * @public
+ */
+export declare function listboxTemplate<T extends Listbox>(): ElementViewTemplate<T>;
+/**
+ * Template for the Listbox component.
+ *
+ * @public
+ */
+export declare const template: ElementViewTemplate<Listbox>;

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

@@ -1,4 +1,4 @@
-export * from './menu.js';
+export { Menu } 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.bench.d.ts

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

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

@@ -1,7 +1,47 @@
 import { FASTElement } from '@microsoft/fast-element';
-import { MenuList } from '../menu-list/menu-list.js';
+import type { MenuList } from '../menu-list/menu-list.js';
 /**
- * The Menu class represents a menu component.
+ * A Menu component that provides a customizable menu element.
+ *
+ * @tag fluent-menu
+ *
+ * @class Menu
+ * @extends FASTElement
+ *
+ * @attr open-on-hover - Determines if the menu should open on hover.
+ * @attr open-on-context - Determines if the menu should open on right click.
+ * @attr close-on-scroll - Determines if the menu should close on scroll.
+ * @attr persist-on-item-click - Determines if the menu open state should persist on click of menu item.
+ * @attr split - Determines if the menu is in split state.
+ *
+ * @cssproperty --menu-max-height - The max-height of the menu.
+ *
+ * @slot primary-action - Slot for the primary action elements. Used when in `split` state.
+ * @slot trigger - Slot for the trigger elements.
+ * @slot - Default slot for the menu list.
+ *
+ * @method connectedCallback - Called when the element is connected to the DOM. Sets up the component.
+ * @method disconnectedCallback - Called when the element is disconnected from the DOM. Removes event listeners.
+ * @method setComponent - Sets the component state.
+ * @method toggleMenu - Toggles the open state of the menu.
+ * @method closeMenu - Closes the menu.
+ * @method openMenu - Opens the menu.
+ * @method focusMenuList - Focuses on the menu list.
+ * @method focusTrigger - Focuses on the menu trigger.
+ * @method openOnHoverChanged - Called whenever the 'openOnHover' property changes.
+ * @method persistOnItemClickChanged - Called whenever the 'persistOnItemClick' property changes.
+ * @method openOnContextChanged - Called whenever the 'openOnContext' property changes.
+ * @method closeOnScrollChanged - Called whenever the 'closeOnScroll' property changes.
+ * @method addListeners - Adds event listeners.
+ * @method removeListeners - Removes event listeners.
+ * @method menuKeydownHandler - Handles keyboard interaction for the menu.
+ * @method triggerKeydownHandler - Handles keyboard interaction for the trigger.
+ * @method documentClickHandler - Handles document click events to close the menu when a click occurs outside of the menu or the trigger.
+ *
+ * @summary The Menu component functions as a customizable menu element.
+ *
+ * @tag fluent-menu
+ *
  * @public
  */
 export declare class Menu extends FASTElement {
@@ -26,10 +66,10 @@ export declare class Menu extends FASTElement {
      */
     persistOnItemClick?: boolean;
     /**
-     * Defines whether the menu is open or not.
+     * Determines if the menu is in split state.
      * @public
      */
-    open: boolean;
+    split?: boolean;
     /**
      * Holds the slotted menu list.
      * @public
@@ -41,25 +81,25 @@ export declare class Menu extends FASTElement {
      */
     slottedTriggers: HTMLElement[];
     /**
-     * The positioning container of the menu.
+     * Holds the primary slot element.
+     * @public
+     */
+    primaryAction: HTMLSlotElement;
+    /**
+     * Defines whether the menu is open or not.
      * @internal
      */
-    positioningContainer?: HTMLElement;
+    private _open;
     /**
      * The trigger element of the menu.
-     * @private
+     * @internal
      */
     private _trigger?;
     /**
-     * The menu list element of the menu.
-     * @private
+     * The menu list element of the menu which has the popover behavior.
+     * @internal
      */
     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.
@@ -87,7 +127,7 @@ export declare class Menu extends FASTElement {
      * Closes the menu.
      * @public
      */
-    closeMenu: () => void;
+    closeMenu: (event?: Event) => void;
     /**
      * Opens the menu.
      * @public
@@ -104,91 +144,83 @@ export declare class Menu extends FASTElement {
      */
     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
+     * Handles the 'toggle' event on the popover.
      * @public
-     * @param {boolean} oldValue - The previous value of 'open'.
-     * @param {boolean} newValue - The new value of 'open'.
+     * @param e - the event
+     * @returns void
      */
-    openChanged(oldValue: boolean, newValue: boolean): 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.
+     *
+     * @param oldValue - The previous value of 'openOnHover'.
+     * @param newValue - The new value of 'openOnHover'.
      * @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'.
+     * @param oldValue - The previous value of 'persistOnItemClick'.
+     * @param 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'.
+     * @param oldValue - The previous value of 'openOnContext'.
+     * @param 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'.
+     * @param oldValue - The previous value of 'closeOnScroll'.
+     * @param 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.
+     * Adds click and keydown event listeners to the trigger.
+     * Adds a 'toggle' event listener to the menu list.
      * If 'openOnHover' is true, adds a 'mouseover' event listener to the trigger.
-     * @public
+     * If 'openOnContext' is true, adds a 'contextmenu' event listener to the trigger and a document 'click' event listener.
+     * @internal
      */
     private addListeners;
     /**
      * Removes event listeners.
-     * Removes click and keydown event listeners from the trigger and a click event listener from the document.
+     * Removes click and keydown event listeners from the trigger.
+     * Also removes toggle event listener from the menu list.
      * Also removes 'mouseover' event listeners from the trigger.
-     * @private
+     * Also removes 'contextmenu' event listeners from the trigger and document 'click' event listeners.
+     * @internal
      */
     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.
+     * 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.
+     *
+     * @param e - the keyboard event
      * @public
-     * @param {KeyboardEvent} e - the keyboard event
      */
-    handleMenuKeydown(e: KeyboardEvent): boolean | void;
+    menuKeydownHandler(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.
+     * 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.
+     *
+     * @param e - the keyboard event
      * @public
-     * @param {KeyboardEvent} e - the keyboard event
      */
-    handleTriggerKeydown: (e: KeyboardEvent) => boolean | void;
+    triggerKeydownHandler: (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.
+     * Handles document click events to close a menu opened with contextmenu in popover="manual" mode.
+     * @internal
+     * @param e - The event triggered on document click.
      */
-    private handleDocumentClick;
+    private documentClickHandler;
 }

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

@@ -1,4 +1,4 @@
-import { ElementViewTemplate } from '@microsoft/fast-element';
+import { type 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,6 @@
-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';
+export { MenuButton } from './menu-button.js';
+export { MenuButtonAppearance, MenuButtonShape, MenuButtonSize } from './menu-button.options.js';
+export type { MenuButtonOptions } from './menu-button.options.js';
+export { template as MenuButtonTemplate } from './menu-button.template.js';

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

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

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

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

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

@@ -1,4 +1,4 @@
-import type { ButtonOptions } from '../button/index.js';
+import type { ButtonOptions } from '../button/button.options.js';
 import type { ValuesOf } from '../utils/index.js';
 /**
  * Menu Button Appearance constants
@@ -8,14 +8,13 @@ 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>;
+export type MenuButtonAppearance = ValuesOf<typeof MenuButtonAppearance>;
 /**
  * A Menu Button can be square, circular or rounded.
  * @public
@@ -29,7 +28,7 @@ export declare const MenuButtonShape: {
  * A Menu Button can be square, circular or rounded
  * @public
  */
-export declare type MenuButtonShape = ValuesOf<typeof MenuButtonShape>;
+export type MenuButtonShape = ValuesOf<typeof MenuButtonShape>;
 /**
  * A Menu Button can be a size of small, medium or large.
  * @public
@@ -43,5 +42,5 @@ export declare const MenuButtonSize: {
  * A Menu Button can be on of several preset sizes.
  * @public
  */
-export declare type MenuButtonSize = ValuesOf<typeof MenuButtonSize>;
-export { ButtonOptions as MenuButtonOptions };
+export type MenuButtonSize = ValuesOf<typeof MenuButtonSize>;
+export type { ButtonOptions as MenuButtonOptions };

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

@@ -1,4 +1,4 @@
-import { ElementViewTemplate } from '@microsoft/fast-element';
+import { type ElementViewTemplate } from '@microsoft/fast-element';
 import type { MenuButton } from './menu-button.js';
 /**
  * The template for the Button component.

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

@@ -1,4 +1,6 @@
-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';
+export { MenuItem } from './menu-item.js';
+export type { MenuItemColumnCount, MenuItemOptions } from './menu-item.js';
+export { MenuItemRole, roleForMenuItem } from './menu-item.options.js';
+export { styles as MenuItemStyles } from './menu-item.styles.js';
+export { template as MenuItemTemplate } from './menu-item.template.js';

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

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