Context MenuAPI/ExamplesGithub

Creates a menu when the right mouse button is clicked.


    Browser Support

    Chrome Chrome IE Internet Explorer Edge Edge Safari Safari Firefox Firefox
    Yes 8+ Yes Yes Yes

    Features

    • Creates a context menu hierarchically by data.
    • Makes each menu item enable or disable.
    • Supports custom events.

    Examples

    • Basic : Example of using default options.

    Install

    TOAST UI products can be used by using the package manager or downloading the source directly. However, we highly recommend using the package manager.

    Via Package Manager

    TOAST UI products are registered in two package managers, npm and bower. You can conveniently install it using the commands provided by each package manager. When using npm, be sure to use it in the environment Node.js is installed.

    npm
    $ npm install --save tui-context-menu # Latest version
    $ npm install --save tui-context-menu@<version> # Specific version
    bower
    $ bower install tui-context-menu # Latest version
    $ bower install tui-context-menu#<tag> # Specific version

    Via Contents Delivery Network (CDN)

    TOAST UI products are available over the CDN powered by TOAST Cloud.

    You can use the CDN as below.

    <link rel="stylesheet" href="https://uicdn.toast.com/tui.context-menu/latest/tui-context-menu.css" />
    
    <script src="https://uicdn.toast.com/tui.context-menu/latest/tui-context-menu.js"></script>
    

    If you want to use a specific version, use the tag name instead of latest in the url's path.

    The CDN directory has the following structure.

    tui.context-menu/
    ├─ latest/
    │  ├─ tui-context-menu.css
    │  ├─ tui-context-menu.js
    │  └─ tui-context-menu.min.js
    ├─ v2.1.0/
    │  ├─ ...

    Download Source Files


    Usage

    HTML

    You need to add two elements. One is the container element to display a context menu, and the other is a target element in which a context menu is attached.

    <div id="tui-context-menu-container"></div>
    
    <div id="tui-context-menu-target"></div>
    

    JavaScript

    This component can be used by creating an instance with the constructor function. To get the constructor function, you should import the module using one of the following ways depending on your environment.

    Using namespace in browser environment
    var ContextMenu = tui.ContextMenu;
    
    Using module format in node environment
    var ContextMenu = require('tui-context-menu'); /* CommonJS */
    
    import {ContextMenu} from 'tui-context-menu'; /* ES6 */
    

    You should call register method with options after creating an instance to attach a context menu.

    var container = document.getElementById('tui-context-menu-container');
    var target = document.getElementById('tui-context-menu-target');
    
    var instance = new ContextMenu(container);
    
    instance.register(target, { ... });
    

    For more information about the API, please see here.


    Documents

    You can also see the older versions of API page on the releases page.


    Contributing


    License

    This software is licensed under the MIT © NHN Entertainment.