Skip to content

Commit 04cb28c

Browse files
committed
OpenUI5 Documentation Update 08.02.2024
1 parent 979b408 commit 04cb28c

13 files changed

+37
-26
lines changed

docs/0index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -316,7 +316,7 @@ OpenUI5 Version for the OpenUI5 Demo Kit
316316
- [Compatibility Version Information](Compatibility_Version_Information_9feb96d.md)
317317
- [Structuring: Components and Descriptor](Structuring_Components_and_Descriptor_dc9e11c.md)
318318
- [Components](Components_958ead5.md)
319-
- [Component.js File](Component_js_File_27ce0e4.md)
319+
- [Component Controller](Component_Controller_27ce0e4.md)
320320
- [Component Metadata](Component_Metadata_0187ea5.md)
321321
- [Methods Controlling the Initial Instantiation](Methods_Controlling_the_Initial_Instantiation_b430345.md)
322322
- [Using and Nesting Components](Using_and_Nesting_Components_346599f.md)

docs/Best_Practices_for_Developers_28fcd55.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -192,7 +192,7 @@ In the following we'll focus on crucial aspects of app development, specifically
192192
#### Asynchronous Loading
193193
194194
- Use asynchronous loading for views, fragments, and components to enhance performance; see, for example, [Legacy Factories Replacement](Legacy_Factories_Replacement_491bd9c.md).
195-
- Implement the `sap.ui.core.IAsyncContentCreation` marker interface in your [Component.js file](Component_js_File_27ce0e4.md) to allow the content to be created fully asynchronously and for a stricter handling of certain types of errors during its view processing.
195+
- Implement the `sap.ui.core.IAsyncContentCreation` marker interface in your [Component.js file](Component_Controller_27ce0e4.md) to allow the content to be created fully asynchronously and for a stricter handling of certain types of errors during its view processing.
196196
- Load libraries via the new asynchronous APIs in advance before accessing code. Ensure that dependent librares are preloaded through the `manifest.json` in the `sap.ui5/dependencies/libs` section if not already maintained there. For more information, see [Ensure that Library Preloads are Enabled](Performance_Speed_Up_Your_App_408b40e.md#loio408b40efed3c416681e1bd8cdd8910d4__section_LibraryPreloads).
197197
198198
**Additional Information:**

docs/Component_js_File_27ce0e4.md renamed to docs/Component_Controller_27ce0e4.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,11 @@
88

99
view on: [demo kit nightly build](https://sdk.openui5.org/nightly/#/topic/27ce0e4987cd426f8fa3e60836316428) | [demo kit latest release](https://sdk.openui5.org/topic/27ce0e4987cd426f8fa3e60836316428)</div>
1010

11-
## Component.js File
11+
## Component Controller
1212

13-
The `Component.js` file is the component controller and provides the runtime metadata and the component methods.
13+
The component controller is a script file \(written in either JavaScript or TypeScript\) that provides the runtime metadata and contains the component methods.
1414

15-
A component controller is defined with the asynchronous module definition \(AMD\) syntax. In the `sap.ui.define` statement; the required dependencies can be declared which can be used in the controller.
15+
When written in JavaScript, a component controller is defined with the asynchronous module definition \(AMD\) syntax; this does not apply when using TypeScript. In the `sap.ui.define` statement the required dependencies can be declared which can be used in the controller.
1616

1717
To create an OpenUI5 component, you extend either the `Component` or `UIComponent` base class and pass the name of the module \(namespace + `.Component`\).
1818

docs/Components_958ead5.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -76,8 +76,9 @@ The following list explains how other concepts used in OpenUI5 are distinguished
7676
The MVC concept allows to define views and controllers and, thus, to structure and reuse parts within an application. As MVC can only be deployed separately and has no means to define dependent styles or scripts that are loaded together with a view, this concept is of limited use across different applications.
7777

7878

79-
- **[Component.js File](Component_js_File_27ce0e4.md "The Component.js file is the component controller and provides the runtime metadata and the component methods.")**
80-
The `Component.js` file is the component controller and provides the runtime metadata and the component methods.
79+
- **[Component Controller](Component_Controller_27ce0e4.md "The component controller is a script file (written in either JavaScript or TypeScript) that provides the runtime metadata and contains the
80+
component methods.")**
81+
The component controller is a script file \(written in either JavaScript or TypeScript\) that provides the runtime metadata and contains the component methods.
8182
- **[Using and Nesting Components](Using_and_Nesting_Components_346599f.md "You can use a ComponentContainer to wrap a
8283
UIComponent and reuse it anywhere within the OpenUI5 control tree. With the
8384
ComponentContainer you can nest components inside other

docs/Descriptor_for_Applications_Components_and_Libraries_manifest_json_be0cf40.md

Lines changed: 19 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1063,6 +1063,23 @@ Version 61
10631063

10641064
1.60.0
10651065

1066+
</td>
1067+
</tr>
1068+
<tr>
1069+
<td valign="top">
1070+
1071+
Version 62
1072+
1073+
</td>
1074+
<td valign="top">
1075+
1076+
\>=1.121
1077+
1078+
</td>
1079+
<td valign="top">
1080+
1081+
1.61.0
1082+
10661083
</td>
10671084
</tr>
10681085
</table>
@@ -2110,7 +2127,7 @@ Current version of the `manifest.json`
21102127
```
21112128

21122129
{
2113-
"_version": "1.60.0",
2130+
"_version": "1.61.0",
21142131

21152132
"start_url": "index.html",
21162133

@@ -2198,7 +2215,7 @@ Current version of the `manifest.json`
21982215
}]
21992216
},
22002217
"dependencies": {
2201-
"minUI5Version": "1.120.0",
2218+
"minUI5Version": "1.121.0",
22022219
"libs": {
22032220
"sap.m": {
22042221
"minVersion": "1.34.0"

docs/Methods_Controlling_the_Initial_Instantiation_b430345.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -69,5 +69,5 @@ You can use the following methods:
6969
> ### Note:
7070
> The settings passed to the `sap.ui.core.Component.create` or `sap.ui.component` factory calls are not available in the `Init` and `createContent` methods. Use `componentData` instead. For more information, see [`sap.ui.core.Component.create`](https://sdk.openui5.org/api/sap.ui.core.Component/methods/sap.ui.core.Component.create).
7171

72-
You can also overwrite the getters and setters for component properties in the `Component.js` file.
72+
You can also overwrite the getters and setters for component properties in the Component controller.
7373

docs/Step_10_Descriptor_for_Applications_TypeScript_2a46b75.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -205,7 +205,7 @@ export default class Component extends UIComponent {
205205

206206
<a name="loio2a46b7567a73457c81b1b67741146063__section_ok2_4n5_zgb"/>
207207

208-
### webapp\\index.html
208+
### webapp/index.html
209209

210210
Let's explore how we can create a component in a simple and straightforward way directly in the HTML markup of our `index.html` file. To do this, we need to make a few changes in our HTML document.
211211

docs/Step_7_JSON_Model_70ef981.md

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -101,13 +101,6 @@ We add an `sap/m/Input` control to the view. With this, the user can enter a rec
101101
- `/recipient/name` declares the path in the model.
102102

103103

104-
***
105-
106-
### Conventions
107-
108-
- Use Hungarian notation for variable names.
109-
110-
111104
**Parent topic:**[Walkthrough Tutorial](Walkthrough_Tutorial_3da5f4b.md "In this tutorial we will introduce you to all major development paradigms of OpenUI5.")
112105

113106
**Next:**[Step 6: Modules](Step_6_Modules_f665d0d.md "In OpenUI5, resources are often referred to as modules. In this step, we replace the alert from the last exercise with a proper Message Toast from the sap.m library.")

docs/Step_9_Component_Configuration_TypeScript_f9d0e2f.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -33,11 +33,11 @@ You can view all files at [OpenUI5 TypeScript Walkthrough - Step 9: Component Co
3333

3434

3535

36-
**Folder Structure for this Step**
36+
**Figure: Folder Structure for this Step**
3737

38+
![The graphic has an explanatory text](images/loioaa6ba83cdebc4a75be6a6b2ff6efffcb_LowRes.png "Figure: Folder Structure for this Step")
3839

39-
40-
![The graphic has an explanatory text](images/loioaa6ba83cdebc4a75be6a6b2ff6efffcb_LowRes.png)After this step your project structure will look like the figure above. We will create the `Component.ts` file now and modify the related files in the app.
40+
After this step your project structure will look like the figure above. We'll create the `Component.ts` file now and modify the related files in the app.
4141

4242
***
4343

docs/The_Owner_Component_a7a3138.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ If you wish to extend your view or controller, you must define the extension in
1818

1919
### What is the Owner Component?
2020

21-
Technically, the owner component is the `sap.ui.core.(UI)Component` instance which created \(and thus "owns"\) any `sap.ui.base.ManagedObject` instance. This of course includes all subclasses of `ManagedObject`, e.g. any UI5 control, as well as views, fragments, and even other \(UI\)Components.
21+
Technically, the owner component is the `sap.ui.core.(UI)Component` instance which created \(and thus "owns"\) any `sap.ui.base.ManagedObject` instance. This of course includes all subclasses of `ManagedObject`, e.g. any OpenUI5 control, as well as views, fragments, and even other \(UI\)Components.
2222

2323
One of the most common use cases of the owner component is the extensibility of \(UI\)Components. The framework uses the owner component to identify [extension points](View_Extension_403c050.md), [view modifications](View_Modification_aa93e1c.md), and [controller extensions](Using_Controller_Extension_21515f0.md) from the owner component's manifest.json.
2424

0 commit comments

Comments
 (0)