Vaadin Core Elements

Vaadin elements are an evolving set of open sourced custom HTML elements, which seamlessly extend the Polymer Element Catalog with high-quality user interface components commonly needed in modern mobile and desktop business web applications.

Vaadin Core Elements is a bundle that contains all the free elements, licensed under the Apache License 2.0.

Learn more

See the list of elements, demos and documentation, instructions how to get started, video tutorials, application demos and more by visiting:

vaadin.com/elements ›

---

Roadmap

This is a high level view of the upcoming releases for Vaadin Core Elements. The nearest releases are more likely to include what is stated here, but further plans have a higher risk of changing.

Individual elements of the Core Elements bundle are released separately, and you can track their progress from their relevant milestones (TBA). The bundle version is released once all individual element milestones for it are finished.

You can see more detailed roadmaps of each element from their respective GitHub repositories.

Version 0.4

• <vaadin-combo-box> 1.0
• <vaadin-icons> 1.0

Version 0.5

• <vaadin-date-picker> 1.0

Version 1.0

• <vaadin-upload> 1.0
• <vaadin-grid> 1.1

Version 1.1

• <vaadin-grid> 1.2
• <vaadin-combo-box> 1.1
• <vaadin-date-picker> 1.1

Version labels

On top of the common version numbering (major.minor.patch) Vaadin uses labels to indicate the maturity of a version.

Examples: 1.0.0-alpha2, 1.0.0-beta4, 1.0.0-rc1

• Alpha: A snapshot mainly to gather feedback from users. All features and implementation details are still subject to change.

• Beta: Feature-complete release of the upcoming version. The API may change a bit here and there, but no changes in functionality are to be expected.

• RC: Also known as “release candidate”. Only bug fixes can be expected to happen before the stable version.

All of the maturity tags can be suffixed with a number, so for example “rc2” is the second release candidate of a certain version.

Contributing

We would like nothing more than getting the community involved, and welcome any form of contributions – comments and questions on different communication channels, issues and pull request in the repositories, and anything that you build and share using our elements.

Get in touch with the team

The chat and the forum category are dedicated channels for this project, while the Twitter, Facebook and G+ pages are common for all Vaadin related discussion (including the Java framework).

• Chat
• Forum
• Twitter
• Facebook
• G+

Some ways to help:

• Test the elements and provide feedback: We would love to hear your feedback on anything related to the elements, like features, API and design. The best way to start is by trying them out. And to get a quick response, either drop a question/comment on the chat or open an issue in GitHub.
• Report bugs: File issues for the elements in their respective GitHub projects. You can find links to them from https://vaadin.com/elements
• Send pull requests: If you want to contribute code, check out the development instructions below.

We encourage you to read the contribution instructions by GitHub also.

Development

Each element has it’s own GitHub repository, where development is done. The vaadin-core-element project is just a top-level bundle without actual production code.

Familiarize yourself with the code and try to follow the same syntax conventions to make it easier for us to accept your pull requests.

The following instructions are common for all Vaadin core elements. Replace vaadin-combo-box with any other element in the following examples. Check the element readmes for any special development notes.

Getting the code

1. Clone the element project from GitHub:
   

  $ git clone https://github.com/vaadin/vaadin-combo-box.git

1. Install Node. It comes bundled with npm, which is needed to install other tooling.

2. Install Bower using npm:

  $ npm install -g bower

If you encounter permission issues when running npm see the article about fixing npm permissions on npmjs.com

1. Use Bower to install the dependencies of the element:
   

  $ cd vaadin-combo-box
  $ bower install

Running demos

1. Install polyserve using npm:
   

  $ npm install -g polyserve

1. Start a local server in the project root directory:
   

  $ cd vaadin-combo-box
  $ polyserve

1. Open the following URLs in your browser:
   • Demo: http://localhost:8080/components/vaadin-combo-box/demo/
   • Generated API documentation: http://localhost:8080/components/vaadin-combo-box/

Running tests

Install Web Component Tester using npm:

$ npm install -g web-component-tester

Tests can be run with the wct task from the element directory:

$ cd vaadin-combo-box
$ wct

You can also run and debug the tests manually:

$ cd vaadin-combo-box
$ polyserve

• Open http://localhost:8080/components/vaadin-combo-box/test/ in your browser.

You should include new tests in your pull requests if you add features to the elements or if you are fixing a bug.

Documentation

We follow the same style guide as Polymer.

Contributor License Agreement

Before we can accept any of your code contributions, you need to sign the CLA. More details to come regarding this, but you can already open pull requests if you want to. We will work out the CLA case-by-case until we get an automated solution in place.

License

Apache License 2.0