Skip to content

feat: enhance sidebar menu with N-level recursion and improved UX #1811

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

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

feat: enhance sidebar menu with N-level recursion and improved UX #1811

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e61ed9b
feat: enhance sidebar menu with N-level recursion and improved UX
lfsigreja Aug 20, 2025
d00ca3e
Merge branch 'main' into dx-142
lfsigreja Aug 26, 2025
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
108 changes: 85 additions & 23 deletions src/components/sidebarpanelmenu/SidebarPanelMenu.vue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@
:unstyled="true"
:pt="{
headerContent: { class: ['cursor-text'] },
content: { class: ['indent-4'] }
}"
>
<template #item="{ item }">
Expand All @@ -23,6 +22,7 @@
<div
v-if="!item.slug && item.text"
class="flex hover:surface-hover py-2 px-4 border-none cursor-pointer rounded h-9"
:style="{ paddingLeft: `${(item.level * 16) + 16}px !important` }"
>
<p v-if="item.text" class="text-sm">
{{ item.text }}
Expand All @@ -33,12 +33,34 @@
class="pi pi-angle-right text-primary ml-auto pr-1">
</i>
</div>
<a v-else-if="item.slug && item.text && item.items"
:title="item.text"
:href="isCurrent(item, lang) ? '#' : modelSlug(item.slug, item.isFallback, lang)"
:target="(isURL(item.slug) ? '_blank' : '_self')"
:class="isCurrent(item, lang) ? 'surface-200': ''"
class="text-sm h-9 flex justify-between items-center hover:surface-hover py-2 px-4 border-none cursor-pointer rounded"
:style="{ paddingLeft: `${(item.level * 16) + 16}px !important` }"
@click="handleItemClick(item, $event)"
>
{{ item.text }}
<i
v-if="(isURL(item.slug) ? true : false)"
class="text-base pi pi-external-link text-primary mr-1">
</i>

<span @click="handleItemClick(item, $event)">
<i
class="pi pi-angle-right text-primary ml-auto pr-1">
</i>
</span>
</a>
<a v-else-if="item.slug"
:title="item.text"
:href="modelSlug(item.slug, item.isFallback, lang)"
:target="(isURL(item.slug) ? '_blank' : '_self')"
:class="isCurrent(item, lang) ? 'surface-200': ''"
class="text-sm h-9 flex justify-between items-center hover:surface-hover py-2 px-4 border-none cursor-pointer rounded"
:style="{ paddingLeft: `${(item.level * 16) + 16}px !important` }"
>
{{ item.text }}
<i
Expand Down Expand Up @@ -77,33 +99,73 @@
} = props;

const dataNoMobile = data.filter((item) => !item.onlyMobile);
const dataWithIndex = ( filterMobile ? dataNoMobile : data).map((item, index) => {
// Modifying original data during buildtime

// index is used to decide the margin top
item.index = index;

function processMenuItems(items, parentKey = null, level = 0) {
return items.map((item, index) => {
item.index = index;
item.level = level;

if (parentKey) {
item.parent = parentKey;
}

if (item.items && item.items.length) {
item.items = processMenuItems(item.items, item.key, level + 1);
}

return item;
});
}

const dataWithIndex = processMenuItems(filterMobile ? dataNoMobile : data);

function handleItemClick(item, event) {
const isArrowClick = event.target.closest('span') || event.target.tagName === 'I';
const isCurrentPage = isCurrent(item, lang);

if(item.items && item.items.length) {
item.items.map(subItem => {
// subItemParent used to know the parent umbrella to be opened
subItem.parent = item.key;
});
if (isArrowClick || isCurrentPage) {
event.preventDefault();
if (expandedKeys.value[item.key]) {
expandedKeys.value[item.key] = false;
} else {
expandedKeys.value[item.key] = true;
}
}

return item;
});

function expandNode(key) {
expandedKeys.value[key] = true;
};

// function collapseAll() {
// expandedKeys.value = {};
// }
}

function expandParentNodes(item) {
if (item.parent) {
expandedKeys.value[item.parent] = true;
const parentItem = findItemByKey(data, item.parent);
if (parentItem) {
expandParentNodes(parentItem);
}
}
}

function findItemByKey(items, key) {
for (const item of items) {
if (item.key === key) {
return item;
}
if (item.items && item.items.length) {
const found = findItemByKey(item.items, key);
if (found) return found;
}
}
return null;
}

function isCurrent(item, lang) {
const currentPageMatch = `${lang}${item.slug}` === props.currentPageMatch;
if(currentPageMatch && item.parent) expandNode(item.parent);
if(currentPageMatch) {
if(item.parent) {
expandParentNodes(item);
}
if(item.items && item.items.length) {
expandedKeys.value[item.key] = true;
}
}
return currentPageMatch;
}
</script>
Loading