mirrors
/
vaadin-framework
mirror of https://github.com/vaadin/framework.git
Watch 1
Star 0
Fork 0
Code Issues 0 Releases 329 Wiki Activity
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.
19188 Commits
114 Branches
Branch: master
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from 'master'
${ noResults }
vaadin-framework/documentation/addons/addons-overview.asciidoc

addons-overview.asciidoc 2.4KB
Raw Permalink Blame History

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849 
  1. ---

  2. title: Overview

  3. order: 1

  4. layout: page

  5. ---

  6. 

  7. [[addons.overview]]

  8. = Overview

  9. 

  10. In addition to the components, layouts, themes, and data sources built in into

  11. the core Vaadin library, many others are available as add-ons.

  12. link:http://vaadin.com/directory/[Vaadin Directory] provides a rich collection

  13. of add-ons for Vaadin, and you may find others from independent sources. Add-ons

  14. are also one way to share your own components between projects.

  15. 

  16. == Installing

  17. 

  18. Installing add-ons from Vaadin Directory is simple, just adding a Maven or an Ivy dependency, or downloading the JAR package and and dropping it in the web library folder of the project.

  19. 

  20. [[figure.addons.maven.widgetset]]

  21. .Role of the widget set

  22. image::img/addon-architecture.png[width=75%, scaledwidth=80%]

  23. 

  24. Most add-ons include _widgets_, client-side counterparts of the server-side components used in the Vaadin Java API, as illustrated in <<figure.addons.maven.widgetset>>.

  25. The _widget set_ needs to be compiled into the application widget set.

  26. 

  27. Adding the dependency in Maven projects and compiling the widget set is described in <<addons-maven#addons.maven, "Using Add-ons in a Maven Project">>.

  28. The section also describes how to use the online compilation and CDN services during development.

  29. 

  30. For Eclipse projects that use Ivy for dependency management, see <<addons-eclipse.asciidoc#addons.eclipse, "Installing Add-ons in Eclipse with Ivy">>.

  31. You can also download and install add-ons from a ZIP-package, as described in <<addons-downloading.asciidoc#addons.downloading, "Downloading Add-ons from Vaadin Directory">>.

  32. 

  33. == Add-on Licenses

  34. 

  35. Add-ons available from Vaadin Directory are distributed under different

  36. licenses, of which some are commercial. While the add-ons can be downloaded

  37. directly, you should note their license and other terms and conditions. Many are

  38. offered under a dual licensing agreement so that they can be used in open source

  39. projects for free, and many have a trial period for closed-source development.

  40. Commercial Vaadin add-ons distributed under the CVAL license require installing

  41. a license key as instructed in

  42. <<addons-cval#addons.cval, "Installing Commercial Vaadin Add-on License">>.

  43. 

  44. == Feedback and Support

  45. 

  46. After trying out an add-on, you can give some feedback to the author of the

  47. add-on by rating the add-on with one to five stars and optionally leaving a

  48. comment. Most add-ons also have a discussion forum thread for user feedback and

  49. questions.