feat(menu): priority-sorted menu groups, user-menu items, sidebar appearance toggle

Every main_menu entry moves from numeric group (1/2/3) to string-based group + group_label + priority. Groups now carry their own i18n label and child entries are sorted by an explicit priority field instead of config-array order, so module-contributed menu items can slot into any existing group at any position.

BootstrapController merges module-registered menu items into main_menu (previously they lived in a separate module_menu response key) and introduces a user_menu response key for items modules want to place in the avatar dropdown. The global store follows suit: moduleMenu becomes userMenu, menuGroups is a computed that sorts by priority, and hasActiveModules drops out.

New admin Appearance setting page with a single toggle for whether sidebar group labels render — so instances that prefer a compact sidebar can hide the Documents/Administration/Modules headings without losing the grouping itself. CompanyLayout watches route meta and re-bootstraps when the admin-mode flag flips so the sidebar repaints with the right menu on navigation across the admin boundary.

Test suites updated: module menu merging is asserted against main_menu (name: 'module-{slug}') rather than the old module_menu response; HelloWorldIntegrationTest verifies the schema translation path; CompanyModulesIndexTest covers the display_name attachment.
This commit is contained in:
Darko Gjorgjijoski
2026-04-11 00:30:00 +02:00
parent 345bfde306
commit 7885bf9d11
17 changed files with 246 additions and 148 deletions

View File

