primevue 3.16.2 → 3.18.0

package/tieredmenu/TieredMenu.vue

@@ -1,28 +1,52 @@
 <template>
     <Portal :appendTo="appendTo" :disabled="!popup">
-        <transition name="p-connected-overlay" @enter="onEnter" @leave="onLeave" @after-leave="onAfterLeave">
-            <div :ref="containerRef" :class="containerClass" v-if="popup ? visible : true" v-bind="$attrs" @click="onOverlayClick">
-                <TieredMenuSub :model="model" :root="true" :popup="popup" @leaf-click="onLeafClick" :template="$slots.item" :exact="exact" />
+        <transition name="p-connected-overlay" @enter="onEnter" @after-enter="onAfterEnter" @leave="onLeave" @after-leave="onAfterLeave">
+            <div v-if="visible" :ref="containerRef" :id="id" :class="containerClass" @click="onOverlayClick" v-bind="$attrs">
+                <TieredMenuSub
+                    :ref="menubarRef"
+                    :id="id + '_list'"
+                    class="p-tieredmenu-root-list"
+                    :tabindex="!disabled ? tabindex : -1"
+                    role="menubar"
+                    :aria-label="ariaLabel"
+                    :aria-labelledby="ariaLabelledby"
+                    :aria-disabled="disabled || undefined"
+                    aria-orientation="vertical"
+                    :aria-activedescendant="focused ? focusedItemId : undefined"
+                    :menuId="id"
+                    :focusedItemId="focused ? focusedItemId : undefined"
+                    :items="processedItems"
+                    :template="$slots.item"
+                    :activeItemPath="activeItemPath"
+                    :exact="exact"
+                    :level="0"
+                    @focus="onFocus"
+                    @blur="onBlur"
+                    @keydown="onKeyDown"
+                    @item-click="onItemClick"
+                    @item-mouseenter="onItemMouseEnter"
+                />
             </div>
         </transition>
     </Portal>
 </template>
 
 <script>
-import {ConnectedOverlayScrollHandler,DomHandler,ZIndexUtils} from 'primevue/utils';
 import OverlayEventBus from 'primevue/overlayeventbus';
 import Portal from 'primevue/portal';
