search

SAP / ui5-webcomponents

UI5 Web Components - the enterprise-flavored sugar on top of native APIs! Build SAP Fiori user interfaces with the technology of your choice.
https://sap.github.io/ui5-webcomponents/
Apache License 2.0
1.5k stars 260 forks source link

[SideNavigationGroup] Import not required as SideNavigation automatically imports NavigationGroup #9545

Open ehni opened 1 month ago

ehni commented 1 month ago

Issue Description

→ https://sap.github.io/ui5-webcomponents/components/fiori/SideNavigationGroup/

The Import for the SideNavigationGroup is implicitly imported within the SideNavigation, so an additional import is not required, see e.g. the Basic Sample (https://sap.github.io/ui5-webcomponents/components/fiori/SideNavigation/#basic-sample) which is using the NavigationGroup but does not import it.

This is currently not stated in the documentation.

It would be good to have it either clearly documented that: a) the SideNavigationGroup is automatically imported within the SideNavigation, or b) have the SideNavigation not implicitly import the SideNavigationGroup so that it need to be explicitly imported. (I would prefer this option as it is best practice to have all used components imported so that IDEs do not throw warnings or errors).

Issue Type

kgogov commented 1 month ago

Hello @ehni,

Thank you for sharing this finding. I am forwarding this ticket to the responsible team, who will look into it and assist.

@SAP/ui5-webcomponents-topic-rd, could you please look into this?

SideNavigationGroup is implicitly imported within the SideNavigation. We may need to improve our documentation regarding this.

Regards, Konstantin Gogov UI5 Web Components GitHub Dispatcher