Note: in general, all information relevant for UI5 application development in TypeScript can be found at https://sap.github.io/ui5-typescript
This app demonstrates a TypeScript setup for developing UI5 applications.
As the focus is on the TypeScript setup, the app code itself is quite minimal, it is not using models, translation files etc.
This repository also contains a detailed step-by-step guide, which explains how this setup is created and how all the bits and pieces fit together.
In the custom-controls branch, this repository also contains instructions and an example how custom controls can be developed in TypeScript within applications.
In the ui5-2.0 branch, this repository demonstrates how an application can be tested against the type definitions (and runtime) of the upcoming UI5 2.x version.
The TypeScript branch of the "UI5 CAP Event App" sample demonstrates a slightly more complex application, using the same setup. It comes with an explanation of what UI5 TypeScript code usually looks like and what to consider.
The UI5con 2021 session on TypeScript (recording available at YouTube) explains the overall approach for TypeScript and UI5.
There is also an application template (based on yeoman and easy-ui5) which has been shown in the UI5con Keynote and explained in this blog.
| ☝️ Overview of TypeScript-related Entities |
|---|
The UI5 type definitions (*.d.ts files) are loaded as dev dependency from npm. They are a work in progress, so while they should be working well already, we are still improving them, which might also lead to breaking changes. |
The file tsconfig.json contains the configuration for the TypeScript compilation, including a reference to the UI5 *.d.ts files. |
Normally, the UI5 JavaScript files (controllers, Component.js etc.) would reside in the webapp folder. Now they are in the src folder. The TypeScript compilation will create the webapp folder and put all output there. |
In addition to the TypeScript compilation, there is also a conversion from the ES6 module and class syntax used in the source files to the classic UI5 module loading and class definition syntax (sap.ui.define(...) and superClass.extend(...)). This conversion is using the babel-plugin-transform-modules-ui5 project from the UI5 Community (initially developed by Ryan Murphy). |
| Both, the TypeScript compilation and the ES6 syntax transformation, are executed by Babel, as configured in the file .babelrc.json |
This combined transformation is triggered by both the build:ts and watch:ts scripts in package.json. |
Either npm, yarn, or pnpm for dependency management.
- Clone the project:
git clone https://github.com/SAP-samples/ui5-typescript-helloworld.git
cd ui5-typescript-helloworld(or download from https://github.com/SAP-samples/ui5-typescript-helloworld/archive/main.zip)
- Use npm (or any other package manager) to install the dependencies:
npm installExecute the following command to run the app locally for development in watch mode (the browser reloads the app automatically when there are changes in the source code):
npm startAs shown in the terminal after executing this command, the app is then running on http://localhost:8080/index.html. A browser window with this URL should automatically open.
In the browser, you can directly debug the original TypeScript code, which is supplied via sourcemaps (need to be enabled in the browser's developer console if it does not work straight away). If the browser doesn't automatically jump to the TypeScript code when setting breakpoints, use e.g. Ctrl/Cmd + P in Chrome to open the *.ts file you want to debug.
Execute the following command to build the project and get an app that can be deployed:
npm run buildThe result is placed into the dist folder. To start the generated package, just run
npm run start:distNote that index.html still loads the UI5 framework from the relative URL resources/..., which does not physically exist, but is only provided dynamically by the UI5 tooling. So for an actual deployment you should change this URL to either the CDN or your local deployment of UI5.
For an optimized self-contained build (takes longer because the UI5 resources are built, too), do:
npm run build:optTo start the generated package, again just run
npm run start:distIn this case, all UI5 framework resources are also available within the dist folder, so the folder can be deployed as-is to any static web server, without changing the bootstrap URL.
With the self-contained build, the bootstrap URL in index.html has already been modified to load the newly created sap-ui-custom.js for bootstrapping, which contains all app resources as well as all needed UI5 JavaScript resources. Most UI5 resources inside the dist folder are for this reason actually not needed to run the app. Only the non-JS-files, like translation texts and CSS files, are used and must also be deployed. (Only when for some reason JS files are missing from the optimized self-contained bundle, they are also loaded separately.)
Do the following to run a TypeScript check:
npm run ts-typecheckThis checks the application code for any type errors (but will also complain in case of fundamental syntax issues which break the parsing).
To lint the TypeScript code, do:
npm run lint- At this time, the used eslint rules are not verified to be optimal or to be in sync with UI5 recommendations.
None.
The sample code is provided as-is. No support is provided.
Create an issue in this repository if you find a bug. Questions can be asked in SAP Community.
Once you have understood the setup and want to inspect the code of a slightly more comprehensive UI5 app written in TypeScript, you can check out the TypeScript version of the UI5 CAP Event App Sample.
Copyright (c) 2023 SAP SE or an SAP affiliate company. All rights reserved. This project is licensed under the Apache Software License, version 2.0 except as noted otherwise in the LICENSE file.