@spectrum-web-components/menu 1.2.0-beta.8 → 1.2.0

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@spectrum-web-components/menu",
-    "version": "1.2.0-beta.8",
+    "version": "1.2.0",
     "publishConfig": {
         "access": "public"
     },
@@ -90,15 +90,15 @@
     ],
     "dependencies": {
         "@lit-labs/observers": "^2.0.2",
-        "@spectrum-web-components/action-button": "^1.2.0-beta.8",
-        "@spectrum-web-components/base": "^1.2.0-beta.8",
-        "@spectrum-web-components/divider": "^1.2.0-beta.8",
-        "@spectrum-web-components/icon": "^1.2.0-beta.8",
-        "@spectrum-web-components/icons-ui": "^1.2.0-beta.8",
-        "@spectrum-web-components/overlay": "^1.2.0-beta.8",
-        "@spectrum-web-components/popover": "^1.2.0-beta.8",
-        "@spectrum-web-components/reactive-controllers": "^1.2.0-beta.8",
-        "@spectrum-web-components/shared": "^1.2.0-beta.8"
+        "@spectrum-web-components/action-button": "^1.2.0",
+        "@spectrum-web-components/base": "^1.2.0",
+        "@spectrum-web-components/divider": "^1.2.0",
+        "@spectrum-web-components/icon": "^1.2.0",
+        "@spectrum-web-components/icons-ui": "^1.2.0",
+        "@spectrum-web-components/overlay": "^1.2.0",
+        "@spectrum-web-components/popover": "^1.2.0",
+        "@spectrum-web-components/reactive-controllers": "^1.2.0",
+        "@spectrum-web-components/shared": "^1.2.0"
     },
     "devDependencies": {
         "@spectrum-css/menu": "8.0.0-s2-foundations.17"
@@ -109,5 +109,5 @@
         "./sp-*.js",
         "./**/*.dev.js"
     ],
-    "gitHead": "740377aa5f17e15650d4871e3034bd9c9a2f5c35"
+    "gitHead": "e4aec7b389e6209984e4df74f9b86b3ee0c485dd"
 }

package/src/Menu.d.ts

@@ -1,5 +1,7 @@
 import { CSSResultArray, PropertyValues, SpectrumElement, TemplateResult } from '@spectrum-web-components/base';
 import { MenuItem } from './MenuItem.js';
+import type { MenuItemKeydownEvent } from './MenuItem.js';
+import { RovingTabindexController } from '@spectrum-web-components/reactive-controllers/src/RovingTabindex.js';
 export interface MenuChildItem {
     menuItem: MenuItem;
     managed: boolean;
@@ -26,21 +28,54 @@ declare const Menu_base: typeof SpectrumElement & {
  */
 export declare class Menu extends Menu_base {
     static get styles(): CSSResultArray;
+    static shadowRootOptions: {
+        delegatesFocus: boolean;
+        mode: ShadowRootMode;
+        slotAssignment?: SlotAssignmentMode | undefined;
+    };
     private get isSubmenu();
+    protected rovingTabindexController?: RovingTabindexController<MenuItem>;
+    /**
+     * label of the menu
+     */
     label: string;
+    /**
+     * whether menu should be ignored by roving tabindex controller
+     */
     ignore: boolean;
+    /**
+     * how the menu allows selection of its items:
+     * - `undefined` (default): no selection is allowed
+     * - `"inherit"`: the selection behavior is managed from an ancestor
+     * - `"single"`: only one item can be selected at a time
+     *  - `"multiple"`: multiple items can be selected
+     */
     selects: undefined | 'inherit' | 'single' | 'multiple';
+    /**
+     * value of the selected item(s)
+     */
     value: string;
     valueSeparator: string;
+    /**
+     * selected items values as string
+     */
     get selected(): string[];
     set selected(selected: string[]);
     protected _selected: string[];
+    /**
+     * array of selected menu items
+     */
     selectedItems: MenuItem[];
     menuSlot: HTMLSlotElement;
     private childItemSet;
     focusedItemIndex: number;
     focusInItemIndex: number;
+    get focusInItem(): MenuItem | undefined;
+    protected get controlsRovingTabindex(): boolean;
     private selectedItemsMap;
+    /**
+     * child items managed by menu
+     */
     get childItems(): MenuItem[];
     private cachedChildItems;
     private updateCachedMenuItems;
@@ -53,7 +88,13 @@ export declare class Menu extends Menu_base {
      */
     get childRole(): string;
     protected get ownRole(): string;
+    /**
+     * menuitem role based on selection type
+     */
     private resolvedSelects?;
+    /**
+     * menu role based on selection type
+     */
     private resolvedRole?;
     /**
      * When a descendant `<sp-menu-item>` element is added or updated it will dispatch
@@ -74,34 +115,44 @@ export declare class Menu extends Menu_base {
     private addChildItem;
     private removeChildItem;
     constructor();
+    /**
+     * for picker elements, will set focus on first selected item
+     */
+    focusOnFirstSelectedItem({ preventScroll, }?: FocusOptions): void;
     focus({ preventScroll }?: FocusOptions): void;
     private pointerUpTarget;
+    private handleFocusout;
     private handleClick;
     private handlePointerup;
     private handlePointerBasedSelection;
-    handleFocusin(event: FocusEvent): void;
-    startListeningToKeyboard(): void;
-    handleBlur(event: FocusEvent): void;
-    stopListeningToKeyboard(): void;
     private descendentOverlays;
     protected handleDescendentOverlayOpened(event: Event): void;
     protected handleDescendentOverlayClosed(event: Event): void;
     handleSubmenuClosed: (event: Event) => void;
+    /**
+     * given a menu item, returns the next focusable menu item before or after it;
+     * if no menu item is provided, returns the first focusable menu item
+     * @param menuItem {MenuItem}
+     * @param before {boolean} return the item before; default is false
+     * @returns {MenuItem}
+     */
+    getNeighboringFocusableElement(menuItem?: MenuItem, before?: boolean): MenuItem;
     handleSubmenuOpened: (event: Event) => void;
     selectOrToggleItem(targetItem: MenuItem): Promise<void>;
-    protected navigateWithinMenu(event: KeyboardEvent): void;
-    protected navigateBetweenRelatedMenus(event: KeyboardEvent): void;
-    handleKeydown(event: KeyboardEvent): void;
-    focusMenuItemByOffset(offset: number): MenuItem;
-    private prepareToCleanUp;
+    protected navigateBetweenRelatedMenus(event: MenuItemKeydownEvent): void;
+    handleKeydown(event: Event): void;
     private _hasUpdatedSelectedItemIndex;
+    /**
+     * on focus, removes focus from focus styling item, and updates the selected item index
+     */
+    private prepareToCleanUp;
     updateSelectedItemIndex(): void;
     private _willUpdateItems;
+    private _updateFocus?;
     private handleItemsChanged;
     private updateCache;
     private updateItemFocus;
     closeDescendentOverlays(): void;
-    private forwardFocusVisibleToItem;
     private handleSlotchange;
     protected renderMenuItemSlot(): TemplateResult;
     render(): TemplateResult;
@@ -109,6 +160,7 @@ export declare class Menu extends Menu_base {
     protected updated(changes: PropertyValues<this>): void;
     protected selectsChanged(): void;
     connectedCallback(): void;
+    private isFocusableElement;
     disconnectedCallback(): void;
     protected childItemsUpdated: Promise<unknown[]>;
     protected cacheUpdated: Promise<void>;