Skip to content

How to add a new component to the platform

Jump to bottom
Tien Nguyen edited this page Dec 7, 2018 · 1 revision

How to add a new component to the platform

  1. Add version information into versions.json as a child of core or vaadin depending on it's a core or a pro component. e.g.
"vaadin-new-component": {
    "npmName": "@vaadin/vaadin-new-component",
    "javaVersion": "1.0.0",
    "jsVersion": "1.0.0",
    "component": true,
    "pro": true
},

  1. If the component has Java implementation:

    1. Add its version into scripts/generator/templates/template-vaadin-spring-bom.xml. Example:

      <dependency>
    <groupId>com.vaadin</groupId>
    <artifactId>vaadin-new-component-flow</artifactId>
    <version>${vaadin.new.component.version}</version>
</dependency>

    2. Add the dependency to vaadin-core/pom.xml for core components or vaadin/pom.xml for pro components

      <dependency>
    <groupId>com.vaadin</groupId>
    <artifactId>vaadin-new-component</artifactId>
</dependency>

    3. Add an IT test for the new component like others did in vaadin-platform-test.

  2. Check if we need to include any information of the new component in release note: scripts/generator/templates/template-release-notes.md

  3. Update README.md to include the information if needed

  4. Make a PR to a correct branch (master for the latest, vX for version X, e.g. v12 for Platform 12)

Clone this wiki locally