Skip to content

Commit

Permalink
OpenUI5 Documentation Update 22.11.2024
Browse files Browse the repository at this point in the history
  • Loading branch information
openui5bot committed Nov 22, 2024
1 parent 9911fb2 commit d2e6567
Show file tree
Hide file tree
Showing 12 changed files with 769 additions and 165 deletions.
1 change: 1 addition & 0 deletions docs/0index.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ OpenUI5 Version for the OpenUI5 Demo Kit

- [OpenUI5: UI Development Toolkit for HTML5](OpenUI5_UI_Development_Toolkit_for_HTML5_95d113b.md)
- [What's New in OpenUI5](What_s_New_in_OpenUI5_99ac68a.md)
- [What's New in OpenUI5 1.131](What_s_New_in_OpenUI5_1_131_7d24d94.md)
- [What's New in OpenUI5 1.130](What_s_New_in_OpenUI5_1_130_85609d4.md)
- [Previous Versions](Previous_Versions_6660a59.md)
- [What's New in OpenUI5 1.129](What_s_New_in_OpenUI5_1_129_d22b8af.md)
Expand Down
4 changes: 2 additions & 2 deletions docs/Pages_Which_One_Should_I_Choose_8a860c0.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,15 +18,15 @@ OpenUI5 applications are used in different environments: They can either be embe

### Standalone App

A **standalone OpenUI5 application** could use an `sap.m.Page` control as the root control of its views. The `Page` control provides a visually distinguished header bar with space for an application \(or page\) title and has a built-in *Back* button allowing the user to navigate back to the previous page. You can enable the *Back* button by setting the `Page`'s `showNavButton` property to `true`.
A **standalone OpenUI5 application** could use `sap.m.Page` controls as root controls of its views. The `Page` control provides a visually distinguished header bar with space for an application \(or page\) title and has a built-in *Back* button allowing the user to navigate back to the previous page. You can enable the *Back* button by setting the `Page`'s `showNavButton` property to `true`.

***

<a name="loio8a860c05f38145029c4dcab75ac11ba7__section_dtc_x2m_3fb"/>

### Embedded App

On the other hand, an **embedding shell** \(like SAP Build Work Zone or the SAP Fiori launchpad\) might already come with its own header containing a *Back* button and space for a title. Using an `sap.m.Page` control would then lead to a duplicate header and possibly even duplicate*Back* buttons.
An **embedding shell** \(like SAP Build Work Zone or the SAP Fiori launchpad\) might already come with its own header containing a *Back* button and space for a title. Using an `sap.m.Page` control would then lead to a duplicate header and possibly even a duplicate *Back* button.

The `sap.f.DynamicPage` control could be your preferred alternative in such a scenario as it comes without a header bar and *Back* button but still offers the option to configure a title if needed, as well as many other features on top of a plain `sap.m.Page`.

Expand Down
69 changes: 35 additions & 34 deletions docs/Step_27_Unit_Test_with_QUnit_TypeScript_750c8c1.md
Original file line number Diff line number Diff line change
Expand Up @@ -121,15 +121,15 @@ The page will be referenced in the test suite that we will create next.
<head>
<meta charset="utf-8">
<script
src="../resources/sap/ui/test/starter/runTest.js"
data-sap-ui-resource-roots='{
"test-resources.ui5.walkthrough": "./"
}'
src="../resources/sap/ui/test/starter/runTest.js"
data-sap-ui-resource-roots='{
"test-resources.ui5.walkthrough": "./"
}'
></script>
</head>
<body class="sapUiBody">
<div id="qunit"></div>
<div id="qunit-fixture"></div>
<div id="qunit"></div>
<div id="qunit-fixture"></div>
</body>
</html>
```
Expand All @@ -154,27 +154,28 @@ For more information, see [Concept and Basic Setup](Concept_and_Basic_Setup_22f5
> There are currently no types available for the test suite configuration. Please refer to [Configuration Options](Configuration_Options_738ed02.md) to see all options.
```ts

export default {
name: "QUnit test suite for UI5 TypeScript Walkthrough",
defaults: {
page: "ui5://test-resources/ui5/walkthrough/Test.qunit.html?testsuite={suite}&test={name}",
qunit: {
version: 2
},
ui5: {
theme: "sap_horizon"
},
loader: {
paths: {
"ui5/walkthrough": "../"
}
}
},
tests: {
"unit/unitTests": {
title: "UI5 TypeScript Walkthrough - Unit Tests"
}
}
name: "QUnit test suite for UI5 TypeScript Walkthrough",
defaults: {
page: "ui5://test-resources/ui5/walkthrough/Test.qunit.html?testsuite={suite}&test={name}",
qunit: {
version: 2
},
ui5: {
theme: "sap_horizon"
},
loader: {
paths: {
"ui5/walkthrough": "../"
}
}
},
tests: {
"unit/unitTests": {
title: "UI5 TypeScript Walkthrough - Unit Tests"
}
}
};
```

Expand All @@ -190,13 +191,13 @@ We also create a corresponding `testsuite.qunit.html` in the same folder. This i
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<script
src="../resources/sap/ui/test/starter/createSuite.js"
data-sap-ui-testsuite="test-resources/ui5/walkthrough/testsuite.qunit"
data-sap-ui-resource-roots='{
"test-resources.ui5.walkthrough": "./"
}'
<meta charset="utf-8">
<script
src="../resources/sap/ui/test/starter/createSuite.js"
data-sap-ui-testsuite="test-resources/ui5/walkthrough/testsuite.qunit"
data-sap-ui-resource-roots='{
"test-resources.ui5.walkthrough": "./"
}'
></script>
</head>
<body>
Expand All @@ -212,7 +213,7 @@ If we now open the `webapp/test/testsuite.qunit.html` file in the browser and se

- All unit tests are placed in the webapp/test/unit folder of the app.

- The default naming convention for the test suite is `testsuite.qunit.html` and `testsuite.qunit.ts`. When adding additional test suites, the naming must follow the pattern`testsuite.<name>.qunit.html`/`testsuite.<name>.qunit.ts`.
- The default naming convention for the test suite is `testsuite.qunit.html` and `testsuite.qunit.ts`. When adding additional test suites, the naming must follow the pattern `testsuite.<name>.qunit.html`/`testsuite.<name>.qunit.ts`.

- All test files referenced in the test suite end with `.qunit.ts`.

Expand Down
47 changes: 25 additions & 22 deletions docs/Step_27_Unit_Test_with_QUnit_e1ce1de.md
Original file line number Diff line number Diff line change
Expand Up @@ -101,8 +101,9 @@ We create a new `unitTests.qunit.js` file under `webapp/test/unit/`. This module
Inside the `unitTests.qunit.js` file we import the unit test for the custom formatter. This ensures that any tests related to the custom formatter functionality will be included when running our unit tests.

```js

sap.ui.define([
"./model/formatter"
"./model/formatter"
]);
```

Expand Down Expand Up @@ -150,29 +151,31 @@ Additionally, the `sap_horizon` theme is configured in the `ui5` section, where
The test suite serves as the entry point for all tests within our project such as the previously created `unit/unitTests` \(The `.qunit.js` extension is omitted and will be added automatically during runtime\). The previously created generic `Test.qunit.html` file is referenced as the test `page` and configured with query parameters so that individual tests can be run. The placeholders `{suite}` and `{name}` are replaced with the suite and test names respectively. For more information, see [Concept and Basic Setup](Concept_and_Basic_Setup_22f50c0.md).

```js


sap.ui.define(() => {
"use strict";
return {
name: "QUnit test suite for UI5 Walkthrough",
defaults: {
page: "ui5://test-resources/ui5/walkthrough/Test.qunit.html?testsuite={suite}&test={name}",
qunit: {
version: 2
},
ui5: {
theme: "sap_horizon"
},
loader: {
paths: {
"use strict";
return {
name: "QUnit test suite for UI5 Walkthrough",
defaults: {
page: "ui5://test-resources/ui5/walkthrough/Test.qunit.html?testsuite={suite}&test={name}",
qunit: {
version: 2
},
ui5: {
theme: "sap_horizon"
},
loader: {
paths: {
"ui5/walkthrough": "../"
}
}
},
tests: {
"unit/unitTests": {
title: "UI5 Walkthrough - Unit Tests"
}
}
}
}
},
tests: {
"unit/unitTests": {
title: "UI5 Walkthrough - Unit Tests"
}
}
};
});
```
Expand Down
28 changes: 15 additions & 13 deletions docs/Step_28_Integration_Test_with_OPA_9bf4dce.md
Original file line number Diff line number Diff line change
Expand Up @@ -155,8 +155,9 @@ We create a new `opaTests.qunit.js` file under `webapp/test/integration/`.
This module imports our `NavigationJourney` and is the entrypoint for all integration tests in the project.

```js

sap.ui.define([
"./NavigationJourney"
"./NavigationJourney"
]);
```

Expand All @@ -169,19 +170,20 @@ sap.ui.define([
Finally we reference the new `integration/opaTests.qunit.js` in the `testsuite.qunit.js` file. The `.qunit.js` extension is omitted and will be added automatically during runtime.

```js

sap.ui.define(() => {
"use strict";
return {
// ...
tests: {
"unit/unitTests": {
title: "UI5 Walkthrough - Unit Tests"
},
"integration/opaTests": {
title: "UI5 Walkthrough - Integration Tests"
}
}
};
"use strict";
return {
// ...
tests: {
"unit/unitTests": {
title: "UI5 Walkthrough - Unit Tests"
},
"integration/opaTests": {
title: "UI5 Walkthrough - Integration Tests"
}
}
};
});
```

Expand Down
17 changes: 9 additions & 8 deletions docs/Step_28_Integration_Test_with_OPA_TypeScript_412f0b6.md
Original file line number Diff line number Diff line change
Expand Up @@ -164,16 +164,17 @@ import "./NavigationJourney";
Finally we reference the new `integration/opaTests.qunit.ts` in the `testsuite.qunit.ts` file. The `.qunit.ts` extension is omitted and will be added automatically during runtime.

```ts

export default {
// ...
tests: {
"unit/unitTests": {
title: "UI5 TypeScript Walkthrough - Unit Tests"
},
"integration/opaTests": {
title: "UI5 TypeScript Walkthrough - Integration Tests"
}
}
tests: {
"unit/unitTests": {
title: "UI5 TypeScript Walkthrough - Unit Tests"
},
"integration/opaTests": {
title: "UI5 TypeScript Walkthrough - Integration Tests"
}
}
};
```

Expand Down
86 changes: 0 additions & 86 deletions docs/What_s_New_in_OpenUI5_1_129_d22b8af.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,6 @@

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

<link rel="stylesheet" type="text/css" href="css/sap-icons.css"/>

## What's New in OpenUI5 1.129

With this release OpenUI5 is upgraded from version 1.128 to 1.129.
Expand Down Expand Up @@ -73,90 +71,6 @@ Feature
</td>
<td valign="top">

**Harmonized Context Menu in Key User Adaptation**

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

**Harmonized Context Menu in Key User Adaptation**

The context menu is now consistent when you select elements. It no longer depends on how you select an element, such as using the left or right mouse button. The familiar right-click context menu now also appears when you left-click an element.

<sub>Changed•Feature•Info Only•1.129</sub>

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

Info Only

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

2024-10-03

</td>
</tr>
<tr>
<td valign="top">

1.129

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

New

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

Feature

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

**What's New Dialog in Key User Adaptation**

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

**What's New Dialog in Key User Adaptation**

The *What's New* dialog keeps you informed about the latest updates, features, and improvements in key user adaptation.

After an upgrade, the dialog automatically shows the new features introduced with the new version. If you're interested in features from previous versions, you can find an overview in the <span class="SAP-icons-V5"></span> \(More Actions\) menu in the toolbar.

<sub>New•Feature•Info Only•1.129</sub>

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

Info Only

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

2024-10-03

</td>
</tr>
<tr>
<td valign="top">

1.129

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

Changed

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

Feature

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

**OpenUI5 OData V4 Model**

</td>
Expand Down
Loading

0 comments on commit d2e6567

Please sign in to comment.