萬盛學電腦網

您现在的位置: 萬盛學電腦網 >> 程式設計 >  >> 腳本程式專題 >> JavaScript

jQuery ContextMenu 右鍵選單插件完整使用指南:初始化、自訂樣式、事件控制與動態菜單

jQuery ContextMenu 插件 (jquery.contextmenu.r2.js) 提供簡單 API 建立右鍵選單。本文完整說明初始化選項、樣式自訂、事件鉤子、動態菜單生成、銷毀與現代化替代方案。

基礎 HTML 結構

<!-- 觸發元素 -->
<span class="demo1">右鍵點此 (span.demo1)</span>
<div id="demo2">右鍵點此 (id=demo2)</div>
<div class="demo3" id="dontShow">不顯示菜單</div>
<div class="demo3" id="showOne">僅顯示第一項</div>
<div class="demo3" id="showAll">顯示全部項目</div>

<!-- 菜單模板 (隱藏) -->
<div class="contextMenu" id="myMenu1">
  <ul>
    <li id="open"><img src="folder.png"> 開啟</li>
    <li id="email"><img src="email.png"> 郵件</li>
    <li id="save"><img src="disk.png"> 儲存</li>
    <li id="delete"><img src="cross.png"> 關閉</li>
  </ul>
</div>

<div class="contextMenu" id="myMenu2">
  <ul>
    <li id="item_1">選項一</li>
    <li id="item_2">選項二</li>
    <li id="item_3">選項三</li>
    <li id="item_4">選項四</li>
  </ul>
</div>

<div class="contextMenu" id="myMenu3">
  <ul>
    <li id="item_1">CSDN</li>
    <li id="item_2">JavaEye</li>
    <li id="item_3">ITPub</li>
  </ul>
</div>

初始化選項完整配置

$(selector).contextMenu(menuId, options);

選項物件完整屬性

var options = {
    // 菜單容器樣式
    menuStyle: {
        border: '1px solid #ccc',
        backgroundColor: '#fff',
        minWidth: '150px',
        zIndex: 1000
    },
    
    // 菜單項預設樣式
    itemStyle: {
        fontFamily: 'inherit',
        padding: '6px 12px',
        color: '#333',
        cursor: 'pointer',
        whiteSpace: 'nowrap'
    },
    
    // 滑鼠懸停樣式
    itemHoverStyle: {
        backgroundColor: '#e8f0fe',
        color: '#1a73e8'
    },
    
    // 事件綁定:鍵為菜單項 id,值為回呼函式 (接收觸發元素 t)
    bindings: {
        'open': function(t) { console.log('開啟:', t.id); },
        'save': function(t) { console.log('儲存:', t.id); },
        'delete': function(t) { 
            if (confirm('確定刪除?')) console.log('刪除:', t.id); 
        }
    },
    
    // 顯示前鉤子:可動態決定是否顯示、修改菜單項
    onContextMenu: function(e) {
        // e: 原生事件物件
        // this: 觸發元素
        // return false 取消顯示
        // return true 或 undefined 正常顯示
    },
    
    // 菜單顯示後鉤子
    onShowMenu: function(e, menu) {
        // menu: 菜單 jQuery 物件
        // 可動態啟用/停用項目
        // menu.find('#item_3').addClass('disabled');
    },
    
    // 陰影深度 (舊版參數)
    shadow: true
};

三種綁定範例

1. 類別選取器綁定 (多元素共用)

$('.demo1').contextMenu('myMenu1', {
    bindings: {
        open: function(t) { alert('開啟: ' + t.id); },
        email: function(t) { alert('郵件: ' + t.id); },
        save: function(t) { alert('儲存: ' + t.id); },
        delete: function(t) { alert('刪除: ' + t.id); }
    }
});

2. ID 選取器綁定 + 自訂樣式

$('#demo2').contextMenu('myMenu2', {
    menuStyle: { border: '2px solid #000' },
    itemStyle: { 
        fontFamily: 'verdana', 
        backgroundColor: 'green', 
        color: 'white', 
        border: 'none', 
        padding: '1px' 
    },
    itemHoverStyle: { 
        color: 'blue', 
        backgroundColor: 'red', 
        border: 'none' 
    },
    bindings: {
        item_1: function(t) { alert('選項一'); },
        item_2: function(t) { alert('選項二'); },
        item_3: function(t) { alert('選項三'); },
        item_4: function(t) { alert('選項四'); }
    }
});

3. 動態控制顯示內容 (onContextMenu)

