How to include third party libraries / modules in SAPUI5

Hi all,

In the JavaScript there already exists many libraries with a lot out of the box functionalities that make the developments easier. When working on complex SAPUI5 apps, you’ll probably use at least one third party JavaScript library. Two libraries that I often use:

• Lodash
  • Contains functions that makes it easier to work with arrays
  • https://lodash.com/
• MomentJS
  • A library with additional date and time functionalities
  • https://momentjs.com

In this blog I’ll explain how you can use these libraries in your SAPUI5 app. I’ll use the library MomentJs to show you how.

First go to the website of Moment.js: https://momentjs.com/

Click on: “moment-with-locales.min.js”

Copy the content of the page.

In your UI5 project create a folder “libs”. This is the place to put in all the third party libraries.

In the folder “libs” we create a file “moment.js”

In this file we paste the code that we’ve copied from the MomentJS website.

The project structure will look like this.

One of the ways to include this library into your project could be including the library in the index.html page. Please, don’t do this, this will not work when your UI5 app is used in the Fiori Launchpad. The Fiori Launchpad will start your app from the Component.js and not from the Index.html .

We have to include the library in the JavaScript files where we want to use it, in this example we’ll use it in the controller. You include the library by using the define functionality. In the define function you add the path to the file that contains the code of the library, in this case it will be “SAPUI5ExternalLibs/libs/moment” ( “<Namespace of the project>/<Path to the folder where it’s located>/<Name of the file>” ).

The value in the define function will be undefined and should be different from the global name of the library. Therefore we used the name “momentjs”. The global name of the library is “moment” in this case so we cannot use that.

You can read more details about this in the API Refrence

https://sapui5.hana.ondemand.com/#docs/api/symbols/sap.ui.html#.define

After that we can use moment in our controller by using the global name of the library. In this example I use moment to add 18 days to today and get the name of that day in English, French and Dutch.

As you can see, the SAPWebIDE still gives errors when using the library although we’ve included correctly! To fix this errors we have to add the following line at the top of the controller:

/* global moment:true */

Where “moment” is the name of the global library. For lodash it would look like this:

/* global _:true */

“_” is the global name for the lodash library.

This will fix the errors!

In the view we just bind some text fields to the JSONModel

And this will give the following result.

A basic example to show you how to include libraries in your SAPUI5 project in the SAPWebIDE without having errors!

Kind regards,

Wouter