SAP UI 5 - Webcomponents for Vaadin Flow

THIS README IS WORK IN PROGRESS

This repo is under active development. In this early stage, changes are bigger if need. After the release 1.0.0 is defined, the API will be stable.

SAP Components

Component Playground

• Icons
• Timeline
• NPM UI5

Status

Here is an overview on the SAP UI 5 <-> Vaadin Flow mapping:

SAP UI 5	Vaadin Flow	Remarks
Badge	org.rapidpm.vaadin.webcomponents.sapui5.UI5Badge
BusyIndicator	org.rapidpm.vaadin.webcomponents.sapui5.UI5BusyIndicator
Button	org.rapidpm.vaadin.webcomponents.sapui5.UI5Button
Card	org.rapidpm.vaadin.webcomponents.sapui5.UI5Card
CheckBox
DatePicker
Dialog
Icon	org.rapidpm.vaadin.webcomponents.sapui5.UI5Icon
Input
Label
Link	org.rapidpm.vaadin.webcomponents.sapui5.UI5Link
List	org.rapidpm.vaadin.webcomponents.sapui5.UI5List	Basic mapping, no listeners, features missing
MessageStrip	org.rapidpm.vaadin.webcomponents.sapui5.UI5MessageStrip
MultiComboBox
Panel
RadioButton	org.rapidpm.vaadin.webcomponents.sapui5.UI5RadioButton	Only the first change event is passed to flow
Select
ShellBar
Switch	org.rapidpm.vaadin.webcomponents.sapui5.UI5Switch
TabContainer
Table
TextArea	org.rapidpm.vaadin.webcomponents.sapui5.UI5TextArea
Timeline	org.rapidpm.vaadin.webcomponents.sapui5.UI5Timeline
Title	org.rapidpm.vaadin.webcomponents.sapui5.UI5Title
ToggleButton	org.rapidpm.vaadin.webcomponents.sapui5.UI5ToggleButton

Maven

To understand what is going on during the build process use the following command

mvn fr.jcgay.maven.plugins:buildplan-maven-plugin:list

Supported JDK

This example is running from JDK8 up to JDK13

Support for Heroku

To support the Heroku pipeline we need a few preparations.

1. the app must be able to get a configured port for the http port during the start up
2. add the shade plugin to create a fat jar
3. create the file Procfile and add the line web: java -jar target/vaadin-app.jar -port $PORT
   • web - to activate the web profile
   • -jar - define what fat jar must be started
   • -port make the dynamic associated port available for the app
4. add a file settings.xml to configure the maven build process

For this project

This project contains a demo that is using the SAP UI 5 WebComponents for Flow. The Demo itself is located inside the module 03_demoapp. The URL to have a look at this demo is https://flow-sap-ui5.herokuapp.com/ However, if you want to have a look at it on your machine you can run the Docker image that is provided as well.

The basic demoapp is created with the Vaadin App Starter. https://start.vaadin.com

Docker DemoApp

TBD

target of this project

With this project, we want to provide a serverside java API to work with SAP UI 5 webcomponents. The Java-part is under Apache Lic.

project structure / modules

How to use it

Roadmap - bird eye view

Happy Coding.

if you have any questions: ping me on Twitter https://twitter.com/SvenRuppert or via mail.