Skip to content
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.

Sign up for GitHub

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

Jump to bottom

chore(ui5-side-navigation): adapt documentation #10110

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
+17 −16
Open

chore(ui5-side-navigation): adapt documentation #10110

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5fc0b32
chore(ui5-side-navigation): adapt documentation
TeodorTaushanov Oct 30, 2024
1ea4850
chore: fix typo
TeodorTaushanov Oct 30, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 17 additions & 16 deletions packages/fiori/src/SideNavigation.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,6 +82,10 @@ type NavigationMenuClickEventDetail = MenuItemClickEventDetail & {
* The items can consist of text only or an icon with text. The use or non-use of icons must be consistent for all items on one level.
* You must not combine entries with and without icons on the same level. We strongly recommend that you do not use icons on the second level.
*
* The `ui5-side-navigation` component is intended for use within an `ui5-navigation-layout` component.
* While it can function independently, it is recommended to use it with
* the `ui5-navigation-layout` for optimal user experience.
*
* ### Keyboard Handling
*
* ### Fast Navigation
Expand Down Expand Up @@ -146,25 +150,22 @@ class SideNavigation extends UI5Element {
collapsed = false;

/**
* Defines the main items of the `ui5-side-navigation`. Use the `ui5-side-navigation-item` component
* for the top-level items, and the `ui5-side-navigation-sub-item` component for second-level items, nested
* inside the items.
* Defines the main items of the component.
*
* @public
*/
@slot({ type: HTMLElement, invalidateOnChildChange: true, "default": true })
items!: Array<SideNavigationItemBase>;
items!: Array<SideNavigationGroup | SideNavigationItem>;

/**
* Defines the fixed items at the bottom of the `ui5-side-navigation`. Use the `ui5-side-navigation-item` component
* for the fixed items, and optionally the `ui5-side-navigation-sub-item` component to provide second-level items inside them.
* Defines the fixed items at the bottom of the component.
*
* **Note:** In order to achieve the best user experience, it is recommended that you keep the fixed items "flat" (do not pass sub-items)
*
* @public
*/
@slot({ type: HTMLElement, invalidateOnChildChange: true })
fixedItems!: Array<SideNavigationItemBase>;
fixedItems!: Array<SideNavigationGroup | SideNavigationItem>;

/**
* Defines the header of the `ui5-side-navigation`.
Expand Down Expand Up @@ -226,7 +227,7 @@ class SideNavigation extends UI5Element {
onBeforeRendering() {
super.onBeforeRendering();

this._getAllItems(this.items as Array<SideNavigationItem | SideNavigationGroup>).concat(this._getAllItems(this.fixedItems as Array<SideNavigationItem | SideNavigationGroup>)).forEach(item => {
this._getAllItems(this.items).concat(this._getAllItems(this.fixedItems)).forEach(item => {
item.sideNavCollapsed = this.collapsed;
item.inPopover = this.inPopover;
item.sideNavigation = this;
Expand All @@ -238,7 +239,7 @@ class SideNavigation extends UI5Element {
// item navigation index should be managed, because items are
// dynamically recreated and tabIndexes are not updated
const tree = this.getPickerTree();
const selectedItem = tree._findSelectedItem(tree.items as Array<SideNavigationItem | SideNavigationGroup>);
const selectedItem = tree._findSelectedItem(tree.items);
if (selectedItem) {
selectedItem.focus();
} else {
Expand Down Expand Up @@ -386,11 +387,11 @@ class SideNavigation extends UI5Element {
}

getEnabledFixedItems() : Array<ITabbable> {
return this.getEnabledItems(this.fixedItems as Array<SideNavigationItem | SideNavigationGroup>);
return this.getEnabledItems(this.fixedItems);
}

getEnabledFlexibleItems() : Array<ITabbable> {
const items = this.getEnabledItems(this.items as Array<SideNavigationItem | SideNavigationGroup>);
const items = this.getEnabledItems(this.items);

if (this._overflowItem) {
items.push(this._overflowItem);
Expand Down Expand Up @@ -425,12 +426,12 @@ class SideNavigation extends UI5Element {

onAfterRendering() {
if (!this.getDomRef()?.matches(":focus-within")) {
let selectedItem = this._findSelectedItem(this.items as Array<SideNavigationItem | SideNavigationGroup>);
let selectedItem = this._findSelectedItem(this.items);
if (selectedItem) {
this._flexibleItemNavigation.setCurrentItem(selectedItem);
}

selectedItem = this._findSelectedItem(this.fixedItems as Array<SideNavigationItem | SideNavigationGroup>);
selectedItem = this._findSelectedItem(this.fixedItems);
if (selectedItem) {
this._fixedItemNavigation.setCurrentItem(selectedItem);
}
Expand Down Expand Up @@ -549,7 +550,7 @@ class SideNavigation extends UI5Element {
}

get overflowItems() : Array<HTMLElement> {
return (this.items as Array<SideNavigationItem | SideNavigationGroup>).reduce((result, item) => {
return (this.items).reduce((result, item) => {
return result.concat(item.overflowItems);
}, new Array<HTMLElement>());
}
Expand Down Expand Up @@ -609,8 +610,8 @@ class SideNavigation extends UI5Element {
return;
}

let items = this._getSelectableItems(this.items as Array<SideNavigationItem | SideNavigationGroup>);
items = items.concat(this._getSelectableItems(this.fixedItems as Array<SideNavigationItem | SideNavigationGroup>));
let items = this._getSelectableItems(this.items);
items = items.concat(this._getSelectableItems(this.fixedItems));

items.forEach(current => {
current.selected = false;
Expand Down