import type { CustomSlotsType, Key } from '../../_util/type'; import type { ExtractPropTypes, PropType, VNode } from 'vue'; import { shallowRef, Teleport, computed, defineComponent, ref, inject, watchEffect, watch, onMounted, unref, } from 'vue'; import shallowEqual from '../../_util/shallowequal'; import type { StoreMenuInfo } from './hooks/useMenuContext'; import useProvideMenu, { MenuContextProvider, useProvideFirstLevel } from './hooks/useMenuContext'; import useConfigInject from '../../config-provider/hooks/useConfigInject'; import type { MenuTheme, MenuMode, BuiltinPlacements, TriggerSubMenuAction, MenuInfo, SelectInfo, MenuClickEventHandler, SelectEventHandler, } from './interface'; import devWarning from '../../vc-util/devWarning'; import type { CSSMotionProps } from '../../_util/transition'; import uniq from 'lodash-es/uniq'; import { SiderCollapsedKey } from '../../layout/injectionKey'; import { flattenChildren } from '../../_util/props-util'; import Overflow from '../../vc-overflow'; import MenuItem from './MenuItem'; import SubMenu from './SubMenu'; import EllipsisOutlined from '@ant-design/icons-vue/EllipsisOutlined'; import { cloneElement } from '../../_util/vnode'; import { OVERFLOW_KEY, PathContext } from './hooks/useKeyPath'; import type { FocusEventHandler, MouseEventHandler } from '../../_util/EventInterface'; import collapseMotion from '../../_util/collapseMotion'; import type { ItemType } from './hooks/useItems'; import useItems from './hooks/useItems'; import useStyle from '../style'; import { useInjectOverride } from './OverrideContext'; export const menuProps = () => ({ id: String, prefixCls: String, // donot use items, now only support inner use items: Array as PropType, disabled: Boolean, inlineCollapsed: Boolean, disabledOverflow: Boolean, forceSubMenuRender: Boolean, openKeys: Array as PropType, selectedKeys: Array as PropType, activeKey: String, // 内部组件使用 selectable: { type: Boolean, default: true }, multiple: { type: Boolean, default: false }, tabindex: { type: [Number, String] }, motion: Object as PropType, role: String, theme: { type: String as PropType, default: 'light' }, mode: { type: String as PropType, default: 'vertical' }, inlineIndent: { type: Number, default: 24 }, subMenuOpenDelay: { type: Number, default: 0 }, subMenuCloseDelay: { type: Number, default: 0.1 }, builtinPlacements: { type: Object as PropType }, triggerSubMenuAction: { type: String as PropType, default: 'hover' }, getPopupContainer: Function as PropType<(node: HTMLElement) => HTMLElement>, expandIcon: Function as PropType<(p?: { isOpen: boolean; [key: string]: any }) => any>, onOpenChange: Function as PropType<(keys: Key[]) => void>, onSelect: Function as PropType, onDeselect: Function as PropType, onClick: [Function, Array] as PropType, onFocus: Function as PropType, onBlur: Function as PropType, onMousedown: Function as PropType, 'onUpdate:openKeys': Function as PropType<(keys: Key[]) => void>, 'onUpdate:selectedKeys': Function as PropType<(keys: Key[]) => void>, 'onUpdate:activeKey': Function as PropType<(key: Key) => void>, }); export type MenuProps = Partial>>; const EMPTY_LIST: string[] = []; export default defineComponent({ compatConfig: { MODE: 3 }, name: 'AMenu', inheritAttrs: false, props: menuProps(), slots: Object as CustomSlotsType<{ expandIcon?: { isOpen: boolean; [key: string]: any }; overflowedIndicator?: any; default: any; }>, setup(props, { slots, emit, attrs }) { const { direction, getPrefixCls } = useConfigInject('menu', props); const override = useInjectOverride(); const prefixCls = computed(() => { return getPrefixCls('menu', props.prefixCls || override?.prefixCls?.value); }); const [wrapSSR, hashId] = useStyle( prefixCls, computed(() => { return !override; }), ); const store = shallowRef>(new Map()); const siderCollapsed = inject(SiderCollapsedKey, ref(undefined)); const inlineCollapsed = computed(() => { if (siderCollapsed.value !== undefined) { return siderCollapsed.value; } return props.inlineCollapsed; }); const { itemsNodes } = useItems(props); const isMounted = shallowRef(false); onMounted(() => { isMounted.value = true; }); watchEffect(() => { devWarning( !(props.inlineCollapsed === true && props.mode !== 'inline'), 'Menu', '`inlineCollapsed` should only be used when `mode` is inline.', ); devWarning( !(siderCollapsed.value !== undefined && props.inlineCollapsed === true), 'Menu', '`inlineCollapsed` not control Menu under Sider. Should set `collapsed` on Sider instead.', ); // devWarning( // !!props.items && !slots.default, // 'Menu', // '`children` will be removed in next major version. Please use `items` instead.', // ); }); const activeKeys = ref([]); const mergedSelectedKeys = ref([]); const keyMapStore = ref>({}); watch( store, () => { const newKeyMapStore = {}; for (const menuInfo of store.value.values()) { newKeyMapStore[menuInfo.key] = menuInfo; } keyMapStore.value = newKeyMapStore; }, { flush: 'post' }, ); watchEffect(() => { if (props.activeKey !== undefined) { let keys = []; const menuInfo = props.activeKey ? keyMapStore.value[props.activeKey] : undefined; if (menuInfo && props.activeKey !== undefined) { keys = uniq([].concat(unref(menuInfo.parentKeys), props.activeKey)); } else { keys = []; } if (!shallowEqual(activeKeys.value, keys)) { activeKeys.value = keys; } } }); watch( () => props.selectedKeys, selectedKeys => { if (selectedKeys) { mergedSelectedKeys.value = selectedKeys.slice(); } }, { immediate: true, deep: true }, ); const selectedSubMenuKeys = ref([]); watch( [keyMapStore, mergedSelectedKeys], () => { let subMenuParentKeys = []; mergedSelectedKeys.value.forEach(key => { const menuInfo = keyMapStore.value[key]; if (menuInfo) { subMenuParentKeys = subMenuParentKeys.concat(unref(menuInfo.parentKeys)); } }); subMenuParentKeys = uniq(subMenuParentKeys); if (!shallowEqual(selectedSubMenuKeys.value, subMenuParentKeys)) { selectedSubMenuKeys.value = subMenuParentKeys; } }, { immediate: true }, ); // >>>>> Trigger select const triggerSelection = (info: MenuInfo) => { if (props.selectable) { // Insert or Remove const { key: targetKey } = info; const exist = mergedSelectedKeys.value.includes(targetKey); let newSelectedKeys: Key[]; if (props.multiple) { if (exist) { newSelectedKeys = mergedSelectedKeys.value.filter(key => key !== targetKey); } else { newSelectedKeys = [...mergedSelectedKeys.value, targetKey]; } } else { newSelectedKeys = [targetKey]; } // Trigger event const selectInfo: SelectInfo = { ...info, selectedKeys: newSelectedKeys, }; if (!shallowEqual(newSelectedKeys, mergedSelectedKeys.value)) { if (props.selectedKeys === undefined) { mergedSelectedKeys.value = newSelectedKeys; } emit('update:selectedKeys', newSelectedKeys); if (exist && props.multiple) { emit('deselect', selectInfo); } else { emit('select', selectInfo); } } } // Whatever selectable, always close it if (mergedMode.value !== 'inline' && !props.multiple && mergedOpenKeys.value.length) { triggerOpenKeys(EMPTY_LIST); } }; const mergedOpenKeys = ref([]); watch( () => props.openKeys, (openKeys = mergedOpenKeys.value) => { if (!shallowEqual(mergedOpenKeys.value, openKeys)) { mergedOpenKeys.value = openKeys.slice(); } }, { immediate: true, deep: true }, ); let timeout: any; const changeActiveKeys = (keys: Key[]) => { clearTimeout(timeout); timeout = setTimeout(() => { if (props.activeKey === undefined) { activeKeys.value = keys; } emit('update:activeKey', keys[keys.length - 1]); }); }; const disabled = computed(() => !!props.disabled); const isRtl = computed(() => direction.value === 'rtl'); const mergedMode = ref('vertical'); const mergedInlineCollapsed = shallowRef(false); watchEffect(() => { if ((props.mode === 'inline' || props.mode === 'vertical') && inlineCollapsed.value) { mergedMode.value = 'vertical'; mergedInlineCollapsed.value = inlineCollapsed.value; } else { mergedMode.value = props.mode; mergedInlineCollapsed.value = false; } if (override?.mode?.value) { mergedMode.value = override.mode.value; } }); const isInlineMode = computed(() => mergedMode.value === 'inline'); const triggerOpenKeys = (keys: string[]) => { mergedOpenKeys.value = keys; emit('update:openKeys', keys); emit('openChange', keys); }; // >>>>> Cache & Reset open keys when inlineCollapsed changed const inlineCacheOpenKeys = ref(mergedOpenKeys.value); const mountRef = shallowRef(false); // Cache watch( mergedOpenKeys, () => { if (isInlineMode.value) { inlineCacheOpenKeys.value = mergedOpenKeys.value; } }, { immediate: true }, ); // Restore watch( isInlineMode, () => { if (!mountRef.value) { mountRef.value = true; return; } if (isInlineMode.value) { mergedOpenKeys.value = inlineCacheOpenKeys.value; } else { // Trigger open event in case its in control triggerOpenKeys(EMPTY_LIST); } }, { immediate: true }, ); const className = computed(() => { return { [`${prefixCls.value}`]: true, [`${prefixCls.value}-root`]: true, [`${prefixCls.value}-${mergedMode.value}`]: true, [`${prefixCls.value}-inline-collapsed`]: mergedInlineCollapsed.value, [`${prefixCls.value}-rtl`]: isRtl.value, [`${prefixCls.value}-${props.theme}`]: true, }; }); const rootPrefixCls = computed(() => getPrefixCls()); const defaultMotions = computed(() => ({ horizontal: { name: `${rootPrefixCls.value}-slide-up` }, inline: collapseMotion, other: { name: `${rootPrefixCls.value}-zoom-big` }, })); useProvideFirstLevel(true); const getChildrenKeys = (eventKeys: string[] = []): Key[] => { const keys = []; const storeValue = store.value; eventKeys.forEach(eventKey => { const { key, childrenEventKeys } = storeValue.get(eventKey); keys.push(key, ...getChildrenKeys(unref(childrenEventKeys))); }); return keys; }; // ========================= Open ========================= /** * Click for item. SubMenu do not have selection status */ const onInternalClick = (info: MenuInfo) => { emit('click', info); triggerSelection(info); override?.onClick?.(); }; const onInternalOpenChange = (key: Key, open: boolean) => { const childrenEventKeys = keyMapStore.value[key]?.childrenEventKeys || []; let newOpenKeys = mergedOpenKeys.value.filter(k => k !== key); if (open) { newOpenKeys.push(key); } else if (mergedMode.value !== 'inline') { // We need find all related popup to close const subPathKeys = getChildrenKeys(unref(childrenEventKeys)); newOpenKeys = uniq(newOpenKeys.filter(k => !subPathKeys.includes(k))); } if (!shallowEqual(mergedOpenKeys, newOpenKeys)) { triggerOpenKeys(newOpenKeys); } }; const registerMenuInfo = (key: string, info: StoreMenuInfo) => { store.value.set(key, info); store.value = new Map(store.value); }; const unRegisterMenuInfo = (key: string) => { store.value.delete(key); store.value = new Map(store.value); }; const lastVisibleIndex = ref(0); const expandIcon = computed(() => props.expandIcon || slots.expandIcon || override?.expandIcon?.value ? opt => { let icon = props.expandIcon || slots.expandIcon; icon = typeof icon === 'function' ? icon(opt) : icon; return cloneElement( icon as unknown as VNode, { class: `${prefixCls.value}-submenu-expand-icon`, }, false, ); } : null, ); useProvideMenu({ prefixCls, activeKeys, openKeys: mergedOpenKeys, selectedKeys: mergedSelectedKeys, changeActiveKeys, disabled, rtl: isRtl, mode: mergedMode, inlineIndent: computed(() => props.inlineIndent), subMenuCloseDelay: computed(() => props.subMenuCloseDelay), subMenuOpenDelay: computed(() => props.subMenuOpenDelay), builtinPlacements: computed(() => props.builtinPlacements), triggerSubMenuAction: computed(() => props.triggerSubMenuAction), getPopupContainer: computed(() => props.getPopupContainer), inlineCollapsed: mergedInlineCollapsed, theme: computed(() => props.theme), siderCollapsed, defaultMotions: computed(() => (isMounted.value ? defaultMotions.value : null)), motion: computed(() => (isMounted.value ? props.motion : null)), overflowDisabled: shallowRef(undefined), onOpenChange: onInternalOpenChange, onItemClick: onInternalClick, registerMenuInfo, unRegisterMenuInfo, selectedSubMenuKeys, expandIcon, forceSubMenuRender: computed(() => props.forceSubMenuRender), rootClassName: hashId, }); return () => { const childList = itemsNodes.value || flattenChildren(slots.default?.()); const allVisible = lastVisibleIndex.value >= childList.length - 1 || mergedMode.value !== 'horizontal' || props.disabledOverflow; // >>>>> Children const wrappedChildList = mergedMode.value !== 'horizontal' || props.disabledOverflow ? childList : // Need wrap for overflow dropdown that do not response for open childList.map((child, index) => ( // Always wrap provider to avoid sub node re-mount lastVisibleIndex.value} v-slots={{ default: () => child }} > )); const overflowedIndicator = slots.overflowedIndicator?.() || ; return wrapSSR( node} renderRawRest={omitItems => { // We use origin list since wrapped list use context to prevent open const len = omitItems.length; const originOmitItems = len ? childList.slice(-len) : null; return ( <> originOmitItems }} > originOmitItems }} > ); }} maxCount={ mergedMode.value !== 'horizontal' || props.disabledOverflow ? Overflow.INVALIDATE : Overflow.RESPONSIVE } ssr="full" data-menu-list onVisibleChange={newLastIndex => { lastVisibleIndex.value = newLastIndex; }} >
{wrappedChildList}
, ); }; }, });