Skip to content

Commit

Permalink
OpenUI5 Documentation Update 27.11.2024
Browse files Browse the repository at this point in the history
  • Loading branch information
openui5bot committed Nov 27, 2024
1 parent df280e0 commit 6223150
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 7 deletions.
5 changes: 2 additions & 3 deletions docs/OpenUI5_UI_Development_Toolkit_for_HTML5_95d113b.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,9 +62,8 @@ This chapter and its sections describe the development concepts of OpenUI5, such
- **[Developing Apps](Developing_Apps_23cfd95.md "Create apps with rich user interfaces for modern web business applications,
responsive across browsers and devices, based on HTML5.")**
Create apps with rich user interfaces for modern web business applications, responsive across browsers and devices, based on HTML5.
- **[Extending Apps](Extending_Apps_a264a9a.md "You can adapt an OpenUI5 app
to your specific requirements. For example, you can adapt or replace views, extend or
replace controllers, or change language-specific texts.")**
- **[Extending Apps](Extending_Apps_a264a9a.md "You can adapt an OpenUI5 app to your specific requirements. For example,
you can adapt or replace views, extend or replace controllers, or change language-specific texts.")**
You can adapt an OpenUI5 app to your specific requirements. For example, you can adapt or replace views, extend or replace controllers, or change language-specific texts.
- **[Developing Controls](Developing_Controls_8dcab00.md "You can create own content for OpenUI5. To develop controls in
JavaScript, you can either extend existing controls or create new ones.")**
Expand Down
8 changes: 4 additions & 4 deletions docs/Step_30_Routing_and_Navigation_TypeScript_6173e3d.md
Original file line number Diff line number Diff line change
Expand Up @@ -132,14 +132,14 @@ We add a new “routing" section to the `sap.ui5` part of the descriptor. There

- `config`

This section contains the global router configuration and default values that apply for all routes and targets. The property `routerClass` is special as it determines the router implementation. The default value is `sap.ui.core.routing.Router`. Here, we set it to `sap.m.routing.Router``sap.m`. All other properties in `config` are given to the router instance. For example, we define in `path` where our views are located in the app. As we want to specify view-to-view navigation and we only use XML views in our app, we preset also the parameters `type` and `viewType`. To load and display views automatically, we also specify the `controlId` of the control that will contain the views, and the aggregation \(`controlAggregation`\) of the control where the views will be added. Here, we specify that the views are loaded into the `pages` aggregation of the control with the ID we provided in the app view.
This section contains the global router configuration and default values that apply for all routes and targets. The property `routerClass` is special as it determines the router implementation. The default value is `sap.ui.core.routing.Router`. Here, we set it to `sap.m.routing.Router`, because our app is based on `sap.m`. All other properties in `config` are given to the router instance. For example, we define in `path` where our views are located in the app. As we want to specify view-to-view navigation and we only use XML views in our app, we preset also the parameters `type` and `viewType`. To load and display views automatically, we also specify the `controlId` of the control that will contain the views, and the aggregation \(`controlAggregation`\) of the control where the views will be added. Here, we specify that the views are loaded into the `pages` aggregation of the control with the ID we provided in the app view.

> ### Note:
> The possible values for `routerClass` are `sap.ui.core.routing.Router`, `sap.m.routing.Router`, or any other subclass of `sap.ui.core.routing.Router`. Compared to `sap.ui.core.routing.Router`, the `sap.m.routing.Router` is optimized for mobile apps and adds the properties `level`, `transition` and `transitionParameters`, which can be specified for each route or target created by `sap.m.routing.Router`.
- `routes`

Each route defines a name, a pattern, and one or more targets to navigate to when the route has been hit. The pattern is basically the URL part that matches to the route, we define two routes for our app. The first one is a default route that will show the overview page with the content from the previous steps, and the second is the detail route with the URL pattern , because our app is based on `detail` that will show our new details page.
Each route defines a name, a pattern, and one or more targets to navigate to when the route has been hit. The pattern is basically the URL part that matches to the route, we define two routes for our app. The first one is a default route that will show the overview page with the content from the previous steps, and the second is the detail route with the URL pattern `detail` that will show our new details page.

- `targets`

Expand Down Expand Up @@ -187,12 +187,12 @@ We add a new “routing" section to the `sap.ui5` part of the descriptor. There
}
```

The router will automatically add the view that corresponds to the current URL into the app control. The router identifies the app control with the ID that corresponds to the property `controlId: “app”` in the app descriptor\`.
The router will automatically add the view that corresponds to the current URL into the app control. The router identifies the app control with the ID that corresponds to the property `controlId: “app”` in the app descriptor.

The overview view is always shown when the hash is empty. The detail view is shown when the hash matches the pattern `detail`.

> ### Note:
> , because our appThe sequence of the routes in the routes definition is important. As soon as a pattern is matched, the following patterns are ignored. To prevent this for a specific route, you can use the `greedy` parameter. If set to `true`, the route is always taken into account.
> The sequence of the routes in the routes definition is important. As soon as a pattern is matched, the following patterns are ignored. To prevent this for a specific route, you can use the `greedy` parameter. If set to `true`, the route is always taken into account.
***

Expand Down

0 comments on commit 6223150

Please sign in to comment.