Skip to Content

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:

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

Third Party Modules
Although third party modules don’t use UI5 APIs, they still can be listed as dependencies in a sap.ui.define call. They will be requested and executed like UI5 modules, but their module value will be undefined.If the currently defined module needs to access the module value of such a third party module, it can access the value via its global name (if the module supports such a usage).Note that UI5 temporarily deactivates an existing AMD loader while it executes third party modules known to support AMD. This sounds contradictarily at a first glance as UI5 wants to support AMD, but for now it is necessary to fully support UI5 apps that rely on global names for such modules. 

 

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!

Additional note/question:

 

In the SAPWebIDE innovation version there is grunt integration for running JavaScript tasks. It would be great to also have a package manager like bower or like the NPM integration for Cordova plugins in Mobile apps.

 

 

Kind regards,

Wouter

To report this post you need to login first.

14 Comments

You must be Logged on to comment or reply to a post.

    1. Wouter Lemaire Post author

      Hi Mark,

       

      In the stackoverflow topic I think they are talking about SAPUI5 libraries. In this blog I’m talking about non SAPUI5 JavaScript libraries. When you add the libary as a SAPUI5 library it wil search for a library.js file. The non-SAPUI5 JavaScript libraries don’t have those files.

       

      Hope it helps.

       

      Kind regards,

      Wouter

      (1) 
      1. Mark Teichmann

        I was also talking about external js libraries. I think you can include them by using the resources in manifest.json.

        Then the library is loaded automatically by the require mechanism ( according to help documentation)

        (0) 
        1. Srikanth KV

          Hi Wouter,

          As mentioned by Mark, I have used third party libraries like “underscore.js” in projects and linked that as resources in manifest.json file. With this I can access “underscore” global name “_” in all the controllers without the need for injecting library again using AMD in each controller….

          can you let me know the difference between manifest.json resources and your approach?

           

          Regards

          Srikanth

          (0) 
          1. Wouter Lemaire Post author

            The difference between the manifest and my approach:

            • using the manifest will load the library at the start of the UI5 app
            • my approach will load the library only when it’s defined, but only once. If it’s already loaded, it will not load again.

             

            Kind regards,

            Wouter

            (3) 
  1. Boghyon Hoffmann

    Hi Wouter, Thank you for this great post. I’m using your approach to include C3.js in my project. I have some questions though:

    1. Besides the script file, C3 also needs its own c3.css file to be loaded. Any idea how to load CSS files on demand? Currently, I’m doing it in the app descriptor (sap.ui5/resources/css) but this loads the file right away at the start. I guess it’s not a big deal since the CSS file is just 1 KB and gets loaded asynchronously together with other files. What do you think?
    2. The lib uses “c3” as a global variable name so I had to include
      /* global c3 */​

      in order to prevent the “error”. Where can I find a documentation about the usage of such syntax? The API ref doesn’t explain much.

    3. I noticed that Web IDE doesn’t complain about the usage of global names from UI5’s third party libs such as “d3” and “sinon”. Do you know why? Or is the IDE making an exception for them?

    Thanks in advance!

    (1) 
    1. Wouter Lemaire Post author

      Some good questions.

      1. I don’t think it’s a problem, as you say it’s only 1kb.
      2. I found it in an example of SAP but no docu…
      3. I guess they have exceptions for everything in the UI5 SDK.

      Kr,

      Wouter

      (0) 
  2. Srikanth KV

    Hi Wouter,

    I’m using HANA WebIDE for UI5 development and XSOData services for data retrieval.

    Tried using your approach for ‘moment.js’ and ‘lodash’, at runtime the libs are not loaded, but with the same code when executed on my local PC with IIS server it works fine.

    I think the issue here is not the approach of including the libraries but something else,Can you help me with this.

    Here is what I did so far:

    1. Downloaded ‘moment.js’ from https://momentjs.com/downloads/moment-with-locales.min.js
    2. Created ‘libs’ folder and included the downloaded file as ‘moment.js’
    3. Included ‘moment.js’ through sap.ui.define AMD procedure
    4. Error
      Uncaught Error: Mismatched anonymous define() module: function (){"use strict";function a(){return re.apply(null,arguments)}function b(a){re=a}function c(a){return a instanceof Array||"[object ​

    Thanks in Advance

    (0) 
    1. Wouter Lemaire Post author

      Hi Srikanth,

       

      I didn’t tried it in the HANA Web IDE yet. Which version are you using? Already the same SAP Web IDE as for Fiori apps or an older version? What version of SAPUI5 SDK are you using in the HANA Web IDE? What if you try to use the latest online sdk?

      Regards,

      Wouter

       

      (0) 
      1. Srikanth KV

        Hi Wouter,

        Sorry for the late reply. I have tried using CDN version of SAPUI5 SDK also and facing the same issue.

        Regards

        Srikanth

        (0) 

Leave a Reply