Skip to content

Commit fa9a862

Browse files
committed
OpenUI5 Documentation Update 24.04.2025
1 parent b513293 commit fa9a862

File tree

40 files changed

+123
-62
lines changed

40 files changed

+123
-62
lines changed

docs/02_Read-Me-First/deprecated-themes-and-libraries-a87ca84.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ Recommendation\(\*\)
4949
</td>
5050
<td valign="top">
5151

52-
 
52+
1.136
5353

5454
</td>
5555
<td valign="top">
@@ -71,7 +71,7 @@ Switch to `sap_horizon`.
7171
</td>
7272
<td valign="top">
7373

74-
 
74+
1.136
7575

7676
</td>
7777
<td valign="top">
@@ -93,7 +93,7 @@ Switch to `sap_horizon_hcb`.
9393
</td>
9494
<td valign="top">
9595

96-
 
96+
1.136
9797

9898
</td>
9999
<td valign="top">

docs/02_Read-Me-First/supported-combinations-of-themes-and-libraries-38ff8c2.md

+72-6
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ This chapter gives an overview of the possible combinations of themes and librar
88

99
### Active Libraries
1010

11-
The following table shows the [Available Themes](../04_Essentials/available-themes-da0d2e7.md) for the active OpenUI5 libraries.Even though the `sap_belize`, `sap_bluecrystal`, and the `sap_hcb` themes are now deprecated, they currently are still available, but will not be maintained. We recommend that you migrate your existing apps to the supported themes.
11+
The following table shows the [Available Themes](../04_Essentials/available-themes-da0d2e7.md) for the active OpenUI5 libraries.
1212

