Skip to content

The Postgres development platform. Supabase gives you a dedicated Postgres database to build your web, mobile, and AI applications.

fix(studio): keep project sidebar navigation accessible (#51055)

Alaister Young55c297655eab
diff --git a/apps/studio/components/layouts/ProjectLayout/LayoutHeader/MobileMenuContent/MobileMenuContent.test.tsx b/apps/studio/components/layouts/ProjectLayout/LayoutHeader/MobileMenuContent/MobileMenuContent.test.tsx
index 5d1ce2953fb..f7048911f4c 100644
--- a/apps/studio/components/layouts/ProjectLayout/LayoutHeader/MobileMenuContent/MobileMenuContent.test.tsx
+++ b/apps/studio/components/layouts/ProjectLayout/LayoutHeader/MobileMenuContent/MobileMenuContent.test.tsx
@@ -1,7 +1,9 @@
import { screen } from '@testing-library/react'
import userEvent from '@testing-library/user-event'
+import { mockAnimationsApi } from 'jsdom-testing-mocks'
import { HttpResponse } from 'msw'
import { useState } from 'react'
+import { MobileSheetNav } from 'ui-patterns/MobileSheetNav'
import { beforeEach, describe, expect, it, vi } from 'vitest'
import { MobileMenuContent } from './MobileMenuContent'
@@ -11,6 +13,8 @@ import type { ProjectDetail } from '@/data/projects/project-detail-query'
import { customRender } from '@/tests/lib/custom-render'
import { addAPIMock } from '@/tests/lib/msw'
+mockAnimationsApi()
+
const createNotebook = vi.fn()
const createChat = vi.fn()
vi.mock('@/components/interfaces/Explorer/hooks', () => ({
@@ -37,18 +41,25 @@ vi.mock('./mobileProductMenuRegistry', () => ({
const ExplorerMobileMenu = ({ initialSection }: { initialSection: ExplorerResourceType }) => {
const [section, setSection] = useState<ExplorerResourceType | undefined>(initialSection)
return (
- <MobileMenuContent
- currentProduct="Explorer"
- currentSectionKey="explorer"
- currentProductMenu={<span>{section ?? 'Home'} content</span>}
- currentProductMenuHeader={
- <ExplorerNavHeader
- section={section}
- onBack={() => setSection(undefined)}
- rootAction={<span>Explorer preferences</span>}
- />
- }
- />
+ <MobileSheetNav
+ open
+ onOpenChange={() => {}}
+ shouldCloseOnRouteChange={false}
+ shouldCloseOnViewportResize={false}
+ >
+ <MobileMenuContent
+ currentProduct="Explorer"
+ currentSectionKey="explorer"
+ currentProductMenu={<span>{section ?? 'Home'} content</span>}
+ currentProductMenuHeader={
+ <ExplorerNavHeader
+ section={section}
+ onBack={() => setSection(undefined)}
+ rootAction={<span>Explorer preferences</span>}
+ />
+ }
+ />
+ </MobileSheetNav>
)
}
@@ -112,4 +123,21 @@ describe('Mobile product header', () => {
expect(screen.getByText('Database menu')).toBeInTheDocument()
expect(screen.queryByRole('button', { name: 'New notebook' })).not.toBeInTheDocument()
})
+
+ it('names the project menu dialog across top-level and section navigation', async () => {
+ const user = userEvent.setup()
+ customRender(<ExplorerMobileMenu initialSection="notebook" />)
+
+ expect(screen.getByRole('dialog', { name: 'Project menu' })).toBeInTheDocument()
+ expect(screen.getAllByRole('heading', { name: 'Project menu' })).toHaveLength(1)
+
+ await user.click(screen.getByRole('button', { name: 'Back to menu' }))
+ expect(screen.getByRole('navigation', { name: 'Project menu' })).toBeInTheDocument()
+ expect(screen.getByRole('dialog', { name: 'Project menu' })).toBeInTheDocument()
+
+ await user.click(screen.getByRole('button', { name: 'Database' }))
+ expect(screen.getByText('Database menu')).toBeInTheDocument()
+ expect(screen.getByRole('dialog', { name: 'Project menu' })).toBeInTheDocument()
+ expect(screen.getAllByRole('heading', { name: 'Project menu' })).toHaveLength(1)
+ })
})
diff --git a/apps/studio/components/layouts/ProjectLayout/LayoutHeader/MobileMenuContent/MobileMenuContent.tsx b/apps/studio/components/layouts/ProjectLayout/LayoutHeader/MobileMenuContent/MobileMenuContent.tsx
index 8f1d3e52e68..e56031ccb13 100644
--- a/apps/studio/components/layouts/ProjectLayout/LayoutHeader/MobileMenuContent/MobileMenuContent.tsx
+++ b/apps/studio/components/layouts/ProjectLayout/LayoutHeader/MobileMenuContent/MobileMenuContent.tsx
@@ -5,7 +5,7 @@ import { Home } from 'icons'
import { ChevronLeft } from 'lucide-react'
import { useRouter } from 'next/router'
import React, { useMemo } from 'react'
-import { Button, cn, Separator, SidebarGroup, SidebarMenu } from 'ui'
+import { Button, cn, Separator, SheetTitle, SidebarGroup, SidebarMenu } from 'ui'
import { GenericSkeletonLoader } from 'ui-patterns/ShimmeringLoader'
import { resolveSectionDisplay } from './MobileMenuContent.utils'
@@ -133,6 +133,7 @@ export function MobileMenuContent({
return (
<div className="flex flex-col h-full bg-background">
+ <SheetTitle className="sr-only">Project menu</SheetTitle>
{viewLevel === 'section' && sectionLabel && (
<div
className={cn(
diff --git a/apps/studio/components/layouts/ProjectLayout/index.test.tsx b/apps/studio/components/layouts/ProjectLayout/index.test.tsx
index 3d09809777c..f2603a560d3 100644
--- a/apps/studio/components/layouts/ProjectLayout/index.test.tsx
+++ b/apps/studio/components/layouts/ProjectLayout/index.test.tsx
@@ -8,16 +8,19 @@ import { ProjectLayout } from './index'
import type { MobileMenuContentProps } from './LayoutHeader/MobileMenuContent'
import { STUDIO_PAGE_TITLE_SEPARATOR } from '@/lib/page-title'
-const { mockRouter, mockSetSelectedDatabaseId, mockSetMobileMenuOpen } = vi.hoisted(() => ({
- mockRouter: {
- pathname: '/project/[ref]/observability/query-performance',
- asPath: '/project/default/observability/query-performance',
- push: vi.fn(),
- replace: vi.fn(),
- },
- mockSetSelectedDatabaseId: vi.fn(),
- mockSetMobileMenuOpen: vi.fn(),
-}))
+const { mockRouter, mockSetSelectedDatabaseId, mockSetMobileMenuOpen, mockViewport } = vi.hoisted(
+ () => ({
+ mockRouter: {
+ pathname: '/project/[ref]/observability/query-performance',
+ asPath: '/project/default/observability/query-performance',
+ push: vi.fn(),
+ replace: vi.fn(),
+ },
+ mockSetSelectedDatabaseId: vi.fn(),
+ mockSetMobileMenuOpen: vi.fn(),
+ mockViewport: { isMobile: false },
+ })
+)
const {
mockAddBanner,
@@ -93,7 +96,8 @@ vi.mock('framer-motion', () => ({
},
}))
-vi.mock('ui', () => ({
+vi.mock('ui', async () => ({
+ ...(await import('ui/src/components/shadcn/ui/resizable')),
cn: (...classes: Array<string | false | null | undefined>) => classes.filter(Boolean).join(' '),
Alert: ({ children, ...props }: any) => <div {...props}>{children}</div>,
AlertDescription: ({ children, ...props }: any) => <div {...props}>{children}</div>,
@@ -104,9 +108,6 @@ vi.mock('ui', () => ({
CommandItem: { displayName: 'CommandItem' },
CommandList: { displayName: 'CommandList' },
LogoLoader: () => <div data-testid="logo-loader" />,
- ResizableHandle: (props: any) => <div {...props} />,
- ResizablePanel: ({ children, ...props }: any) => <div {...props}>{children}</div>,
- ResizablePanelGroup: ({ children, ...props }: any) => <div {...props}>{children}</div>,
Sidebar: ({ children, ...props }: any) => <div {...props}>{children}</div>,
SidebarContent: ({ children, ...props }: any) => <div {...props}>{children}</div>,
SidebarFooter: ({ children, ...props }: any) => <div {...props}>{children}</div>,
@@ -114,8 +115,7 @@ vi.mock('ui', () => ({
SidebarMenu: ({ children, ...props }: any) => <div {...props}>{children}</div>,
SidebarMenuButton: (props: any) => <div {...props} />,
SidebarMenuItem: (props: any) => <div {...props} />,
- useIsMobile: () => false,
- usePanelRef: () => undefined,
+ useIsMobile: () => mockViewport.isMobile,
useSidebar: () => ({ setOpen: vi.fn() }),
}))
@@ -243,7 +243,7 @@ vi.mock('./LayoutHeader/MobileMenuContent', async (importOriginal) => {
})
vi.mock('../Navigation/ProductMenuBar', () => ({
- ProductMenuBar: () => null,
+ ProductMenuBar: ({ children }: { children: ReactNode }) => <>{children}</>,
}))
const MobileSheetHarness = () => {
@@ -298,6 +298,7 @@ const renderLayout = () =>
describe('ProjectLayout title', () => {
beforeEach(() => {
+ mockViewport.isMobile = false
mockRouter.pathname = '/project/[ref]/observability/query-performance'
mockRouter.asPath = '/project/default/observability/query-performance'
document.title = ''
@@ -322,6 +323,7 @@ describe('ProjectLayout title', () => {
})
it('updates the open mobile menu when resource navigation changes without replacing other sheets', () => {
+ mockViewport.isMobile = true
render(
<MobileSheetProvider>
<ResourceMenuHarness />
@@ -340,6 +342,38 @@ describe('ProjectLayout title', () => {
expect(screen.getByTestId('mobile-sheet')).toHaveTextContent('Other sheet')
})
+ it.each([false, true])(
+ 'keeps sidebar navigation enabled with resizableSidebar=%s and preserves handle availability',
+ (resizableSidebar) => {
+ render(
+ <MobileSheetProvider>
+ <ProjectLayout
+ product="Database"
+ isBlocking={false}
+ resizableSidebar={resizableSidebar}
+ productMenu={<a href="/project/default/database/tables">Tables</a>}
+ >
+ <div>Page Content</div>
+ </ProjectLayout>
+ </MobileSheetProvider>
+ )
+
+ const link = screen.getByRole('link', { name: 'Tables' })
+ expect(link.closest('[aria-disabled="true"]')).toBeNull()
+ link.focus()
+ expect(link).toHaveFocus()
+
+ const handle = screen.getByRole('separator')
+ if (resizableSidebar) {
+ expect(handle).not.toHaveAttribute('aria-disabled')
+ expect(handle).toHaveAttribute('tabindex', '0')
+ } else {
+ expect(handle).toHaveAttribute('aria-disabled', 'true')
+ expect(handle).not.toHaveAttribute('tabindex')
+ }
+ }
+ )
+
it('sets a composed document title and deduplicates identical section/surface labels', async () => {
render(
<MobileSheetProvider>
diff --git a/apps/studio/components/layouts/ProjectLayout/index.tsx b/apps/studio/components/layouts/ProjectLayout/index.tsx
index 764e0f23bce..2a432a54e51 100644
--- a/apps/studio/components/layouts/ProjectLayout/index.tsx
+++ b/apps/studio/components/layouts/ProjectLayout/index.tsx
@@ -311,7 +311,6 @@ export const ProjectLayout = forwardRef<HTMLDivElement, PropsWithChildren<Projec
maxSize={resizableSidebar ? 512 : 256}
defaultSize={256}
id="panel-left"
- disabled={!resizableSidebar}
>
<AnimatePresence initial={false}>
<motion.div