Skip to content

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

fix: mobile sheet nav close (#43239)

Francesco Sansalvadoreaffdf865e0d9
diff --git a/apps/studio/components/layouts/ProjectLayout/LayoutSidebar/index.tsx b/apps/studio/components/layouts/ProjectLayout/LayoutSidebar/index.tsx
index b8e61d94b51..ac76bf48164 100644
--- a/apps/studio/components/layouts/ProjectLayout/LayoutSidebar/index.tsx
+++ b/apps/studio/components/layouts/ProjectLayout/LayoutSidebar/index.tsx
@@ -37,6 +37,8 @@ export const LayoutSidebar = ({
if (isMobile)
return (
<MobileSheetNav
+ shouldCloseOnRouteChange={false}
+ shouldCloseOnViewportResize={false}
open={mobileSheetContent !== null}
onOpenChange={(open: boolean) => {
if (!open) {
diff --git a/apps/studio/components/layouts/ProjectLayout/NavigationBar/MobileSheetNavLayout.tsx b/apps/studio/components/layouts/ProjectLayout/NavigationBar/MobileSheetNavLayout.tsx
deleted file mode 100644
index 423a81f812a..00000000000
--- a/apps/studio/components/layouts/ProjectLayout/NavigationBar/MobileSheetNavLayout.tsx
+++ /dev/null
@@ -1,23 +0,0 @@
-import { sidebarManagerState, useSidebarManagerSnapshot } from 'state/sidebar-manager-state'
-import { MobileSheetNav } from 'ui-patterns'
-
-import { useMobileSheet } from './MobileSheetContext'
-
-export function MobileSheetNavLayout() {
- const { content: mobileSheetContent, setContent: setMobileSheetContent } = useMobileSheet()
- const { activeSidebar } = useSidebarManagerSnapshot()
-
- return (
- <MobileSheetNav
- open={mobileSheetContent !== null}
- onOpenChange={(open: boolean) => {
- if (!open) {
- setMobileSheetContent(null)
- sidebarManagerState.closeActive()
- }
- }}
- >
- {activeSidebar?.component?.() ?? null}
- </MobileSheetNav>
- )
-}
diff --git a/packages/ui-patterns/src/MobileSheetNav/MobileSheetNav.test.tsx b/packages/ui-patterns/src/MobileSheetNav/MobileSheetNav.test.tsx
new file mode 100644
index 00000000000..65137313efd
--- /dev/null
+++ b/packages/ui-patterns/src/MobileSheetNav/MobileSheetNav.test.tsx
@@ -0,0 +1,199 @@
+import { act, render, screen, waitFor } from '@testing-library/react'
+import { useEffect, useState } from 'react'
+import { beforeEach, describe, expect, it, vi } from 'vitest'
+
+import { MobileSheetNav } from './MobileSheetNav'
+
+const mockRouter = vi.hoisted(() => ({ asPath: '/initial' }))
+const mockWindowSize = vi.hoisted(() => ({ width: 400 }))
+
+vi.mock('next/router', () => ({
+ useRouter: () => mockRouter,
+}))
+
+vi.mock('react-use', () => ({
+ useWindowSize: () => mockWindowSize,
+}))
+
+function MobileSheetNavWithState({
+ shouldCloseOnRouteChange = true,
+ shouldCloseOnViewportResize = true,
+}: {
+ shouldCloseOnRouteChange?: boolean
+ shouldCloseOnViewportResize?: boolean
+}) {
+ const [open, setOpen] = useState(false)
+ useEffect(() => {
+ setOpen(true)
+ }, [])
+ return (
+ <>
+ <span data-testid="sheet-open">{String(open)}</span>
+ <MobileSheetNav
+ open={open}
+ onOpenChange={setOpen}
+ shouldCloseOnRouteChange={shouldCloseOnRouteChange}
+ shouldCloseOnViewportResize={shouldCloseOnViewportResize}
+ >
+ <div>Nav content</div>
+ </MobileSheetNav>
+ </>
+ )
+}
+
+describe('MobileSheetNav', () => {
+ const defaultProps = {
+ onOpenChange: vi.fn(),
+ children: <div>Nav content</div>,
+ }
+
+ beforeEach(() => {
+ vi.clearAllMocks()
+ mockRouter.asPath = '/initial'
+ mockWindowSize.width = 400
+ })
+
+ describe('shouldCloseOnRouteChange', () => {
+ it('calls onOpenChange(false) when route changes and shouldCloseOnRouteChange is true (default)', () => {
+ const onOpenChange = vi.fn()
+ const { rerender } = render(<MobileSheetNav {...defaultProps} onOpenChange={onOpenChange} />)
+
+ onOpenChange.mockClear()
+ mockRouter.asPath = '/other-page'
+ act(() => {
+ rerender(<MobileSheetNav {...defaultProps} onOpenChange={onOpenChange} />)
+ })
+
+ expect(onOpenChange).toHaveBeenCalledWith(false)
+ })
+
+ it('effectively closes the sheet on route change when shouldCloseOnRouteChange is true', async () => {
+ const { rerender } = render(<MobileSheetNavWithState />)
+
+ await waitFor(() => {
+ expect(screen.getByTestId('sheet-open')).toHaveTextContent('true')
+ })
+
+ mockRouter.asPath = '/other-page'
+ act(() => {
+ rerender(<MobileSheetNavWithState />)
+ })
+
+ await waitFor(() => {
+ expect(screen.getByTestId('sheet-open')).toHaveTextContent('false')
+ })
+ })
+
+ it('effectively does NOT close the sheet on route change when shouldCloseOnRouteChange is false', async () => {
+ const { rerender } = render(<MobileSheetNavWithState shouldCloseOnRouteChange={false} />)
+
+ await waitFor(() => {
+ expect(screen.getByTestId('sheet-open')).toHaveTextContent('true')
+ })
+
+ mockRouter.asPath = '/other-page'
+ act(() => {
+ rerender(<MobileSheetNavWithState shouldCloseOnRouteChange={false} />)
+ })
+
+ expect(screen.getByTestId('sheet-open')).toHaveTextContent('true')
+ })
+
+ it('does not call onOpenChange when route changes if shouldCloseOnRouteChange is false', () => {
+ const onOpenChange = vi.fn()
+ const { rerender } = render(
+ <MobileSheetNav
+ {...defaultProps}
+ onOpenChange={onOpenChange}
+ shouldCloseOnRouteChange={false}
+ />
+ )
+
+ onOpenChange.mockClear()
+ mockRouter.asPath = '/other-page'
+ act(() => {
+ rerender(
+ <MobileSheetNav
+ {...defaultProps}
+ onOpenChange={onOpenChange}
+ shouldCloseOnRouteChange={false}
+ />
+ )
+ })
+
+ expect(onOpenChange).not.toHaveBeenCalled()
+ })
+ })
+
+ describe('shouldCloseOnViewportResize', () => {
+ it('calls onOpenChange(false) when width changes and shouldCloseOnViewportResize is true (default)', () => {
+ const onOpenChange = vi.fn()
+ const { rerender } = render(<MobileSheetNav {...defaultProps} onOpenChange={onOpenChange} />)
+
+ onOpenChange.mockClear()
+ mockWindowSize.width = 800
+ act(() => {
+ rerender(<MobileSheetNav {...defaultProps} onOpenChange={onOpenChange} />)
+ })
+
+ expect(onOpenChange).toHaveBeenCalledWith(false)
+ })
+
+ it('effectively closes the sheet on viewport resize when shouldCloseOnViewportResize is true', async () => {
+ const { rerender } = render(<MobileSheetNavWithState />)
+
+ await waitFor(() => {
+ expect(screen.getByTestId('sheet-open')).toHaveTextContent('true')
+ })
+
+ mockWindowSize.width = 800
+ act(() => {
+ rerender(<MobileSheetNavWithState />)
+ })
+
+ await waitFor(() => {
+ expect(screen.getByTestId('sheet-open')).toHaveTextContent('false')
+ })
+ })
+
+ it('effectively does NOT close the sheet on viewport resize when shouldCloseOnViewportResize is false', async () => {
+ const { rerender } = render(<MobileSheetNavWithState shouldCloseOnViewportResize={false} />)
+
+ await waitFor(() => {
+ expect(screen.getByTestId('sheet-open')).toHaveTextContent('true')
+ })
+
+ mockWindowSize.width = 800
+ act(() => {
+ rerender(<MobileSheetNavWithState shouldCloseOnViewportResize={false} />)
+ })
+
+ expect(screen.getByTestId('sheet-open')).toHaveTextContent('true')
+ })
+
+ it('does not call onOpenChange when width changes if shouldCloseOnViewportResize is false', () => {
+ const onOpenChange = vi.fn()
+ const { rerender } = render(
+ <MobileSheetNav
+ {...defaultProps}
+ onOpenChange={onOpenChange}
+ shouldCloseOnViewportResize={false}
+ />
+ )
+
+ onOpenChange.mockClear()
+ mockWindowSize.width = 800
+ act(() => {
+ rerender(
+ <MobileSheetNav
+ {...defaultProps}
+ onOpenChange={onOpenChange}
+ shouldCloseOnViewportResize={false}
+ />
+ )
+ })
+
+ expect(onOpenChange).not.toHaveBeenCalled()
+ })
+ })
+})
diff --git a/packages/ui-patterns/src/MobileSheetNav/MobileSheetNav.tsx b/packages/ui-patterns/src/MobileSheetNav/MobileSheetNav.tsx
index 7749316d350..064035ac607 100644
--- a/packages/ui-patterns/src/MobileSheetNav/MobileSheetNav.tsx
+++ b/packages/ui-patterns/src/MobileSheetNav/MobileSheetNav.tsx
@@ -1,6 +1,9 @@
'use client'
+import { useRouter } from 'next/router'
+import { useEffect } from 'react'
import { ErrorBoundary } from 'react-error-boundary'
+import { useWindowSize } from 'react-use'
import { CommandEmpty_Shadcn_, Sheet, SheetContent } from 'ui'
import { cn } from 'ui/src/lib/utils'
@@ -9,7 +12,32 @@ const MobileSheetNav: React.FC<{
open?: boolean
onOpenChange(open: boolean): void
className?: string
-}> = ({ children, open = false, onOpenChange, className }) => {
+ shouldCloseOnRouteChange?: boolean
+ shouldCloseOnViewportResize?: boolean
+}> = ({
+ children,
+ open = false,
+ onOpenChange,
+ className,
+ shouldCloseOnRouteChange = true,
+ shouldCloseOnViewportResize = true,
+}) => {
+ const router = useRouter()
+ const { width } = useWindowSize()
+
+ const pathWithoutQuery = router?.asPath?.split('?')?.[0]
+ useEffect(() => {
+ if (shouldCloseOnRouteChange) {
+ onOpenChange(false)
+ }
+ }, [pathWithoutQuery])
+
+ useEffect(() => {
+ if (shouldCloseOnViewportResize) {
+ onOpenChange(false)
+ }
+ }, [width])
+
return (
<Sheet open={open} onOpenChange={onOpenChange}>
<SheetContent