adobe / spectrum-web-components / 13968910853

/*

Copyright 2020 Adobe. All rights reserved.

This file is licensed to you under the Apache License, Version 2.0 (the "License");

you may not use this file except in compliance with the License. You may obtain a copy

of the License at http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under

the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS

OF ANY KIND, either express or implied. See the License for the specific language

governing permissions and limitations under the License.

*/

import {

    CSSResultArray,

    html,

    PropertyValues,

    SizedMixin,

    SpectrumElement,

    TemplateResult,

} from '@spectrum-web-components/base';

import {

    property,

    query,

} from '@spectrum-web-components/base/src/decorators.js';

import { MenuItem } from './MenuItem.js';

import type {

    MenuItemAddedOrUpdatedEvent,

    MenuItemKeydownEvent,

} from './MenuItem.js';

import type { Overlay } from '@spectrum-web-components/overlay';

import menuStyles from './menu.css.js';

import { RovingTabindexController } from '@spectrum-web-components/reactive-controllers/src/RovingTabindex.js';

export interface MenuChildItem {

    menuItem: MenuItem;

    managed: boolean;

    active: boolean;

    focusable: boolean;

    focusRoot: Menu;

}

type SelectsType = 'none' | 'ignore' | 'inherit' | 'multiple' | 'single';

type RoleType = 'group' | 'menu' | 'listbox' | 'none';

/**

 * Spectrum Menu Component

 * @element sp-menu

 *

 * @slot - menu items to be listed in the menu

 * @fires change - Announces that the `value` of the element has changed

 * @attr selects - whether the element has a specific selection algorithm that it applies

 *   to its item descendants. `single` allows only one descendent to be selected at a time.

 *   `multiple` allows many descendants to be selected. `inherit` will be applied dynamically

 *   when an ancestor of this element is actively managing the selection of its descendents.

 *   When the `selects` attribute is not present a `value` will not be maintained and the Menu

 *   Item children of this Menu will not have their `selected` state managed.

 */

export class Menu extends SizedMixin(SpectrumElement, { noDefaultSize: true }) {

    public static override get styles(): CSSResultArray {

        return [menuStyles];

    }

    static override shadowRootOptions = {

        ...SpectrumElement.shadowRootOptions,

        delegatesFocus: true,

    };

    private get isSubmenu(): boolean {

        return this.slot === 'submenu';

    }

    protected rovingTabindexController?: RovingTabindexController<MenuItem>;

    /**

     * label of the menu

     */

    @property({ type: String, reflect: true })

    public label = '';

    /**

     * whether menu should be ignored by roving tabindex controller

     */

    @property({ type: Boolean, reflect: true })

    public ignore = false;

    /**

     * 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

     */

    @property({ type: String, reflect: true })

    public selects: undefined | 'inherit' | 'single' | 'multiple';

    /**

     * value of the selected item(s)

     */

    @property({ type: String })

    public value = '';

    // For the multiple select case, we'll join the value strings together

    // for the value property with this separator

    @property({ type: String, attribute: 'value-separator' })

    public valueSeparator = ',';

    /**

     * selected items values as string

     */

    @property({ attribute: false })

    public get selected(): string[] {

        return !this.selects ? [] : this._selected;

    }

    public set selected(selected: string[]) {

        const old = this.selected;

        this._selected = selected;

        this.selectedItems = [];

        this.selectedItemsMap.clear();

        this.childItems.forEach((item) => {

            if (this !== item.menuData.selectionRoot) {

                return;

            }

            item.selected = this.selected.includes(item.value);

            if (item.selected) {

                this.selectedItems.push(item);

                this.selectedItemsMap.set(item, true);

            }

        });

        this.requestUpdate('selected', old);

    }

    protected _selected = [] as string[];

    /**

     * array of selected menu items

     */

    @property({ attribute: false })

    public selectedItems = [] as MenuItem[];

    @query('slot:not([name])')

    public menuSlot!: HTMLSlotElement;

    private childItemSet = new Set<MenuItem>();

