Using Vaadin Add-ons

Using add-ons are intended to be as "drop-in packages" for your web project using the Vaadin Framework.

Downloading Add-ons

Downloading Vaadin Add-ons

There are two ways to install Vaadin add-ons:

  1. Maven dependency
  2. Jar or zip download

Installing with Maven

Note: We assume and recommend that you create the project using one of the Vaadin Maven archetypes: See https://vaadin.com/maven for details.

1 ) Vaadin add-ons are served from own Maven repository availble at http://maven.vaadin.com/vaadin-addons. Add the following repository to you project pom.xml:


<repositories>
<repository>
   <id>vaadin-addons</id>
   <url>http://maven.vaadin.com/vaadin-addons</url>
</repository>
</repositories>

2 ) Pick the Maven dependency snippet from the add-on details page in the Directory and put to your pom.xml dependencies section.

Note to NetBeans IDE users:
Vaadin plugin for NetBeans has very good built-in Directory support, that automates these steps and you can just use code completion to install new add-ons from the Directory.

4 ) Compile the widgetset using Vaadin Maven plugin. You should have this installed in your pom.xml, if you have generated the project using the archetype. See detailed instructions.

Installing Add-ons from zip or jar

1 ) You can download the add-on packages from the add-on details page in the Directory (like this one). Simply save the jar or zip file on to your computer.

2 ) Some add-ons have several versions available and you can choose the version to download from the dropdown menu in the header of the add-on details page. The latest version is always selected by default.

The usage depends on the way the add-on is packed as well as the type of project you have.

  • Zip-files: Extract the zip file and follow the instructions included in the package. Typically you just copy a jar-file from the zip to your web project under WEB-INF/lib folder and recompile the project.
  • Jar-files: Copy the jar-file to your web project under WEB-INF/lib folder and recompile the project.

Important
If the add-on has any custom client-side code (i.e. contains a *.gwt.xml file defining a widget set), your application must define a single widget set that inherits from the add-on widget sets in your project. See the links below for more details on how this is accomplished.

Eclipse IDE users use the Vaadin Plugin for Eclipse. The plugin automatically detects any new add-ons in the classpath does a GWT compilation as needed. If you have any problems with automatic compilation, ensure that you are using the most recent plugin version.

NetBeans IDE users can use Vaadin Plugin for Netbeans. The plugin automatically detects any new add-ons in the classpath does a GWT compilation as needed.

Using Add-ons

Depending on the type of the add-on you can then start using it:

  • Themes: Add a @Theme("theme-name") annotation into UI class.
  • Components and widgets: The components and widgets are Java classes and you can use them right away. Remember that client-side widgets need GWT compilation before they can be deployed.
  • Tools: Please follow the documentation provided in the zip file.

The add-on information page typically contains helpful information and links to samples and tutorials. Follow these to learn more about the specific add-on.

Installing Add-on licenses

Some add-ons need a license key before they can be used. You can find more information about installing the licenses here: Install CVAL license keys