Skip to content

Latest commit

 

History

History
118 lines (77 loc) · 4.73 KB

README.md

File metadata and controls

118 lines (77 loc) · 4.73 KB
Raw

Published on Vaadin Directory Stars on vaadin.com/directory Build Status Maven Central Javadoc

Error Window Add-on for Vaadin

Error Window Add-on is a UI component add-on for Vaadin Flow

Features

This add-on shows a dialog to inform that an error was cause by an exception.

The dialog shows different information depending on the running mode of the application:

  • if the application is running in development mode, it shows the stack trace of the exception.
  • if the applicacion is running in production mode, it shows a code to report that can be found in log files.

The dialog (ErrorWindow) is invoked automatically through a com.vaadin.flow.server.VaadinServiceInitListener (WindowErrorHandler) or just by itself calling the "open" method.

It is posible to customize the message shown.

This add-on is built using server side API

Online demo

Online demo here

Download release

Available in Vaadin Directory

Maven install

Add the following dependencies in your pom.xml file:

<dependency>
   <groupId>com.flowingcode.vaadin.addons</groupId>
   <artifactId>error-window-vaadin</artifactId>
   <version>X.Y.Z</version>
</dependency>

Release versions are available from Maven Central 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 requirements.

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.

Error Window Add-on is written by Flowing Code S.A.

Developer Guide

Getting started

Button errorButton =
    new Button(
        "Throw Error",
        event -> {
          Integer.parseInt("asdf");
        });
Button throwErrorWithoutErrorHandler =
    new Button(
        "Throw Error without an error handler",
        ev -> {
          try {
            Integer.parseInt("asdf");
          } catch (NumberFormatException e) {
            ErrorManager.showError(e);
          }
        });

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 add-on might need to be allowed in order to display correctly.

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

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

More information on Spring scanning configuration here.