Share your code. npm Orgs help your team discover, share, and reuse code. Create a free org »

tui-context-menu

2.1.0 • Public • Published

TOAST UI Component : Context Menu

Component that creates a menu when the right mouse button is clicked.

GitHub release npm GitHub license PRs welcome code with hearth by NHN Entertainment

🚩 Table of Contents

🌏 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.

🔧 Pull Request Steps

TOAST UI products are open source, so you can create a pull request(PR) after you fix issues. Run npm scripts and develop yourself with the following process.

Setup

Fork develop branch into your personal repository. Clone it to local computer. Install node modules. Before starting development, you should check to haveany errors.

$ git clone https://github.com/{your-personal-repo}/tui.context-menu.git
cd tui.context-menu
$ npm install
$ npm run test

Develop

Let's start development! You can see your code is reflected as soon as you saving the codes by running a server. Don't miss adding test cases and then make green rights.

Run webpack-dev-server

$ npm run serve
$ npm run serve:ie8 # Run on Internet Explorer 8 

Run karma test

$ npm run test

Pull Request

Before PR, check to test lastly and then check any errors. If it has no error, commit and then push it!

For more information on PR's step, please see links of Contributing section.

📙 Documents

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

💬 Contributing

🔩 Dependency

📜 License

This software is licensed under the MIT © NHN Entertainment.

install

npm i tui-context-menu

Downloadsweekly downloads

5

version

2.1.0

license

MIT

homepage

github.com

repository

Gitgithub

last publish

collaborators

  • avatar
Report a vulnerability