Web Notifications Add-on for Vaadin 8

Web Notifications API

View larger

Close

View larger

Close

Web Notifications Add-on for Vaadin 8

This is a Vaadin extension to support the (Web) Notifications API. This allows you to show notifications directly on the user's desktop, regardless of whether browser or browser tab are currently visible.

There are two competing specifications for this API: one from the WHATWG and one from the W3C. They share features, but there are differences. And differing browser support on different platforms makes the situation even more complicated. That's an abyss that I didn't want to fully explore.

If you just want to show notifications without getting down to the nitty-gritty of browser support, the following options should be rather safe to use - at least in desktop browsers:

• body(String)
• icon(String)
• tag(String)
• onClick(Runnable)
• onError(Runnable)
• timeout(Integer)
• closeOnClick(boolean)

This extension needs to be attached to a UI and needs to request the user's permission to show notifications. However all that is taken care of automatically.

Uses notify.js by Alex Gibson.

Sample code

    WebNotifications.create(uiOrComponent, "Title")
      .body("Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Aliquam hendrerit mi posuere lectus. Vestibulum enim wisi, viverra nec, fringilla in, laoreet vitae, risus.")
      .icon("theme://img/logo.png").tag("sometag")
      .onClick(() -> Notification.show("onClick")).show());

Links

• Issue Tracker
• Source Code

Compatibility