@vonage/vivid 3.0.0-next.45 → 3.0.0-next.48

package/menu/index.js

@@ -0,0 +1,661 @@
+import { P as Popup } from '../shared/index3.js';
+import { F as FoundationElement, D as DOM, _ as __decorate, a as attr, o as observable, b as __metadata, h as html, d as designSystem } from '../shared/index.js';
+import { s as styleInject } from '../shared/style-inject.es.js';
+import '../shared/web.dom-collections.iterator.js';
+import { S as StartEnd } from '../shared/aria-global.js';
+import { a as applyMixins } from '../shared/apply-mixins.js';
+import { a as keyArrowLeft, b as keyArrowRight, k as keySpace, c as keyEnter, d as keyHome, e as keyEnd, f as keyArrowUp, g as keyArrowDown } from '../shared/form-associated.js';
+import { s as slotted } from '../shared/slotted.js';
+import '../shared/index2.js';
+import '../shared/class-names.js';
+import '../button/index.js';
+import '../icon/index.js';
+import '../shared/icon.js';
+import '../shared/export.js';
+import '../shared/iterators.js';
+import '../shared/to-string.js';
+import '../shared/_has.js';
+import '../shared/when.js';
+import '../focus/index.js';
+import '../shared/focus.js';
+import '../shared/affix.js';
+import '../shared/button.js';
+import '../shared/focus2.js';
+import '../shared/ref.js';
+import '../shared/object-keys.js';
+import '../shared/es.object.assign.js';
+
+/**
+ * A test that ensures that all arguments are HTML Elements
+ */
+function isHTMLElement(...args) {
+    return args.every((arg) => arg instanceof HTMLElement);
+}
+
+/**
+ * Expose ltr and rtl strings
+ */
+var Direction;
+(function (Direction) {
+    Direction["ltr"] = "ltr";
+    Direction["rtl"] = "rtl";
+})(Direction || (Direction = {}));
+
+/**
+ * a method to determine the current localization direction of the view
+ * @param rootNode - the HTMLElement to begin the query from, usually "this" when used in a component controller
+ * @public
+ */
+const getDirection = (rootNode) => {
+    const dirNode = rootNode.closest("[dir]");
+    return dirNode !== null && dirNode.dir === "rtl" ? Direction.rtl : Direction.ltr;
+};
+
+/**
+ * Menu items roles.
+ * @public
+ */
+const MenuItemRole = {
+    /**
+     * The menu item has a "menuitem" role
+     */
+    menuitem: "menuitem",
+    /**
+     * The menu item has a "menuitemcheckbox" role
+     */
+    menuitemcheckbox: "menuitemcheckbox",
+    /**
+     * The menu item has a "menuitemradio" role
+     */
+    menuitemradio: "menuitemradio",
+};
+/**
+ * @internal
+ */
+const roleForMenuItem = {
+    [MenuItemRole.menuitem]: "menuitem",
+    [MenuItemRole.menuitemcheckbox]: "menuitemcheckbox",
+    [MenuItemRole.menuitemradio]: "menuitemradio",
+};
+
+/**
+ * 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
+ */
+class MenuItem extends FoundationElement {
+    constructor() {
+        super(...arguments);
+        /**
+         * The role of the element.
+         *
+         * @public
+         * @remarks
+         * HTML Attribute: role
+         */
+        this.role = MenuItemRole.menuitem;
+        /**
+         * @internal
+         */
+        this.hasSubmenu = false;
+        /**
+         * Track current direction to pass to the anchored region
+         *
+         * @internal
+         */
+        this.currentDirection = Direction.ltr;
+        this.focusSubmenuOnLoad = false;
+        /**
+         * @internal
+         */
+        this.handleMenuItemKeyDown = (e) => {
+            if (e.defaultPrevented) {
+                return false;
+            }
+            switch (e.key) {
+                case keyEnter:
+                case keySpace:
+                    this.invoke();
+                    return false;
+                case keyArrowRight:
+                    //open/focus on submenu
+                    this.expandAndFocus();
+                    return false;
+                case keyArrowLeft:
+                    //close submenu
+                    if (this.expanded) {
+                        this.expanded = false;
+                        this.focus();
+                        return false;
+                    }
+            }
+            return true;
+        };
+        /**
+         * @internal
+         */
+        this.handleMenuItemClick = (e) => {
+            if (e.defaultPrevented || this.disabled) {
+                return false;
+            }
+            this.invoke();
+            return false;
+        };
+        /**
+         * @internal
+         */
+        this.submenuLoaded = () => {
+            if (!this.focusSubmenuOnLoad) {
+                return;
+            }
+            this.focusSubmenuOnLoad = false;
+            if (this.hasSubmenu) {
+                this.submenu.focus();
+                this.setAttribute("tabindex", "-1");
+            }
+        };
+        /**
+         * @internal
+         */
+        this.handleMouseOver = (e) => {
+            if (this.disabled || !this.hasSubmenu || this.expanded) {
+                return false;
+            }
+            this.expanded = true;
+            return false;
+        };
+        /**
+         * @internal
+         */
+        this.handleMouseOut = (e) => {
+            if (!this.expanded || this.contains(document.activeElement)) {
+                return false;
+            }
+            this.expanded = false;
+            return false;
+        };
+        /**
+         * @internal
+         */
+        this.expandAndFocus = () => {
+            if (!this.hasSubmenu) {
+                return;
+            }
+            this.focusSubmenuOnLoad = true;
+            this.expanded = true;
+        };
+        /**
+         * @internal
+         */
+        this.invoke = () => {
+            if (this.disabled) {
+                return;
+            }
+            switch (this.role) {
+                case MenuItemRole.menuitemcheckbox:
+                    this.checked = !this.checked;
+                    break;
+                case MenuItemRole.menuitem:
+                    // update submenu
+                    this.updateSubmenu();
+                    if (this.hasSubmenu) {
+                        this.expandAndFocus();
+                    }
+                    else {
+                        this.$emit("change");
+                    }
+                    break;
+                case MenuItemRole.menuitemradio:
+                    if (!this.checked) {
+                        this.checked = true;
+                    }
+                    break;
+            }
+        };
+        /**
+         * Gets the submenu element if any
+         *
+         * @internal
+         */
+        this.updateSubmenu = () => {
+            this.submenu = this.domChildren().find((element) => {
+                return element.getAttribute("role") === "menu";
+            });
+            this.hasSubmenu = this.submenu === undefined ? false : true;
+        };
+    }
+    expandedChanged(oldValue) {
+        if (this.$fastController.isConnected) {
+            if (this.submenu === undefined) {
+                return;
+            }
+            if (this.expanded === false) {
+                this.submenu.collapseExpandedItem();
+            }
+            else {
+                this.currentDirection = getDirection(this);
+            }
+            this.$emit("expanded-change", this, { bubbles: false });
+        }
+    }
+    checkedChanged(oldValue, newValue) {
+        if (this.$fastController.isConnected) {
+            this.$emit("change");
+        }
+    }
+    /**
+     * @internal
+     */
+    connectedCallback() {
+        super.connectedCallback();
+        DOM.queueUpdate(() => {
+            this.updateSubmenu();
+        });
+        if (!this.startColumnCount) {
+            this.startColumnCount = 1;
+        }
+        this.observer = new MutationObserver(this.updateSubmenu);
+    }
+    /**
+     * @internal
+     */
+    disconnectedCallback() {
+        super.disconnectedCallback();
+        this.submenu = undefined;
+        if (this.observer !== undefined) {
+            this.observer.disconnect();
+            this.observer = undefined;
+        }
+    }
+    /**
+     * get an array of valid DOM children
+     */
+    domChildren() {
+        return Array.from(this.children).filter(child => !child.hasAttribute("hidden"));
+    }
+}
+__decorate([
+    attr({ mode: "boolean" })
+], MenuItem.prototype, "disabled", void 0);
+__decorate([
+    attr({ mode: "boolean" })
+], MenuItem.prototype, "expanded", void 0);
+__decorate([
+    observable
+], MenuItem.prototype, "startColumnCount", void 0);
+__decorate([
+    attr
+], MenuItem.prototype, "role", void 0);
+__decorate([
+    attr({ mode: "boolean" })
+], MenuItem.prototype, "checked", void 0);
+__decorate([
+    observable
+], MenuItem.prototype, "submenuRegion", void 0);
+__decorate([
+    observable
+], MenuItem.prototype, "hasSubmenu", void 0);
+__decorate([
+    observable
+], MenuItem.prototype, "currentDirection", void 0);
+__decorate([
+    observable
+], MenuItem.prototype, "submenu", void 0);
+applyMixins(MenuItem, StartEnd);
+
+/**
+ * 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
+ */
+class Menu$1 extends FoundationElement {
+    constructor() {
+        super(...arguments);
+        this.expandedItem = null;
+        /**
+         * The index of the focusable element in the items array
+         * defaults to -1
+         */
+        this.focusIndex = -1;
+        /**
+         * @internal
+         */
+        this.isNestedMenu = () => {
+            return (this.parentElement !== null &&
+                isHTMLElement(this.parentElement) &&
+                this.parentElement.getAttribute("role") === "menuitem");
+        };
+        /**
+         * if focus is moving out of the menu, reset to a stable initial state
+         * @internal
+         */
+        this.handleFocusOut = (e) => {
+            if (!this.contains(e.relatedTarget) && this.menuItems !== undefined) {
+                this.collapseExpandedItem();
+                // find our first focusable element
+                const focusIndex = this.menuItems.findIndex(this.isFocusableElement);
+                // set the current focus index's tabindex to -1
+                this.menuItems[this.focusIndex].setAttribute("tabindex", "-1");
+                // set the first focusable element tabindex to 0
+                this.menuItems[focusIndex].setAttribute("tabindex", "0");
+                // set the focus index
+                this.focusIndex = focusIndex;
+            }
+        };
+        this.handleItemFocus = (e) => {
+            const targetItem = e.target;
+            if (this.menuItems !== undefined &&
+                targetItem !== this.menuItems[this.focusIndex]) {
+                this.menuItems[this.focusIndex].setAttribute("tabindex", "-1");
+                this.focusIndex = this.menuItems.indexOf(targetItem);
+                targetItem.setAttribute("tabindex", "0");
+            }
+        };
+        this.handleExpandedChanged = (e) => {
+            if (e.defaultPrevented ||
+                e.target === null ||
+                this.menuItems === undefined ||
+                this.menuItems.indexOf(e.target) < 0) {
+                return;
+            }
+            e.preventDefault();
+            const changedItem = e.target;
+            // closing an expanded item without opening another
+            if (this.expandedItem !== null &&
+                changedItem === this.expandedItem &&
+                changedItem.expanded === false) {
+                this.expandedItem = null;
+                return;
+            }
+            if (changedItem.expanded) {
+                if (this.expandedItem !== null && this.expandedItem !== changedItem) {
+                    this.expandedItem.expanded = false;
+                }
+                this.menuItems[this.focusIndex].setAttribute("tabindex", "-1");
+                this.expandedItem = changedItem;
+                this.focusIndex = this.menuItems.indexOf(changedItem);
+                changedItem.setAttribute("tabindex", "0");
+            }
+        };
+        this.removeItemListeners = () => {
+            if (this.menuItems !== undefined) {
+                this.menuItems.forEach((item) => {
+                    item.removeEventListener("expanded-change", this.handleExpandedChanged);
+                    item.removeEventListener("focus", this.handleItemFocus);
+                });
+            }
+        };
+        this.setItems = () => {
+            const newItems = this.domChildren();
+            this.removeItemListeners();
+            this.menuItems = newItems;
+            const menuItems = this.menuItems.filter(this.isMenuItemElement);
+            // if our focus index is not -1 we have items
+            if (menuItems.length) {
+                this.focusIndex = 0;
+            }
+            function elementIndent(el) {
+                const role = el.getAttribute("role");
+                const startSlot = el.querySelector("[slot=start]");
+                if (role !== MenuItemRole.menuitem && startSlot === null) {
+                    return 1;
+                }
+                else if (role === MenuItemRole.menuitem && startSlot !== null) {
+                    return 1;
+                }
+                else if (role !== MenuItemRole.menuitem && startSlot !== null) {
+                    return 2;
+                }
+                else {
+                    return 0;
+                }
+            }
+            const indent = menuItems.reduce((accum, current) => {
+                const elementValue = elementIndent(current);
+                return accum > elementValue ? accum : elementValue;
+            }, 0);
+            menuItems.forEach((item, index) => {
+                item.setAttribute("tabindex", index === 0 ? "0" : "-1");
+                item.addEventListener("expanded-change", this.handleExpandedChanged);
+                item.addEventListener("focus", this.handleItemFocus);
+                if (item instanceof MenuItem) {
+                    item.startColumnCount = indent;
+                }
+            });
+        };
+        /**
+         * handle change from child element
+         */
+        this.changeHandler = (e) => {
+            if (this.menuItems === undefined) {
+                return;
+            }
+            const changedMenuItem = e.target;
+            const changeItemIndex = this.menuItems.indexOf(changedMenuItem);
+            if (changeItemIndex === -1) {
+                return;
+            }
+            if (changedMenuItem.role === "menuitemradio" &&
+                changedMenuItem.checked === true) {
+                for (let i = changeItemIndex - 1; i >= 0; --i) {
+                    const item = this.menuItems[i];
+                    const role = item.getAttribute("role");
+                    if (role === MenuItemRole.menuitemradio) {
+                        item.checked = false;
+                    }
+                    if (role === "separator") {
+                        break;
+                    }
+                }
+                const maxIndex = this.menuItems.length - 1;
+                for (let i = changeItemIndex + 1; i <= maxIndex; ++i) {
+                    const item = this.menuItems[i];
+                    const role = item.getAttribute("role");
+                    if (role === MenuItemRole.menuitemradio) {
+                        item.checked = false;
+                    }
+                    if (role === "separator") {
+                        break;
+                    }
+                }
+            }
+        };
+        /**
+         * check if the item is a menu item
+         */
+        this.isMenuItemElement = (el) => {
+            return (isHTMLElement(el) &&
+                Menu$1.focusableElementRoles.hasOwnProperty(el.getAttribute("role")));
+        };
+        /**
+         * check if the item is focusable
+         */
+        this.isFocusableElement = (el) => {
+            return this.isMenuItemElement(el);
+        };
+    }
+    itemsChanged(oldValue, newValue) {
+        // only update children after the component is connected and
+        // the setItems has run on connectedCallback
+        // (menuItems is undefined until then)
+        if (this.$fastController.isConnected && this.menuItems !== undefined) {
+            this.setItems();
+        }
+    }
+    /**
+     * @internal
+     */
+    connectedCallback() {
+        super.connectedCallback();
+        DOM.queueUpdate(() => {
+            // wait until children have had a chance to
+            // connect before setting/checking their props/attributes
+            this.setItems();
+        });
+        this.addEventListener("change", this.changeHandler);
+    }
+    /**
+     * @internal
+     */
+    disconnectedCallback() {
+        super.disconnectedCallback();
+        this.removeItemListeners();
+        this.menuItems = undefined;
+        this.removeEventListener("change", this.changeHandler);
+    }
+    /**
+     * Focuses the first item in the menu.
+     *
+     * @public
+     */
+    focus() {
+        this.setFocus(0, 1);
+    }
+    /**
+     * Collapses any expanded menu items.
+     *
+     * @public
+     */
+    collapseExpandedItem() {
+        if (this.expandedItem !== null) {
+            this.expandedItem.expanded = false;
+            this.expandedItem = null;
+        }
+    }
+    /**
+     * @internal
+     */
+    handleMenuKeyDown(e) {
+        if (e.defaultPrevented || this.menuItems === undefined) {
+            return;
+        }
+        switch (e.key) {
+            case keyArrowDown:
+                // go forward one index
+                this.setFocus(this.focusIndex + 1, 1);
+                return;
+            case keyArrowUp:
+                // go back one index
+                this.setFocus(this.focusIndex - 1, -1);
+                return;
+            case keyEnd:
+                // set focus on last item
+                this.setFocus(this.menuItems.length - 1, -1);
+                return;
+            case keyHome:
+                // set focus on first item
+                this.setFocus(0, 1);
+                return;
+            default:
+                // if we are not handling the event, do not prevent default
+                return true;
+        }
+    }
+    /**
+     * get an array of valid DOM children
+     */
+    domChildren() {
+        return Array.from(this.children).filter(child => !child.hasAttribute("hidden"));
+    }
+    setFocus(focusIndex, adjustment) {
+        if (this.menuItems === undefined) {
+            return;
+        }
+        while (focusIndex >= 0 && focusIndex < this.menuItems.length) {
+            const child = this.menuItems[focusIndex];
+            if (this.isFocusableElement(child)) {
+                // change the previous index to -1
+                if (this.focusIndex > -1 &&
+                    this.menuItems.length >= this.focusIndex - 1) {
+                    this.menuItems[this.focusIndex].setAttribute("tabindex", "-1");
+                }
+                // update the focus index
+                this.focusIndex = focusIndex;
+                // update the tabindex of next focusable element
+                child.setAttribute("tabindex", "0");
+                // focus the element
+                child.focus();
+                break;
+            }
+            focusIndex += adjustment;
+        }
+    }
+}
+Menu$1.focusableElementRoles = roleForMenuItem;
+__decorate([
+    observable
+], Menu$1.prototype, "items", void 0);
+
+var css_248z = ".base {\n  padding-block: 8px;\n}";
+styleInject(css_248z);
+
+class Menu extends Menu$1 {
+  constructor() {
+    super(...arguments);
+    this.open = false;
+  }
+
+}
+
+__decorate([attr({
+  mode: 'boolean'
+}), __metadata("design:type", Object)], Menu.prototype, "open", void 0);
+
+__decorate([attr, __metadata("design:type", String)], Menu.prototype, "placement", void 0);
+
+__decorate([attr, __metadata("design:type", String)], Menu.prototype, "anchor", void 0);
+
+let _ = t => t,
+    _t;
+const MenuTemplate = context => {
+  const popupTag = context.tagFor(Popup);
+  return html(_t || (_t = _`
+		<template
+			slot="${0}"
+		>
+			<${0}
+				placement=${0}
+				open=${0}
+				anchor=${0}
+			>
+				<div
+					class="base"
+					role="menu"
+					@keydown="${0}"
+					@focusout="${0}"
+				>
+					<slot ${0}></slot>
+				</div>
+		</${0}>
+	</template>`), x => x.slot || x.isNestedMenu() ? 'submenu' : void 0, popupTag, x => x.placement, x => x.open, x => x.anchor, (x, c) => x.handleMenuKeyDown(c.event), (x, c) => x.handleFocusOut(c.event), slotted('items'), popupTag);
+};
+
+const vividMenu = Menu.compose({
+  baseName: 'menu',
+  template: MenuTemplate,
+  styles: css_248z
+});
+designSystem.register(vividMenu());
+
+export { vividMenu };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vonage/vivid",
-  "version": "3.0.0-next.45",
+  "version": "3.0.0-next.48",
   "type": "module",
   "module": "./index.esm.js",
   "main": "./index.js",
@@ -38,12 +38,12 @@
     "./nav": "./nav",
     "./nav-item": "./nav-item",
     "./nav-disclosure": "./nav-disclosure",
-    "./text": "./text",
     "./text-field": "./text-field",
     "./tooltip": "./tooltip",
     "./checkbox": "./checkbox",
     "./dialog": "./dialog",
-    "./divider": "./divider"
+    "./divider": "./divider",
+    "./menu": "./menu"
   },
   "typings": "./index.d.ts",
   "dependencies": {