Documentation improvement: Link Sorting, Grouping, and Filtering for List Binding in items aggregation binding documentation

[gregorwolf]

OpenUI5 version: 1.106.0

Steps to reproduce the problem:

Right now the documentation for controls that have an aggregation binding "items" like:

• https://sdk.openui5.org/api/sap.m.List#aggregations
• https://sdk.openui5.org/api/sap.m.SelectDialog#aggregations

point all to the documentation for sap.m.ListItemBase:

https://sdk.openui5.org/api/sap.m.ListItemBase#overview

But the items attribute does also support the syntax described in Sorting, Grouping, and Filtering for List Binding.

What is the expected result?

A link to the documentation for Sorting, Grouping, and Filtering for List Binding should be included in the control documentation.

[tsanislavgatev]

Hello @gregorwolf ,

Can you please elaborate where is the issue in this case, and why is it expected to have part of the tutorial as a part of the API documentation? We have samples showing different usages of the lists, we have one also in the select dialog: https://sdk.openui5.org/entity/sap.m.SelectDialog/sample/sap.m.sample.SelectDialog/code/Dialog.fragment.xml

Please give more information about your proposition.

Best Regards, Tsanislav

[codeworrior]

I guess, what @gregorwolf wants to see is that the type column not only shows the concrete item type but also mentions that a binding info can be provided.

I understand this wish to some degree. But for me, the aggregations section in the API reference does not only represent the constructor but is rather a description of the control structure. And then, AggregationBindingInfo as type would be misleading, it's only supported in the constructor.

That's - by the way - how we addressed this in the TypeScript signatures. The interface for the constructor settings also mentions binding strings (for properties and aggregations with simple alternative types) and binding info objects (for properties and aggregations).

Maybe detailing the constructor signature in the API reference could be a solution?

[artless-soul]

well.. I have similar comments to @gregorwolf.. it is not very clear what is supported as part of items attribute (path, sorting, grouping etc) while working with for example XML fragment with SelectDialog control by looking at the API documentation.. one need to be searching sample code to understand supported features.. It would be nice to have this mentioned in API documentation somehow..

[flovogt]

Hello @gregorwolf , Thank you for sharing this finding. I've created an internal incident 2270167993. The status of the issue will be updated here in GitHub. Florian