This npm package contains the types signatures based on ES modules for all the SAPUI5 libraries.
These signatures can be used to:
- Enable advanced content assist in IDEs, e.g: (VSCode / IntelliJ / Webstorm) for SAPUI5.
- Integrate type checking for SAPUI5 applications using the TypeScript compiler.
NOTE: "based on ES modules" means that the code needs to load UI5 modules using the ES6 modules syntax and then needs to be transformed to standard UI5 require/define syntax. Nevertheless, this is the recommended approach!
See the "Usage" section below for links to detailed documentation about this setup.
To see the suggested project setup for TypeScript development, please check out the TypeScript Hello World app. It not only can serve as copy template, but also includes a detailed step-by-step guide for creating this setup from scratch.
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 when writing such code.
For quick and easy scaffolding of a new UI5 app written in TypeScript, you can also use the easy-ui5 tool with the generator-ui5-ts-app generator.
This project is in an experimental Beta State. Significant changes are likely to occur, including potential breaking changes.
This package is provided under the terms of the SAP Developer License Agreement.