Vaadin Flow and Component Java APIs Documentation
This is the documentation for Vaadin Flow, the new Java web framework available in Vaadin platform. It also contains documentation on the Java APIs for Vaadin's web components.
This documentation is available in vaadin.com/docs. Any issues and contributions can be added here, or in vaadin.com/docs via the report issues or edit page actions.
This branch is Flow version 1.1 compatible (Vaadin 12). See other branches for other framework versions:
- master branch is for Flow version 1.1 (Vaadin 12)
- 1.0 branch is for Flow version 1.0 (Vaadin 10 & 11)
Structure
The documentation is split into the following modules:
docs-helpers
- sources for validating the code snippets to match the documentationtutorial-*
- standalone tutorial projects that can be run individuallydocumentation
- the documentation files written in .asciidoc and tests
For verifying the changes made to the documentation, run mvn verify
on the root level project.
Adding new tutorials
When a new tutorial is added, the end result should be included as a new module that needs to be built before the documentation
module.
The tutorial should use the @CodeFor("path/file.asciidoc")
annotation available from the docs-helpers
dependency to map the source files to the tutorial code snippets in the documentation
module.
If a tutorial needs extra helper classes to create, those should be added into TestTutorialCodeCoverage#HELPER_CLASSES
field as exclusions so that the checks won't fail on unused class.
Any added tutorial module can be included as a dependency to the documentation
module,
so that the code snippets from the documentation can be verified. This requires couple steps:
- For web app projects with
war
packaging:- the
<appendClasses>
configuration must be enabled for themaven-war-plugin
- The dependency should be to
documentation
added with<classifier>classes</classifier>
- the
- The
TestTutorialCodeCoverage
class needs to know the source folder location (see static variables)