mdui/components/menu/menu-item.js

实现 material you 设计规范的 Web Components 组件库

import { __decorate } from "tslib";
import { html } from 'lit';
import { customElement, property, state } from 'lit/decorators.js';
import { createRef, ref } from 'lit/directives/ref.js';
import { when } from 'lit/directives/when.js';
import cc from 'classcat';
import { $ } from '@mdui/jq/$.js';
import '@mdui/jq/methods/css.js';
import '@mdui/jq/methods/height.js';
import '@mdui/jq/methods/innerHeight.js';
import '@mdui/jq/methods/innerWidth.js';
import '@mdui/jq/methods/width.js';
import { isUndefined } from '@mdui/jq/shared/helper.js';
import '@mdui/jq/static/contains.js';
import { MduiElement } from '@mdui/shared/base/mdui-element.js';
import { DefinedController } from '@mdui/shared/controllers/defined.js';
import { HasSlotController } from '@mdui/shared/controllers/has-slot.js';
import { watch } from '@mdui/shared/decorators/watch.js';
import { animateTo, stopAnimations } from '@mdui/shared/helpers/animate.js';
import { booleanConverter } from '@mdui/shared/helpers/decorator.js';
import { getDuration, getEasing } from '@mdui/shared/helpers/motion.js';
import { nothingTemplate } from '@mdui/shared/helpers/template.js';
import { uniqueId } from '@mdui/shared/helpers/uniqueId.js';
import '@mdui/shared/icons/arrow-right.js';
import '@mdui/shared/icons/check.js';
import { componentStyle } from '@mdui/shared/lit-styles/component-style.js';
import { AnchorMixin } from '@mdui/shared/mixins/anchor.js';
import { FocusableMixin } from '@mdui/shared/mixins/focusable.js';
import '../icon.js';
import { RippleMixin } from '../ripple/ripple-mixin.js';
import { menuItemStyle } from './menu-item-style.js';
/**
 * @summary 菜单项组件。需配合 `<mdui-menu>` 组件使用
 *
 * ```html
 * <mdui-menu>
 * ..<mdui-menu-item>Item 1</mdui-menu-item>
 * ..<mdui-menu-item>Item 2</mdui-menu-item>
 * </mdui-menu>
 * ```
 *
 * @event focus - 获得焦点时触发
 * @event blur - 失去焦点时触发
 * @event submenu-open - 子菜单开始打开时，事件被触发。可以通过调用 `event.preventDefault()` 阻止子菜单打开
 * @event submenu-opened - 子菜单打开动画完成时，事件被触发
 * @event submenu-close - 子菜单开始关闭时，事件被触发。可以通过调用 `event.preventDefault()` 阻止子菜单关闭
 * @event submenu-closed - 子菜单关闭动画完成时，事件被触发
 *
 * @slot - 菜单项的文本
 * @slot icon - 菜单项左侧图标
 * @slot end-icon - 菜单项右侧图标
 * @slot end-text - 菜单右侧的文本
 * @slot selected-icon - 选中状态的图标
 * @slot submenu - 子菜单
 * @slot custom - 任意自定义内容
 *
 * @csspart container - 菜单项的容器
 * @csspart icon - 左侧的图标
 * @csspart label - 文本内容
 * @csspart end-icon - 右侧的图标
 * @csspart end-text - 右侧的文本
 * @csspart selected-icon - 选中状态的图标
 * @csspart submenu - 子菜单元素
 */
