Skip to content

Latest commit

 

History

History
87 lines (56 loc) · 3.2 KB

README.md

File metadata and controls

87 lines (56 loc) · 3.2 KB

Build Status Maven Central Javadoc

Add-on Utils

Utilities for Vaadin add-ons.

Features

  • Check that the add-on package is allowed. In development mode, show a browser alert if it isn't allowed.
  • Compatible with Vaadin 14-24

Maven install

Add the following dependencies in your pom.xml file:

<dependency>
   <groupId>com.flowingcode.vaadin.addons</groupId>
   <artifactId>addon-utils</artifactId>
   <version>X.Y.Z</version>
</dependency>

Release versions are available from Maven Central repository. For SNAPSHOT versions see here.

Release notes

See here

Issue tracking

The issues for this library are tracked on its github.com page. All bug reports and feature requests are appreciated.

Contributions

Contributions are welcome, but there are no guarantees that they are accepted as such.

As first step, please refer to our Development Conventions page to find information about Conventional Commits & Code Style requirements.

Then, follow these steps for creating a contribution:

  • Fork this project.
  • Create an issue to this project about the contribution (bug or feature) if there is no such issue about it already. Try to keep the scope minimal.
  • Develop and test the fix or functionality carefully. Only include minimum amount of code needed to fix the issue.
  • For commit message, use Conventional Commits to describe your change.
  • Send a pull request for the original project.
  • Comment on the original issue that you have implemented a fix for it.

License & Author

This library is distributed under Apache License 2.0. For license terms, see LICENSE.txt.

AddonUtils is written by Flowing Code S.A.

Developer Guide

Getting started

Check that com.flowingcode.vaadin.addons.example is included in the allowed-packages list. If missing, show an alert in the browser.

package com.flowingcode.vaadin.addons.example;

public class MyComponent extends Div {

  public MyComponent() {
    AllowedPackageChecker.check(this, MyComponent.class);
  }

}

Check that com.flowingcode.vaadin.addons.example is included in the allowed-packages list. If missing, show an alert in the browser (the alert will reference com.flowingcode).

package com.flowingcode.vaadin.addons.example;

public class MyComponent extends Div {

  public MyComponent() {
    AllowedPackageChecker.check(this, MyComponent.class, "com.flowingcode");
  }

}