首頁 > 軟體

vue實現自定義全域性右鍵選單

2022-04-08 19:00:30

前段時間公司在做一個webIDE專案,其中有對檔案樹的各種操作,主要通過右鍵選單實現,今天就來記錄一下怎麼在vue專案中實現全域性的自定義右鍵選單。效果如圖所示:

注意:

需要在專案中找到頁面整體佈局的元件,比如專案使用Home.vue作為整個專案的公共佈局,將根元素定位設定成relative,使右鍵選單相對於其進行定位。

本文的右鍵選單主要使用vuex實現

一、vuex中定義全域性狀態用於管理右鍵選單

export default {
    /**
     * menuContent格式:
     * [
     *      {
     *          name: '新建檔案',   // 操作名
     *          method: 'createDirectory',  // 需要執行的對應元件中的方法
     *             disabled: true        // 是否禁用,可以根據頁面具體邏輯進行調整
     *      }
     * ]
     * 
     * 
     * 整體右鍵選單採用絕對定位,所以clientX、clientY代表是left和top定位
     */
    state: {
        menuContent: [],    // 右鍵選單內容
        clientX: '',    // left
        clientY: '',    // top
        displayContextMenu: false   // 是否展示右鍵選單
    },
    mutations: {
        SET_CONTEXT_MENU: (state, payload) => {
            state.menuContent = payload.menuContent;
            state.clientX = payload.clientX;
            state.clientY = payload.clientY;
            state.displayContextMenu = payload.displayContextMenu;
        },
    }
}

二、定義公共元件ContextMenu.vue

<template>
    <div class="context-menu" v-show="contextMenu.displayContextMenu" 
        :style="{'left': contextMenu.clientX + 'px', 'top': contextMenu.clientY + 'px'}">
        <ul>
            <li v-for="(item, i) in contextMenu.menuContent" :key="i" :class="item.disabled ? 'disabled' : ''" 
                @click="emitEvent(item.method)">
                {{item.name}}
            </li>
        </ul>
    </div>
</template>

<script>
import { mapState } from 'vuex';
import bus from '@/views/common/bus';
export default {
    name: 'ContextMenu',
    data(){
        return {
        }
    },
    computed: {
        ...mapState(['contextMenu'])
    },
    methods: {
        emitEvent(type){
            bus.$emit('operateDirectory', type)
        }
    }
}
</script>

<style lang="scss" scoped>
    .context-menu {
        position: absolute;
        background: #FFF;
        color: #34495E;
        min-width: 100px;
        box-shadow: 0px 2px 4px 0px rgba(0, 0, 0, 0.2);
        border-radius: 2px;
        cursor: pointer;
        z-index: 1002;
        &>ul {
            text-align: left;
            padding: 5px 10px;
            &>li {
                padding: 3px 4px;
                font-size: 12px;
                list-style: none;
                height: 24px;
                line-height: 24px;
                &:hover {
                    background: #EDF6FF;
                }
            }
            .disabled {
                color: #888585;
                pointer-events: none;
            }
        }
    }
</style>

三、在元件中使用

import { mapState } from 'vuex';
// ...

computed: {
    ...mapState(['contextMenu'])
},
created(){
    bus.$on('operateDirectory', (param) => {
    // 點選右鍵選單時,應觸發元件內的同名方法,首先應判斷該方法是否在本元件記憶體在,存在則呼叫
        if(this[param]){
            this[param]();
        }
    });
},
// ...

methods: {
    showContextMenu(event, data) {
        event.preventDefault();        // 阻止瀏覽器的預設事件
        const menuContent = {
            menuContent: [
            {
                icon: "el-icon-upload2",
                name: "執行",
                method: "run",
            },
            {
                icon: "el-icon-refresh",
                name: "編輯",
                method: "editConfig",
            },
            {
                icon: "el-icon-refresh",
                name: "新增",
                method: "addCommond",
            },
            {
                icon: "el-icon-refresh",
                name: "刪除",
                method: "deleteConfig",
            },
            ],
            clientX: event.clientX,
            clientY: event.clientY,
            displayContextMenu: true,
        };
        this.$store.commit("SET_CONTEXT_MENU", menuContent);
        // 再次點選頁面,右鍵選單消失
        document.onclick = (event) => {
            this.$store.commit("SET_CONTEXT_MENU", {
                displayContextMenu: false,
            });
        };
    },
    run(){
        // ...
    },
    editConfig(){
        // ...
    },
    addCommond(){
        // ...
    },
    deleteConfig(){
        // ...
    }
}

總結

這種可以實現全域性右鍵選單,並且支援自定義右鍵內容,但是vue3.0對event bus的取消會導致不可用。

目前有一種優化方法:專案中對應會使用元件庫,例如element ui,在定義contextMenu.vue的時候,使用dialog,將內容定義在Popover 彈出框中,當元件使用右鍵選單時,使用子元件的方式使用ContextMenu.vue,點選右鍵選單內容時就不需要使用emit觸發了。

以上就是本文的全部內容,希望對大家的學習有所幫助,也希望大家多多支援it145.com。


IT145.com E-mail:sddin#qq.com