@@ -12,23 +12,10 @@ export interface MenuItem {
icon: string
group: string
group_label?: string
priority?: number
ability?: string
}
/**
* Sidebar item registered by an active module via
* \InvoiceShelf\Modules\Registry::registerMenu() in the module's ServiceProvider::boot().
*
* Distinct shape from MenuItem because module entries are namespaced (i18n
* keys come from the module's lang files) and don't carry group/ability —
* they always render under the dynamic "Modules" sidebar section.
*/
export interface ModuleMenuItem {
title: string
link: string
icon: string
}
export interface BootstrapResponse {
current_user: User
current_user_settings: Record<string, string>
@@ -42,7 +29,7 @@ export interface BootstrapResponse {
config: Record<string, unknown>
global_settings: Record<string, string>
modules: string[]
module_menu?: ModuleMenuItem[]
user_menu?: Array<{ title: string; link: string; icon: string; priority: number; name: string }>
admin_mode?: boolean
pending_invitations?: Array<{
token: string

View File

@@ -14,6 +14,7 @@ const AdminBackupView = () => import('./views/settings/AdminBackupView.vue')
const AdminFileDiskView = () => import('./views/settings/AdminFileDiskView.vue')
const AdminFontView = () => import('./views/settings/AdminFontView.vue')
const AdminUpdateAppView = () => import('./views/settings/AdminUpdateAppView.vue')
const AdminAppearanceView = () => import('./views/settings/AdminAppearanceView.vue')
export const adminRoutes: RouteRecordRaw[] = [
{
@@ -126,6 +127,14 @@ export const adminRoutes: RouteRecordRaw[] = [
},
component: AdminUpdateAppView,
},
{
path: 'appearance',
name: 'admin.settings.appearance',
meta: {
isSuperAdmin: true,
},
component: AdminAppearanceView,
},
],
},
],

View File

@@ -98,6 +98,11 @@ const menuItems = computed<SettingsMenuItem[]>(() => [
link: '/admin/administration/settings/update-app',
icon: 'ArrowPathIcon',
},
{
title: t('settings.menu_title.appearance'),
link: '/admin/administration/settings/appearance',
icon: 'PaintBrushIcon',
},
])
watchEffect(() => {

View File

@@ -0,0 +1,37 @@
<script setup lang="ts">
import { computed } from 'vue'
import { useI18n } from 'vue-i18n'
import { useGlobalStore } from '@/scripts/stores/global.store'
const { t } = useI18n()
const globalStore = useGlobalStore()
const showSidebarGroupLabels = computed<boolean>({
get: () => globalStore.globalSettings?.show_sidebar_group_labels === 'YES',
set: async (enabled) => {
await globalStore.updateGlobalSettings({
data: {
settings: {
show_sidebar_group_labels: enabled ? 'YES' : 'NO',
},
},
message: t('general.setting_updated'),
})
},
})
</script>
<template>
<BaseSettingCard
:title="$t('settings.appearance.title')"
:description="$t('settings.appearance.description')"
>
<div class="mt-14">
<BaseSwitchSection
v-model="showSidebarGroupLabels"
:title="$t('settings.appearance.sidebar_group_labels')"
:description="$t('settings.appearance.sidebar_group_labels_desc')"
/>
</div>
</BaseSettingCard>
</template>

View File

@@ -29,7 +29,7 @@
<script setup lang="ts">
import { useI18n } from 'vue-i18n'
import { onMounted, computed } from 'vue'
import { onMounted, computed, watch } from 'vue'
import { useRoute, useRouter } from 'vue-router'
import { useGlobalStore } from '@/scripts/stores/global.store'
import { useUserStore } from '@/scripts/stores/user.store'
@@ -63,6 +63,10 @@ const hasCompany = computed<boolean>(() => {
return !!companyStore.selectedCompany || companyStore.isAdminMode
})
const usesAdminBootstrap = computed<boolean>(() => {
return route.meta.usesAdminBootstrap === true
})
async function initializeLayout(): Promise<void> {
const meta = route.meta as RouteMeta
const res = await globalStore.bootstrap({
@@ -102,4 +106,10 @@ async function initializeLayout(): Promise<void> {
onMounted(() => {
void initializeLayout()
})
watch(usesAdminBootstrap, (isAdminBootstrap, previousValue) => {
if (previousValue !== undefined && isAdminBootstrap !== previousValue) {
void initializeLayout()
}
})
</script>

View File

@@ -144,13 +144,30 @@
</BaseDropdownItem>
</router-link>
<router-link
v-for="item in globalStore.userMenu"
:key="item.name"
:to="item.link"
>
<BaseDropdownItem>
<BaseIcon
:name="item.icon"
class="w-5 h-5 mr-3 text-subtle group-hover:text-muted"
aria-hidden="true"
/>
{{ item.title }}
</BaseDropdownItem>
</router-link>
<div class="my-1 border-t border-line-light" />
<BaseDropdownItem @click="logout">
<BaseIcon
name="ArrowRightOnRectangleIcon"
class="w-5 h-5 mr-3 text-subtle group-hover:text-muted"
class="w-5 h-5 mr-3 text-red-400"
aria-hidden="true"
/>
{{ $t('navigation.logout') }}
<span class="text-red-600">{{ $t('navigation.logout') }}</span>
</BaseDropdownItem>
</BaseDropdown>
</li>

View File

@@ -99,34 +99,6 @@
{{ $t(item.title) }}
</router-link>
</nav>
<!-- Dynamic Modules section (one entry per active module's registered settings link) -->
<nav v-if="globalStore.hasActiveModules" class="mt-5 space-y-1">
<div class="px-4 mt-6 mb-2 text-xs font-semibold text-subtle uppercase tracking-wider">
{{ $t('modules.sidebar.section_title') }}
</div>
<router-link
v-for="(item, idx) in globalStore.moduleMenu"
:key="`module-${idx}`"
:to="item.link"
:class="[
hasActiveUrl(item.link)
? 'text-primary-600 bg-primary-50 font-semibold'
: 'text-body hover:bg-hover',
'cursor-pointer mx-3 px-3 py-2.5 flex items-center rounded-lg text-sm not-italic font-medium transition-colors',
]"
@click="globalStore.setSidebarVisibility(false)"
>
<BaseIcon
:name="item.icon"
:class="[
hasActiveUrl(item.link) ? 'text-primary-500' : 'text-subtle',
'mr-3 shrink-0 h-5 w-5',
]"
/>
{{ $t(item.title) }}
</router-link>
</nav>
</div>
</div>
</TransitionChild>
@@ -154,16 +126,18 @@
:key="index"
class="p-0 m-0 mt-4 list-none"
>
<div
v-if="menu[0] && menu[0].group_label && !globalStore.isSidebarCollapsed"
class="px-6 mt-6 mb-2 text-xs font-semibold text-subtle uppercase tracking-wider whitespace-nowrap"
>
{{ $t(menu[0].group_label) }}
</div>
<div
v-else-if="menu[0] && menu[0].group_label && globalStore.isSidebarCollapsed"
class="mx-3 my-2 border-t border-line-light"
/>
<template v-if="menu[0] && menu[0].group_label">
<div
v-if="showGroupLabels && !globalStore.isSidebarCollapsed"
class="px-6 mt-6 mb-2 text-xs font-semibold text-subtle uppercase tracking-wider whitespace-nowrap"
>
{{ $t(menu[0].group_label) }}
</div>
<div
v-else-if="globalStore.isSidebarCollapsed"
class="mx-3 my-2 border-t border-line-light"
/>
</template>
<router-link
v-for="item in menu"
:key="item.name"
@@ -196,49 +170,6 @@
</router-link>
</div>
<!-- Dynamic Modules section: one shortcut per active module's registered
settings link. Hidden when no modules are active. -->
<div
v-if="globalStore.hasActiveModules"
class="p-0 m-0 mt-4 list-none"
>
<div
v-if="!globalStore.isSidebarCollapsed"
class="px-6 mt-6 mb-2 text-xs font-semibold text-subtle uppercase tracking-wider whitespace-nowrap"
>
{{ $t('modules.sidebar.section_title') }}
</div>
<div
v-else
class="mx-3 my-2 border-t border-line-light"
/>
<router-link
v-for="(item, idx) in globalStore.moduleMenu"
:key="`module-desktop-${idx}`"
:to="item.link"
v-tooltip="globalStore.isSidebarCollapsed ? { content: $t(item.title), placement: 'right' } : null"
:class="[
hasActiveUrl(item.link)
? 'text-primary-600 bg-primary-50 font-semibold'
: 'text-body hover:bg-hover',
globalStore.isSidebarCollapsed
? 'cursor-pointer mx-2 px-0 py-2.5 group flex items-center justify-center rounded-lg text-sm font-medium transition-colors'
: 'cursor-pointer mx-3 px-3 py-2.5 group flex items-center rounded-lg text-sm not-italic font-medium transition-colors',
]"
>
<BaseIcon
:name="item.icon"
:class="[
hasActiveUrl(item.link) ? 'text-primary-500' : 'text-subtle group-hover:text-body',
globalStore.isSidebarCollapsed ? 'shrink-0 h-6 w-6' : 'mr-3 shrink-0 h-5 w-5',
]"
/>
<span v-if="!globalStore.isSidebarCollapsed" class="whitespace-nowrap">
{{ $t(item.title) }}
</span>
</router-link>
</div>
<!-- Bottom toolbar -->
<div class="mt-auto sticky bottom-0 border-t border-white/10 bg-surface/80 backdrop-blur-xl p-2 flex flex-col items-center gap-1">
<button
@@ -267,6 +198,7 @@ import {
TransitionChild,
TransitionRoot,
} from '@headlessui/vue'
import { computed } from 'vue'
import { useRoute } from 'vue-router'
import { useGlobalStore } from '@/scripts/stores/global.store'
import MainLogo from '@/scripts/components/icons/MainLogo.vue'
@@ -282,7 +214,20 @@ interface MenuItemData {
const route = useRoute()
const globalStore = useGlobalStore()
const showGroupLabels = computed<boolean>(() => {
return globalStore.globalSettings?.show_sidebar_group_labels === 'YES'
})
const activeMenuLink = computed<string | null>(() => {
const allLinks = globalStore.menuGroups.flat().map((item) => item.link)
const matches = allLinks.filter(
(url) => route.path === url || route.path.startsWith(url + '/'),
)
// Return the longest (most specific) match
return matches.sort((a, b) => b.length - a.length)[0] ?? null
})
function hasActiveUrl(url: string): boolean {
return route.path.indexOf(url) > -1
return url === activeMenuLink.value
}
</script>

View File

@@ -2,7 +2,7 @@ import { defineStore } from 'pinia'
import { ref, computed } from 'vue'
import groupBy from 'lodash/groupBy'
import { bootstrapService } from '@/scripts/api/services/bootstrap.service'
import type { MenuItem, ModuleMenuItem, BootstrapResponse } from '@/scripts/api/services/bootstrap.service'
import type { MenuItem, BootstrapResponse } from '@/scripts/api/services/bootstrap.service'
import { settingService } from '@/scripts/api/services/setting.service'
import type {
DateFormat,
@@ -25,7 +25,7 @@ export const useGlobalStore = defineStore('global', () => {
const config = ref<Record<string, unknown> | null>(null)
const globalSettings = ref<Record<string, string> | null>(null)
const timeZones = ref<string[]>([])
const timeZones = ref<Array<{ key: string; value: string }>>([])
const dateFormats = ref<DateFormat[]>([])
const timeFormats = ref<TimeFormat[]>([])
const currencies = ref<Currency[]>([])
@@ -35,8 +35,7 @@ export const useGlobalStore = defineStore('global', () => {
const mainMenu = ref<MenuItem[]>([])
const settingMenu = ref<MenuItem[]>([])
const moduleMenu = ref<ModuleMenuItem[]>([])
const userMenu = ref<Array<{ title: string; link: string; icon: string; name: string }>>([])
const isAppLoaded = ref<boolean>(false)
const isSidebarOpen = ref<boolean>(false)
const isSidebarCollapsed = ref<boolean>(localStore.getBoolean('sidebarCollapsed'))
@@ -46,11 +45,13 @@ export const useGlobalStore = defineStore('global', () => {
// Getters
const menuGroups = computed<MenuItem[][]>(() => {
return Object.values(groupBy(mainMenu.value, 'group'))
const sorted = [...mainMenu.value].sort((a, b) => (a.priority ?? 100) - (b.priority ?? 100))
const groups = groupBy(sorted, 'group')
return Object.values(groups).sort(
(a, b) => (a[0]?.priority ?? 100) - (b[0]?.priority ?? 100)
)
})
const hasActiveModules = computed<boolean>(() => moduleMenu.value.length > 0)
// Actions
async function bootstrap(options?: { adminMode?: boolean }): Promise<BootstrapResponse> {
const companyStore = useCompanyStore()
@@ -62,7 +63,7 @@ export const useGlobalStore = defineStore('global', () => {
mainMenu.value = response.main_menu
settingMenu.value = response.setting_menu
moduleMenu.value = response.module_menu ?? []
userMenu.value = response.user_menu ?? []
config.value = response.config
globalSettings.value = response.global_settings
@@ -196,7 +197,7 @@ export const useGlobalStore = defineStore('global', () => {
}
}
async function fetchTimeZones(): Promise<string[]> {
async function fetchTimeZones(): Promise<Array<{ key: string; value: string }>> {
if (timeZones.value.length) {
return timeZones.value
}
@@ -290,7 +291,7 @@ export const useGlobalStore = defineStore('global', () => {
fiscalYears,
mainMenu,
settingMenu,
moduleMenu,
userMenu,
isAppLoaded,
isSidebarOpen,
isSidebarCollapsed,
@@ -298,7 +299,6 @@ export const useGlobalStore = defineStore('global', () => {
downloadReport,
// Getters
menuGroups,
hasActiveModules,
// Actions
bootstrap,
fetchCurrencies,