https://github.com/nhn/tui.context-menu
Component that creates a menu when the right mouse button is clicked.
https://github.com/nhn/tui.context-menu
component
Last synced: about 2 months ago
JSON representation
Component that creates a menu when the right mouse button is clicked.
- Host: GitHub
- URL: https://github.com/nhn/tui.context-menu
- Owner: nhn
- License: mit
- Created: 2016-05-20T08:53:15.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2023-04-17T05:59:55.000Z (over 2 years ago)
- Last Synced: 2025-06-11T02:09:54.997Z (4 months ago)
- Topics: component
- Language: JavaScript
- Homepage: https://nhn.github.io/tui.context-menu/latest/
- Size: 5.29 MB
- Stars: 46
- Watchers: 13
- Forks: 9
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# TOAST UI Component : Context Menu
> Component that creates a menu when the right mouse button is clicked.
[](https://github.com/nhn/tui.context-menu/releases/latest)
[](https://www.npmjs.com/package/tui-context-menu)
[](https://github.com/nhn/tui.context-menu/blob/production/LICENSE)
[](https://github.com/nhn/tui.project-name/labels/help%20wanted)
[](https://github.com/nhn)
## 🚩 Table of Contents
- [Collect statistics on the use of open source](#collect-statistics-on-the-use-of-open-source)
- [📙 Documents](#-documents)
- [🎨 Features](#-features)
- [🐾 Examples](#-examples)
- [💾 Install](#-install)
- [Via Package Manager](#via-package-manager)
- [npm](#npm)
- [bower](#bower)
- [Via Contents Delivery Network (CDN)](#via-contents-delivery-network-cdn)
- [Download Source Files](#download-source-files)
- [🔨 Usage](#-usage)
- [HTML](#html)
- [JavaScript](#javascript)
- [Using namespace in browser environment](#using-namespace-in-browser-environment)
- [Using module format in node environment](#using-module-format-in-node-environment)
- [🌏 Browser Support](#-browser-support)
- [🔧 Pull Request Steps](#-pull-request-steps)
- [Setup](#setup)
- [Develop](#develop)
- [Running dev server](#running-dev-server)
- [Running test](#running-test)
- [Pull Request](#pull-request)
- [💬 Contributing](#-contributing)
- [🍞 TOAST UI Family](#-toast-ui-family)
- [📜 License](#-license)
## Collect statistics on the use of open source
TOAST UI ContextMenu applies Google Analytics (GA) to collect statistics on the use of open source, in order to identify how widely TOAST UI ContextMenu is used throughout the world.
It also serves as important index to determine the future course of projects.
`location.hostname` (e.g. > “ui.toast.com") is to be collected and the sole purpose is nothing but to measure statistics on the usage.
To disable GA, use the following `usageStatistics` option when creating the instance.
```js
const options = {
...
usageStatistics: false
}
const instance = new ContextMenu(container, options);
```
Or, include [`tui-code-snippet`](https://github.com/nhn/tui.code-snippet)(**v2.2.0** or **later**) and then immediately write the options as follows:
```js
tui.usageStatistics = false;
```
## 📙 Documents
- [Getting Started](https://github.com/nhn/tui.context-menu/blob/production/docs/getting-started.md)
- [Tutorials](https://github.com/nhn/tui.context-menu/tree/production/docs)
- [APIs](https://nhn.github.io/tui.context-menu/latest/)
You can also see the older versions of API page on the [releases page](https://github.com/nhn/tui.context-menu/releases).
## 🎨 Features
- Creates a context menu hierarchically by data.
- Makes each menu item enable or disable.
- Supports custom events.
## 🐾 Examples
- [Basic](https://nhn.github.io/tui.context-menu/latest/tutorial-example01-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](https://www.npmjs.com/) and [bower](https://bower.io/).
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](https://nodejs.org/ko/) is installed.
#### npm
```sh
$ npm install --save tui-context-menu # Latest version
$ npm install --save tui-context-menu@ # Specific version
```
#### bower
```sh
$ bower install tui-context-menu # Latest version
$ bower install tui-context-menu# # Specific version
```
### Via Contents Delivery Network (CDN)
TOAST UI products are available over the CDN powered by [TOAST Cloud](https://www.toast.com).
You can use the CDN as below.
```html
```
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.css
│ └─ tui-context-menu.min.js
├─ v2.1.0/
│ ├─ ...
```
### Download Source Files
- [Download bundle files](https://github.com/nhn/tui.context-menu/tree/production/dist)
- [Download all sources for each version](https://github.com/nhn/tui.context-menu/releases)
## 🔨 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.
```html
```
### 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
```javascript
const ContextMenu = tui.ContextMenu;
```
#### Using module format in node environment
```javascript
const ContextMenu = require('tui-context-menu'); /* CommonJS */
```
```javascript
import ContextMenu from 'tui-context-menu'; /* ES6 */
```
You should call `register` method with [options](https://nhn.github.io/tui.context-menu/latest/ContextMenu#register) after creating an instance to attach a context menu.
```javascript
const container = document.getElementById('tui-context-menu-container');
const target = document.getElementById('tui-context-menu-target');
const instance = new ContextMenu(container);
instance.register(target, { ... });
```
For more information about the API, please see [here](http://nhn.github.io/tui.context-menu/latest/ContextMenu).
## 🌏 Browser Support
| 
Chrome | 
Internet Explorer | 
Edge | 
Safari | 
Firefox |
| :--------------------------------------------------------------------------------------------------------------------------------------------------------------: | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :----------------------------------------------------------------------------------------------------------------------------------------------------------: | :--------------------------------------------------------------------------------------------------------------------------------------------------------------: | :----------------------------------------------------------------------------------------------------------------------------------------------------------------: |
| Yes | 9+ | Yes | Yes | Yes |
## 🔧 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 if there are any errors.
```sh
$ 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 reflected as soon as you save the code by running a server.
Don't miss adding test cases and then make green rights.
#### Running dev server
```sh
$ npm run serve
```
#### Running test
```sh
$ npm run test
```
### Pull Request
Before uploading your PR, run test one last time to check if there are any errors.
If it has no errors, commit and then push it!
For more information on PR's steps, please see links in the Contributing section.
## 💬 Contributing
- [Code of Conduct](https://github.com/nhn/tui.context-menu/blob/master/CODE_OF_CONDUCT.md)
- [Contributing guideline](https://github.com/nhn/tui.context-menu/blob/master/CONTRIBUTING.md)
- [Issue guideline](https://github.com/nhn/tui.context-menu/blob/master/ISSUE_TEMPLATE.md)
- [Commit convention](https://github.com/nhn/tui.context-menu/blob/master/docs/COMMIT_MESSAGE_CONVENTION.md)
## 🍞 TOAST UI Family
- [TOAST UI Editor](https://github.com/nhn/tui.editor)
- [TOAST UI Calendar](https://github.com/nhn/tui.calendar)
- [TOAST UI Chart](https://github.com/nhn/tui.chart)
- [TOAST UI Image-Editor](https://github.com/nhn/tui.image-editor)
- [TOAST UI Grid](https://github.com/nhn/tui.grid)
- [TOAST UI Components](https://github.com/nhn)
## 📜 License
This software is licensed under the [MIT](https://github.com/nhn/tui.context-menu/blob/production/LICENSE) © [NHN Cloud](https://github.com/nhn).