UI5 / UI5/webcomponents

[SideNavigationGroup] Import not required as SideNavigation automatically imports NavigationGroup

Open
#9,545 1 comment 0 reactions 1 assignee View on GitHub

@olannyv is already working on this.

Since Jul 30, 2024.

documentation enhancement Low Prio TOPIC RD
Dominant language
TypeScript
Stars
1.8k
Forks
285
Avg merge
3d 2h
Merged PRs (30d)
59

Description

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
  • Documentation is unclear
  • Documentation is incorrect
  • Documentation is missing
  • Other

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.