$('.demo3').contextMenu('myMenu3', {
    onContextMenu: function(e) {
        var $trigger = $(this);
        var $menu = $('#myMenu3');
        
        // 根據觸發元素 ID 動態顯示/隱藏項目
        if ($trigger.is('#dontShow')) {
            return false; // 完全不顯示菜單
        }
        
        if ($trigger.is('#showOne')) {
            $menu.find('li:not(#item_1)').hide();
            $menu.find('#item_1').show();
        } else if ($trigger.is('#showAll')) {
            $menu.find('li').show();
        }
        
        return true; // 顯示菜單
    },
    bindings: {
        item_1: function(t) { alert('CSDN'); },
        item_2: function(t) { alert('JavaEye'); },
        item_3: function(t) { alert('ITPub'); }
    }
});

進階技巧

動態生成菜單項 (無需預置 HTML)

function buildDynamicMenu(items, trigger) {
    var $menu = $('
    '); var $ul = $menu.find('ul'); items.forEach(function(item, index) { var $li = $('
  • ').attr('id', 'dynamic_' + index).text(item.label); if (item.disabled) $li.addClass('disabled'); $ul.append($li); }); $('body').append($menu); // 必須加入 DOM // 初始化 (需插件支援動態菜單,或手動實作) $(trigger).contextMenu($menu.attr('id'), { bindings: items.reduce((acc, item, i) => { acc['dynamic_' + i] = item.action; return acc; }, {}) }); return $menu.attr('id'); }
  • 銷毀與重新綁定

    // 移除綁定 (插件未提供原生 destroy,需手動)
    function destroyContextMenu(selector) {
        $(selector).off('contextmenu.contextMenu') // 命名空間事件
                   .removeData('contextMenu');      // 清除資料
        
        // 移除菜單 DOM (若動態生成)
        $('.contextMenu[data-dynamic="true"]').remove();
    }

    鍵盤無障礙支援

    // 攔截 Shift+F10 / Menu 鍵
    $(document).on('keydown', function(e) {
        if (e.key === 'ContextMenu' || (e.shiftKey && e.key === 'F10')) {
            var $target = $(e.target).closest('[data-context-menu]');
            if ($target.length) {
                e.preventDefault();
                // 手動觸發 contextmenu 事件
                $target.trigger($.Event('contextmenu', { 
                    pageX: $target.offset().left, 
                    pageY: $target.offset().top + $target.outerHeight() 
                }));
            }
        }
    });

    現代替代方案:原生 JS + CSS 實作

    不依賴 jQuery、無外部依賴、支援 ES Module:

    class ContextMenu {
        constructor(options = {}) {
            this.items = options.items || [];
            this.menu = this.createMenu();
            document.body.appendChild(this.menu);
            this.bindEvents();
        }
        
        createMenu() {
            const menu = document.createElement('div');
            menu.className = 'ctx-menu';
            menu.setAttribute('role', 'menu');
            menu.innerHTML = this.items.map((item, i) => 
                ``
            ).join('');
            return menu;
        }
        
        bindEvents() {
            document.addEventListener('contextmenu', e => {
                const target = e.target.closest('[data-context-menu]');
                if (!target) return;
                
                e.preventDefault();
                this.show(e.pageX, e.pageY, target);
            });
            
            this.menu.addEventListener('click', e => {
                const item = e.target.closest('[role="menuitem"]:not(.disabled)');
                if (item) {
                    const action = item.dataset.action;
                    const handler = this.items.find(i => i.action === action)?.handler;
                    handler?.(target);
                    this.hide();
                }
            });
            
            document.addEventListener('click', () => this.hide());
            document.addEventListener('keydown', e => { if (e.key === 'Escape') this.hide(); });
        }
        
        show(x, y, trigger) {
            this.trigger = trigger;
            this.menu.style.left = `${x}px`;
            this.menu.style.top = `${y}px`;
            this.menu.classList.add('visible');
            this.menu.querySelector('[role="menuitem"]')?.focus();
        }
        
        hide() {
            this.menu.classList.remove('visible');
            this.trigger = null;
        }
    }
    
    // 使用
    new ContextMenu({
        items: [
            { label: '複製', action: 'copy', handler: t => console.log('複製', t) },
            { label: '貼上', action: 'paste', handler: t => console.log('貼上', t) },
            { label: '刪除', action: 'delete', handler: t => console.log('刪除', t) }
        ]
    });

    總結

    jQuery ContextMenu 適合維護舊專案快速加入右鍵選單。新專案建議採用原生實作或成熟庫 (如 @github/hotkey、tippy.js 搭配 contextmenu 觸發),獲得更好效能、Tree-shaking、TypeScript 支援與無依賴優勢。

    copyright © 萬盛學電腦網 all rights reserved