Consuming SAPUI5 libraries

Info

Make sure you have installed the UI5 CLI in Version 2.0 or later: npm install --global @ui5/cli

Overview

SAPUI5 libraries are hosted on the public npm registry at registry.npmjs.org. However, you should not install them using node package managers like npm or Yarn. Instead, please let the UI5 Tooling handle them by following this guide.

Usage

Since Version 2.0 the UI5 CLI will automatically download all required framework dependencies of a project if they have been defined in the corresponding ui5.yaml configuration. They will be cached in a .ui5 directory located in your users' home directory. This happens transparently whenever you execute the ui5 serve or ui5 build commands.

All non-framework dependencies, such as reuse libraries or UI5 Tooling extensions, still need to be maintained as npm dependencies in the projects package.json. At the same time, framework dependencies listed in the ui5.yaml should not be listed in the package.json as they will be ignored by the UI5 Tooling.

Configuration

There is a new configuration section dedicated to framework dependency handling.

Example:

specVersion: "2.1"
type: application
metadata:
  name: some.project.name
framework:
  name: SAPUI5
  version: 1.76.0
  libraries:
    - name: sap.ui.core
    - name: sap.m
    - name: sap.ui.comp
    - name: sap.ushell
      development: true
    - name: themelib_sap_fiori_3

Example:

specVersion: "2.1"
type: library
metadata:
  name: some.library
framework:
  name: SAPUI5
  libraries:
    - name: sap.ui.core
    - name: themelib_sap_belize
      optional: true
    - name: themelib_sap_bluecrystal
      optional: true
    - name: themelib_sap_fiori_3
      optional: true

Make sure that your project defines Specification Version 2.0 or higher.

For details, please see the corresponding framework configuration documentation.

Differences Between OpenUI5 and SAPUI5

The open source project OpenUI5 provides most of the fundamental framework features. SAPUI5 enhances on this by providing additional libraries under a different license.

OpenUI5 is provided under the Apache 2.0 license. The SAPUI5 packages that are consumed in the UI5 Tooling are provided under the terms of the SAP Developer License Agreement.

Note that projects which use the OpenUI5 framework cannot depend on projects that use the SAPUI5 framework.

Please also see the UI5 SDK documentation "SAPUI5 vs. OpenUI5".