Skip to content

Commit 5a9ebdf

Browse files
docs(ui5-side-navigation-item): update documentation (#11659)
* docs(ui5-side-navigation-item): updated documentation --------- Co-authored-by: Teodor Taushanov <[email protected]>
1 parent 5b17cc8 commit 5a9ebdf

File tree

1 file changed

+10
-7
lines changed

1 file changed

+10
-7
lines changed

packages/fiori/src/SideNavigationSelectableItemBase.ts

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,9 @@ class SideNavigationSelectableItemBase extends SideNavigationItemBase {
5757
icon?: string;
5858

5959
/**
60-
* Defines whether the item is selected
60+
* Defines whether the item is selected.
61+
*
62+
* **Note:** Items that have a set `href` and `target` set to `_blank` should not be selectable.
6163
*
6264
* @public
6365
* @default false
@@ -81,15 +83,16 @@ class SideNavigationSelectableItemBase extends SideNavigationItemBase {
8183
/**
8284
* Defines the component target.
8385
*
84-
* **Notes:**
86+
* Possible values:
8587
*
8688
* - `_self`
8789
* - `_top`
8890
* - `_blank`
8991
* - `_parent`
90-
* - `_search`
92+
* - `framename`
9193
*
92-
* **This property must only be used when the `href` property is set.**
94+
* **Note:** Items that have a defined `href` and `target`
95+
* attribute set to `_blank` should not be selectable.
9396
*
9497
* @public
9598
* @default undefined
@@ -111,15 +114,15 @@ class SideNavigationSelectableItemBase extends SideNavigationItemBase {
111114
design: `${SideNavigationItemDesign}` = "Default";
112115

113116
/**
114-
* Indicates whether the navigation item is selectable. By default all items are selectable unless specifically marked as unselectable.
117+
* Indicates whether the navigation item is selectable. By default, all items are selectable unless specifically marked as unselectable.
115118
*
116119
* When a parent item is marked as unselectable, selecting it will only expand or collapse its sub-items.
117120
* To improve user experience do not mix unselectable parent items with selectable parent items in a single side navigation.
118121
*
119122
*
120123
* **Guidelines**:
121-
* - External links should be unselectable.
122-
* - Items that trigger actions (with design "Action") should be unselectable.
124+
* - Items with an assigned `href` and a target of `_blank` should be marked as unselectable.
125+
* - Items that trigger actions (with design "Action") should be marked as unselectable.
123126
*
124127
* @public
125128
* @default false

0 commit comments

Comments
 (0)