+import { ConnectedOverlayScrollHandler, DomHandler, ObjectUtils, UniqueComponentId, ZIndexUtils } from 'primevue/utils';
 import TieredMenuSub from './TieredMenuSub.vue';
 
 export default {
     name: 'TieredMenu',
     inheritAttrs: false,
+    emits: ['focus', 'blur', 'before-show', 'before-hide', 'hide', 'show'],
     props: {
         popup: {
             type: Boolean,
             default: false
         },
-		model: {
+        model: {
             type: Array,
             default: null
         },
@@ -41,68 +65,365 @@ export default {
         exact: {
             type: Boolean,
             default: true
+        },
+        disabled: {
+            type: Boolean,
+            default: false
+        },
+        tabindex: {
+            type: Number,
+            default: 0
+        },
+        'aria-labelledby': {
+            type: String,
+            default: null
+        },
+        'aria-label': {
+            type: String,
+            default: null
         }
     },
-    target: null,
-    container: null,
     outsideClickListener: null,
     scrollHandler: null,
     resizeListener: null,
+    target: null,
+    container: null,
+    menubar: null,
+    searchTimeout: null,
+    searchValue: null,
     data() {
         return {
-            visible: false
+            focused: false,
+            focusedItemInfo: { index: -1, level: 0, parentKey: '' },
+            activeItemPath: [],
+            visible: !this.popup,
+            dirty: false
         };
     },
+    watch: {
+        activeItemPath(newPath) {
+            if (!this.popup) {
+                if (ObjectUtils.isNotEmpty(newPath)) {
+                    this.bindOutsideClickListener();
+                    this.bindResizeListener();
+                } else {
+                    this.unbindOutsideClickListener();
+                    this.unbindResizeListener();
+                }
+            }
+        }
+    },
     beforeUnmount() {
-        this.unbindResizeListener();
         this.unbindOutsideClickListener();
+        this.unbindResizeListener();
 
         if (this.scrollHandler) {
             this.scrollHandler.destroy();
             this.scrollHandler = null;
         }
-        this.target = null;
+
         if (this.container && this.autoZIndex) {
             ZIndexUtils.clear(this.container);
         }
+
+        this.target = null;
         this.container = null;
     },
     methods: {
-        itemClick(event) {
-            const item = event.item;
-            if (item.command) {
-                item.command(event);
-                event.originalEvent.preventDefault();
-            }
-            this.hide();
+        getItemProp(item, name) {
+            return item ? ObjectUtils.getItemValue(item[name]) : undefined;
+        },
+        getItemLabel(item) {
+            return this.getItemProp(item, 'label');
+        },
+        isItemDisabled(item) {
+            return this.getItemProp(item, 'disabled');
+        },
+        isItemGroup(item) {
+            return ObjectUtils.isNotEmpty(this.getItemProp(item, 'items'));
+        },
+        isItemSeparator(item) {
+            return this.getItemProp(item, 'separator');
+        },
+        getProccessedItemLabel(processedItem) {
+            return processedItem ? this.getItemLabel(processedItem.item) : undefined;
+        },
+        isProccessedItemGroup(processedItem) {
+            return processedItem && ObjectUtils.isNotEmpty(processedItem.items);
         },
         toggle(event) {
-            if (this.visible)
-                this.hide();
-            else
-                this.show(event);
+            this.visible ? this.hide(event) : this.show(event);
         },
-        show(event) {
-            this.visible = true;
-            this.target = event.currentTarget;
+        show(event, isFocus) {
+            if (this.popup) {
+                this.$emit('before-show');
+                this.visible = true;
+                this.target = this.target || event.currentTarget;
+            }
+
+            this.focusedItemInfo = { index: this.findFirstFocusedItemIndex(), level: 0, parentKey: '' };
+
+            isFocus && DomHandler.focus(this.menubar);
         },
-        hide() {
-            this.visible = false;
+        hide(event, isFocus) {
+            if (this.popup) {
+                this.$emit('before-hide');
+                this.visible = false;
+            }
+
+            this.activeItemPath = [];
+            this.focusedItemInfo = { index: -1, level: 0, parentKey: '' };
+
+            isFocus && DomHandler.focus(this.target || this.menubar);
+            this.dirty = false;
+        },
+        onFocus(event) {
+            this.focused = true;
+            this.focusedItemInfo = this.focusedItemInfo.index !== -1 ? this.focusedItemInfo : { index: this.findFirstFocusedItemIndex(), level: 0, parentKey: '' };
+
+            this.$emit('focus', event);
+        },
+        onBlur(event) {
+            this.focused = false;
+            this.focusedItemInfo = { index: -1, level: 0, parentKey: '' };
+            this.searchValue = '';
+            this.dirty = false;
+            this.$emit('blur', event);
+        },
+        onKeyDown(event) {
+            if (this.disabled) {
+                event.preventDefault();
+
+                return;
+            }
+
+            const metaKey = event.metaKey || event.ctrlKey;
+
+            switch (event.code) {
+                case 'ArrowDown':
+                    this.onArrowDownKey(event);
+                    break;
+
+                case 'ArrowUp':
+                    this.onArrowUpKey(event);
+                    break;
+
+                case 'ArrowLeft':
+                    this.onArrowLeftKey(event);
+                    break;
+
+                case 'ArrowRight':
+                    this.onArrowRightKey(event);
+                    break;
+
+                case 'Home':
+                    this.onHomeKey(event);
+                    break;
+
+                case 'End':
+                    this.onEndKey(event);
+                    break;
+
+                case 'Space':
+                    this.onSpaceKey(event);
+                    break;
+
+                case 'Enter':
+                    this.onEnterKey(event);
+                    break;
+
+                case 'Escape':
+                    this.onEscapeKey(event);
+                    break;
+
+                case 'Tab':
+                    this.onTabKey(event);
+                    break;
+
+                case 'PageDown':
+                case 'PageUp':
+                case 'Backspace':
+                case 'ShiftLeft':
+                case 'ShiftRight':
+                    //NOOP
+                    break;
+
+                default:
+                    if (!metaKey && ObjectUtils.isPrintableCharacter(event.key)) {
+                        this.searchItems(event, event.key);
+                    }
+
+                    break;
+            }
+        },
+        onItemChange(event) {
+            const { processedItem, isFocus } = event;
+
+            if (ObjectUtils.isEmpty(processedItem)) return;
+
+            const { index, key, level, parentKey, items } = processedItem;
+            const grouped = ObjectUtils.isNotEmpty(items);
+
+            const activeItemPath = this.activeItemPath.filter((p) => p.parentKey !== parentKey && p.parentKey !== key);
+
+            grouped && activeItemPath.push(processedItem);
+
+            this.focusedItemInfo = { index, level, parentKey };
+            this.activeItemPath = activeItemPath;
+
+            grouped && (this.dirty = true);
+            isFocus && DomHandler.focus(this.menubar);
+        },
+        onOverlayClick(event) {
+            OverlayEventBus.emit('overlay-click', {
+                originalEvent: event,
+                target: this.target
+            });
+        },
+        onItemClick(event) {
+            const { originalEvent, processedItem } = event;
+            const grouped = this.isProccessedItemGroup(processedItem);
+            const root = ObjectUtils.isEmpty(processedItem.parent);
+            const selected = this.isSelected(processedItem);
+
+            if (selected) {
+                const { index, key, level, parentKey } = processedItem;
+
+                this.activeItemPath = this.activeItemPath.filter((p) => key !== p.key && key.startsWith(p.key));
+                this.focusedItemInfo = { index, level, parentKey };
+
+                this.dirty = !root;
+                DomHandler.focus(this.menubar);
+            } else {
+                grouped ? this.onItemChange(event) : this.hide(originalEvent, !root);
+            }
+        },
+        onItemMouseEnter(event) {
+            if (this.dirty) {
+                this.onItemChange(event);
+            }
+        },
+        onArrowDownKey(event) {
+            const itemIndex = this.focusedItemInfo.index !== -1 ? this.findNextItemIndex(this.focusedItemInfo.index) : this.findFirstFocusedItemIndex();
+
+            this.changeFocusedItemIndex(event, itemIndex);
+            event.preventDefault();
+        },
+        onArrowUpKey(event) {
+            if (event.altKey) {
+                if (this.focusedItemInfo.index !== -1) {
+                    const processedItem = this.visibleItems[this.focusedItemInfo.index];
+                    const grouped = this.isProccessedItemGroup(processedItem);
+
+                    !grouped && this.onItemChange({ originalEvent: event, processedItem });
+                }
+
+                this.popup && this.hide(event, true);
+                event.preventDefault();
+            } else {
+                const itemIndex = this.focusedItemInfo.index !== -1 ? this.findPrevItemIndex(this.focusedItemInfo.index) : this.findLastFocusedItemIndex();
+
+                this.changeFocusedItemIndex(event, itemIndex);
+                event.preventDefault();
+            }
+        },
+        onArrowLeftKey(event) {
+            const processedItem = this.visibleItems[this.focusedItemInfo.index];
+            const parentItem = this.activeItemPath.find((p) => p.key === processedItem.parentKey);
+            const root = ObjectUtils.isEmpty(processedItem.parent);
+
+            if (!root) {
+                this.focusedItemInfo = { index: -1, parentKey: parentItem ? parentItem.parentKey : '' };
+                this.searchValue = '';
+                this.onArrowDownKey(event);
+            }
+
+            this.activeItemPath = this.activeItemPath.filter((p) => p.parentKey !== this.focusedItemInfo.parentKey);
+
+            event.preventDefault();
+        },
+        onArrowRightKey(event) {
+            const processedItem = this.visibleItems[this.focusedItemInfo.index];
+            const grouped = this.isProccessedItemGroup(processedItem);
+
+            if (grouped) {
+                this.onItemChange({ originalEvent: event, processedItem });
+                this.focusedItemInfo = { index: -1, parentKey: processedItem.key };
+                this.searchValue = '';
+                this.onArrowDownKey(event);
+            }
+
+            event.preventDefault();
+        },
+        onHomeKey(event) {
+            this.changeFocusedItemIndex(event, this.findFirstItemIndex());
+            event.preventDefault();
+        },
+        onEndKey(event) {
+            this.changeFocusedItemIndex(event, this.findLastItemIndex());
+            event.preventDefault();
+        },
+        onEnterKey(event) {
+            if (this.focusedItemInfo.index !== -1) {
+                const element = DomHandler.findSingle(this.menubar, `li[id="${`${this.focusedItemId}`}"]`);
+                const anchorElement = element && DomHandler.findSingle(element, '.p-menuitem-link');
+
+                anchorElement ? anchorElement.click() : element && element.click();
+
+                if (!this.popup) {
+                    const processedItem = this.visibleItems[this.focusedItemInfo.index];
+                    const grouped = this.isProccessedItemGroup(processedItem);
+
+                    !grouped && (this.focusedItemInfo.index = this.findFirstFocusedItemIndex());
+                }
+            }
+
+            event.preventDefault();
+        },
+        onSpaceKey(event) {
+            this.onEnterKey(event);
+        },
+        onEscapeKey(event) {
+            this.hide(event, true);
+            !this.popup && (this.focusedItemInfo.index = this.findFirstFocusedItemIndex());
+
+            event.preventDefault();
+        },
+        onTabKey(event) {
+            if (this.focusedItemInfo.index !== -1) {
+                const processedItem = this.visibleItems[this.focusedItemInfo.index];
+                const grouped = this.isProccessedItemGroup(processedItem);
+
+                !grouped && this.onItemChange({ originalEvent: event, processedItem });
+            }
+
+            this.hide();
         },
         onEnter(el) {
+            if (this.autoZIndex) {
+                ZIndexUtils.set('menu', el, this.baseZIndex + this.$primevue.config.zIndex.menu);
+            }
+
+            DomHandler.focus(this.menubar);
+
             this.alignOverlay();
+            this.scrollInView();
+        },
+        onAfterEnter() {
             this.bindOutsideClickListener();
-            this.bindResizeListener();
             this.bindScrollListener();
+            this.bindResizeListener();
 
-            if (this.autoZIndex) {
-                ZIndexUtils.set('menu', el, this.baseZIndex + this.$primevue.config.zIndex.menu);
-            }
+            this.$emit('show');
         },
         onLeave() {
             this.unbindOutsideClickListener();
-            this.unbindResizeListener();
             this.unbindScrollListener();
+            this.unbindResizeListener();
+
+            this.$emit('hide');
+            this.container = null;
+            this.dirty = false;
         },
         onAfterLeave(el) {
             if (this.autoZIndex) {
@@ -110,16 +431,20 @@ export default {
             }
         },
         alignOverlay() {
-            DomHandler.absolutePosition(this.container, this.target);
             this.container.style.minWidth = DomHandler.getOuterWidth(this.target) + 'px';
+            DomHandler.absolutePosition(this.container, this.target);
         },
         bindOutsideClickListener() {
             if (!this.outsideClickListener) {
                 this.outsideClickListener = (event) => {
-                    if (this.visible && this.container && !this.container.contains(event.target) && !this.isTargetClicked(event)) {
+                    const isOutsideContainer = this.container && !this.container.contains(event.target);
+                    const isOutsideTarget = this.popup ? !(this.target && (this.target === event.target || this.target.contains(event.target))) : true;
+
+                    if (isOutsideContainer && isOutsideTarget) {
                         this.hide();
                     }
                 };
+
                 document.addEventListener('click', this.outsideClickListener);
             }
         },
@@ -131,10 +456,8 @@ export default {
         },
         bindScrollListener() {
             if (!this.scrollHandler) {
-                this.scrollHandler = new ConnectedOverlayScrollHandler(this.target, () => {
-                    if (this.visible) {
-                        this.hide();
-                    }
+                this.scrollHandler = new ConnectedOverlayScrollHandler(this.target, (event) => {
+                    this.hide(event, true);
                 });
             }
 
@@ -147,11 +470,12 @@ export default {
         },
         bindResizeListener() {
             if (!this.resizeListener) {
-                this.resizeListener = () => {
-                    if (this.visible && !DomHandler.isTouchDevice()) {
-                        this.hide();
+                this.resizeListener = (event) => {
+                    if (!DomHandler.isTouchDevice()) {
+                        this.hide(event, true);
                     }
                 };
+
                 window.addEventListener('resize', this.resizeListener);
             }
         },
@@ -161,38 +485,156 @@ export default {
                 this.resizeListener = null;
             }
         },
-        isTargetClicked(event) {
-            return this.target && (this.target === event.target || this.target.contains(event.target));
+        isItemMatched(processedItem) {
+            return this.isValidItem(processedItem) && this.getProccessedItemLabel(processedItem).toLocaleLowerCase().startsWith(this.searchValue.toLocaleLowerCase());
         },
-        onLeafClick() {
-            if (this.popup) {
-                this.hide();
+        isValidItem(processedItem) {
+            return !!processedItem && !this.isItemDisabled(processedItem.item) && !this.isItemSeparator(processedItem.item);
+        },
+        isValidSelectedItem(processedItem) {
+            return this.isValidItem(processedItem) && this.isSelected(processedItem);
+        },
+        isSelected(processedItem) {
+            return this.activeItemPath.some((p) => p.key === processedItem.key);
+        },
+        findFirstItemIndex() {
+            return this.visibleItems.findIndex((processedItem) => this.isValidItem(processedItem));
+        },
+        findLastItemIndex() {
+            return ObjectUtils.findLastIndex(this.visibleItems, (processedItem) => this.isValidItem(processedItem));
+        },
+        findNextItemIndex(index) {
+            const matchedItemIndex = index < this.visibleItems.length - 1 ? this.visibleItems.slice(index + 1).findIndex((processedItem) => this.isValidItem(processedItem)) : -1;
+
+            return matchedItemIndex > -1 ? matchedItemIndex + index + 1 : index;
+        },
+        findPrevItemIndex(index) {
+            const matchedItemIndex = index > 0 ? ObjectUtils.findLastIndex(this.visibleItems.slice(0, index), (processedItem) => this.isValidItem(processedItem)) : -1;
+
+            return matchedItemIndex > -1 ? matchedItemIndex : index;
+        },
+        findSelectedItemIndex() {
+            return this.visibleItems.findIndex((processedItem) => this.isValidSelectedItem(processedItem));
+        },
+        findFirstFocusedItemIndex() {
+            const selectedIndex = this.findSelectedItemIndex();
+
+            return selectedIndex < 0 ? this.findFirstItemIndex() : selectedIndex;
+        },
+        findLastFocusedItemIndex() {
+            const selectedIndex = this.findSelectedItemIndex();
+
+            return selectedIndex < 0 ? this.findLastItemIndex() : selectedIndex;
+        },
+        searchItems(event, char) {
+            this.searchValue = (this.searchValue || '') + char;
+
+            let itemIndex = -1;
+            let matched = false;
+
+            if (this.focusedItemInfo.index !== -1) {
+                itemIndex = this.visibleItems.slice(this.focusedItemInfo.index).findIndex((processedItem) => this.isItemMatched(processedItem));
+                itemIndex = itemIndex === -1 ? this.visibleItems.slice(0, this.focusedItemInfo.index).findIndex((processedItem) => this.isItemMatched(processedItem)) : itemIndex + this.focusedItemInfo.index;
+            } else {
+                itemIndex = this.visibleItems.findIndex((processedItem) => this.isItemMatched(processedItem));
+            }
+
+            if (itemIndex !== -1) {
+                matched = true;
+            }
+
+            if (itemIndex === -1 && this.focusedItemInfo.index === -1) {
+                itemIndex = this.findFirstFocusedItemIndex();
+            }
+
+            if (itemIndex !== -1) {
+                this.changeFocusedItemIndex(event, itemIndex);
+            }
+
+            if (this.searchTimeout) {
+                clearTimeout(this.searchTimeout);
             }
+
+            this.searchTimeout = setTimeout(() => {
+                this.searchValue = '';
+                this.searchTimeout = null;
+            }, 500);
+
+            return matched;
+        },
+        changeFocusedItemIndex(event, index) {
+            if (this.focusedItemInfo.index !== index) {
+                this.focusedItemInfo.index = index;
+                this.scrollInView();
+            }
+        },
+        scrollInView(index = -1) {
+            const id = index !== -1 ? `${this.id}_${index}` : this.focusedItemId;
+            const element = DomHandler.findSingle(this.menubar, `li[id="${id}"]`);
+
+            if (element) {
+                element.scrollIntoView && element.scrollIntoView({ block: 'nearest', inline: 'start' });
+            }
+        },
+        createProcessedItems(items, level = 0, parent = {}, parentKey = '') {
+            const processedItems = [];
+
+            items &&
+                items.forEach((item, index) => {
+                    const key = (parentKey !== '' ? parentKey + '_' : '') + index;
+                    const newItem = {
+                        item,
+                        index,
+                        level,
+                        key,
+                        parent,
+                        parentKey
+                    };
+
+                    newItem['items'] = this.createProcessedItems(item.items, level + 1, newItem, key);
+                    processedItems.push(newItem);
+                });
+
+            return processedItems;
         },
         containerRef(el) {
             this.container = el;
         },
-        onOverlayClick(event) {
-            OverlayEventBus.emit('overlay-click', {
-                originalEvent: event,
-                target: this.target
-            });
+        menubarRef(el) {
+            this.menubar = el ? el.$el : undefined;
         }
     },
     computed: {
         containerClass() {
-            return ['p-tieredmenu p-component', {
-                'p-tieredmenu-overlay': this.popup,
-                'p-input-filled': this.$primevue.config.inputStyle === 'filled',
-                'p-ripple-disabled': this.$primevue.config.ripple === false
-            }];
+            return [
+                'p-tieredmenu p-component',
+                {
+                    'p-tieredmenu-overlay': this.popup,
+                    'p-input-filled': this.$primevue.config.inputStyle === 'filled',
+                    'p-ripple-disabled': this.$primevue.config.ripple === false
+                }
+            ];
+        },
+        processedItems() {
+            return this.createProcessedItems(this.model || []);
+        },
+        visibleItems() {
+            const processedItem = this.activeItemPath.find((p) => p.key === this.focusedItemInfo.parentKey);
+
+            return processedItem ? processedItem.items : this.processedItems;
+        },
+        id() {
+            return this.$attrs.id || UniqueComponentId();
+        },
+        focusedItemId() {
+            return this.focusedItemInfo.index !== -1 ? `${this.id}${ObjectUtils.isNotEmpty(this.focusedItemInfo.parentKey) ? '_' + this.focusedItemInfo.parentKey : ''}_${this.focusedItemInfo.index}` : null;
         }
     },
     components: {
-        'TieredMenuSub': TieredMenuSub,
-        'Portal': Portal
+        TieredMenuSub: TieredMenuSub,
+        Portal: Portal
     }
-}
+};
 </script>
 
 <style>