OpenUI5 Documentation Update 25.07.2023

SAP · Jul 25, 2023 · 749137e · 749137e
1 parent 3595c37
commit 749137e
Show file tree

Hide file tree

Showing 7 changed files with 40 additions and 0 deletions.
diff --git a/docs/0index.md b/docs/0index.md
@@ -668,6 +668,7 @@ OpenUI5 Version for the OpenUI5 Demo Kit
  - [JavaScript Coding Guidelines](JavaScript_Coding_Guidelines_eded636.md)
  - [JavaScript Namespaces](JavaScript_Namespaces_5a978fe.md)
  - [Example for Defining a Class](Example_for_Defining_a_Class_f6fba4c.md)
+ - [TypeScript Guidelines](TypeScript_Guidelines_192397d.md)
  - [OpenUI5 Control Development Guidelines](OpenUI5_Control_Development_Guidelines_4549da6.md)
  - [Control Development Guidelines: Theming/CSS](Control_Development_Guidelines_Theming_CSS_5e08ff9.md)
  - [Product Standards and Acceptance Criteria](Product_Standards_and_Acceptance_Criteria_bafc686.md)

diff --git a/docs/Development_Conventions_and_Guidelines_753b326.md b/docs/Development_Conventions_and_Guidelines_753b326.md
@@ -39,6 +39,9 @@ The following list gives some general guidelines to be adhered to when developin
 - **[JavaScript Coding Guidelines](JavaScript_Coding_Guidelines_eded636.md "Provides an overview of the guidelines for JavaScript coding for OpenUI5 with regard to code
  formatting, naming conventions, and creating classes.")** 
 Provides an overview of the guidelines for JavaScript coding for OpenUI5 with regard to code formatting, naming conventions, and creating classes.
+- **[TypeScript Guidelines](TypeScript_Guidelines_192397d.md "Provides an overview how to develop OpenUI5 control libraries in
+ TypeScript.")** 
+Provides an overview how to develop OpenUI5 control libraries in TypeScript.
 - **[OpenUI5 Control Development Guidelines](OpenUI5_Control_Development_Guidelines_4549da6.md "Content developers developing OpenUI5 controls should follow the guidelines outlined
  below with regard to APIs, behavior, and themes/CSS.")** 
 Content developers developing OpenUI5 controls should follow the guidelines outlined below with regard to APIs, behavior, and themes/CSS.

diff --git a/docs/TypeScript_Guidelines_192397d.md b/docs/TypeScript_Guidelines_192397d.md
@@ -0,0 +1,30 @@
+<!-- loio192397d3cb954d4e986bcdc525c5205c -->
+
+| loio |
+| -----|
+| 192397d3cb954d4e986bcdc525c5205c |
+
+<div id="loio">
+
+view on: [demo kit nightly build](https://sdk.openui5.org/nightly/#/topic/192397d3cb954d4e986bcdc525c5205c) | [demo kit latest release](https://sdk.openui5.org/topic/192397d3cb954d4e986bcdc525c5205c)</div>
+
+## TypeScript Guidelines
+
+Provides an overview how to develop OpenUI5 control libraries in TypeScript.
+
+For general information on TypeScript, see [TypeScript in OpenUI5](TypeScript_in_OpenUI5_a7ee961.md).
+
+***
+
+<a name="loio192397d3cb954d4e986bcdc525c5205c__section_mdl_gyq_3xb"/>
+
+### Developing Custom Controls in TypeScript
+
+Check the [documentation](https://github.com/SAP-samples/ui5-typescript-helloworld/blob/custom-controls/README.md) and the sample code in the [custom-controls branch of the Hello World application](https://github.com/SAP-samples/ui5-typescript-helloworld/tree/custom-controls), which explains how you can implement custom controls in TypeScript within OpenUI5 applications. It makes use of a [tool for generating TypeScript interfaces for the control API](https://github.com/SAP/ui5-typescript/tree/main/packages/ts-interface-generator), which has been [released via npm](https://www.npmjs.com/package/@ui5/ts-interface-generator) in alpha state. There is also a sample project that demonstrates how flull-fledged [control libraries can be developed in TypeScript](https://github.com/SAP-samples/ui5-typescript-control-library).
+
+***
+
+#### Further information
+
+- [TypeScript interface generator for control development on npm](https://www.npmjs.com/package/@ui5/ts-interface-generator) to support UI5 control development in TypeScript
+
diff --git a/docs/TypeScript_in_OpenUI5_a7ee961.md b/docs/TypeScript_in_OpenUI5_a7ee961.md
@@ -68,4 +68,5 @@ npm Packages \(check the individual packages for licensing information\):
 
 - [UI5 type signatures on npm](https://www.npmjs.com/package/@sapui5/ts-types-esm)
 - [Babel preset UI5 transformer on npm](https://www.npmjs.com/package/babel-preset-transform-ui5) to transform ES modules and classes to classic UI5 code
+- For UI5 control development in TypeScript, see [TypeScript Guidelines](TypeScript_Guidelines_192397d.md)
 
diff --git a/docs/index.json b/docs/index.json
@@ -2197,6 +2197,9 @@
  }
  }
  },
+ "TypeScript Guidelines": {
+ "link": "TypeScript_Guidelines_192397d.md"
+ },
  "OpenUI5 Control Development Guidelines": {
  "link": "OpenUI5_Control_Development_Guidelines_4549da6.md",
  "items": {

diff --git a/docs/index.md b/docs/index.md
@@ -668,6 +668,7 @@ OpenUI5 Version for the OpenUI5 Demo Kit
  - [JavaScript Coding Guidelines](JavaScript_Coding_Guidelines_eded636.md)
  - [JavaScript Namespaces](JavaScript_Namespaces_5a978fe.md)
  - [Example for Defining a Class](Example_for_Defining_a_Class_f6fba4c.md)
+ - [TypeScript Guidelines](TypeScript_Guidelines_192397d.md)
  - [OpenUI5 Control Development Guidelines](OpenUI5_Control_Development_Guidelines_4549da6.md)
  - [Control Development Guidelines: Theming/CSS](Control_Development_Guidelines_Theming_CSS_5e08ff9.md)
  - [Product Standards and Acceptance Criteria](Product_Standards_and_Acceptance_Criteria_bafc686.md)

diff --git a/docs/sidebar.md b/docs/sidebar.md
@@ -662,6 +662,7 @@
  - [JavaScript Coding Guidelines](JavaScript_Coding_Guidelines_eded636.md)
  - [JavaScript Namespaces](JavaScript_Namespaces_5a978fe.md)
  - [Example for Defining a Class](Example_for_Defining_a_Class_f6fba4c.md)
+ - [TypeScript Guidelines](TypeScript_Guidelines_192397d.md)
  - [OpenUI5 Control Development Guidelines](OpenUI5_Control_Development_Guidelines_4549da6.md)
  - [Control Development Guidelines: Theming/CSS](Control_Development_Guidelines_Theming_CSS_5e08ff9.md)
  - [Product Standards and Acceptance Criteria](Product_Standards_and_Acceptance_Criteria_bafc686.md)