-
Notifications
You must be signed in to change notification settings - Fork 278
docs(ui5-side-navigation-item): update documentation #11659
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR enhances the JSDoc comments for SideNavigationSelectableItemBase
to clarify how href
, target
, selection, and child items should interact.
- Refined description of the
selected
property and its relation tohref
/target="_blank"
. - Added guidance on children usage when
href
andtarget
are set. - Clarified recommended
target
usage for internal navigation.
Comments suppressed due to low confidence (2)
packages/fiori/src/SideNavigationSelectableItemBase.ts:62
- [nitpick] Consider rephrasing for clarity, e.g., "Items with an
href
andtarget="_blank"
are not selectable." to make the statement more concise and consistent with other JSDoc entries.
* Items that have a set href and target set to <code>_blank</code> should not be selectable.
packages/fiori/src/SideNavigationSelectableItemBase.ts:96
- [nitpick] This sentence is a bit unclear. You could simplify it to: "Items with an
href
should not specify atarget
for internal navigation." to better convey the intended restriction.
* **Items that have a set href, should not use target for internal navigation.**
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please change the header to:
docs(ui5-side-navigation-item): update documentation
Please consider changing the additional explanation below the header:
Document the correct usage recommendations for external link items: use the target
=_blank
attribute along with the href
property.
Done |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good, thank you.
Document the correct usage recommendations for external link items: use the target=_blank attribute along with the href property.
JIRA: BGSOFUIRODOPI-3487