SAP-docs / sapui5

This is the markdown version of the official SAPUI5 documentation from the SAPUI5 Demo Kit for external contributions.
Creative Commons Attribution 4.0 International
92 stars 144 forks source link

[doc issue] Where can I find a complete API reference for `routing` in `manifest.json`? #124

Closed ziyang-works closed 1 month ago

ziyang-works commented 6 months ago

Issue description

I'm working on Step 30: Routing and Navigation of the Walkthrough Tutorial, and have some questions regarding the given manifes.json code:

{
  ...
  "sap.ui5": {
  ...
    "routing": {
      "config": {
        "routerClass": "sap.m.routing.Router",
        "type": "View",
        "viewType": "XML",
        "path": "ui5.walkthrough.view",
        "controlId": "app",
        "controlAggregation": "pages"
      },
      "routes": [
        {
          "pattern": "",
          "name": "overview",
          "target": "overview"
        },
        {
          "pattern": "detail",
          "name": "detail",
          "target": "detail"
        }
      ],
      "targets": {
        "overview": {
          "id": "overview",
          "name": "Overview"
        },
        "detail": {
          "id": "detail",
          "name": "Detail"
        }
      }
    }
  }
}

I want to find API reference documents that provides the complete list of possible properties in routing and their values but failed to do so.

For example, I want to find what config.controlId and config.controlAggregation mean, but in Routing Configuration page, they are under targets property instead of config, so the page does not provide all possible properties and values.

Besides, Is it possible to list all attributes in a table as something like follows so it's easier to find the property name I'm looking for? I find it difficult to locate a specific property on that Routing Configuration page. For now I have to read through unnecessary lines of text or search in the page to find the property name I need.

For example, currently it's

image

It might be easier to navigate if it's something like:

config

Property name Description
routerClass some description
homeRoute some description

Feedback Type (Optional)

content structure

Page Title on SAP Help Portal (prefilled)

No response

Page URL on SAP Help Portal (prefilled)

No response

KvM2 commented 6 months ago

Hi @ziyang-works . thanks for your contribution! We'll look into it and will get back to you.

flovogt commented 6 months ago

Hi @ziyang-works, thanks a lot for reporting this. I totally agree with you that this information is currently hard to get. You can basically use every property defined here https://ui5.sap.com/#/api/sap.ui.core.routing.$TargetSettings.

@KvM2 please get in touch with @stopcoder

KlattG commented 1 month ago

Hi @ziyang-works , we had a look at this issue but cannot provide a solution in the near future for capacity reasons, so we're closing it for now. If you’d like to check again with us at a later point, please comment below. We'll review and reopen the conversation if necessary. Until next time, thanks!