Skip to content

The complete open source platform to run your entire marketplace. Storefront, vendor panel, admin console, and integrations in one enterprise-grade platform you own.

fix(dashboard): keep sidebar menus usable when collapsed and hide settings sidebar fully (#1586)

Viktor Holik9387ab4ed2ea
diff --git a/packages/admin/src/components/layout/main-layout/main-layout.tsx b/packages/admin/src/components/layout/main-layout/main-layout.tsx
index 3c7ef8b77..450485c41 100644
--- a/packages/admin/src/components/layout/main-layout/main-layout.tsx
+++ b/packages/admin/src/components/layout/main-layout/main-layout.tsx
@@ -23,7 +23,11 @@ import { useStore } from "../../../hooks/api/store";
import { useDocumentDirection } from "../../../hooks/use-document-direction";
import { queryClient } from "../../../lib/query-client";
import { useSearch } from "../../../providers/search-provider";
-import { SIDEBAR_RAIL_FADE } from "../../../providers/sidebar-provider";
+import {
+ SIDEBAR_MENU_CONTENT,
+ SIDEBAR_RAIL_FADE,
+ useSidebarMenuPlacement,
+} from "../../../providers/sidebar-provider";
import { Skeleton } from "../../common/skeleton";
import { INavItem, NavItem } from "../../layout/nav-item";
import { Shell } from "../../layout/shell";
@@ -209,6 +213,7 @@ const Header = () => {
const { t } = useTranslation();
const { store, isPending, isError, error } = useStore();
const direction = useDocumentDirection();
+ const menuPlacement = useSidebarMenuPlacement("start");
const name = store?.name;
const fallback = store?.name?.slice(0, 1).toUpperCase();
@@ -262,7 +267,8 @@ const Header = () => {
</DropdownMenu.Trigger>
{isLoaded && (
<DropdownMenu.Content
- className="w-[var(--radix-dropdown-menu-trigger-width)] min-w-0"
+ {...menuPlacement}
+ className={SIDEBAR_MENU_CONTENT}
data-testid="sidebar-header-dropdown-content"
>
<div
diff --git a/packages/admin/src/components/layout/settings-layout/settings-layout.tsx b/packages/admin/src/components/layout/settings-layout/settings-layout.tsx
index cfa18f227..7bd0aa65d 100644
--- a/packages/admin/src/components/layout/settings-layout/settings-layout.tsx
+++ b/packages/admin/src/components/layout/settings-layout/settings-layout.tsx
@@ -12,6 +12,7 @@ import { Shell } from "@components/layout/shell";
import { UserMenu } from "@components/layout/user-menu";
import menuItemsModule from "virtual:mercur/menu-items";
import { usePermissions } from "@mercurjs/dashboard-shared";
+import { useExpandedSidebar } from "../../../providers/sidebar-provider";
import {
filterMenuItemsByPermissions,
getMenuItemsByType,
@@ -19,8 +20,10 @@ import {
import { getRoutePermission } from "../../../lib/permissions/route-permissions";
export const SettingsLayout = () => {
+ useExpandedSidebar();
+
return (
- <Shell>
+ <Shell rail={false}>
<SettingsSidebar />
</Shell>
);
diff --git a/packages/admin/src/components/layout/shell/shell.tsx b/packages/admin/src/components/layout/shell/shell.tsx
index 252c7ad1a..c566238a0 100644
--- a/packages/admin/src/components/layout/shell/shell.tsx
+++ b/packages/admin/src/components/layout/shell/shell.tsx
@@ -18,7 +18,15 @@ import { useGlobalShortcuts } from "../../../providers/keybind-provider/hooks"
import { useSidebar } from "../../../providers/sidebar-provider"
import { ProgressBar } from "../../common/progress-bar"
-export const Shell = ({ children }: PropsWithChildren) => {
+type ShellProps = PropsWithChildren<{
+ /**
+ * Whether the collapsed desktop sidebar shrinks to an icon rail. Sidebars
+ * without icons hide completely instead.
+ */
+ rail?: boolean
+}>
+
+export const Shell = ({ children, rail = true }: ShellProps) => {
const globalShortcuts = useGlobalShortcuts()
const navigation = useNavigation()
@@ -30,7 +38,7 @@ export const Shell = ({ children }: PropsWithChildren) => {
<NavigationBar loading={loading} />
<div>
<MobileSidebarContainer>{children}</MobileSidebarContainer>
- <DesktopSidebarContainer>{children}</DesktopSidebarContainer>
+ <DesktopSidebarContainer rail={rail}>{children}</DesktopSidebarContainer>
</div>
<div className="flex h-screen w-full flex-col overflow-auto">
<Topbar />
@@ -206,7 +214,10 @@ const Topbar = () => {
)
}
-const DesktopSidebarContainer = ({ children }: PropsWithChildren) => {
+const DesktopSidebarContainer = ({
+ children,
+ rail,
+}: PropsWithChildren<{ rail: boolean }>) => {
const { state } = useSidebar()
return (
@@ -215,10 +226,16 @@ const DesktopSidebarContainer = ({ children }: PropsWithChildren) => {
className={clx(
"group/sidebar hidden h-screen w-[220px] shrink-0 overflow-x-hidden border-e lg:flex",
"transition-[width] duration-200 ease-sidebar motion-reduce:transition-none",
- "data-[state=collapsed]:w-[52px]"
+ rail
+ ? "data-[state=collapsed]:w-[52px]"
+ : "data-[state=collapsed]:w-0 data-[state=collapsed]:border-e-0"
)}
>
- {children}
+ {rail ? (
+ children
+ ) : (
+ <div className="flex w-[220px] shrink-0">{children}</div>
+ )}
</div>
)
}
diff --git a/packages/admin/src/components/layout/user-menu/user-menu.tsx b/packages/admin/src/components/layout/user-menu/user-menu.tsx
index c5e825cea..46979c2c7 100644
--- a/packages/admin/src/components/layout/user-menu/user-menu.tsx
+++ b/packages/admin/src/components/layout/user-menu/user-menu.tsx
@@ -29,13 +29,18 @@ import { useLogout, useMe } from "../../../hooks/api"
import { queryClient } from "../../../lib/query-client"
import { useGlobalShortcuts } from "../../../providers/keybind-provider/hooks"
import { useTheme } from "../../../providers/theme-provider"
-import { SIDEBAR_RAIL_FADE } from "../../../providers/sidebar-provider"
+import {
+ SIDEBAR_MENU_CONTENT,
+ SIDEBAR_RAIL_FADE,
+ useSidebarMenuPlacement,
+} from "../../../providers/sidebar-provider"
import { useDocumentDirection } from "../../../hooks/use-document-direction"
export const UserMenu = () => {
const { t } = useTranslation()
const location = useLocation()
const direction = useDocumentDirection()
+ const menuPlacement = useSidebarMenuPlacement("end")
const [openMenu, setOpenMenu] = useState(false)
const [openModal, setOpenModal] = useState(false)
@@ -49,7 +54,7 @@ export const UserMenu = () => {
<div data-testid="sidebar-user-menu">
<DropdownMenu dir={direction} open={openMenu} onOpenChange={setOpenMenu} data-testid="sidebar-user-menu-dropdown">
<UserBadge />
- <DropdownMenu.Content className="min-w-[var(--radix-dropdown-menu-trigger-width)] max-w-[var(--radix-dropdown-menu-trigger-width)]" data-testid="sidebar-user-menu-content">
+ <DropdownMenu.Content {...menuPlacement} className={SIDEBAR_MENU_CONTENT} data-testid="sidebar-user-menu-content">
<UserItem />
<DropdownMenu.Separator data-testid="sidebar-user-menu-separator-1" />
<DropdownMenu.Item asChild data-testid="sidebar-user-menu-profile-settings">
diff --git a/packages/admin/src/providers/sidebar-provider/index.ts b/packages/admin/src/providers/sidebar-provider/index.ts
index 580f89c85..8372f22d3 100644
--- a/packages/admin/src/providers/sidebar-provider/index.ts
+++ b/packages/admin/src/providers/sidebar-provider/index.ts
@@ -1,8 +1,11 @@
export {
+ SIDEBAR_MENU_CONTENT,
SIDEBAR_RAIL_FADE,
SidebarProvider,
useCollapsedSidebar,
+ useExpandedSidebar,
useSidebar,
+ useSidebarMenuPlacement,
type SidebarContextValue,
type SidebarState,
} from "@mercurjs/dashboard-shared"
diff --git a/packages/dashboard-shared/src/providers/sidebar-provider/classes.ts b/packages/dashboard-shared/src/providers/sidebar-provider/classes.ts
index 8d392a5d8..8724b38c3 100644
--- a/packages/dashboard-shared/src/providers/sidebar-provider/classes.ts
+++ b/packages/dashboard-shared/src/providers/sidebar-provider/classes.ts
@@ -9,3 +9,10 @@ export const SIDEBAR_RAIL_FADE = [
"group-data-[state=collapsed]/sidebar:opacity-0",
"group-data-[state=collapsed]/sidebar:delay-0 group-data-[state=collapsed]/sidebar:duration-75",
].join(" ")
+
+/**
+ * Sidebar dropdowns take the trigger's width, which in the icon rail is only
+ * the avatar — the floor keeps them readable when opened from the rail.
+ */
+export const SIDEBAR_MENU_CONTENT =
+ "w-[var(--radix-dropdown-menu-trigger-width)] min-w-[196px]"
diff --git a/packages/dashboard-shared/src/providers/sidebar-provider/index.ts b/packages/dashboard-shared/src/providers/sidebar-provider/index.ts
index a67a1e6a3..16541260a 100644
--- a/packages/dashboard-shared/src/providers/sidebar-provider/index.ts
+++ b/packages/dashboard-shared/src/providers/sidebar-provider/index.ts
@@ -3,3 +3,4 @@ export * from "./sidebar-context"
export * from "./sidebar-provider"
export * from "./use-collapsed-sidebar"
export * from "./use-sidebar"
+export * from "./use-sidebar-menu-placement"
diff --git a/packages/dashboard-shared/src/providers/sidebar-provider/use-collapsed-sidebar.tsx b/packages/dashboard-shared/src/providers/sidebar-provider/use-collapsed-sidebar.tsx
index 686393281..f05f806ae 100644
--- a/packages/dashboard-shared/src/providers/sidebar-provider/use-collapsed-sidebar.tsx
+++ b/packages/dashboard-shared/src/providers/sidebar-provider/use-collapsed-sidebar.tsx
@@ -2,26 +2,39 @@ import { useEffect, useRef } from "react"
import { useSidebar } from "./use-sidebar"
-/**
- * Collapses the desktop sidebar to its icon rail for as long as the calling
- * component is mounted, restoring whatever the user had open before. Intended
- * for dense, full-height surfaces — the inbox, the editor — that need the
- * horizontal space but should not permanently change the user's preference.
- */
-export const useCollapsedSidebar = (collapsed = true) => {
- const { desktop, setDesktop } = useSidebar()
+const useDesktopSidebarOverride = (desktop: boolean, enabled: boolean) => {
+ const { desktop: current, setDesktop } = useSidebar()
- const desktopRef = useRef(desktop)
- desktopRef.current = desktop
+ const desktopRef = useRef(current)
+ desktopRef.current = current
useEffect(() => {
- if (!collapsed) {
+ if (!enabled) {
return
}
const previous = desktopRef.current
- setDesktop(false)
+ setDesktop(desktop)
return () => setDesktop(previous)
- }, [collapsed, setDesktop])
+ }, [desktop, enabled, setDesktop])
+}
+
+/**
+ * Collapses the desktop sidebar to its icon rail for as long as the calling
+ * component is mounted, restoring whatever the user had open before. Intended
+ * for dense, full-height surfaces — the inbox, the editor — that need the
+ * horizontal space but should not permanently change the user's preference.
+ */
+export const useCollapsedSidebar = (collapsed = true) => {
+ useDesktopSidebarOverride(false, collapsed)
+}
+
+/**
+ * Opens the desktop sidebar on mount and restores the previous state on
+ * unmount. For sidebars without an icon rail, where arriving collapsed would
+ * leave nothing to navigate with.
+ */
+export const useExpandedSidebar = (expanded = true) => {
+ useDesktopSidebarOverride(true, expanded)
}
diff --git a/packages/dashboard-shared/src/providers/sidebar-provider/use-sidebar-menu-placement.ts b/packages/dashboard-shared/src/providers/sidebar-provider/use-sidebar-menu-placement.ts
new file mode 100644
index 000000000..9748178c9
--- /dev/null
+++ b/packages/dashboard-shared/src/providers/sidebar-provider/use-sidebar-menu-placement.ts
@@ -0,0 +1,7 @@
+import { useSidebar } from "./use-sidebar"
+
+export const useSidebarMenuPlacement = (align: "start" | "end") => {
+ const { state } = useSidebar()
+
+ return state === "collapsed" ? { side: "right" as const, align } : {}
+}
diff --git a/packages/vendor/src/components/layout/main-layout/main-layout.tsx b/packages/vendor/src/components/layout/main-layout/main-layout.tsx
index 99522eeab..e6a7ab489 100644
--- a/packages/vendor/src/components/layout/main-layout/main-layout.tsx
+++ b/packages/vendor/src/components/layout/main-layout/main-layout.tsx
@@ -23,7 +23,11 @@ import { Shell } from "../../layout/shell";
import { useLocation, useNavigate } from "react-router-dom";
import { useMe, useSelectSeller, useSellers } from "../../../hooks/api";
import { useSearch } from "../../../providers/search-provider";
-import { SIDEBAR_RAIL_FADE } from "../../../providers/sidebar-provider";
+import {
+ SIDEBAR_MENU_CONTENT,
+ SIDEBAR_RAIL_FADE,
+ useSidebarMenuPlacement,
+} from "../../../providers/sidebar-provider";
import { UserMenu } from "../user-menu";
import { useDocumentDirection } from "../../../hooks/use-document-direction";
import menuItemsModule from "virtual:mercur/menu-items";
@@ -233,6 +237,7 @@ export const Header = () => {
const { t } = useTranslation();
const { seller_member, isPending, isError, error } = useMe();
const direction = useDocumentDirection();
+ const menuPlacement = useSidebarMenuPlacement("start");
const name = seller_member?.seller.name;
const fallback = seller_member?.seller?.name?.slice(0, 1).toUpperCase();
@@ -276,7 +281,7 @@ export const Header = () => {
<EllipsisHorizontal className={clx("text-ui-fg-muted", SIDEBAR_RAIL_FADE)} />
</DropdownMenu.Trigger>
{isLoaded && (
- <DropdownMenu.Content className="w-[var(--radix-dropdown-menu-trigger-width)] min-w-0">
+ <DropdownMenu.Content {...menuPlacement} className={SIDEBAR_MENU_CONTENT}>
<div className="flex items-center gap-x-3 px-2 py-1">
<Avatar variant="squared" size="small" fallback={fallback} />
<div className="flex flex-col overflow-hidden">
diff --git a/packages/vendor/src/components/layout/settings-layout/settings-layout.tsx b/packages/vendor/src/components/layout/settings-layout/settings-layout.tsx
index 5318fa8a0..f6ca3e9ca 100644
--- a/packages/vendor/src/components/layout/settings-layout/settings-layout.tsx
+++ b/packages/vendor/src/components/layout/settings-layout/settings-layout.tsx
@@ -10,6 +10,7 @@ import { Shell } from "../shell";
import { UserMenu } from "../user-menu";
import menuItemsModule from "virtual:mercur/menu-items";
import { usePermissions } from "@mercurjs/dashboard-shared";
+import { useExpandedSidebar } from "../../../providers/sidebar-provider";
import {
filterMenuItemsByPermissions,
getMenuItemsByType,
@@ -17,8 +18,10 @@ import {
import { getRoutePermission } from "../../../lib/permissions/route-permissions";
export const SettingsLayout = () => {
+ useExpandedSidebar();
+
return (
- <Shell>
+ <Shell rail={false}>
<SettingsSidebar />
</Shell>
);
diff --git a/packages/vendor/src/components/layout/shell/shell.tsx b/packages/vendor/src/components/layout/shell/shell.tsx
index 0a8eed247..25f46cdc0 100644
--- a/packages/vendor/src/components/layout/shell/shell.tsx
+++ b/packages/vendor/src/components/layout/shell/shell.tsx
@@ -20,7 +20,15 @@ import { useSidebar } from "../../../providers/sidebar-provider"
import { useMe } from "../../../hooks/api"
import { ProgressBar } from "../../common/progress-bar"
-export const Shell = ({ children }: PropsWithChildren) => {
+type ShellProps = PropsWithChildren<{
+ /**
+ * Whether the collapsed desktop sidebar shrinks to an icon rail. Sidebars
+ * without icons hide completely instead.
+ */
+ rail?: boolean
+}>
+
+export const Shell = ({ children, rail = true }: ShellProps) => {
const globalShortcuts = useGlobalShortcuts()
const navigation = useNavigation()
@@ -32,7 +40,7 @@ export const Shell = ({ children }: PropsWithChildren) => {
<NavigationBar loading={loading} />
<div>
<MobileSidebarContainer>{children}</MobileSidebarContainer>
- <DesktopSidebarContainer>{children}</DesktopSidebarContainer>
+ <DesktopSidebarContainer rail={rail}>{children}</DesktopSidebarContainer>
</div>
<div className="flex h-screen w-full flex-col overflow-auto">
<Topbar />
@@ -209,7 +217,10 @@ const Topbar = () => {
)
}
-const DesktopSidebarContainer = ({ children }: PropsWithChildren) => {
+const DesktopSidebarContainer = ({
+ children,
+ rail,
+}: PropsWithChildren<{ rail: boolean }>) => {
const { state } = useSidebar()
return (
@@ -218,10 +229,16 @@ const DesktopSidebarContainer = ({ children }: PropsWithChildren) => {
className={clx(
"group/sidebar hidden h-screen w-[220px] shrink-0 overflow-x-hidden border-e lg:flex",
"transition-[width] duration-200 ease-sidebar motion-reduce:transition-none",
- "data-[state=collapsed]:w-[52px]"
+ rail
+ ? "data-[state=collapsed]:w-[52px]"
+ : "data-[state=collapsed]:w-0 data-[state=collapsed]:border-e-0"
)}
>
- {children}
+ {rail ? (
+ children
+ ) : (
+ <div className="flex w-[220px] shrink-0">{children}</div>
+ )}
</div>
)
}
diff --git a/packages/vendor/src/components/layout/user-menu/user-menu.tsx b/packages/vendor/src/components/layout/user-menu/user-menu.tsx
index 202460d39..c9e48c3c3 100644
--- a/packages/vendor/src/components/layout/user-menu/user-menu.tsx
+++ b/packages/vendor/src/components/layout/user-menu/user-menu.tsx
@@ -30,7 +30,11 @@ import { useLogout, useMe } from "../../../hooks/api";
import { queryClient } from "../../../lib/query-client";
import { useGlobalShortcuts } from "../../../providers/keybind-provider/hooks";
import { useTheme } from "../../../providers/theme-provider";
-import { SIDEBAR_RAIL_FADE } from "../../../providers/sidebar-provider";
+import {
+ SIDEBAR_MENU_CONTENT,
+ SIDEBAR_RAIL_FADE,
+ useSidebarMenuPlacement,
+} from "../../../providers/sidebar-provider";
import { useDocumentDirection } from "../../../hooks/use-document-direction";
import { languages } from "../../../i18n/languages";
@@ -38,6 +42,7 @@ export const UserMenu = () => {
const { t } = useTranslation();
const location = useLocation();
const direction = useDocumentDirection();
+ const menuPlacement = useSidebarMenuPlacement("end");
const [openMenu, setOpenMenu] = useState(false);
const [openModal, setOpenModal] = useState(false);
@@ -51,7 +56,7 @@ export const UserMenu = () => {
<div>
<DropdownMenu dir={direction} open={openMenu} onOpenChange={setOpenMenu}>
<UserBadge />
- <DropdownMenu.Content className="min-w-[var(--radix-dropdown-menu-trigger-width)] max-w-[var(--radix-dropdown-menu-trigger-width)]">
+ <DropdownMenu.Content {...menuPlacement} className={SIDEBAR_MENU_CONTENT}>
<UserItem />
<DropdownMenu.Separator />
<DropdownMenu.Item asChild>
diff --git a/packages/vendor/src/providers/sidebar-provider/index.ts b/packages/vendor/src/providers/sidebar-provider/index.ts
index 580f89c85..8372f22d3 100644
--- a/packages/vendor/src/providers/sidebar-provider/index.ts
+++ b/packages/vendor/src/providers/sidebar-provider/index.ts
@@ -1,8 +1,11 @@
export {
+ SIDEBAR_MENU_CONTENT,
SIDEBAR_RAIL_FADE,
SidebarProvider,
useCollapsedSidebar,
+ useExpandedSidebar,
useSidebar,
+ useSidebarMenuPlacement,
type SidebarContextValue,
type SidebarState,
} from "@mercurjs/dashboard-shared"