Extended Login Add-on

This add-on extends the Vaadin Login component adding new features.

Features

• Adds a LoginLayout that allows to create views with the same layout as the LoginOverlay
• Adds an extended LoginOverlay that allows to customize the appearance with more features than the base version

Online demo

Online demo here

Download release

Available in Vaadin Directory

Maven install

Add the following dependencies in your pom.xml file:

<dependency>
   <groupId>org.vaadin.addons.flowingcode</groupId>
   <artifactId>extended-login-addon</artifactId>
   <version>X.Y.Z</version>
</dependency>

<repository>
   <id>vaadin-addons</id>
   <url>https://maven.vaadin.com/vaadin-addons</url>
</repository>

For SNAPSHOT versions see here.

Building and running demo

• git clone repository
• mvn clean install jetty:run

To see the demo, navigate to http://localhost:8080/

Release notes

See here

Issue tracking

The issues for this add-on are tracked on its github.com page. All bug reports and feature requests are appreciated.

Contributions

Contributions are welcome, but there are no guarantees that they are accepted as such.

As first step, please refer to our Development Conventions page to find information about Conventional Commits & Code Style requeriments.

Then, follow these steps for creating a contribution:

• Fork this project.
• Create an issue to this project about the contribution (bug or feature) if there is no such issue about it already. Try to keep the scope minimal.
• Develop and test the fix or functionality carefully. Only include minimum amount of code needed to fix the issue.
• For commit message, use Conventional Commits to describe your change.
• Send a pull request for the original project.
• Comment on the original issue that you have implemented a fix for it.

License & Author

This add-on is distributed under Apache License 2.0. For license terms, see LICENSE.txt.

Extended Login Add-on is written by Flowing Code S.A.

Developer Guide

Getting started

Using the ExtendedLoginOverlay

Just create it in the same way that you would do with original LoginOverlay, but you can call new methods for replacing content:

ExtendedLoginOverlay elo = new ExtendedLoginOverlay();
elo.replaceFormComponents(new TextField("Test", "test"), new ComboBox<String>("Test2"), new Button("Test3"));
elo.replaceHeaderComponent(new Image("/img/LogoChicoGlow.png", "Login image"));
elo.replaceForgotPassword(new Anchor("https://www.flowingcode.com","Flowing Code"));
elo.setOpened(true);
add(elo);

Using the LoginLayout

The LoginLayout is like a regular RouterLayout that can be extended and then used in your views that you would like to have the same layout as the LoginOverlay. All the content will be inside the vaadin-login-form-wrapper. It also provides the same replace methods as the ExtendedLoginOverlay

Special configuration when using Spring

By default, Vaadin Flow only includes com/vaadin/flow/component to be always scanned for UI components and views. For this reason, the addon might need to be whitelisted in order to display correctly.

To do so, just add com.flowingcode to the vaadin.whitelisted-packages property in src/main/resources/application.properties, like:

vaadin.whitelisted-packages = com.vaadin,org.vaadin,dev.hilla,com.flowingcode

More information on Spring whitelisted configuration here.