    public focusedItemIndex = 0;

    public focusInItemIndex = 0;

    /**

     * whether or not to support pointerdown - drag - pointerup selection strategy

     * default is true

     * should be false for mobile to prevent click event being captured behind the menu-tray (cz menu immediately closes on pointerup)

     */

    public shouldSupportDragAndSelect = true;

    public get focusInItem(): MenuItem | undefined {

        return this.rovingTabindexController?.focusInElement;

    }

    protected get controlsRovingTabindex(): boolean {

        return true;

    }

    private selectedItemsMap = new Map<MenuItem, boolean>();

    /**

     * child items managed by menu

     */

    public get childItems(): MenuItem[] {

        if (!this.cachedChildItems) {

            this.cachedChildItems = this.updateCachedMenuItems();

        }

        return this.cachedChildItems;

    }

    private cachedChildItems: MenuItem[] | undefined;

    private updateCachedMenuItems(): MenuItem[] {

        if (!this.menuSlot) {

            return [];

        }

        const itemsList = [];

        const slottedElements = this.menuSlot.assignedElements({

            flatten: true,

        }) as HTMLElement[];

        // Recursively flatten <slot> and non-<sp-menu-item> elements assigned to the menu into a single array.

        for (const [i, slottedElement] of slottedElements.entries()) {

            if (this.childItemSet.has(slottedElement as MenuItem)) {

                // Assign <sp-menu-item> members of the array that are in this.childItemSet to this.chachedChildItems.

                itemsList.push(slottedElement as MenuItem);

                continue;

            }

            const isHTMLSlotElement = slottedElement.localName === 'slot';

            const flattenedChildren = isHTMLSlotElement

                ? (slottedElement as HTMLSlotElement).assignedElements({

                      flatten: true,

                  })

                : [...slottedElement.querySelectorAll(`:scope > *`)];

            slottedElements.splice(

                i,

                1,

                slottedElement,

                ...(flattenedChildren as HTMLElement[])

            );

        }

        this.cachedChildItems = [...itemsList];

        this.rovingTabindexController?.clearElementCache();

        return this.cachedChildItems;

    }

    /**

     * Hide this getter from web-component-analyzer until

     * https://github.com/runem/web-component-analyzer/issues/131

     * has been addressed.

     *

     * @private

     */

    public get childRole(): string {

        if (this.resolvedRole === 'listbox') {

            return 'option';

        }

        switch (this.resolvedSelects) {

            case 'single':

                return 'menuitemradio';

            case 'multiple':

                return 'menuitemcheckbox';

            default:

                return 'menuitem';

        }

    }

    protected get ownRole(): string {

        return 'menu';

    }

    /**

     * menuitem role based on selection type

     */

    private resolvedSelects?: SelectsType;

    /**

     * menu role based on selection type

     */

    private resolvedRole?: RoleType;

    /**

     * When a descendant `<sp-menu-item>` element is added or updated it will dispatch

     * this event to announce its presence in the DOM. During the CAPTURE phase the first

     * Menu based element that the event encounters will manage the focus state of the

     * dispatching `<sp-menu-item>` element.

     * @param event

     */

    private onFocusableItemAddedOrUpdated(

        event: MenuItemAddedOrUpdatedEvent

    ): void {

        event.menuCascade.set(this, {

            hadFocusRoot: !!event.item.menuData.focusRoot,

            ancestorWithSelects: event.currentAncestorWithSelects,

        });

        if (this.selects) {

            event.currentAncestorWithSelects = this;

        }

        event.item.menuData.focusRoot = event.item.menuData.focusRoot || this;

    }

    /**

     * When a descendant `<sp-menu-item>` element is added or updated it will dispatch

     * this event to announce its presence in the DOM. During the BUBBLE phase the first

     * Menu based element that the event encounters that does not inherit selection will

     * manage the selection state of the dispatching `<sp-menu-item>` element.

     * @param event

     */

