README.md


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61

![Bower version](https://badge.fury.io/bo/vaadin-core-elements.svg)
[![Published on webcomponents.org](https://img.shields.io/badge/webcomponents.org-published-blue.svg)](https://www.webcomponents.org/collection/vaadin/vaadin-core-elements)
[![Gitter](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/vaadin/vaadin-core-elements?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)

# Vaadin Core Elements

[Vaadin elements](https://vaadin.com/elements) are an evolving set of open sourced custom HTML elements, which seamlessly extend the [Polymer Element Catalog](https://elements.polymer-project.org) with high-quality user interface components commonly needed in modern mobile and desktop business web applications. The following elements are included:

| Element | Bower Version | Npm version | Build Status |
|---------|---------------|-------------|--------------|
| [vaadin-combo-box](https://github.com/vaadin/vaadin-combo-box) | ![Bower version](https://badge.fury.io/bo/vaadin-combo-box.svg) | [![npm version](https://badge.fury.io/js/vaadin-combo-box.svg)](https://www.npmjs.com/package/vaadin-combo-box) | [![Build Status](https://travis-ci.org/vaadin/vaadin-combo-box.svg?branch=master)](https://travis-ci.org/vaadin/vaadin-combo-box) |
| [vaadin-context-menu](https://github.com/vaadin/vaadin-context-menu) | ![Bower version](https://badge.fury.io/bo/vaadin-context-menu.svg) | [![npm version](https://badge.fury.io/js/vaadin-context-menu.svg)](https://www.npmjs.com/package/vaadin-context-menu) | [![Build Status](https://travis-ci.org/vaadin/vaadin-context-menu.svg?branch=master)](https://travis-ci.org/vaadin/vaadin-context-menu) |
| [vaadin-date-picker](https://github.com/vaadin/vaadin-date-picker) | ![Bower version](https://badge.fury.io/bo/vaadin-date-picker.svg) | [![npm version](https://badge.fury.io/js/vaadin-date-picker.svg)](https://www.npmjs.com/package/vaadin-date-picker) | [![Build Status](https://travis-ci.org/vaadin/vaadin-date-picker.svg?branch=master)](https://travis-ci.org/vaadin/vaadin-date-picker) |
| [vaadin-grid](https://github.com/vaadin/vaadin-grid) | ![Bower version](https://badge.fury.io/bo/vaadin-grid.svg) | [![npm version](https://badge.fury.io/js/vaadin-grid.svg)](https://www.npmjs.com/package/vaadin-grid) | [![Build Status](https://travis-ci.org/vaadin/vaadin-grid.svg?branch=2.0-dev)](https://travis-ci.org/vaadin/vaadin-grid) |
| [vaadin-icons](https://github.com/vaadin/vaadin-icons) | ![Bower version](https://badge.fury.io/bo/vaadin-icons.svg) | [![npm version](https://badge.fury.io/js/vaadin-icons.svg)](https://www.npmjs.com/package/vaadin-icons) | |
| [vaadin-split-layout](https://github.com/vaadin/vaadin-split-layout) | ![Bower version](https://badge.fury.io/bo/vaadin-split-layout.svg) | [![npm version](https://badge.fury.io/js/vaadin-split-layout.svg)](https://www.npmjs.com/package/vaadin-split-layout) | [![Build status](https://travis-ci.org/vaadin/vaadin-split-layout.svg?branch=master)](https://travis-ci.org/vaadin/vaadin-split-layout) |
| [vaadin-upload](https://github.com/vaadin/vaadin-upload) | ![Bower version](https://badge.fury.io/bo/vaadin-upload.svg) | [![npm version](https://badge.fury.io/js/vaadin-upload.svg)](https://www.npmjs.com/package/vaadin-upload) | [![Build Status](https://travis-ci.org/vaadin/vaadin-upload.svg?branch=master)](https://travis-ci.org/vaadin/vaadin-upload) |

Vaadin Core Elements is a bundle that contains all the free elements, licensed under the Apache License 2.0. In addition, we have commercially licensed elements, such as [Vaadin Charts](https://github.com/vaadin/vaadin-charts).

## 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 ›](https://vaadin.com/elements)

---

## Roadmap

See https://vaadin.com/roadmap for a high level roadmap that is updated once a week.

## Contributing

We would absolutely love to get the community involved, and we 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](https://gitter.im/vaadin/vaadin-core-elements)
- [Forum](https://vaadin.com/forum/#!/category/9848927)
- [Twitter](https://twitter.com/vaadin)
- [Facebook](https://www.facebook.com/vaadin/)
- [G+](https://plus.google.com/communities/108116678608923665301)

### 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](https://vaadin.com/docs/-/part/elements/elements-getting-started.html). 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](https://guides.github.com/activities/contributing-to-open-source/#contributing) also.

## Development

If you want to develop the elements yourself see the [development instructions](DEVELOPMENT.md) that apply to all Vaadin elements.

## License

Apache License 2.0