You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

README.md 14KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778
  1. ![Bower version](https://badge.fury.io/bo/vaadin.svg)
  2. [![Published on Vaadin Directory](https://img.shields.io/badge/Vaadin%20Directory-published-00b4f0.svg)](https://vaadin.com/directory/search?framework=Polymer%202&keyword=vaadin)
  3. [![Published on webcomponents.org](https://img.shields.io/badge/webcomponents.org-published-blue.svg)](https://www.webcomponents.org/author/vaadin)
  4. [![Gitter](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/vaadin/web-components?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
  5. # Vaadin components
  6. [Vaadin components](https://vaadin.com/components) is an evolving set of high-quality user interface web components commonly needed in modern mobile and desktop business web applications. The following components are included:
  7. | Component | Build Status | Polymer 2 (Bower version) | Polymer 3 (npm version) |
  8. |-----------|--------------|---------------------------|-------------------------|
  9. | [vaadin-board](https://github.com/vaadin/vaadin-board)* | [![Build Status](https://travis-ci.org/vaadin/vaadin-board.svg?branch=master)](https://travis-ci.org/vaadin/vaadin-board) | [![Bower version](https://badgen.net/github/release/vaadin/vaadin-board)](https://github.com/vaadin/vaadin-board/releases) | [![npm version](https://badgen.net/npm/v/@vaadin/vaadin-board)](https://www.npmjs.com/package/@vaadin/vaadin-board) |
  10. | [vaadin-button](https://github.com/vaadin/vaadin-button) | [![Build Status](https://travis-ci.org/vaadin/vaadin-button.svg?branch=master)](https://travis-ci.org/vaadin/vaadin-button) | [![Bower version](https://badgen.net/github/release/vaadin/vaadin-button)](https://github.com/vaadin/vaadin-button/releases) | [![npm version](https://badgen.net/npm/v/@vaadin/vaadin-button)](https://www.npmjs.com/package/@vaadin/vaadin-button) |
  11. | [vaadin-charts](https://github.com/vaadin/vaadin-charts)* | [![Build Status](https://travis-ci.org/vaadin/vaadin-charts.svg?branch=master)](https://travis-ci.org/vaadin/vaadin-charts) | [![Bower version](https://badgen.net/github/release/vaadin/vaadin-charts)](https://github.com/vaadin/vaadin-charts/releases) | [![npm version](https://badgen.net/npm/v/@vaadin/vaadin-charts)](https://www.npmjs.com/package/@vaadin/vaadin-charts) |
  12. | [vaadin-checkbox](https://github.com/vaadin/vaadin-checkbox) | [![Build Status](https://travis-ci.org/vaadin/vaadin-checkbox.svg?branch=master)](https://travis-ci.org/vaadin/vaadin-checkbox) | [![Bower version](https://badgen.net/github/release/vaadin/vaadin-checkbox)](https://github.com/vaadin/vaadin-checkbox/releases) | [![npm version](https://badgen.net/npm/v/@vaadin/vaadin-checkbox)](https://www.npmjs.com/package/@vaadin/vaadin-checkbox) |
  13. | [vaadin-combo-box](https://github.com/vaadin/vaadin-combo-box) | [![Build Status](https://travis-ci.org/vaadin/vaadin-combo-box.svg?branch=master)](https://travis-ci.org/vaadin/vaadin-combo-box) | [![Bower version](https://badgen.net/github/release/vaadin/vaadin-combo-box)](https://github.com/vaadin/vaadin-combo-box/releases) | [![npm version](https://badgen.net/npm/v/@vaadin/vaadin-combo-box)](https://www.npmjs.com/package/@vaadin/vaadin-combo-box) |
  14. | [vaadin-confirm-dialog](https://github.com/vaadin/vaadin-confirm-dialog)* | [![Build Status](https://travis-ci.org/vaadin/vaadin-confirm-dialog.svg?branch=master)](https://travis-ci.org/vaadin/vaadin-confirm-dialog) | [![Bower version](https://badgen.net/github/release/vaadin/vaadin-confirm-dialog)](https://github.com/vaadin/vaadin-confirm-dialog/releases) | [![npm version](https://badgen.net/npm/v/@vaadin/vaadin-confirm-dialog)](https://www.npmjs.com/package/@vaadin/vaadin-confirm-dialog) |
  15. | [vaadin-context-menu](https://github.com/vaadin/vaadin-context-menu) | [![Build Status](https://travis-ci.org/vaadin/vaadin-context-menu.svg?branch=master)](https://travis-ci.org/vaadin/vaadin-context-menu) | [![Bower version](https://badgen.net/github/release/vaadin/vaadin-context-menu)](https://github.com/vaadin/vaadin-context-menu/releases) | [![npm version](https://badgen.net/npm/v/@vaadin/vaadin-context-menu)](https://www.npmjs.com/package/@vaadin/vaadin-context-menu) |
  16. | [vaadin-cookie-consent](https://github.com/vaadin/vaadin-cookie-consent)* | [![Build Status](https://travis-ci.org/vaadin/vaadin-cookie-consent.svg?branch=master)](https://travis-ci.org/vaadin/vaadin-cookie-consent) | [![Bower version](https://badgen.net/github/release/vaadin/vaadin-cookie-consent)](https://github.com/vaadin/vaadin-cookie-consent/releases) | [![npm version](https://badgen.net/npm/v/@vaadin/vaadin-cookie-consent)](https://www.npmjs.com/package/@vaadin/vaadin-cookie-consent) |
  17. | [vaadin-date-picker](https://github.com/vaadin/vaadin-date-picker) | [![Build Status](https://travis-ci.org/vaadin/vaadin-date-picker.svg?branch=master)](https://travis-ci.org/vaadin/vaadin-date-picker) | [![Bower version](https://badgen.net/github/release/vaadin/vaadin-date-picker)](https://github.com/vaadin/vaadin-date-picker/releases) | [![npm version](https://badgen.net/npm/v/@vaadin/vaadin-date-picker)](https://www.npmjs.com/package/@vaadin/vaadin-date-picker) |
  18. | [vaadin-dialog](https://github.com/vaadin/vaadin-dialog) | [![Build Status](https://travis-ci.org/vaadin/vaadin-dialog.svg?branch=master)](https://travis-ci.org/vaadin/vaadin-dialog) | [![Bower version](https://badgen.net/github/release/vaadin/vaadin-dialog)](https://github.com/vaadin/vaadin-dialog/releases) | [![npm version](https://badgen.net/npm/v/@vaadin/vaadin-dialog)](https://www.npmjs.com/package/@vaadin/vaadin-dialog) |
  19. | [vaadin-form-layout](https://github.com/vaadin/vaadin-form-layout) | [![Build Status](https://travis-ci.org/vaadin/vaadin-form-layout.svg?branch=master)](https://travis-ci.org/vaadin/vaadin-form-layout) | [![Bower version](https://badgen.net/github/release/vaadin/vaadin-form-layout)](https://github.com/vaadin/vaadin-form-layout/releases) | [![npm version](https://badgen.net/npm/v/@vaadin/vaadin-form-layout)](https://www.npmjs.com/package/@vaadin/vaadin-form-layout) |
  20. | [vaadin-grid](https://github.com/vaadin/vaadin-grid) | [![Build Status](https://travis-ci.org/vaadin/vaadin-grid.svg?branch=master)](https://travis-ci.org/vaadin/vaadin-grid) | [![Bower version](https://badgen.net/github/release/vaadin/vaadin-grid)](https://github.com/vaadin/vaadin-grid/releases) | [![npm version](https://badgen.net/npm/v/@vaadin/vaadin-grid)](https://www.npmjs.com/package/@vaadin/vaadin-grid) |
  21. | [vaadin-icons](https://github.com/vaadin/vaadin-icons) | [![Build status](https://travis-ci.org/vaadin/vaadin-icons.svg?branch=master)](https://travis-ci.org/vaadin/vaadin-icons) | [![Bower version](https://badgen.net/github/release/vaadin/vaadin-icons)](https://github.com/vaadin/vaadin-icons/releases) | [![npm version](https://badgen.net/npm/v/@vaadin/vaadin-icons)](https://www.npmjs.com/package/@vaadin/vaadin-icons) |
  22. | [vaadin-item](https://github.com/vaadin/vaadin-item) | [![Build Status](https://travis-ci.org/vaadin/vaadin-item.svg?branch=master)](https://travis-ci.org/vaadin/vaadin-item) | [![Bower version](https://badgen.net/github/release/vaadin/vaadin-item)](https://github.com/vaadin/vaadin-item/releases) | [![npm version](https://badgen.net/npm/v/@vaadin/vaadin-item)](https://www.npmjs.com/package/@vaadin/vaadin-item) |
  23. | [vaadin-list-box](https://github.com/vaadin/vaadin-list-box) | [![Build Status](https://travis-ci.org/vaadin/vaadin-list-box.svg?branch=master)](https://travis-ci.org/vaadin/vaadin-list-box) | [![Bower version](https://badgen.net/github/release/vaadin/vaadin-list-box)](https://github.com/vaadin/vaadin-list-box/releases) | [![npm version](https://badgen.net/npm/v/@vaadin/vaadin-list-box)](https://www.npmjs.com/package/@vaadin/vaadin-list-box) |
  24. | [vaadin-notification](https://github.com/vaadin/vaadin-notification) | [![Build Status](https://travis-ci.org/vaadin/vaadin-notification.svg?branch=master)](https://travis-ci.org/vaadin/vaadin-notification) | [![Bower version](https://badgen.net/github/release/vaadin/vaadin-notification)](https://github.com/vaadin/vaadin-notification/releases) | [![npm version](https://badgen.net/npm/v/@vaadin/vaadin-notification)](https://www.npmjs.com/package/@vaadin/vaadin-notification) |
  25. | [vaadin-ordered-layout](https://github.com/vaadin/vaadin-ordered-layout) | [![Build Status](https://travis-ci.org/vaadin/vaadin-ordered-layout.svg?branch=master)](https://travis-ci.org/vaadin/vaadin-ordered-layout) | [![Bower version](https://badgen.net/github/release/vaadin/vaadin-ordered-layout)](https://github.com/vaadin/vaadin-ordered-layout/releases) | [![npm version](https://badgen.net/npm/v/@vaadin/vaadin-ordered-layout)](https://www.npmjs.com/package/@vaadin/vaadin-ordered-layout) |
  26. | [vaadin-progress-bar](https://github.com/vaadin/vaadin-progress-bar) | [![Build status](https://travis-ci.org/vaadin/vaadin-progress-bar.svg?branch=master)](https://travis-ci.org/vaadin/vaadin-progress-bar) | [![Bower version](https://badgen.net/github/release/vaadin/vaadin-progress-bar)](https://github.com/vaadin/vaadin-progress-bar/releases) | [![npm version](https://badgen.net/npm/v/@vaadin/vaadin-progress-bar)](https://www.npmjs.com/package/@vaadin/vaadin-progress-bar) |
  27. | [vaadin-radio-button](https://github.com/vaadin/vaadin-radio-button) | [![Build status](https://travis-ci.org/vaadin/vaadin-radio-button.svg?branch=master)](https://travis-ci.org/vaadin/vaadin-radio-button) | [![Bower version](https://badgen.net/github/release/vaadin/vaadin-radio-button)](https://github.com/vaadin/vaadin-radio-button/releases) | [![npm version](https://badgen.net/npm/v/@vaadin/vaadin-radio-button)](https://www.npmjs.com/package/@vaadin/vaadin-radio-button) |
  28. | [vaadin-select](https://github.com/vaadin/vaadin-select) | [![Build status](https://travis-ci.org/vaadin/vaadin-select.svg?branch=master)](https://travis-ci.org/vaadin/vaadin-select) | [![Bower version](https://badgen.net/github/release/vaadin/vaadin-select)](https://github.com/vaadin/vaadin-select/releases) | [![npm version](https://badgen.net/npm/v/@vaadin/vaadin-select)](https://www.npmjs.com/package/@vaadin/vaadin-select) |
  29. | [vaadin-split-layout](https://github.com/vaadin/vaadin-split-layout) | [![Build status](https://travis-ci.org/vaadin/vaadin-split-layout.svg?branch=master)](https://travis-ci.org/vaadin/vaadin-split-layout) | [![Bower version](https://badgen.net/github/release/vaadin/vaadin-split-layout)](https://github.com/vaadin/vaadin-split-layout/releases) | [![npm version](https://badgen.net/npm/v/@vaadin/vaadin-split-layout)](https://www.npmjs.com/package/@vaadin/vaadin-split-layout) |
  30. | [vaadin-tabs](https://github.com/vaadin/vaadin-tabs) | [![Build Status](https://travis-ci.org/vaadin/vaadin-tabs.svg?branch=master)](https://travis-ci.org/vaadin/vaadin-tabs) | [![Bower version](https://badgen.net/github/release/vaadin/vaadin-tabs)](https://github.com/vaadin/vaadin-tabs/releases) | [![npm version](https://badgen.net/npm/v/@vaadin/vaadin-tabs)](https://www.npmjs.com/package/@vaadin/vaadin-tabs) |
  31. | [vaadin-text-field](https://github.com/vaadin/vaadin-text-field) | [![Build Status](https://travis-ci.org/vaadin/vaadin-text-field.svg?branch=master)](https://travis-ci.org/vaadin/vaadin-text-field) | [![Bower version](https://badgen.net/github/release/vaadin/vaadin-text-field)](https://github.com/vaadin/vaadin-text-field/releases) | [![npm version](https://badgen.net/npm/v/@vaadin/vaadin-text-field)](https://www.npmjs.com/package/@vaadin/vaadin-text-field) |
  32. | [vaadin-time-picker](https://github.com/vaadin/vaadin-time-picker) | [![Build Status](https://travis-ci.org/vaadin/vaadin-time-picker.svg?branch=master)](https://travis-ci.org/vaadin/vaadin-time-picker) | [![Bower version](https://badgen.net/github/release/vaadin/vaadin-time-picker)](https://github.com/vaadin/vaadin-time-picker/releases) | [![npm version](https://badgen.net/npm/v/@vaadin/vaadin-time-picker)](https://www.npmjs.com/package/@vaadin/vaadin-time-picker) |
  33. | [vaadin-upload](https://github.com/vaadin/vaadin-upload) | [![Build Status](https://travis-ci.org/vaadin/vaadin-upload.svg?branch=master)](https://travis-ci.org/vaadin/vaadin-upload) | [![Bower version](https://badgen.net/github/release/vaadin/vaadin-upload)](https://github.com/vaadin/vaadin-upload/releases) | [![npm version](https://badgen.net/npm/v/@vaadin/vaadin-upload)](https://www.npmjs.com/package/@vaadin/vaadin-upload) |
  34. Components marked with a `*` are part of the [Vaadin Pro Subscription](https://vaadin.com/pricing), other components are licensed under the Apache License 2.0.
  35. ## Learn more
  36. See the list of components, demos and documentation, instructions how to get started, video tutorials, application demos and more by visiting:
  37. ### [vaadin.com/components ›](https://vaadin.com/components)
  38. ---
  39. ## Contributing
  40. 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 components.
  41. ### Get in touch with the team
  42. 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).
  43. - [Chat](https://gitter.im/vaadin/web-components)
  44. - [Forum](https://vaadin.com/forum/#!/category/9848927)
  45. - [Twitter](https://twitter.com/vaadin)
  46. - [Facebook](https://www.facebook.com/vaadin/)
  47. - [G+](https://plus.google.com/communities/108116678608923665301)
  48. ### Some ways to help:
  49. - **Test the components and provide feedback**: We would love to hear your feedback on anything related to the components, like features, API and design. The best way to start is by [trying them out](https://vaadin.com/components/browse). And to get a quick response, either drop a question/comment on the chat or open an issue in GitHub.
  50. - **Report bugs**: File issues for the components in their respective GitHub projects. You can find links to them from the list in this readme.
  51. - **Send pull requests**: If you want to contribute code, check out the development instructions below.
  52. We encourage you to read the [contribution instructions by GitHub](https://guides.github.com/activities/contributing-to-open-source/#contributing) also.
  53. ## Development
  54. If you want to develop the components yourself see the [development instructions](DEVELOPMENT.md) that apply to all Vaadin components.
  55. ## License
  56. Apache License 2.0 or CVAL 3.0 depending on the component