    private onSelectableItemAddedOrUpdated(

        event: MenuItemAddedOrUpdatedEvent

    ): void {

        const cascadeData = event.menuCascade.get(this);

        /* c8 ignore next 1 */

        if (!cascadeData) return;

        event.item.menuData.parentMenu = event.item.menuData.parentMenu || this;

        this.addChildItem(event.item);

        if (this.selects === 'inherit') {

            this.resolvedSelects = 'inherit';

            this.resolvedRole = ignoreMenu

                ? 'none'

        } else if (this.selects) {

            this.resolvedSelects = this.selects;

        } else {

            this.resolvedSelects =

                this.resolvedRole === 'none' ? 'ignore' : 'none';

        }

        if (this.resolvedRole === 'none') {

            return;

        }

        const selects =

            this.resolvedSelects === 'single' ||

            this.resolvedSelects === 'multiple';

        event.item.menuData.cleanupSteps.push((item: MenuItem) =>

            this.removeChildItem(item)

        );

        if (

            (selects || (!this.selects && this.resolvedSelects !== 'ignore')) &&

            !event.item.menuData.selectionRoot

        ) {

            event.item.setRole(this.childRole);

            event.item.menuData.selectionRoot =

                event.item.menuData.selectionRoot || this;

            if (event.item.selected) {

                this.selectedItemsMap.set(event.item, true);

                this.selectedItems = [...this.selectedItems, event.item];

                this._selected = [...this.selected, event.item.value];

                this.value = this.selected.join(this.valueSeparator);

            }

        }

    }

    private addChildItem(item: MenuItem): void {

        this.childItemSet.add(item);

        this.handleItemsChanged();

    }

    private async removeChildItem(item: MenuItem): Promise<void> {

        if (item.focused || item.hasAttribute('focused') || item.active) {

            this._updateFocus = this.getNeighboringFocusableElement(item);

        }

        this.childItemSet.delete(item);

        this.cachedChildItems = undefined;

    }

    public constructor() {

        super();

        /**

         * only create an RTI if menu controls keyboard navigation and one does not already exist

         */

        if (!this.rovingTabindexController && this.controlsRovingTabindex) {

            this.rovingTabindexController =

                new RovingTabindexController<MenuItem>(this, {

                    direction: 'vertical',

                    focusInIndex: (elements: MenuItem[] | undefined) => {

                        let firstEnabledIndex = -1;

                            (el, index) => {

                                if (

                                    !elements[firstEnabledIndex] &&

                                    !el.disabled

                                ) {

                                    firstEnabledIndex = index;

                                }

                                return el.selected && !el.disabled;

                            }

                        );

                        return elements &&

                            firstSelectedIndex &&

                            elements[firstSelectedIndex]

                            ? firstSelectedIndex

                            : firstEnabledIndex;

                    },

                    elements: () => this.childItems,

                    isFocusableElement: this.isFocusableElement.bind(this),

                    hostDelegatesFocus: true,

                });

        }

        this.addEventListener(

            'sp-menu-item-added-or-updated',

            this.onSelectableItemAddedOrUpdated

        );

        this.addEventListener(

            'sp-menu-item-added-or-updated',

            this.onFocusableItemAddedOrUpdated,

            {

                capture: true,

            }

        );

        this.addEventListener('click', this.handleClick);

        this.addEventListener('mouseover', this.handleMouseover);

        this.addEventListener('focusout', this.handleFocusout);

        this.addEventListener('sp-menu-item-keydown', this.handleKeydown);

        this.addEventListener('pointerup', this.handlePointerup);

        this.addEventListener('sp-opened', this.handleSubmenuOpened);

