vaadin-context-menu

WebJar for vaadin-context-menu

License	Apache-2.0
Categories	Vaadin User Interface Web Frameworks
GroupId	org.webjars.npm
ArtifactId	vaadin-context-menu
Last Version	3.0.0-beta1
Release Date	Mar 12, 2018
Type	jar
Description	vaadin-context-menu WebJar for vaadin-context-menu
Project URL	http://webjars.org
Source Code Management	https://github.com/vaadin/vaadin-context-menu

Download vaadin-context-menu

Filename	Size
vaadin-context-menu-3.0.0-beta1.pom
vaadin-context-menu-3.0.0-beta1.jar	91 KB
vaadin-context-menu-3.0.0-beta1-sources.jar	22 bytes
vaadin-context-menu-3.0.0-beta1-javadoc.jar	22 bytes

How to add to project

Apache Maven

<!-- https://jarcasting.com/artifacts/org.webjars.npm/vaadin-context-menu/ -->
<dependency>
    <groupId>org.webjars.npm</groupId>
    <artifactId>vaadin-context-menu</artifactId>
    <version>3.0.0-beta1</version>
</dependency>

Gradle Groovy

// https://jarcasting.com/artifacts/org.webjars.npm/vaadin-context-menu/
implementation 'org.webjars.npm:vaadin-context-menu:3.0.0-beta1'

Gradle Kotlin

// https://jarcasting.com/artifacts/org.webjars.npm/vaadin-context-menu/
implementation ("org.webjars.npm:vaadin-context-menu:3.0.0-beta1")

Apache Buildr

'org.webjars.npm:vaadin-context-menu:jar:3.0.0-beta1'

Apache Ivy

<dependency org="org.webjars.npm" name="vaadin-context-menu" rev="3.0.0-beta1">
  <artifact name="vaadin-context-menu" type="jar" />
</dependency>

Groovy Grape

@Grapes(
@Grab(group='org.webjars.npm', module='vaadin-context-menu', version='3.0.0-beta1')
)

Scala SBT

libraryDependencies += "org.webjars.npm" % "vaadin-context-menu" % "3.0.0-beta1"

Leiningen

[org.webjars.npm/vaadin-context-menu "3.0.0-beta1"]

Dependencies

There are no dependencies for this project. It is a standalone project that does not depend on any other jars.

Project Modules

There are no modules declared in this project.

<vaadin-context-menu>

Live Demo ↗ | API documentation ↗

<vaadin-context-menu> is a Web Component providing a contextual menu, part of the Vaadin components.

<vaadin-context-menu>
  Open a context menu with <b>right click</b> or with <b>long touch.</b>
</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 vaadin-context-menu:

npm i @vaadin/vaadin-context-menu --save

Once installed, import it in your application:

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

Getting started

Vaadin components use the Lumo theme by default.

To use the Material theme, import the correspondent file from the theme/material folder.

Entry points

• The component with the Lumo theme:

  theme/lumo/vaadin-context-menu.js

• The component with the Material theme:

  theme/material/vaadin-context-menu.js

• Alias for theme/lumo/vaadin-context-menu.js:

  vaadin-context-menu.js

Running API docs and tests in a browser

1. Fork the vaadin-context-menu repository and clone it locally.

2. Make sure you have node.js 12.x installed.

3. Make sure you have npm installed.

4. When in the vaadin-context-menu directory, run npm install to install dependencies.

5. Run npm start, browser will automatically open the component API documentation.

6. You can also open visual tests, for example:

• http://127.0.0.1:3000/test/visual/default.html

Running tests from the command line

1. When in the vaadin-context-menu directory, run npm test

Debugging tests in the browser

1. Run npm run debug, then choose manual mode (M) and open the link in browser.

Following the coding style

We are using ESLint for linting JavaScript code. You can check if your code is following our standards by running npm run lint, which will automatically lint all .js files.

Big Thanks

Cross-browser Testing Platform and Open Source <3 Provided by Sauce Labs.

Contributing

To contribute to the component, please read the guideline first.

License

Apache License 2.0

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

Vaadin

An open platform for building modern web apps for Java back ends

Versions

Version
3.0.0-beta1 Mar 12, 2018