|
-`sap.ui5/dependencies/components//lazy` and `dependencies/libs//lazy`
+`sap.ui5/routing/propagateTitle`
|
-V4 \(1.34\)
+V20 \(1.75\)
|
-If `dependencies/components//lazy` and `dependencies/libs//lazy` are set to `true`, the attribute indicates in an SAP Fiori app that a dependency shall be lazy loaded \(default is `false`\), see the example for `manifest.json` for the SAP Fiori app.
-
-Example for `manifest.json` for the SAP Fiori app:
+The `propagateTitle` property can be set to forward title information from a nested component to the router in the root component.
```
-"sap.ui5": {
- "_version": "1.2.0",
+{
...
- "dependencies": {
- "minUI5Version": "1.34.0",
- "libs": {
- "sap.m": {
- "minVersion": "1.34.0"
+ "componentUsages": {
+ "myreuse": {
+ "name": "reuse.component",
+ ...
+ }
+ },
+ "routing": {
+ "config": {
+ ...
+ },
+ "routes": [{
+ "name": "home",
+ "pattern": "",
+ "target": {
+ "name": "attachment",
+ "prefix": "atch",
+ "propagateTitle": true
+ }
+ }],
+ "targets": {
+ "attachment": {
+ "type": "Component",
+ "usage": "myreuse",
+ "options": {
+ ...
},
- "sap.ui.commons": {
- "minVersion": "1.34.0",
- "lazy": true
- }
- },
- "components": {
- "sap.ui.app.other": {
- "minVersion": "1.1.0"
- "lazy": true
- }
- }
- },
+ ...
+ }
+ }
+ }
+ ...
+}
```
@@ -203,31 +211,28 @@ Example for `manifest.json` for the SAP Fiori app:
|
-`sap.ui5/routing/config/async`
+`sap.ui5/commands`
|
-V4 \(1.34\)
+V17 \(1.70\)
|
-General setting for routing that indicates how the views are loaded; if set to `true`, the views are loaded asynchronously \(default is `false`\)
-
-For performance reasons, we recommend to always use the `async` setting. This recommendation implies that you have followed the OpenUI5 programming model in general and do **not** rely on any sync-execution depending event-orders.
+Specifies provided commands with a unique key/alias.
```
-"sap.ui5": {
- "_version": "1.2.0",
+{
...
- "routing": {
- "config": {
- "viewType": "XML",
- "async": true
- ...
- },
- ...
+ "commands": {
+ "Save": {
+ "shortcut": "Ctrl+S"
+ }
+ },
+ ...
+}
```
@@ -237,25 +242,64 @@ For performance reasons, we recommend to always use the `async` setting. This re
|
-`sap.ui5/models/preload`
+sap.ui5/routing/routes/targets/<targetName>/usage
|
-V5 \(1.38\)
+V16 \(1.66\)
|
-Defines whether or not the model is initialized \(preloaded\) before the component instance is created and while loading the component preload and its dependencies
+A component can be configured as a routing target by defining it in the `componentUsages` section and providing its key to a target via the `usage` property.
```
-"equipment": {
- "preload": true,
- "dataSource": "equipment",
- ...
+{
+ ...
+ "componentUsages": {
+ "myreuse": {
+ "name": "reuse.component",
+ "settings": {},
+ "componentData": {},
+ "lazy": false
+ }
+ },
+ "routing": {
+ "config": {
+ ...
+ },
+ "routes": [{
+ "name": "home",
+ "pattern": "",
+ "target": {
+ "name": "attachment",
+ "prefix": "atch"
+ }
+ }],
+ "targets": {
+ "attachment": {
+ "type": "Component",
+ "usage": "myreuse",
+ "options": {
+ // optional
+ // define the additional parameter for
+ // instantiating the component instance
+ },
+ "containerOptions": {
+ // optional
+ // define the additional parameter for
+ // instantiating the component container
+ // which enables the component to be rendered
+ // in the parent control
+ },
+ "controlId": "page",
+ "controlAggregation": "content"
+ }
+ }
+ }
+ ...
}
-
```
@@ -265,43 +309,51 @@ Defines whether or not the model is initialized \(preloaded\) before the compone
|
-`sap.ui5/routing/routes/target`
+sap.ui5/routing/routes/targets/<targetName>/type
+
+sap.ui5/routing/routes/targets/<targetName>/path
+
+sap.ui5/routing/routes/targets/<targetName>/name
+
+sap.ui5/routing/routes/targets/<targetName>/id
|
-V6 \(1.42\)
+V15 \(1.62\)
|
-Allows to define titles declaratively in the configuration \(`title` under `targets/` and `titleTarget` under `routes/`\), see [Routing and Navigation](Routing_and_Navigation_3d18f20.md)
+A routing target can load either a view or a component.
+
+With the `type` option set to "Component", the `Component.js` which is available under the namespace generated by combining `path` and `name` is loaded and instantiated.
```
{
- ...,
- "routes": [{
- "pattern": "product/{id}/parts",
- "name": "ProductParts",
- "target": ["product", "productParts"],
- "titleTarget": "productParts"
-
- }],
- "targets": {
- "product": {
- "type": "View",
- "path": "shop.products",
- "name": "Product",
- "title": "Product"
- },
- "productParts": {
- "type": "View",
- "path": "shop.products",
- "name": "Product",
- "title": "Product Parts"
- }
- },
- ...
+ "routing": {
+ "config": {
+ ...
+ },
+ "routes": [
+ ...
+ ],
+ "targets": {
+ "/attachment/": {
+ "type": "Component",
+ "path": "reuse.component",
+ "name": "attachment",
+ "options": {
+ ...
+ },
+ "containerOptions": {
+ ...
+ },
+ "controlId": "page",
+ "controlAggregation": "content"
+ }
+ }
+ }
}
```
@@ -312,25 +364,59 @@ Allows to define titles declaratively in the configuration \(`title` under `targ
|
-`sap.ui5/componentUsages`
+`sap.ui5/models//settings/enhanceWith`
|
-V8 \(1.48\)
+V12 \(1.56\)
|
-Specifies the used components with the a unique key/alias. Contains the following:
+The attribute `enhanceWith` can be specified with `bundleUrl`, `bundleUrlRelativeTo` \(either component \(default\) or manifest\) or `bundleName` to provide a list of additional resource bundle configurations to enhance the resource model with.
-- `name`: Mandatory name of the reuse component
+Additional attributes can be found in [Terminologies](Terminologies_eba8d25.md).
-- `settings`: Settings of the component
+```
+{
+ ...
+ "models": {
+ "i18n": {
+ "type": "sap.ui.model.resource.ResourceModel",
+ "uri": "i18n/i18n.properties",
+ "settings": {
+ "enhanceWith": [{
+ "bundleUrl": "i18n/i18n.properties",
+ "bundleUrlRelativeTo": "manifest"
+ }]
+ }
+ },
+ ...
+ },
+ ...
+}
+```
-- `componentData`: Component data of the component
+ |
+
+
+|
+
+`sap.ui5/componentUsages/lazy`
+
+ |
+
+
+V12 \(1.56\)
+
+ |
+
+
+Indicates whether the component usage should be lazily loaded. Default value: `true`
+
For more information see:[Using and Nesting Components](Using_and_Nesting_Components_346599f.md)
```
@@ -340,7 +426,8 @@ For more information see:[Using and Nesting Components](Using_and_Nesting_Compon
"myusage": {
"name": "my.used",
"settings": {},
- "componentData": {}
+ "componentData": {},
+ "lazy": false
}
},
...
@@ -390,17 +477,24 @@ An object can contain additional resource bundle configuration, e.g. terminologi
|
|
-`sap.ui5/componentUsages/lazy`
+`sap.ui5/componentUsages`
|
-V12 \(1.56\)
+V8 \(1.48\)
|
-Indicates whether the component usage should be lazily loaded. Default value: `true`
+Specifies the used components with the a unique key/alias. Contains the following:
+
+- `name`: Mandatory name of the reuse component
+
+- `settings`: Settings of the component
+
+- `componentData`: Component data of the component
+
For more information see:[Using and Nesting Components](Using_and_Nesting_Components_346599f.md)
@@ -411,8 +505,7 @@ For more information see:[Using and Nesting Components](Using_and_Nesting_Compon
"myusage": {
"name": "my.used",
"settings": {},
- "componentData": {},
- "lazy": false
+ "componentData": {}
}
},
...
@@ -426,37 +519,43 @@ For more information see:[Using and Nesting Components](Using_and_Nesting_Compon
|
|
-`sap.ui5/models//settings/enhanceWith`
+`sap.ui5/routing/routes/target`
|
-V12 \(1.56\)
+V6 \(1.42\)
|
-The attribute `enhanceWith` can be specified with `bundleUrl`, `bundleUrlRelativeTo` \(either component \(default\) or manifest\) or `bundleName` to provide a list of additional resource bundle configurations to enhance the resource model with.
-
-Additional attributes can be found in [Terminologies](Terminologies_eba8d25.md).
+Allows to define titles declaratively in the configuration \(`title` under `targets/` and `titleTarget` under `routes/`\), see [Routing and Navigation](Routing_and_Navigation_3d18f20.md)
```
{
- ...
- "models": {
- "i18n": {
- "type": "sap.ui.model.resource.ResourceModel",
- "uri": "i18n/i18n.properties",
- "settings": {
- "enhanceWith": [{
- "bundleUrl": "i18n/i18n.properties",
- "bundleUrlRelativeTo": "manifest"
- }]
- }
- },
- ...
- },
- ...
+ ...,
+ "routes": [{
+ "pattern": "product/{id}/parts",
+ "name": "ProductParts",
+ "target": ["product", "productParts"],
+ "titleTarget": "productParts"
+
+ }],
+ "targets": {
+ "product": {
+ "type": "View",
+ "path": "shop.products",
+ "name": "Product",
+ "title": "Product"
+ },
+ "productParts": {
+ "type": "View",
+ "path": "shop.products",
+ "name": "Product",
+ "title": "Product Parts"
+ }
+ },
+ ...
}
```
@@ -467,52 +566,25 @@ Additional attributes can be found in [Terminologies](Terminologies_eba8d25.md).
|
-`sap.ui5/routing/routes/targets/attachment/type`
-
-`sap.ui5/routing/routes/targets/attachment/path`
-
-`sap.ui5/routing/routes/targets/attachment/name`
-
-`sap.ui5/routing/routes/targets/attachment/id`
+`sap.ui5/models/preload`
|
-V15 \(1.62\)
+V5 \(1.38\)
|
-A routing target can load either a view or a component.
-
-With the `type` option set to "Component", the `Component.js` which is available under the namespace generated by combining `path` and `name` is loaded and instantiated.
+Defines whether or not the model is initialized \(preloaded\) before the component instance is created and while loading the component preload and its dependencies
```
-{
- "routing": {
- "config": {
- ...
- },
- "routes": [
- ...
- ],
- "targets": {
- "//": {
- "type": "Component",
- "path": "reuse.component",
- "name": "attachment",
- "options": {
- ...
- },
- "containerOptions": {
- ...
- },
- "controlId": "page",
- "controlAggregation": "content"
- }
- }
- }
+"equipment": {
+ "preload": true,
+ "dataSource": "equipment",
+ ...
}
+
```
@@ -522,64 +594,31 @@ With the `type` option set to "Component", the `Component.js` which is available
|
-`sap.ui5/routing/routes/targets/attachment/usage`
+`sap.ui5/routing/config/async`
|
-V16 \(1.66\)
+V4 \(1.34\)
|
-A component can be configured as a routing target by defining it in the `componentUsages` section and providing its key to a target via the `usage` property.
+General setting for routing that indicates how the views are loaded; if set to `true`, the views are loaded asynchronously \(default is `false`\)
+
+For performance reasons, we recommend to always use the `async` setting. This recommendation implies that you have followed the OpenUI5 programming model in general and do **not** rely on any sync-execution depending event-orders.
```
-{
- ...
- "componentUsages": {
- "myreuse": {
- "name": "reuse.component",
- "settings": {},
- "componentData": {},
- "lazy": false
- }
- },
- "routing": {
- "config": {
- ...
- },
- "routes": [{
- "name": "home",
- "pattern": "",
- "target": {
- "name": "attachment",
- "prefix": "atch"
- }
- }],
- "targets": {
- "attachment": {
- "type": "Component",
- "usage": "myreuse",
- "options": {
- // optional
- // define the additional parameter for
- // instantiating the component instance
- },
- "containerOptions": {
- // optional
- // define the additional parameter for
- // instantiating the component container
- // which enables the component to be rendered
- // in the parent control
- },
- "controlId": "page",
- "controlAggregation": "content"
- }
- }
- }
+"sap.ui5": {
+ "_version": "1.2.0",
...
-}
+ "routing": {
+ "config": {
+ "viewType": "XML",
+ "async": true
+ ...
+ },
+ ...
```
@@ -589,28 +628,42 @@ A component can be configured as a routing target by defining it in the `compone
|
|
-`sap.ui5/commands`
+`sap.ui5/dependencies/components//lazy` and `dependencies/libs//lazy`
|
-V17 \(1.70\)
+V4 \(1.34\)
|
-Specifies provided commands with a unique key/alias.
+If `dependencies/components//lazy` and `dependencies/libs//lazy` are set to `true`, the attribute indicates in an SAP Fiori app that a dependency shall be lazy loaded \(default is `false`\), see the example for `manifest.json` for the SAP Fiori app.
+
+Example for `manifest.json` for the SAP Fiori app:
```
-{
- ...
- "commands": {
- "Save": {
- "shortcut": "Ctrl+S"
- }
- },
+"sap.ui5": {
+ "_version": "1.2.0",
...
-}
+ "dependencies": {
+ "minUI5Version": "1.34.0",
+ "libs": {
+ "sap.m": {
+ "minVersion": "1.34.0"
+ },
+ "sap.ui.commons": {
+ "minVersion": "1.34.0",
+ "lazy": true
+ }
+ },
+ "components": {
+ "sap.ui.app.other": {
+ "minVersion": "1.1.0"
+ "lazy": true
+ }
+ }
+ },
```
@@ -620,53 +673,34 @@ Specifies provided commands with a unique key/alias.
|
-`sap.ui5/routing/propagateTitle`
+`sap.app/crossNavigation/inbounds//subTitle`
|
-V20 \(1.75\)
+V4 \(1.34\)
|
-The `propagateTitle` property can be set to forward title information from a nested component to the router in the root component.
+Used to overwrite the `subTitle` attribute per inbound; use the `{{...}}` syntax to add the attribute to the `manifest.json` file
+
+> ### Note:
+> Text symbols must be part of the properties file which is defined in `sap.app/i18n` \(default `"i18n/i18n.properties"`\).
```
-{
- ...
- "componentUsages": {
- "myreuse": {
- "name": "reuse.component",
- ...
- }
- },
- "routing": {
- "config": {
- ...
- },
- "routes": [{
- "name": "home",
- "pattern": "",
- "target": {
- "name": "attachment",
- "prefix": "atch",
- "propagateTitle": true
- }
- }],
- "targets": {
- "attachment": {
- "type": "Component",
- "usage": "myreuse",
- "options": {
- ...
- },
- ...
- }
- }
- }
- ...
-}
+"sap.app": {
+ "_version": "1.3.0",
+ ...
+ "crossNavigation": {
+ "inbounds": {
+ "contactCreate":
+ {
+ "semanticObject": "Contact",
+ "action": "create",
+ "icon": "sap-icon://add-contact",
+ "title": "{{title}}",
+ "subTitle": "{{subtitleOther}}",
```
@@ -676,56 +710,27 @@ The `propagateTitle` property can be set to forward title information from a nes
|
|
-`sap.ui5/models//settings/supportedLocales`
-
-`sap.ui5/models//settings/fallbackLocale`
-
-`sap.ui5/models//settings/terminologies`
+`sap.app/subTitle`
|
-V22 \(1.77\)
+V4 \(1.34\)
|
-The `supportedLocales` and `fallbackLocale` settings can be specified with a list of supported locales and a fallback locale to define a language fallback chain and optimize the loading performance of resource bundles.
+Added to the `manifest.json` file by using the `{{...}}` syntax
-Additional resource bundles can be made available by defining `terminologies`.
+> ### Note:
+> Text symbols must be part of the properties file which is defined in `sap.app/i18n` \(default `"i18n/i18n.properties"`\).
```
-{
- ...
- "models": {
- "i18n": {
- "type": "sap.ui.model.resource.ResourceModel",
- "settings": {
- "bundleName": "myapp.i18n.i18n",
- "supportedLocales": ["de", "en"],
- "fallbackLocale": "de",
- "terminologies": {
- "sports": {
- "bundleUrl": "i18n/terminologies/sports/i18n.terminologies.sports.properties",
- "bundleUrlRelativeTo": "manifest",
- "supportedLocales": ["en", "de"]
- },
- "travel": {
- "bundleUrl": "i18n/terminologies/travel/i18n.terminologies.travel.properties",
- "bundleUrlRelativeTo": "manifest",
- "supportedLocales": ["en", "de"]
- },
- "services": {
- "bundleUrl": "i18n/terminologies/services/i18n.terminologies.services.properties",
- "bundleUrlRelativeTo": "manifest",
- "supportedLocales": ["en", "de"]
- }
- }
- }
- }
- }
- ...
-}
+"sap.app": {
+ "_version": "1.3.0",
+ ...
+ "title": "{{title}}",
+ "subTitle": "{{subtitle}}",
```
@@ -735,43 +740,57 @@ Additional resource bundles can be made available by defining `terminologies`.
|
|
-`sap.ui5/resources/js`
+`sap.app/crossNavigation`
|
-V37 \(1.94\)
+V3 \(1.32\)
|
-Since 1.94 the usage of `js` resources is deprecated. Please use regular dependencies instead.
+Contains navigation information and is a mandatory attribute in the `manifest.json` file for SAP Fiori apps; the attribute contains two sections:
+
+- `sap.app/crossNavigation/inbounds` - Contains inbound intents and signature information
+
+- `sap.app/crossNavigation/outbounds` - Contains required intents that are called explicitely by the app, for example, if a business process is split among different apps A and B. If A calls B, A has outbound the intent to address B.
+
+
+
|
|
-`sap.fiori/cloudDevAdaptationStatus`
+`_version`
|
-V51 \(1.110\)
+V3 \(1.32\)
|
-Release status for the developer adaptation in SAP S/4HANA Cloud and SAP BTP, ABAP environment \(SAP-internal\).
+Needs to be updated in the `manifest.json` file when migrating to a new descriptor version:
-Supported types:
+- `_version` for V3 is 1.2.0
+
+- `_version` for V4 is 1.3.0
+
+- `_version` for V5 is 1.4.0 \(see example\)
+
+
+```
+{
+ "_version": "1.4.0",
+ "sap.app": {
+ ...
+```
-- `released`
-- `deprecated`
-- `obsolete`
-- No value means not released .
-For more information, see [Releasing an SAP Fiori Application to Be Extensible in Adaptation Projects on SAP S/4HANA Cloud and SAP BTP, ABAP Environment](https://help.sap.com/docs/bas/developing-sap-fiori-app-in-sap-business-application-studio/releasing-sap-fiori-application-to-be-extensible-in-adaptation-projects-on-sap-s-4hana-cloud).
|
diff --git a/docs/Step_2_Steady_128214a.md b/docs/Step_2_Steady_128214a.md
index 5e7e719b..d3dbafed 100644
--- a/docs/Step_2_Steady_128214a.md
+++ b/docs/Step_2_Steady_128214a.md
@@ -123,7 +123,7 @@ Now reload your `index.html` file. You can see a title bar and a blue button tha
**Related Information**
-[XML View](XML_View_91f2928.md "The XML view type is defined in an XML file. The file name either ends with .view.xml or as an XML string. The file name and the folder structure together specify the name of the view that equals the OpenUI5 module name.")
+[XML View](XML_View_91f2928.md "The XML view type is defined in an XML file, with a file name ending in .view.xml. The file name and the folder structure together specify the name of the view that equals the OpenUI5 module name.")
[Controller](Controller_121b8e6.md "A controller contains methods that define how models and views interact.")
diff --git a/docs/Step_4_XML_Views_1409791.md b/docs/Step_4_XML_Views_1409791.md
index 9f6b8c7b..ad106369 100644
--- a/docs/Step_4_XML_Views_1409791.md
+++ b/docs/Step_4_XML_Views_1409791.md
@@ -115,5 +115,5 @@ We replace the instantiation of the `sap/m/Text` control by our new `App.view.xm
[Views](Views_91f27e3.md "The view in the Model-View-Controller (MVC) concept is responsible for defining and rendering the UI. OpenUI5 supports predefined view types.")
-[XML View](XML_View_91f2928.md "The XML view type is defined in an XML file. The file name either ends with .view.xml or as an XML string. The file name and the folder structure together specify the name of the view that equals the OpenUI5 module name.")
+[XML View](XML_View_91f2928.md "The XML view type is defined in an XML file, with a file name ending in .view.xml. The file name and the folder structure together specify the name of the view that equals the OpenUI5 module name.")
diff --git a/docs/Step_4_XML_Views_TypeScript_6c66ed8.md b/docs/Step_4_XML_Views_TypeScript_6c66ed8.md
index 1135d813..0f2da0df 100644
--- a/docs/Step_4_XML_Views_TypeScript_6c66ed8.md
+++ b/docs/Step_4_XML_Views_TypeScript_6c66ed8.md
@@ -110,7 +110,7 @@ XMLView.create({
[API Reference: `sap.ui.core.mvc.View`](https://sdk.openui5.org/api/sap.ui.core.mvc.View)
-[XML View](XML_View_91f2928.md "The XML view type is defined in an XML file. The file name either ends with .view.xml or as an XML string. The file name and the folder structure together specify the name of the view that equals the OpenUI5 module name.")
+[XML View](XML_View_91f2928.md "The XML view type is defined in an XML file, with a file name ending in .view.xml. The file name and the folder structure together specify the name of the view that equals the OpenUI5 module name.")
[API Reference: `sap.ui.core.mvc.XMLView`](https://sdk.openui5.org/api/sap.ui.core.mvc.XMLView)
diff --git a/docs/Views_91f27e3.md b/docs/Views_91f27e3.md
index 2dba1f2b..d3e87382 100644
--- a/docs/Views_91f27e3.md
+++ b/docs/Views_91f27e3.md
@@ -24,10 +24,9 @@ The following predefined view types are available:
>
> Throughout this documentation, the code examples mainly use XML views.
-- **[XML View](XML_View_91f2928.md "The XML view type is defined in an XML file. The file name either ends with
- .view.xml or as an XML string. The file name and the folder structure
+- **[XML View](XML_View_91f2928.md "The XML view type is defined in an XML file, with a file name ending in .view.xml. The file name and the folder structure
together specify the name of the view that equals the OpenUI5 module name. ")**
-The XML view type is defined in an XML file. The file name either ends with `.view.xml` or as an XML string. The file name and the folder structure together specify the name of the view that equals the OpenUI5 module name.
+The XML view type is defined in an XML file, with a file name ending in `.view.xml`. The file name and the folder structure together specify the name of the view that equals the OpenUI5 module name.
- **[Typed View](Typed_View_e6bb33d.md "A view can also be defined by extending the sap.ui.core.mvc.View class. Such a view is referred to as a typed view. This
means the view definition represents its own view class.")**
A view can also be defined by extending the `sap.ui.core.mvc.View` class. Such a view is referred to as a typed view. This means the view definition represents its own view class.
diff --git a/docs/XML_View_91f2928.md b/docs/XML_View_91f2928.md
index 423c67eb..1b9ebe4a 100644
--- a/docs/XML_View_91f2928.md
+++ b/docs/XML_View_91f2928.md
@@ -10,7 +10,7 @@ view on: [demo kit nightly build](https://sdk.openui5.org/nightly/#/topic/91f292
## XML View
-The XML view type is defined in an XML file. The file name either ends with `.view.xml` or as an XML string. The file name and the folder structure together specify the name of the view that equals the OpenUI5 module name.
+The XML view type is defined in an XML file, with a file name ending in `.view.xml`. The file name and the folder structure together specify the name of the view that equals the OpenUI5 module name.
> ### Example:
> For `resources/sap/hcm/Address.view.xml`, the view name is `sap.hcm.Address`. The application uses this view name for displaying an instance of this view. If you define the XML view by means of an XML string, no file or define/require is needed.
| | | | |