let MenuItem = class MenuItem extends AnchorMixin(RippleMixin(FocusableMixin(MduiElement))) {
    constructor() {
        super();
        /**
         * 是否禁用菜单项
         */
        this.disabled = false;
        /**
         * 是否打开子菜单
         */
        this.submenuOpen = false;
        // 是否已选中该菜单项。由 <mdui-menu> 控制该参数
        this.selected = false;
        // 是否使用更紧凑的布局。由 <mdui-menu> 控制该参数
        this.dense = false;
        // 是否可聚焦。由 <mdui-menu> 控制该参数
        this.focusable = false;
        // 每一个 menu-item 元素都添加一个唯一的 key
        this.key = uniqueId();
        this.rippleRef = createRef();
        this.containerRef = createRef();
        this.submenuRef = createRef();
        this.hasSlotController = new HasSlotController(this, '[default]', 'icon', 'end-icon', 'end-text', 'submenu', 'custom');
        this.definedController = new DefinedController(this, {
            relatedElements: [''],
        });
        this.onOuterClick = this.onOuterClick.bind(this);
        this.onFocus = this.onFocus.bind(this);
        this.onBlur = this.onBlur.bind(this);
        this.onClick = this.onClick.bind(this);
        this.onKeydown = this.onKeydown.bind(this);
        this.onMouseEnter = this.onMouseEnter.bind(this);
        this.onMouseLeave = this.onMouseLeave.bind(this);
    }
    get focusDisabled() {
        return this.disabled || !this.focusable;
    }
    get focusElement() {
        return this.href && !this.disabled ? this.containerRef.value : this;
    }
    get rippleDisabled() {
        return this.disabled;
    }
    get rippleElement() {
        return this.rippleRef.value;
    }
    get hasSubmenu() {
        return this.hasSlotController.test('submenu');
    }
    async onOpenChange() {
        const hasUpdated = this.hasUpdated;
        // 默认为关闭状态。因此首次渲染时，且为关闭状态，不执行
        if (!this.submenuOpen && !hasUpdated) {
            return;
        }
        await this.definedController.whenDefined();
        if (!hasUpdated) {
            await this.updateComplete;
        }
        const easingLinear = getEasing(this, 'linear');
        const easingEmphasizedDecelerate = getEasing(this, 'emphasized-decelerate');
        const easingEmphasizedAccelerate = getEasing(this, 'emphasized-accelerate');
        // 打开
        // 要区分是否首次渲染，首次渲染时不触发事件，不执行动画；非首次渲染，触发事件，执行动画
        if (this.submenuOpen) {
            if (hasUpdated) {
                const eventProceeded = this.emit('submenu-open', { cancelable: true });
                if (!eventProceeded) {
                    return;
                }
            }
            const duration = getDuration(this, 'medium4');
            await stopAnimations(this.submenuRef.value);
            this.submenuRef.value.hidden = false;
            this.updateSubmenuPositioner();
            await Promise.all([
                animateTo(this.submenuRef.value, [{ transform: 'scaleY(0.45)' }, { transform: 'scaleY(1)' }], {
                    duration: hasUpdated ? duration : 0,
                    easing: easingEmphasizedDecelerate,
                }),
                animateTo(this.submenuRef.value, [{ opacity: 0 }, { opacity: 1, offset: 0.125 }, { opacity: 1 }], {
                    duration: hasUpdated ? duration : 0,
                    easing: easingLinear,
                }),
            ]);
            if (hasUpdated) {
                this.emit('submenu-opened');
            }
        }
        else {
            const eventProceeded = this.emit('submenu-close', { cancelable: true });
            if (!eventProceeded) {
                return;
            }
            const duration = getDuration(this, 'short4');
            await stopAnimations(this.submenuRef.value);
            await Promise.all([
                animateTo(this.submenuRef.value, [{ transform: 'scaleY(1)' }, { transform: 'scaleY(0.45)' }], { duration, easing: easingEmphasizedAccelerate }),
                animateTo(this.submenuRef.value, [{ opacity: 1 }, { opacity: 1, offset: 0.875 }, { opacity: 0 }], { duration, easing: easingLinear }),
            ]);
            if (this.submenuRef.value) {
                this.submenuRef.value.hidden = true;
            }
            this.emit('submenu-closed');
        }
    }
    connectedCallback() {
        super.connectedCallback();
        this.definedController.whenDefined().then(() => {
            document.addEventListener('pointerdown', this.onOuterClick);
        });
    }
    disconnectedCallback() {
        super.disconnectedCallback();
        document.removeEventListener('pointerdown', this.onOuterClick);
    }
    firstUpdated(changedProperties) {
        super.firstUpdated(changedProperties);
        this.definedController.whenDefined().then(() => {
            this.addEventListener('focus', this.onFocus);
            this.addEventListener('blur', this.onBlur);
            this.addEventListener('click', this.onClick);
            this.addEventListener('keydown', this.onKeydown);
            this.addEventListener('mouseenter', this.onMouseEnter);
            this.addEventListener('mouseleave', this.onMouseLeave);
        });
    }
    render() {
        const hasSubmenu = this.hasSubmenu;
        const hasCustomSlot = this.hasSlotController.test('custom');
        const hasEndIconSlot = this.hasSlotController.test('end-icon');
        const useDefaultEndIcon = !this.endIcon && hasSubmenu && !hasEndIconSlot;
        const hasEndIcon = this.endIcon || hasSubmenu || hasEndIconSlot;
        const hasIcon = !isUndefined(this.icon) ||
            this.selects === 'single' ||
            this.selects === 'multiple' ||
            this.hasSlotController.test('icon');
        const hasEndText = !!this.endText || this.hasSlotController.test('end-text');
        const className = cc({
            container: true,
            dense: this.dense,
            preset: !hasCustomSlot,
            'has-icon': hasIcon,
            'has-end-text': hasEndText,
            'has-end-icon': hasEndIcon,
        });
        return html `<mdui-ripple ${ref(this.rippleRef)} .noRipple="${this.noRipple}"></mdui-ripple>${this.href && !this.disabled
            ? this.renderAnchor({
                part: 'container',
                className,
                content: this.renderInner(useDefaultEndIcon, hasIcon),
                refDirective: ref(this.containerRef),
                tabIndex: this.focusable ? 0 : -1,
            })
            : html `<div part="container" ${ref(this.containerRef)} class="${className}">${this.renderInner(useDefaultEndIcon, hasIcon)}</div>`} ${when(hasSubmenu, () => html `<slot name="submenu" ${ref(this.submenuRef)} part="submenu" class="submenu" hidden></slot>`)}`;
    }
    /**
     * 点击子菜单外面的区域，关闭子菜单
     */
    onOuterClick(event) {
        if (!this.disabled &&
            this.submenuOpen &&
            this !== event.target &&
            !$.contains(this, event.target)) {
            this.submenuOpen = false;
        }
    }
    hasTrigger(trigger) {
        return this.submenuTrigger
            ? this.submenuTrigger.split(' ').includes(trigger)
            : false;
    }
    onFocus() {
        if (this.disabled ||
            this.submenuOpen ||
            !this.hasTrigger('focus') ||
            !this.hasSubmenu) {
            return;
        }
        this.submenuOpen = true;
    }
    onBlur() {
        if (this.disabled ||
            !this.submenuOpen ||
            !this.hasTrigger('focus') ||
            !this.hasSubmenu) {
            return;
        }
        this.submenuOpen = false;
    }
    onClick(event) {
        // e.button 为 0 时，为鼠标左键点击。忽略鼠标中间和右键
        if (this.disabled || event.button) {
            return;
        }
        // 切换子菜单打开状态
        if (!this.hasTrigger('click') ||
            event.target !== this ||
            !this.hasSubmenu) {
            return;
        }
        // 支持 hover 和 focus 触发时，点击菜单项不关闭子菜单
        if (this.submenuOpen &&
            (this.hasTrigger('hover') || this.hasTrigger('focus'))) {
            return;
        }
        this.submenuOpen = !this.submenuOpen;
    }
    onKeydown(event) {
        // 切换子菜单打开状态
        if (this.disabled || !this.hasSubmenu) {
            return;
        }
        if (!this.submenuOpen && event.key === 'Enter') {
            event.stopPropagation();
            this.submenuOpen = true;
        }
        if (this.submenuOpen && event.key === 'Escape') {
            event.stopPropagation();
            this.submenuOpen = false;
        }
    }
    onMouseEnter() {
        // 不做 submenuOpen 的判断，因为可以延时打开和关闭
        if (this.disabled || !this.hasTrigger('hover') || !this.hasSubmenu) {
            return;
        }
        window.clearTimeout(this.submenuCloseTimeout);
        if (this.submenuOpenDelay) {
            this.submenuOpenTimeout = window.setTimeout(() => {
                this.submenuOpen = true;
            }, this.submenuOpenDelay);
        }
        else {
            this.submenuOpen = true;
        }
    }
    onMouseLeave() {
        // 不做 submenuOpen 的判断，因为可以延时打开和关闭
        if (this.disabled || !this.hasTrigger('hover') || !this.hasSubmenu) {
            return;
        }
        window.clearTimeout(this.submenuOpenTimeout);
        this.submenuCloseTimeout = window.setTimeout(() => {
            this.submenuOpen = false;
        }, this.submenuCloseDelay || 50);
    }
    // 更新子菜单的位置
    updateSubmenuPositioner() {
        const $window = $(window);
        const $submenu = $(this.submenuRef.value);
        const itemRect = this.getBoundingClientRect();
        const submenuWidth = $submenu.innerWidth();
        const submenuHeight = $submenu.innerHeight();
        const screenMargin = 8; // 子菜单与屏幕界至少保留 8px 间距
        let placementX = 'bottom';
        let placementY = 'right';
        // 判断子菜单上下位置
        if ($window.height() - itemRect.top > submenuHeight + screenMargin) {
            placementX = 'bottom';
        }
        else if (itemRect.top + itemRect.height > submenuHeight + screenMargin) {
            placementX = 'top';
        }
        // 判断子菜单左右位置
        if ($window.width() - itemRect.left - itemRect.width >
            submenuWidth + screenMargin) {
            placementY = 'right';
        }
        else if (itemRect.left > submenuWidth + screenMargin) {
            placementY = 'left';
        }
        $(this.submenuRef.value).css({
            top: placementX === 'bottom' ? 0 : itemRect.height - submenuHeight,
            left: placementY === 'right' ? itemRect.width : -submenuWidth,
            transformOrigin: [
                placementY === 'right' ? 0 : '100%',
                placementX === 'bottom' ? 0 : '100%',
            ].join(' '),
        });
    }
    renderInner(useDefaultEndIcon, hasIcon) {
        return html `<slot name="custom">${this.selected
            ? html `<slot name="selected-icon" part="selected-icon" class="selected-icon">${this.selectedIcon
                ? html `<mdui-icon name="${this.selectedIcon}" class="i"></mdui-icon>`
                : html `<mdui-icon-check class="i"></mdui-icon-check>`}</slot>`
            : html `<slot name="icon" part="icon" class="icon">${hasIcon
                ? html `<mdui-icon name="${this.icon}" class="i"></mdui-icon>`
                : nothingTemplate}</slot>`}<div class="label-container"><slot part="label" class="label"></slot></div><slot name="end-text" part="end-text" class="end-text">${this.endText}</slot>${useDefaultEndIcon
            ? html `<mdui-icon-arrow-right part="end-icon" class="end-icon arrow-right"></mdui-icon-arrow-right>`
            : html `<slot name="end-icon" part="end-icon" class="end-icon">${this.endIcon
                ? html `<mdui-icon name="${this.endIcon}"></mdui-icon>`
                : nothingTemplate}</slot>`}</slot>`;
    }
};
MenuItem.styles = [
    componentStyle,
    menuItemStyle,
];
__decorate([
    property({ reflect: true })
], MenuItem.prototype, "value", void 0);
__decorate([
    property({
        type: Boolean,
        reflect: true,
        converter: booleanConverter,
    })
], MenuItem.prototype, "disabled", void 0);
__decorate([
    property({ reflect: true })
], MenuItem.prototype, "icon", void 0);
__decorate([
    property({ reflect: true, attribute: 'end-icon' })
], MenuItem.prototype, "endIcon", void 0);
__decorate([
    property({ reflect: true, attribute: 'end-text' })
], MenuItem.prototype, "endText", void 0);
__decorate([
    property({ reflect: true, attribute: 'selected-icon' })
], MenuItem.prototype, "selectedIcon", void 0);
__decorate([
    property({
        type: Boolean,
        reflect: true,
        converter: booleanConverter,
        attribute: 'submenu-open',
    })
], MenuItem.prototype, "submenuOpen", void 0);
__decorate([
    property({
        type: Boolean,
        reflect: true,
        converter: booleanConverter,
    })
], MenuItem.prototype, "selected", void 0);
__decorate([
    state()
], MenuItem.prototype, "dense", void 0);
__decorate([
    state()
], MenuItem.prototype, "selects", void 0);
__decorate([
    state()
], MenuItem.prototype, "submenuTrigger", void 0);
__decorate([
    state()
], MenuItem.prototype, "submenuOpenDelay", void 0);
__decorate([
    state()
], MenuItem.prototype, "submenuCloseDelay", void 0);
__decorate([
    state()
], MenuItem.prototype, "focusable", void 0);
__decorate([
    watch('submenuOpen')
], MenuItem.prototype, "onOpenChange", null);
MenuItem = __decorate([
    customElement('mdui-menu-item')
], MenuItem);
export { MenuItem };