@openui5/types

This npm package contains the TypeScript type definitions based on ES modules for all the OpenUI5 libraries. Read below and at the main UI5 & TypeScript documentation how to use them.

NOTE: the same types are also available via DefinitelyTyped as @types/openui5. Be aware of the remarks in the readme file, in particular about the versioning difference.

These definitions can be used to:

1. Enable advanced content assist in IDEs, e.g: (VSCode / IntelliJ / Webstorm) for OpenUI5.
2. Integrate type checking for OpenUI5 applications using the TypeScript compiler.

These capabilities are available not only for OpenUI5 apps written in TypeScript, but to some degree also in JavaScript.

NOTE: "based on ES modules" means that the application code needs to load UI5 modules using the ES6 modules syntax and needs to be transformed to standard UI5 require/define syntax before it is executed. This is the recommended approach!

Usage

The central entry point for all information about using UI5 with TypeScript (incl. sample apps and templates) is https://sap.github.io/ui5-typescript.

The UI5 TypeScript tutorial gives the best end-to-end impression of UI5 application and control development in TypeScript. The above and below links lead to further details about certain aspects.

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 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 use the easy-ui5 tool with the generator-ui5-ts-app generator.

Status

We encourage you to use OpenUI5 with TypeScript productively for an improved development efficiency and experience. TypeScript itself keeps evolving and we try to further improve the UI5 type definitions, so there could be potential incompatible changes between versions of the type definitions. However, such incompatibilities would only affect the compilation of your code but will not cause runtime issues in your application. Plus, there are various ways to easily deal with them: you can, for example, simply keep using the previous version of the UI5 type definitions together with an updated UI5 runtime.

For news related to the type definitions, in particular ones which require adaptation, please refer to the Release Notes.

License

OpenUI5 and the type definitions in this package are copyright by SAP and contributors and licensed under the Apache License 2.0.