1313
> ### Note:
1414
> For more information about the *Quartz Dark* theme, see SAP Note [2982978](https://me.sap.com/notes/2982978).
@@ -607,11 +607,7 @@ n/a
607607

608608
### Deprecated Libraries
609609

610-
Should you decide to ignore the deprecation of libraries and continue, for example, using `sap.ui.commons` and `sap.ui.ux3`, we recommend you use the `sap_bluecrystal` or `sap_belize` theme.
611-
612-
The `sap_bluecrystal` theme is also no longer supported, but offers full coverage of the `sap.ui.commons` and the `sap.ui.ux3` library. It is currently still shipped, **but will be removed in one of the next versions.**
613-
614-
The `sap_belize` theme offers an initial implementation for the `sap.ui.commons` and the `sap.ui.ux3` libraries to allow for a smoother transition, but it is not supported for this library and will not be maintained. We recommend that you consider migrating your existing apps to actively developed libraries, such as `sap.m`, and use the most current theme as the default theme going forward.
610+
If you are, for example, still using `sap.ui.commons` and `sap.ui.ux3`, we recommend that you migrate your existing apps to actively developed libraries, such as `sap.m`, and use the most current theme as the default theme going forward.
615611

616612
The following table shows how the available themes interact with the `sap.ui.commons` and the `sap.ui.ux3` libraries:
617613

@@ -674,6 +670,11 @@ The following table shows how the available themes interact with the `sap.ui.com
674670

675671
1.120
676672

673+
</th>
674+
<th valign="top">
675+
676+
1.136
677+
677678
</th>
678679
</tr>
679680
<tr>
@@ -731,6 +732,11 @@ n/a
731732

732733
![Not Supported](images/loiod355123503654aae97106b021020b7be_LowRes.png)
733734

735+
</td>
736+
<td valign="top">
737+
738+
![Not Supported](images/loiod355123503654aae97106b021020b7be_LowRes.png)
739+
734740
</td>
735741
</tr>
736742
<tr>
@@ -788,6 +794,11 @@ n/a
788794

789795
![Not Supported](images/loiod355123503654aae97106b021020b7be_LowRes.png)
790796

797+
</td>
798+
<td valign="top">
799+
800+
![Not Supported](images/loiod355123503654aae97106b021020b7be_LowRes.png)
801+
791802
</td>
792803
</tr>
793804
<tr>
@@ -847,6 +858,11 @@ n/a
847858

848859
![Not Supported](images/loiod355123503654aae97106b021020b7be_LowRes.png)
849860

861+
</td>
862+
<td valign="top">
863+
864+
![Not Supported](images/loiod355123503654aae97106b021020b7be_LowRes.png)
865+
850866
</td>
851867
</tr>
852868
<tr>
@@ -904,6 +920,11 @@ n/a
904920

905921
![Not Supported](images/loiod355123503654aae97106b021020b7be_LowRes.png)
906922

923+
</td>
924+
<td valign="top">
925+
926+
![Not Supported](images/loiod355123503654aae97106b021020b7be_LowRes.png)
927+
907928
</td>
908929
</tr>
909930
<tr>
@@ -961,6 +982,11 @@ n/a
961982

962983
![Not Supported](images/loiod355123503654aae97106b021020b7be_LowRes.png)
963984

985+
</td>
986+
<td valign="top">
987+
988+
![Not Supported](images/loiod355123503654aae97106b021020b7be_LowRes.png)
989+
964990
</td>
965991
</tr>
966992
<tr>
@@ -1020,6 +1046,11 @@ n/a
10201046

10211047
![Not Supported](images/loiod355123503654aae97106b021020b7be_LowRes.png)
10221048

1049+
</td>
1050+
<td valign="top">
1051+
1052+
![Not Supported](images/loiod355123503654aae97106b021020b7be_LowRes.png)
1053+
10231054
</td>
10241055
</tr>
10251056
<tr>
@@ -1079,6 +1110,11 @@ n/a
10791110

10801111
![Deprecated](images/loio3ea53dcd3acc4783a7a4b83e10c8f1aa_LowRes.gif)
10811112

1113+
</td>
1114+
<td valign="top">
1115+
1116+
![Removed](images/loio5befb5af20ed42fd9052a99014d953a3_LowRes.gif)
1117+
10821118
</td>
10831119
</tr>
10841120
<tr>
@@ -1138,6 +1174,11 @@ n/a
11381174

11391175
![Deprecated](images/loio3ea53dcd3acc4783a7a4b83e10c8f1aa_LowRes.gif)
11401176

1177+
</td>
1178+
<td valign="top">
1179+
1180+
![Removed](images/loio5befb5af20ed42fd9052a99014d953a3_LowRes.gif)
1181+
11411182
</td>
11421183
</tr>
11431184
<tr>
@@ -1195,6 +1236,11 @@ n/a
11951236

11961237
![Deprecated](images/loio3ea53dcd3acc4783a7a4b83e10c8f1aa_LowRes.gif)
11971238

1239+
</td>
1240+
<td valign="top">
1241+
1242+
![Removed](images/loio5befb5af20ed42fd9052a99014d953a3_LowRes.gif)
1243+
11981244
</td>
11991245
</tr>
12001246
<tr>
@@ -1252,6 +1298,11 @@ n/a
12521298

12531299
![Deprecated](images/loio3ea53dcd3acc4783a7a4b83e10c8f1aa_LowRes.gif)
12541300

1301+
</td>
1302+
<td valign="top">
1303+
1304+
![Removed](images/loio5befb5af20ed42fd9052a99014d953a3_LowRes.gif)
1305+
12551306
</td>
12561307
</tr>
12571308
<tr>
@@ -1309,6 +1360,11 @@ n/a
13091360

13101361
![Removed](images/loio5befb5af20ed42fd9052a99014d953a3_LowRes.gif)
13111362

1363+
</td>
1364+
<td valign="top">
1365+
1366+
![Removed](images/loio5befb5af20ed42fd9052a99014d953a3_LowRes.gif)
1367+
13121368
</td>
13131369
</tr>
13141370
<tr>
@@ -1366,6 +1422,11 @@ n/a
13661422

13671423
![Removed](images/loio5befb5af20ed42fd9052a99014d953a3_LowRes.gif)
13681424

1425+
</td>
1426+
<td valign="top">
1427+
1428+
![Removed](images/loio5befb5af20ed42fd9052a99014d953a3_LowRes.gif)
1429+
13691430
</td>
13701431
</tr>
13711432
<tr>
@@ -1423,6 +1484,11 @@ n/a
14231484

14241485
![Removed](images/loio5befb5af20ed42fd9052a99014d953a3_LowRes.gif)
14251486

1487+
</td>
1488+
<td valign="top">
1489+
1490+
![Removed](images/loio5befb5af20ed42fd9052a99014d953a3_LowRes.gif)
1491+
14261492
</td>
14271493
</tr>
14281494
</table>
Binary file not shown.
Loading
Binary file not shown.
Loading
Binary file not shown.
Loading
Binary file not shown.
Loading
Binary file not shown.
Loading
Binary file not shown.
Loading
Loading
Binary file not shown.
Loading
Binary file not shown.
Loading
Binary file not shown.
Loading

docs/03_Get-Started/step-1-creating-the-initial-app-fc2c358.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ In this step, we set up the initial app.
1414

1515
**The worklist app**
1616

17-
![](images/loio60e42c87d9494360a64017fc16d8bbcb_HiRes.png "The worklist app")
17+
![](images/loio60e42c87d9494360a64017fc16d8bbcb_LowRes.png "The worklist app")
1818

1919

2020

@@ -43,7 +43,7 @@ With the downloaded code from the Demo Kit, you have an initial app structure wi
4343

4444
**Folder structure of the initial project**
4545

46-
![](images/loio7f6899e87d8240d5bd3fc8594e148714_HiRes.png "Folder structure of the initial project")
46+
![](images/loio7f6899e87d8240d5bd3fc8594e148714_LowRes.png "Folder structure of the initial project")
4747

4848
- **Home Page** \(`webapp/view/Worklist.view.xml` file\)
4949

docs/03_Get-Started/step-2-custom-mock-data-3118903.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -12,13 +12,13 @@ In this step, we want to change the mock data of the initial app.
1212

1313
**The product list of the initial app with custom mock data**
1414

15-
![](images/loiob150a14f277b4d5398442829edc83217_HiRes.png "The product list of the initial app with custom mock data")
15+
![](images/loiob150a14f277b4d5398442829edc83217_LowRes.png "The product list of the initial app with custom mock data")
1616

1717

1818

1919
**Folder structure for this step including custom mock data**
2020

21-
![](images/loiofa4aba84cedc4fefbf345c26eed8bc97_HiRes.png " Folder structure for this step including custom mock data")
21+
![](images/loiofa4aba84cedc4fefbf345c26eed8bc97_LowRes.png " Folder structure for this step including custom mock data")
2222

2323
The service metadata only contains a description of the service entities. The mock server that is part of the app will auto-generate random mock data based on the data types defined in the metadata file. To have a more realistic development environment we will now add additional sample data.
2424

docs/03_Get-Started/step-3-extending-the-worklist-table-84100bc.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ In this step, we will edit the worklist table to include additional columns for
1212

1313
**The improved worklist table with new columns and formatting**
1414

15-
![](images/loio2def9d9de16f4b4a87dd4342486c70f7_HiRes.png "The improved worklist table with new columns and formatting")
15+
![](images/loio2def9d9de16f4b4a87dd4342486c70f7_LowRes.png "The improved worklist table with new columns and formatting")
1616

1717

1818

docs/03_Get-Started/step-4-quick-filter-for-the-worklist-85ec3a9.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ For easily detecting and managing product shortages in our app, we will add a qu
1212

1313
**A quick filter allows filtering the product table**
1414

15-
![](images/loio395f8acac5fd4fbc9a1c52c615fa07d3_HiRes.png "A quick filter allows filtering the product table")
15+
![](images/loio395f8acac5fd4fbc9a1c52c615fa07d3_LowRes.png "A quick filter allows filtering the product table")
1616

1717

1818

docs/03_Get-Started/step-5-adding-actions-to-the-worklist-2da220f.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Now we can easily spot shortages on our stock, but we would also like to take ac
1212

1313
**Actions are now available in the footer bar**
1414

15-
![](images/loio016d473029e04ec9be5ed43fa897e69b_HiRes.png "Actions are now available in the footer bar")
15+
![](images/loio016d473029e04ec9be5ed43fa897e69b_LowRes.png "Actions are now available in the footer bar")
1616

1717

1818

docs/03_Get-Started/step-6-extending-the-detail-page-b561d14.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ In this step, we will extend the detail page of our app to show more information
1212

1313
**Detail page with more product information**
1414

15-
![](images/loio49780e41de4e4766b41cdf65acf81ea2_HiRes.png "Detail page with more product information")
15+
![](images/loio49780e41de4e4766b41cdf65acf81ea2_LowRes.png "Detail page with more product information")
1616

1717

1818

docs/03_Get-Started/step-7-adding-a-comments-section-c73dfe3.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ In this step, we extend the product detail view by adding a feature allowing to
1212

1313
**Comments section added to the detail page**
1414

15-
![](images/loioa517fe596aa04b4d8d080fbf6168cf40_HiRes.png "Comments section added to the detail page")
15+
![](images/loioa517fe596aa04b4d8d080fbf6168cf40_LowRes.png "Comments section added to the detail page")
1616

1717

1818

docs/03_Get-Started/worklist-app-tutorial-6a6a621.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -25,13 +25,13 @@ We will use the worklist template as a starting point for this tutorial and add
2525

2626
**Start page of the app with list of products and actions**
2727

28-
![](images/loio016d473029e04ec9be5ed43fa897e69b_HiRes.png "Start page of the app with list of products and actions")
28+
![](images/loio016d473029e04ec9be5ed43fa897e69b_LowRes.png "Start page of the app with list of products and actions")
2929

3030

3131

3232
**Product detail page of the app**
3333

34-
![](images/loioa517fe596aa04b4d8d080fbf6168cf40_HiRes.png "Product detail page of the app")
34+
![](images/loioa517fe596aa04b4d8d080fbf6168cf40_LowRes.png "Product detail page of the app")
3535

3636

3737

docs/04_Essentials/create-a-rule-c24569d.md

+21-20
Original file line numberDiff line numberDiff line change
@@ -178,13 +178,13 @@ The check function has three main and one optional parameters. The main ones are
178178

179179
- `oCoreFacade` - gives you access to the different elements provided by the OpenUI5 core framework:
180180

181-
- <code><a href="https://ui5.sap.com/#/api/sap.ui.base.Object/methods/getMetadata">getMetadata()</a></code>
181+
- <code><a href="https://ui5.sap.com/#/api/sap.ui.support.CoreFacade%23methods/getMetadata">getMetadata()</a></code>
182182

183-
- <code><a href="https://ui5.sap.com/#/api/sap.ui.core.Core/methods/getUIArea">getUIAreas()</a></code>
183+
- <code><a href="https://ui5.sap.com/#/api/sap.ui.support.CoreFacade%23methods/getUIAreas">getUIAreas()</a></code>
184184

185-
- <code><a href="https://ui5.sap.com/#/api/sap.ui.core.Core/methods/getComponent">getComponents()</a></code>
185+
- <code><a href="https://ui5.sap.com/#/api/sap.ui.support.CoreFacade%23methods/getComponents">getComponents()</a></code>
186186

187-
- <code><a href="https://ui5.sap.com/#/api/sap.ui.core.Core/methods/getModel">getModels()</a></code>
187+
- <code><a href="https://ui5.sap.com/#/api/sap.ui.support.CoreFacade%23methods/getModels">getModels()</a></code>
188188

189189

190190
- `oScope` - retrieves elements in the scope with the following methods:
@@ -223,24 +223,25 @@ The check function has three main and one optional parameters. The main ones are
223223
```js
224224
225225
function(issueManager, oCoreFacade, oScope) {
226-
var mElements = oScope.getElements({
227-
type: "sap.m.Input",
228-
public: true,
229-
cloned: false
230-
});
231-
for (var n in mElements) {
232-
var oElement = mElements[n];
233-
if (!oElement.getParent()) {
234-
issueManager.addIssue({
235-
severity: sap.ui.support.Severity.Medium,
236-
details: "The element " + oElement.getId() + " has no parent.",
237-
context: {
238-
id: oElement.getId()
239-
}
240-
});
226+
var mElements = oScope.getElements({
227+
type: "sap.m.Input",
228+
public: true,
229+
cloned: false
230+
});
231+
232+
for (var n in mElements) {
233+
var oElement = mElements[n];
241234
235+
if (!oElement.getParent()) {
236+
issueManager.addIssue({
237+
severity: Severity.Medium, // Severity enum is taken from "sap/ui/support/library" import
238+
details: "The element " + oElement.getId() + " has no parent.",
239+
context: {
240+
id: oElement.getId()
241+
}
242+
});
243+
}
242244
}
243-
}
244245
}
245246
246247
```

docs/04_Essentials/enabling-the-automatic-header-adaptation-in-the-manifest-0635156.md renamed to docs/04_Essentials/enabling-the-automatic-header-adaptation-for-legacy-applications-0635156.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
<!-- loio0635156f3950494885ca314a13e15e29 -->
22

3-
## Enabling the Automatic Header Adaptation in the Manifest
3+
## Enabling the Automatic Header Adaptation for Legacy Applications
44

55
Application developers can enable automatic adaptation of legacy applications from the `manifest.json` file also known as descriptor for applications, components and libraries.
66

77

88

99
### The Automatic Header Adapter
1010

11-
The SAP Fiori design guidelines require changes with regards to the headers of applications and the SAP Fiori launchpad. If your application has a header, it needs to be merged into the standardized SAP Fiori header.
11+
The SAP Fiori design guidelines provide recommendations with regards to the headers of applications and the SAP Fiori launchpad. If your application has a header, it needs to be merged into the standardized SAP Fiori header.
1212

1313
Legacy applications using the `sap.m.Page`, including the back button, can use the header adapter to align their header layout with SAP Fiori design guidelines. The header adapter specifically prevents duplicate headers and back buttons when displaying these legacy applications in the SAP Fiori launchpad.
1414

Binary file not shown.
Loading
Binary file not shown.
Loading

docs/04_Essentials/odata-v4-model-5de13cf.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
The `sap.ui.model.odata.v4.ODataModel` is the model implementation for consuming an OData V4 service.
66

77
> ### Note:
8-
> Instead of smart controls \(`sap.ui.comp` library\) or `sap.ui.table.AnalyticalTable` \(or analytical table scenarios\) the SAP Fiori elements building blocks \(`sap.fe.macros`\) have to be used with the OpenUI5 OData V4 model. The `TreeTable` is not supported together with the OpenUI5 OData V4 model.
8+
> Instead of smart controls \(`sap.ui.comp` library\) or `sap.ui.table.AnalyticalTable` \(or analytical table scenarios\) the SAP Fiori elements building blocks \(`sap.fe.macros`\) have to be used with the OpenUI5 OData V4 model.
99
>
1010
> The interface for applications has been changed for an easier and more efficient use of the model. For a summary of these changes, see [Changes Compared to OData V2 Model](changes-compared-to-odata-v2-model-abd4d7c.md).
1111

0 commit comments

Comments
 (0)