Skip to content

Commit 979b408

Browse files
committed
OpenUI5 Documentation Update 07.02.2024
1 parent 8729a63 commit 979b408

7 files changed

+92
-170
lines changed

docs/Best_Practices_for_Developers_28fcd55.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -377,7 +377,7 @@ Implement strict error handling to address critical issues.
377377

378378
- Don't use the global namespace of the library to add types. Use the return value of `Lib.init` instead to add them.
379379
380-
- Migrate to the library `apiVersion 2`.
380+
- Migrate to the library `apiVersion 2`.For more information, see the [API Reference](https://sdk.openui5.org/api/sap.ui.core.Lib%23methods/sap.ui.core.Lib.init).
381381
382382
- Use [`sap.ui.base.DataType.registerEnum`](https://sdk.openui5.org/api/sap.ui.base.DataType%23methods/sap.ui.base.DataType.registerEnum) to register enums that shall be usable as a type of control properties.
383383

docs/Configuration_Options_and_URL_Parameters_91f2d03.md

Lines changed: 26 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -1112,6 +1112,32 @@ If set to a non-empty list of URLs, the `AppCacheBuster` will be activated and w
11121112
<tr>
11131113
<td valign="top">
11141114

1115+
`async`
1116+
1117+
</td>
1118+
<td valign="top">
1119+
1120+
Type: `boolean`
1121+
1122+
Default value: `false`
1123+
1124+
This configuration setting enables the module loader to load both modules and library-preload files asynchronously. Activating this feature requires intensive application-side cooperation and testing to ensure a stable and fully working application. In case you encounter issues, or if you want to prepare your application in advance, see [Is Your Application Ready for Asynchronous Loading?](Is_Your_Application_Ready_for_Asynchronous_Loading_493a15a.md)
1125+
1126+
</td>
1127+
<td valign="top">
1128+
1129+
![YES](images/loio3929e469c7824eb0a69206aeac69f257_LowRes.png)
1130+
1131+
</td>
1132+
<td valign="top">
1133+
1134+
![NO](images/loiodfb38de82f6d46dab60cb1397e3ed8ae_LowRes.png)
1135+
1136+
</td>
1137+
</tr>
1138+
<tr>
1139+
<td valign="top">
1140+
11151141
`exclude-jquery-compat`
11161142

11171143
</td>
@@ -1255,40 +1281,6 @@ Within `globalThis["sap-ui-config"]["on-init"]` it is also possible to provide a
12551281
<tr>
12561282
<td valign="top">
12571283

1258-
`preload`
1259-
1260-
</td>
1261-
<td valign="top">
1262-
1263-
[Type](Configuration_Options_and_URL_Parameters_91f2d03.md#loio91f2d03b6f4d1014b6dd926db0e91070__section_TVT): `string`
1264-
1265-
Default value: `auto`
1266-
1267-
Defines the loading behaviour of the so-called preload files. They contain all modules of a library. The contained modules are only loaded, but not executed until they are used by the application.
1268-
1269-
The values are used as follows:
1270-
1271-
- When set to `auto`, the runtime loads preload files asynchronously if the bootstrap configuration parameter `async` is set as `async=true`. We recommend to use the `async=true` configuration parameter in the bootstrap, as it switches many module-related APIs to `async`, including the loading behaviour of the preload files.
1272-
- Preload files for the declared libraries are loaded synchronously when the `async` bootstrap configuration parameter is set to`false` \(`async=false`\) or not set at all. Best practices discourage such behavior.
1273-
- For any other value \(for example blank\), the preload feature is deactivated and modules are loaded on demand.
1274-
1275-
1276-
1277-
</td>
1278-
<td valign="top">
1279-
1280-
![NO](images/loiodfb38de82f6d46dab60cb1397e3ed8ae_LowRes.png)
1281-
1282-
</td>
1283-
<td valign="top">
1284-
1285-
![NO](images/loiodfb38de82f6d46dab60cb1397e3ed8ae_LowRes.png)
1286-
1287-
</td>
1288-
</tr>
1289-
<tr>
1290-
<td valign="top">
1291-
12921284
`resource-roots`
12931285

12941286
</td>

docs/Deprecated_and_Experimental_Configuration_Options_b474a71.md

Lines changed: 36 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -78,34 +78,6 @@ This configuration parameter defines UI areas that shall be created in advance;
7878
<tr>
7979
<td valign="top">
8080

81-
`async`
82-
83-
\(deprecated\)
84-
85-
</td>
86-
<td valign="top">
87-
88-
Type: `boolean`
89-
90-
Default value: `false`
91-
92-
This configuration setting enables the module loader to load both modules and library-preload files asynchronously. Activating this feature requires intensive application-side cooperation and testing to ensure a stable and fully working application. In case you encounter issues, or if you want to prepare your application in advance, see [Is Your Application Ready for Asynchronous Loading?](Is_Your_Application_Ready_for_Asynchronous_Loading_493a15a.md)
93-
94-
</td>
95-
<td valign="top">
96-
97-
![YES](images/loio3929e469c7824eb0a69206aeac69f257_LowRes.png)
98-
99-
</td>
100-
<td valign="top">
101-
102-
![NO](images/loiodfb38de82f6d46dab60cb1397e3ed8ae_LowRes.png)
103-
104-
</td>
105-
</tr>
106-
<tr>
107-
<td valign="top">
108-
10981
`auto-aria-body-role`
11082

11183
\(deprecated\)
@@ -313,6 +285,42 @@ If set to `true`, additional information for text resources is provided that all
313285
<tr>
314286
<td valign="top">
315287

288+
`preload`
289+
290+
\(deprecated\)
291+
292+
</td>
293+
<td valign="top">
294+
295+
[Type](Configuration_Options_and_URL_Parameters_91f2d03.md#loio91f2d03b6f4d1014b6dd926db0e91070__section_TVT): `string`
296+
297+
Default value: `auto`
298+
299+
Defines the loading behaviour of the so-called preload files. They contain all modules of a library. The contained modules are only loaded, but not executed until they are used by the application.
300+
301+
The values are used as follows:
302+
303+
- When set to `auto`, the runtime loads preload files asynchronously if the bootstrap configuration parameter `async` is set as `async=true`. We recommend to use the `async=true` configuration parameter in the bootstrap, as it switches many module-related APIs to `async`, including the loading behaviour of the preload files.
304+
- Preload files for the declared libraries are loaded synchronously when the `async` bootstrap configuration parameter is set to`false` \(`async=false`\) or not set at all. Best practices discourage such behavior.
305+
- For any other value \(for example blank\), the preload feature is deactivated and modules are loaded on demand.
306+
307+
308+
309+
</td>
310+
<td valign="top">
311+
312+
![NO](images/loiodfb38de82f6d46dab60cb1397e3ed8ae_LowRes.png)
313+
314+
</td>
315+
<td valign="top">
316+
317+
![NO](images/loiodfb38de82f6d46dab60cb1397e3ed8ae_LowRes.png)
318+
319+
</td>
320+
</tr>
321+
<tr>
322+
<td valign="top">
323+
316324
`trace`
317325

318326
\(deprecated\)

0 commit comments

Comments
 (0)