        this.addEventListener('sp-closed', this.handleSubmenuClosed);

    }

    /**

     * for picker elements, will set focus on first selected item

     */

    public focusOnFirstSelectedItem({

        preventScroll,

    }: FocusOptions = {}): void {

        const selectedItem = this.selectedItems.find((el) =>

            this.isFocusableElement(el)

        );

        if (!selectedItem) {

            this.focus({ preventScroll });

            return;

        }

        if (selectedItem && !preventScroll) {

            selectedItem.scrollIntoView({ block: 'nearest' });

        }

    }

    public override focus({ preventScroll }: FocusOptions = {}): void {

        if (this.rovingTabindexController) {

            if (

                !this.childItems.length ||

                this.childItems.every((childItem) => childItem.disabled)

            ) {

                return;

            }

            if (

                this.childItems.some(

                    (childItem) => childItem.menuData.focusRoot !== this

                )

            this.rovingTabindexController.focus({ preventScroll });

        }

    }

    // if the click and pointerup events are on the same target, we should not

    // handle the click event.

    private pointerUpTarget = null as EventTarget | null;

    private handleMouseover(event: MouseEvent): void {

        const { target } = event;

        const menuItem = target as MenuItem;

        if (

            this.childItems.includes(menuItem) &&

            this.isFocusableElement(menuItem)

        ) {

            this.rovingTabindexController?.focusOnItem(menuItem);

        }

    }

    private handleFocusout(): void {

        if (!this.matches(':focus-within'))

            this.rovingTabindexController?.reset();

    }

    private handleClick(event: Event): void {

        if (this.pointerUpTarget === event.target) {

            this.pointerUpTarget = null;

            return;

        }

        this.handlePointerBasedSelection(event);

    }

    private handlePointerup(event: Event): void {

        /*

         * early return if drag and select is not supported

         * in this case, selection will be handled by the click event

         */

        this.pointerUpTarget = event.target;

        this.handlePointerBasedSelection(event);

    }

    private async handlePointerBasedSelection(event: Event): Promise<void> {

        // Only handle left clicks

        if (event instanceof MouseEvent && event.button !== 0) {

            return;

        }

        const path = event.composedPath();

        const target = path.find((el) => {

            /* c8 ignore next 3 */

            if (!(el instanceof Element)) {

                return false;

            }

            return el.getAttribute('role') === this.childRole;

        }) as MenuItem;

        if (event.defaultPrevented) {

            const index = this.childItems.indexOf(target);

            if (target?.menuData?.focusRoot === this && index > -1) {

                this.focusedItemIndex = index;

            }

            return;

        }

        if (target?.href && target.href.length) {

            // This event will NOT ALLOW CANCELATION as link action

            // cancelation should occur on the `<sp-menu-item>` itself.

            await new Promise((resolve) => {

                this.dispatchEvent(

                    new Event('change', {

                        bubbles: true,

                        composed: true,

                    })

                );

                resolve(true);

            });

            return;

        } else if (

            target?.menuData?.selectionRoot === this &&

            this.childItems.length

        ) {

            event.preventDefault();

            this.selectOrToggleItem(target);

        } else {

            return;

        }

        this.prepareToCleanUp();

    }

    private descendentOverlays = new Map<Overlay, Overlay>();

    protected handleDescendentOverlayOpened(event: Event): void {

        const target = event.composedPath()[0] as MenuItem;

        /* c8 ignore next 1 */

        if (!target.overlayElement) return;

        this.descendentOverlays.set(

            target.overlayElement,

            target.overlayElement

        );

    }

    protected handleDescendentOverlayClosed(event: Event): void {

        const target = event.composedPath()[0] as MenuItem;

        /* c8 ignore next 1 */

        if (!target.overlayElement) return;

        this.descendentOverlays.delete(target.overlayElement);

    }

    public handleSubmenuClosed = (event: Event): void => {

        event.stopPropagation();

        const target = event.composedPath()[0] as Overlay;

        target.dispatchEvent(

            new Event('sp-menu-submenu-closed', {

                bubbles: true,

                composed: true,

            })

        );

    };

    /**

     * 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}

     */

    public getNeighboringFocusableElement(

        menuItem?: MenuItem,

        before = false

    ): MenuItem {

        const diff = before ? -1 : 1;

        const elements = this.rovingTabindexController?.elements || [];

        const index = !!menuItem ? elements.indexOf(menuItem) : -1;

        let newIndex = Math.min(Math.max(0, index + diff), elements.length - 1);

        while (

            !this.isFocusableElement(elements[newIndex]) &&

            0 < newIndex &&

            newIndex < elements.length - 1

        ) {

            newIndex += diff;

        }

        return !!this.isFocusableElement(elements[newIndex])

            ? (elements[newIndex] as MenuItem)

    }

    public handleSubmenuOpened = (event: Event): void => {

        event.stopPropagation();

        const target = event.composedPath()[0] as Overlay;

        target.dispatchEvent(

            new Event('sp-menu-submenu-opened', {

                bubbles: true,

                composed: true,

            })

        );

        const openedItem = event

            .composedPath()

            .find((el) => this.childItemSet.has(el as MenuItem));

        /* c8 ignore next 1 */

        if (!openedItem) return;

    };

    public async selectOrToggleItem(targetItem: MenuItem): Promise<void> {

        const resolvedSelects = this.resolvedSelects;

        const oldSelectedItemsMap = new Map(this.selectedItemsMap);

        const oldSelected = this.selected.slice();

        const oldSelectedItems = this.selectedItems.slice();

        const oldValue = this.value;

        if (targetItem.menuData.selectionRoot !== this) {

            return;

        }

        if (resolvedSelects === 'multiple') {

            if (this.selectedItemsMap.has(targetItem)) {

                this.selectedItemsMap.delete(targetItem);

            } else {

                this.selectedItemsMap.set(targetItem, true);

            }

            // Match HTML select and set the first selected

            // item as the value. Also set the selected array

            // in the order of the menu items.

            const selected: string[] = [];

            const selectedItems: MenuItem[] = [];

            this.childItemSet.forEach((childItem) => {

                if (this.selectedItemsMap.has(childItem)) {

                    selected.push(childItem.value);

                    selectedItems.push(childItem);

                }

            });

            this._selected = selected;

            this.selectedItems = selectedItems;

            this.value = this.selected.join(this.valueSeparator);

        } else {

            this.selectedItemsMap.clear();

            this.selectedItemsMap.set(targetItem, true);

            this.value = targetItem.value;

            this._selected = [targetItem.value];

            this.selectedItems = [targetItem];

        }

        const applyDefault = this.dispatchEvent(

            new Event('change', {

                cancelable: true,

                bubbles: true,

                composed: true,

            })

        );

        if (!applyDefault) {

            // Cancel the event & don't apply the selection

            this._selected = oldSelected;

            this.selectedItems = oldSelectedItems;

            this.selectedItemsMap = oldSelectedItemsMap;

            this.value = oldValue;

            return;

        }

        // Apply the selection changes to the menu items

        if (resolvedSelects === 'single') {

            for (const oldItem of oldSelectedItemsMap.keys()) {

                if (oldItem !== targetItem) {

                    oldItem.selected = false;

                }

            }

            targetItem.selected = true;

        } else if (resolvedSelects === 'multiple') {

            targetItem.selected = !targetItem.selected;

        } else if (

            !targetItem.hasSubmenu &&

        ) {

            this.dispatchEvent(new Event('close', { bubbles: true }));

        }

    }

    protected navigateBetweenRelatedMenus(event: MenuItemKeydownEvent): void {

        const { key, root } = event;

        const shouldOpenSubmenu =

            (this.isLTR && key === 'ArrowRight') ||

            (!this.isLTR && key === 'ArrowLeft');

        const shouldCloseSelfAsSubmenu =

            (this.isLTR && key === 'ArrowLeft') ||

            (!this.isLTR && key === 'ArrowRight') ||

            key === 'Escape';

        const lastFocusedItem = root as MenuItem;

        if (shouldOpenSubmenu) {

                //open submenu and set focus

                event.stopPropagation();

                lastFocusedItem.openOverlay();

            }

        } else if (shouldCloseSelfAsSubmenu && this.isSubmenu) {

            event.stopPropagation();

            this.dispatchEvent(new Event('close', { bubbles: true }));

            this.updateSelectedItemIndex();

        }

    }

    public handleKeydown(event: Event): void {

        if (event.defaultPrevented || !this.rovingTabindexController) {

            return;

        }

        const { key, root, shiftKey, target } = event as MenuItemKeydownEvent;

        const openSubmenuKey = ['Enter', ' '].includes(key);

        if (key === 'Tab') {

            this.closeDescendentOverlays();

            return;

        }

        if (openSubmenuKey && root?.hasSubmenu && !root.open) {

            // Remove focus while opening overlay from keyboard or the visible focus

            // will slip back to the first item in the menu.

            event.preventDefault();

            root.openOverlay();

            return;

        }

        if (key === ' ' || key === 'Enter') {

            event.preventDefault();

            if (root) this.selectOrToggleItem(root);

            return;

        }

        this.navigateBetweenRelatedMenus(event as MenuItemKeydownEvent);

    }

    private _hasUpdatedSelectedItemIndex = false;

    /**

     * on focus, removes focus from focus styling item, and updates the selected item index

     */

    private prepareToCleanUp(): void {

        document.addEventListener(

            'focusout',

            () => {

                requestAnimationFrame(() => {

                    const focusedItem = this.focusInItem;

                    if (focusedItem) {

                        focusedItem.focused = false;

                    }

                });

            },

            { once: true }

        );

    }

    public updateSelectedItemIndex(): void {

        let firstOrFirstSelectedIndex = 0;

        const selectedItemsMap = new Map<MenuItem, boolean>();

        const selected: string[] = [];

        const selectedItems: MenuItem[] = [];

        let itemIndex = this.childItems.length;

        while (itemIndex) {

            itemIndex -= 1;

            const childItem = this.childItems[itemIndex];

            if (childItem.menuData.selectionRoot === this) {

                if (

                    childItem.selected ||

                    (!this._hasUpdatedSelectedItemIndex &&

                        this.selected.includes(childItem.value))

                ) {

                    firstOrFirstSelectedIndex = itemIndex;

                    selectedItemsMap.set(childItem, true);

                    selected.unshift(childItem.value);

                    selectedItems.unshift(childItem);

                }

                // Remove "focused" from non-"selected" items ONLY

                // Preserve "focused" on index===0 when no selection

                if (itemIndex !== firstOrFirstSelectedIndex) {

                    childItem.focused = false;

                }

            }

        }

        this.selectedItemsMap = selectedItemsMap;

        this._selected = selected;

        this.selectedItems = selectedItems;

        this.value = this.selected.join(this.valueSeparator);

        this.focusedItemIndex = firstOrFirstSelectedIndex;

        this.focusInItemIndex = firstOrFirstSelectedIndex;

    }

    private _willUpdateItems = false;

    private _updateFocus?: MenuItem;

    private handleItemsChanged(): void {

        this.cachedChildItems = undefined;

        if (!this._willUpdateItems) {

            this._willUpdateItems = true;

            this.cacheUpdated = this.updateCache();

        }

    }

    private async updateCache(): Promise<void> {

        } else {

            await new Promise((res) => requestAnimationFrame(() => res(true)));

        }

        if (this.cachedChildItems === undefined) {

            this.updateSelectedItemIndex();

            this.updateItemFocus();

        }

        this._willUpdateItems = false;

    }

    private updateItemFocus(): void {

        this.focusInItem?.setAttribute('tabindex', '0');

        if (this.childItems.length == 0) {

            return;

        }

    }

    public closeDescendentOverlays(): void {

        this.descendentOverlays.forEach((overlay) => {

            overlay.open = false;

        });

        this.descendentOverlays = new Map<Overlay, Overlay>();

    }

    private handleSlotchange({

        target,

    }: Event & { target: HTMLSlotElement }): void {

        const assignedElements = target.assignedElements({

            flatten: true,

        }) as MenuItem[];

        if (this.childItems.length !== assignedElements.length) {

            assignedElements.forEach((item) => {

                if (typeof item.triggerUpdate !== 'undefined') {