@vaadin/context-menu

@vaadin/context-menu

A web component that can be attached to any component to display a context menu.

Documentation + Live Demo ↗

<vaadin-context-menu>
  <span>Open a context menu with <b>right click</b> or with <b>long touch.</b></span>
</vaadin-context-menu>

<script>
  const contextMenu = document.querySelector('vaadin-context-menu');
  contextMenu.renderer = function (root) {
    let listBox = root.firstElementChild;
    // Check if there is a list-box generated with the previous renderer call to update its content instead of recreation
    if (listBox) {
      listBox.innerHTML = '';
    } else {
      listBox = document.createElement('vaadin-list-box');
      root.appendChild(listBox);
    }

    ['First', 'Second', 'Third'].forEach(function (name) {
      const item = document.createElement('vaadin-item');
      item.textContent = name + ' menu item';
      listBox.appendChild(item);
    });
  };
</script>

Note: <vaadin-list-box> component used in the above example should be installed and imported separately.

Installation

Install the component:

npm i @vaadin/context-menu

Once installed, import the component in your application:

import '@vaadin/context-menu';

Themes

Vaadin components come with two built-in themes, Lumo and Material. The main entrypoint of the package uses the Lumo theme.

To use the Material theme, import the component from the theme/material folder:

import '@vaadin/context-menu/theme/material/vaadin-context-menu.js';

You can also import the Lumo version of the component explicitly:

import '@vaadin/context-menu/theme/lumo/vaadin-context-menu.js';

Finally, you can import the un-themed component from the src folder to get a minimal starting point:

import '@vaadin/context-menu/src/vaadin-context-menu.js';

License

This program is available under Vaadin Commercial License and Service Terms. For license terms, see LICENSE.

Vaadin collects usage statistics at development time to improve this product. For details and to opt-out, see https://github.com/vaadin/vaadin-usage-statistics.