Skip to main content

JET 4.1 : How to use toastr to show non-blocking notifications


NOTE: As of Oracle JET Version 5.0, the below can be achieved by Oracle JET's oj-message component, as described here :
http://www.oracle.com/webfolder/technetwork/jet/jetCookbook.html?component=messages&demo=pageInline
_________________________________________________________________________________
Today I had to implement a mechanism to show user notifications in the Oracle JET application that I am currently working on. One could show a simple popup to tell a user that changes have been saved, or even use a javascript alert to do that. There are also other, more sophisticated solutions that work pretty well. These can be found here:
The authors mention "toast" like notifications. Although the implementations in the above mentioned blogposts work fine, I wondered if there wasn't an easier, more configurable solution. 

After a bit of searching I found the toastr javascript library, whose purpose is exactly what I was looking for: Provide non-blocking notifications that can be configured as needed.

In the remaining part of this post I will describe how to add toastr to your JET application and how to use it so you get really nice toast.


How to get toastr 

Toastr is available on GIT where you can also find the documentation: https://github.com/CodeSeven/toastr

You can get toastr using npm:

 npm install --save toastr

Adding toastr to your JET Application

For the purpose of this blogpost I created a simple JET application with the Oracle JET CLI:

 ojet create toastr-demo --template=navbar

After creating this application the toastr lib can be added in exactly the same way as you would add other js libraries. I will shortly describe the steps here, but if you want to read more, it is all in the Oracle JET Documentation.

  • Add the path to newly added module in main.js require block:
  • Add paths to newly added modules in main-release-paths.js:
  • Update the copyCustomLibsToStaging section in oraclejet-build.js file so that it copies your library to the application when you build the application 

With this all setup, you can now really use the toastr lib in your application.

Using toastr to show messages

First I create the 'global' functionality that I can use from anywhere in my application to invoke the toastr notifications. That can easily be setup in the appController.js file. First add toastr to the define block so it can be used in the module.


Next configure your toastr so it will behave like you want. To show the notifications full width at the top of the page, and auto dismiss them after 3 seconds you could use the following settings:


Now we are ready to build the functions that will be used by the app to show the notifications. It is really easy to do this. Simply create some functions in the appController.js that call the specific functions of the toastr library:


In the application that was created for this blogpost, I use the dashboard page to build some functionality to show the notifications to the end user.  There will be 4 buttons. Each of which shows a different kind of notification. Note that I call directly to the functions in the appController.js 



Final step is to add the toastr.css to the index.html. If you forget to do this, the notifications will show up at the bottom of the page, whit out any styling.


That's it. Build the application, serve it and play around with the buttons.



Obviously there are many possibilities here that can be used to show notifications. You can have 'parameterised' messages in the notifications, you can show the notifications on a different place in the application, show them smaller, change colors, etc etc.  The documentation is great, and it is really easy to understand how to configure your notifications.




Comments

Post a Comment

Popular posts from this blog

ADF 12.1.3 : Implementing Default Table Filter Values

In one of my projects I ran into a requirement where the end user needs to be presented with default values in the table filters. This sounds like it is a common requirement, which is easy to implement. However it proved to be not so common, as it is not in the documentation nor are there any Blogpost to be found that talk about this feature. In this blogpost I describe how to implement this. The Use Case Explained Users of the application would typically enter today's date in a table filter in order to get all data that is valid for today. They do this each and every time. In order to facilitate them I want to have the table filter pre-filled with today's date (at the moment of writing July 31st 2015). So whenever the page is displayed, it should display 'today' in the table filter and execute the query accordingly. The problem is to get the value in the filter without the user typing it. Lets first take a look at how the ADF Search and Filters are implemented by...
6 comments
Read more

ADF 11g Quicky 3 : Adding Error, Info and Warning messages

How can we add a message programatically ? Last week I got this question for the second time in a months time. I decided to write a short blogpost on how this works. Adding messages is very easy, you just need to know how it works. You can add a message to your faces context by creating a new FacesMessage. Set the severity (ERROR, WARNING, INFO or FATAL ), set the message text, and if nessecary a message detail. The fragment below shows the code for an ERROR message. 1: public void setMessagesErr(ActionEvent actionEvent) { 2: String msg = "This is a message"; 3: AdfFacesContext adfFacesContext = null; 4: adfFacesContext = AdfFacesContext.getCurrentInstance(); 5: FacesContext ctx = FacesContext.getCurrentInstance(); 6: FacesMessage fm = 7: new FacesMessage(FacesMessage.SEVERITY_ERROR, msg, ""); 8: ctx.addMessage(null, fm); 9: } I created a simple page with a couple of buttons to show the result of setting the message. When the but...
2 comments
Read more

ADF 12c : Using Jasper Reports en JasperSoft Studio 6.1; What Libraries do you need?

Over the last couple of years, or better in the last decade I have implemented several reporting solutions with Jasper Reports in ADF. I did that in ADF 10g, ADF 11.1.1.x, ADF 11.1.2.x and ADF 12.1.x I also used several version of Jasper Reports. There is a whole lot of documentation, blogposts and presentations available. So when today I got a request from one of my customers to make a setup for the implementation of Jasper Reports 6.1 in ADF 12.1.3 I did not expect any problems. Boy was I wrong. Here is the Story With all the knowledge from the past, I decided to follow the known steps. 1) Download iReport Designer, 2) Build a report in iReport 3) Create an ADF application 4) Add the necessary libraries to use the report 5) Call the report from a button via a Managed Bean Step 1 In the past I used iReport designer to build the reports. When you go to the download site of iReport designer you now see an interesting message. So I took this serious and decided not to u...
2 comments
Read more