Skip to content

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

feat(studio): mobile sheet nav (#43184)

Francesco Sansalvadore9145470ff60d
diff --git a/apps/studio/components/layouts/AppLayout/InlineEditorButton.tsx b/apps/studio/components/layouts/AppLayout/InlineEditorButton.tsx
index da3404e969b..770aff13e72 100644
--- a/apps/studio/components/layouts/AppLayout/InlineEditorButton.tsx
+++ b/apps/studio/components/layouts/AppLayout/InlineEditorButton.tsx
@@ -45,7 +45,7 @@ export const InlineEditorButton = () => {
},
}}
>
- <SqlEditor size={18} strokeWidth={1.5} />
+ <SqlEditor size={16} strokeWidth={1.5} />
</ButtonTooltip>
)
}
diff --git a/apps/studio/components/layouts/DefaultLayout.tsx b/apps/studio/components/layouts/DefaultLayout.tsx
index 210d185d5b8..88d6852d3d4 100644
--- a/apps/studio/components/layouts/DefaultLayout.tsx
+++ b/apps/studio/components/layouts/DefaultLayout.tsx
@@ -14,6 +14,7 @@ import { LayoutHeader } from './ProjectLayout/LayoutHeader/LayoutHeader'
import { LayoutSidebar } from './ProjectLayout/LayoutSidebar'
import { LayoutSidebarProvider } from './ProjectLayout/LayoutSidebar/LayoutSidebarProvider'
import MobileNavigationBar from './ProjectLayout/NavigationBar/MobileNavigationBar'
+import { MobileSheetProvider } from './ProjectLayout/NavigationBar/MobileSheetContext'
import { ProjectContextProvider } from './ProjectLayout/ProjectContext'
export interface DefaultLayoutProps {
@@ -74,50 +75,52 @@ export const DefaultLayout = ({
<SidebarProvider defaultOpen={false}>
<LayoutSidebarProvider>
<ProjectContextProvider projectRef={ref}>
- <BannerStackProvider>
- <div className="flex flex-col h-screen w-screen">
- {/* Top Banner */}
- <AppBannerWrapper />
- <div className="flex-shrink-0">
- <MobileNavigationBar hideMobileMenu={hideMobileMenu} />
- <LayoutHeader
- showProductMenu={showProductMenu}
- headerTitle={headerTitle}
- backToDashboardURL={
- router.pathname.startsWith('/account') ? backToDashboardURL : undefined
- }
- />
- </div>
- {/* Main Content Area */}
- <div className="flex flex-1 w-full overflow-y-hidden">
- {/* Sidebar - Only show for project pages, not account pages */}
- {!router.pathname.startsWith('/account') && <Sidebar />}
- {/* Main Content with Layout Sidebar */}
- <ResizablePanelGroup
- orientation="horizontal"
- className="h-full w-full overflow-x-hidden flex-1 flex flex-row gap-0"
- autoSaveId="default-layout-content"
- >
- <ResizablePanel
- id="panel-content"
- className="w-full"
- minSize={`${contentMinSizePercentage}`}
- maxSize={`${contentMaxSizePercentage}`}
- defaultSize={`${contentMaxSizePercentage}`}
- >
- <div className="h-full overflow-y-auto">{children}</div>
- </ResizablePanel>
- <LayoutSidebar
- minSize={`${100 - contentMaxSizePercentage}`}
- maxSize={`${100 - contentMinSizePercentage}`}
- defaultSize={`${100 - contentMaxSizePercentage}`}
+ <MobileSheetProvider>
+ <BannerStackProvider>
+ <div className="flex flex-col h-screen w-screen">
+ {/* Top Banner */}
+ <AppBannerWrapper />
+ <div className="flex-shrink-0">
+ <MobileNavigationBar hideMobileMenu={hideMobileMenu} />
+ <LayoutHeader
+ showProductMenu={showProductMenu}
+ headerTitle={headerTitle}
+ backToDashboardURL={
+ router.pathname.startsWith('/account') ? backToDashboardURL : undefined
+ }
/>
- </ResizablePanelGroup>
+ </div>
+ {/* Main Content Area */}
+ <div className="flex flex-1 w-full overflow-y-hidden">
+ {/* Sidebar - Only show for project pages, not account pages */}
+ {!router.pathname.startsWith('/account') && <Sidebar />}
+ {/* Main Content with Layout Sidebar */}
+ <ResizablePanelGroup
+ orientation="horizontal"
+ className="h-full w-full overflow-x-hidden flex-1 flex flex-row gap-0"
+ autoSaveId="default-layout-content"
+ >
+ <ResizablePanel
+ id="panel-content"
+ className="w-full"
+ minSize={`${contentMinSizePercentage}`}
+ maxSize={`${contentMaxSizePercentage}`}
+ defaultSize={`${contentMaxSizePercentage}`}
+ >
+ <div className="h-full overflow-y-auto">{children}</div>
+ </ResizablePanel>
+ <LayoutSidebar
+ minSize={`${100 - contentMaxSizePercentage}`}
+ maxSize={`${100 - contentMinSizePercentage}`}
+ defaultSize={`${100 - contentMaxSizePercentage}`}
+ />
+ </ResizablePanelGroup>
+ </div>
</div>
- </div>
- <BannerStack />
- </BannerStackProvider>
+ <BannerStack />
+ </BannerStackProvider>
+ </MobileSheetProvider>
</ProjectContextProvider>
</LayoutSidebarProvider>
</SidebarProvider>
diff --git a/apps/studio/components/layouts/ProjectLayout/LayoutHeader/FeedbackDropdown/FeedbackDropdown.tsx b/apps/studio/components/layouts/ProjectLayout/LayoutHeader/FeedbackDropdown/FeedbackDropdown.tsx
index 31f9342a360..3c4579f01c9 100644
--- a/apps/studio/components/layouts/ProjectLayout/LayoutHeader/FeedbackDropdown/FeedbackDropdown.tsx
+++ b/apps/studio/components/layouts/ProjectLayout/LayoutHeader/FeedbackDropdown/FeedbackDropdown.tsx
@@ -15,9 +15,9 @@ import {
PopoverTrigger_Shadcn_,
} from 'ui'
-import { ASSISTANT_SUGGESTIONS } from '../HelpDropdown/HelpDropdown.constants'
-import { getSupportLinkQueryParams } from '../HelpDropdown/HelpDropdown.utils'
-import { HelpSection } from '../HelpDropdown/HelpSection'
+import { ASSISTANT_SUGGESTIONS } from '../HelpPanel/HelpPanel.constants'
+import { getSupportLinkQueryParams } from '../HelpPanel/HelpPanel.utils'
+import { HelpSection } from '../HelpPanel/HelpSection'
import { FeedbackWidget } from './FeedbackWidget'
export const FeedbackDropdown = ({ className }: { className?: string }) => {
diff --git a/apps/studio/components/layouts/ProjectLayout/LayoutHeader/HelpDropdown/HelpDropdown.tsx b/apps/studio/components/layouts/ProjectLayout/LayoutHeader/HelpDropdown/HelpDropdown.tsx
deleted file mode 100644
index 8e9489008b0..00000000000
--- a/apps/studio/components/layouts/ProjectLayout/LayoutHeader/HelpDropdown/HelpDropdown.tsx
+++ /dev/null
@@ -1,128 +0,0 @@
-import { IS_PLATFORM } from 'common'
-import { SIDEBAR_KEYS } from 'components/layouts/ProjectLayout/LayoutSidebar/LayoutSidebarProvider'
-import { ButtonTooltip } from 'components/ui/ButtonTooltip'
-import { useSendEventMutation } from 'data/telemetry/send-event-mutation'
-import { useSelectedOrganizationQuery } from 'hooks/misc/useSelectedOrganization'
-import { useSelectedProjectQuery } from 'hooks/misc/useSelectedProject'
-import { HelpCircle } from 'lucide-react'
-import Image from 'next/legacy/image'
-import { useRouter } from 'next/router'
-import { useState } from 'react'
-import SVG from 'react-inlinesvg'
-import { useAiAssistantStateSnapshot } from 'state/ai-assistant-state'
-import { useSidebarManagerSnapshot } from 'state/sidebar-manager-state'
-import {
- Button,
- cn,
- Popover,
- Popover_Shadcn_,
- PopoverContent_Shadcn_,
- PopoverTrigger_Shadcn_,
-} from 'ui'
-
-import { ASSISTANT_SUGGESTIONS } from './HelpDropdown.constants'
-import { getSupportLinkQueryParams } from './HelpDropdown.utils'
-import { HelpSection } from './HelpSection'
-
-export const HelpDropdown = () => {
- const router = useRouter()
- const { data: project } = useSelectedProjectQuery()
- const { data: org } = useSelectedOrganizationQuery()
- const snap = useAiAssistantStateSnapshot()
- const { openSidebar } = useSidebarManagerSnapshot()
- const { mutate: sendEvent } = useSendEventMutation()
- const [isOpen, setIsOpen] = useState(false)
-
- const projectRef = project?.parent_project_ref ?? (router.query.ref as string | undefined)
- const supportLinkQueryParams = getSupportLinkQueryParams(
- project,
- org,
- router.query.ref as string | undefined
- )
-
- return (
- <Popover_Shadcn_ open={isOpen} onOpenChange={setIsOpen}>
- <PopoverTrigger_Shadcn_ asChild>
- <ButtonTooltip
- id="help-dropdown-button"
- type="outline"
- size="tiny"
- className={cn(
- 'rounded-full w-[32px] h-[32px] flex items-center justify-center p-0 group',
- isOpen && 'bg-foreground text-background'
- )}
- onClick={() => {
- if (isOpen) return // Don't send telemetry event if dropdown is already open
- sendEvent({
- action: 'help_button_clicked',
- groups: { project: project?.ref, organization: org?.slug },
- })
- }}
- tooltip={{ content: { side: 'bottom', text: 'Help' } }}
- >
- <HelpCircle
- size={16}
- strokeWidth={1.5}
- className={cn(
- 'text-foreground-light group-hover:text-foreground',
- isOpen && 'text-background group-hover:text-background'
- )}
- />
- </ButtonTooltip>
- </PopoverTrigger_Shadcn_>
- <PopoverContent_Shadcn_ className="w-[400px] space-y-5 p-0 py-5" align="end" side="bottom">
- <HelpSection
- className="px-5"
- excludeIds={['discord']}
- isPlatform={IS_PLATFORM}
- projectRef={projectRef}
- supportLinkQueryParams={supportLinkQueryParams}
- onAssistantClick={() => {
- setIsOpen(false)
- openSidebar(SIDEBAR_KEYS.AI_ASSISTANT)
- snap.newChat(ASSISTANT_SUGGESTIONS)
- }}
- onSupportClick={() => setIsOpen(false)}
- />
- <Popover.Separator />
- <div className="flex flex-col gap-4">
- <div className="px-5 flex flex-col gap-0.5">
- <h5 className="text-foreground">Community support</h5>
- <p className="text-xs text-foreground-lighter text-balance">
- Our Discord community can help with code-related issues. Many questions are answered
- in minutes.
- </p>
- </div>
- <div className="px-5">
- <div
- className="relative space-y-2 overflow-hidden rounded px-5 py-4 pb-12 shadow-md"
- style={{ background: '#404EED' }}
- >
- <a
- href="https://discord.supabase.com"
- target="_blank"
- rel="noreferrer"
- className="group dark block cursor-pointer"
- >
- <Image
- className="absolute left-0 top-0 opacity-50 transition-opacity group-hover:opacity-40"
- src={`${router.basePath}/img/support/discord-bg-small.jpg`}
- layout="fill"
- objectFit="cover"
- alt="Discord illustration"
- />
- <Button
- type="secondary"
- size="tiny"
- icon={<SVG src={`${router.basePath}/img/discord-icon.svg`} className="h-4 w-4" />}
- >
- <span style={{ color: '#404EED' }}>Join us on Discord</span>
- </Button>
- </a>
- </div>
- </div>
- </div>
- </PopoverContent_Shadcn_>
- </Popover_Shadcn_>
- )
-}
diff --git a/apps/studio/components/layouts/ProjectLayout/LayoutHeader/HelpPanel/HelpButton.tsx b/apps/studio/components/layouts/ProjectLayout/LayoutHeader/HelpPanel/HelpButton.tsx
new file mode 100644
index 00000000000..c986e14a34c
--- /dev/null
+++ b/apps/studio/components/layouts/ProjectLayout/LayoutHeader/HelpPanel/HelpButton.tsx
@@ -0,0 +1,46 @@
+import { SIDEBAR_KEYS } from 'components/layouts/ProjectLayout/LayoutSidebar/LayoutSidebarProvider'
+import { ButtonTooltip } from 'components/ui/ButtonTooltip'
+import { useSendEventMutation } from 'data/telemetry/send-event-mutation'
+import { useSelectedOrganizationQuery } from 'hooks/misc/useSelectedOrganization'
+import { useSelectedProjectQuery } from 'hooks/misc/useSelectedProject'
+import { HelpCircle } from 'lucide-react'
+import { useSidebarManagerSnapshot } from 'state/sidebar-manager-state'
+import { cn } from 'ui'
+
+export const HelpButton = () => {
+ const { toggleSidebar, activeSidebar } = useSidebarManagerSnapshot()
+ const { data: project } = useSelectedProjectQuery()
+ const { data: org } = useSelectedOrganizationQuery()
+ const { mutate: sendEvent } = useSendEventMutation()
+
+ const isOpen = activeSidebar?.id === SIDEBAR_KEYS.HELP_PANEL
+
+ return (
+ <ButtonTooltip
+ id="help-dropdown-button"
+ type={isOpen ? 'secondary' : 'outline'}
+ size="tiny"
+ className={cn('rounded-full w-[32px] h-[32px] flex items-center justify-center p-0 group')}
+ onClick={() => {
+ toggleSidebar(SIDEBAR_KEYS.HELP_PANEL)
+ // Don't send telemetry event if dropdown is already open
+ if (!isOpen) {
+ sendEvent({
+ action: 'help_button_clicked',
+ groups: { project: project?.ref, organization: org?.slug },
+ })
+ }
+ }}
+ tooltip={{ content: { side: 'bottom', text: 'Help' } }}
+ >
+ <HelpCircle
+ size={16}
+ strokeWidth={1.5}
+ className={cn(
+ 'text-foreground-light group-hover:text-foreground',
+ isOpen && 'text-background group-hover:text-background'
+ )}
+ />
+ </ButtonTooltip>
+ )
+}
diff --git a/apps/studio/components/layouts/ProjectLayout/LayoutHeader/HelpDropdown/HelpOptionsList.tsx b/apps/studio/components/layouts/ProjectLayout/LayoutHeader/HelpPanel/HelpOptionsList.tsx
similarity index 97%
rename from apps/studio/components/layouts/ProjectLayout/LayoutHeader/HelpDropdown/HelpOptionsList.tsx
rename to apps/studio/components/layouts/ProjectLayout/LayoutHeader/HelpPanel/HelpOptionsList.tsx
index 33171c30f44..278f3558462 100644
--- a/apps/studio/components/layouts/ProjectLayout/LayoutHeader/HelpDropdown/HelpOptionsList.tsx
+++ b/apps/studio/components/layouts/ProjectLayout/LayoutHeader/HelpPanel/HelpOptionsList.tsx
@@ -6,8 +6,8 @@ import { useRouter } from 'next/router'
import SVG from 'react-inlinesvg'
import { AiIconAnimation, ButtonGroup, ButtonGroupItem } from 'ui'
-import type { HelpOptionId } from './HelpDropdown.constants'
-import { HELP_OPTION_IDS } from './HelpDropdown.constants'
+import type { HelpOptionId } from './HelpPanel.constants'
+import { HELP_OPTION_IDS } from './HelpPanel.constants'
const DISCORD_URL = 'https://discord.supabase.com'
const STATUS_URL = 'https://status.supabase.com'
diff --git a/apps/studio/components/layouts/ProjectLayout/LayoutHeader/HelpDropdown/HelpDropdown.constants.ts b/apps/studio/components/layouts/ProjectLayout/LayoutHeader/HelpPanel/HelpPanel.constants.ts
similarity index 100%
rename from apps/studio/components/layouts/ProjectLayout/LayoutHeader/HelpDropdown/HelpDropdown.constants.ts
rename to apps/studio/components/layouts/ProjectLayout/LayoutHeader/HelpPanel/HelpPanel.constants.ts
diff --git a/apps/studio/components/layouts/ProjectLayout/LayoutHeader/HelpPanel/HelpPanel.tsx b/apps/studio/components/layouts/ProjectLayout/LayoutHeader/HelpPanel/HelpPanel.tsx
new file mode 100644
index 00000000000..264450d190d
--- /dev/null
+++ b/apps/studio/components/layouts/ProjectLayout/LayoutHeader/HelpPanel/HelpPanel.tsx
@@ -0,0 +1,97 @@
+import { IS_PLATFORM } from 'common'
+import type { SupportFormUrlKeys } from 'components/interfaces/Support/SupportForm.utils'
+import { SIDEBAR_KEYS } from 'components/layouts/ProjectLayout/LayoutSidebar/LayoutSidebarProvider'
+import { ButtonTooltip } from 'components/ui/ButtonTooltip'
+import { X } from 'lucide-react'
+import Image from 'next/image'
+import { useRouter } from 'next/router'
+import SVG from 'react-inlinesvg'
+import { useAiAssistantStateSnapshot } from 'state/ai-assistant-state'
+import { useSidebarManagerSnapshot } from 'state/sidebar-manager-state'
+import { Button, cn, Separator } from 'ui'
+import styleHandler from 'ui/src/lib/theme/styleHandler'
+
+import { ASSISTANT_SUGGESTIONS } from './HelpPanel.constants'
+import { HelpSection } from './HelpSection'
+
+export const HelpPanel = ({
+ onClose,
+ projectRef,
+ supportLinkQueryParams,
+}: {
+ onClose: () => void
+ projectRef: string | undefined
+ supportLinkQueryParams: Partial<SupportFormUrlKeys> | undefined
+}) => {
+ const snap = useAiAssistantStateSnapshot()
+ const { openSidebar, closeSidebar } = useSidebarManagerSnapshot()
+ const router = useRouter()
+
+ const __styles = styleHandler('popover')
+
+ return (
+ <div className="space-y-4">
+ <div className="flex text-xs items-center justify-between pl-4 pr-3 h-[var(--header-height)] border-b">
+ <span>Help & Support</span>
+ <ButtonTooltip
+ type="text"
+ className="w-7 h-7"
+ onClick={() => closeSidebar(SIDEBAR_KEYS.HELP_PANEL)}
+ icon={<X strokeWidth={1.5} />}
+ tooltip={{ content: { side: 'bottom', text: 'Close' } }}
+ />
+ </div>
+ <HelpSection
+ className="px-4"
+ excludeIds={['discord']}
+ isPlatform={IS_PLATFORM}
+ projectRef={projectRef}
+ supportLinkQueryParams={supportLinkQueryParams}
+ onAssistantClick={() => {
+ onClose()
+ openSidebar(SIDEBAR_KEYS.AI_ASSISTANT)
+ snap.newChat(ASSISTANT_SUGGESTIONS)
+ }}
+ onSupportClick={onClose}
+ />
+ <Separator className={cn(__styles.separator, 'my-4')} />
+ <div className="flex flex-col gap-4">
+ <div className="px-4 flex flex-col gap-0.5">
+ <h5 className="text-foreground">Community support</h5>
+ <p className="text-xs text-foreground-lighter text-balance">
+ Our Discord community can help with code-related issues. Many questions are answered in
+ minutes.
+ </p>
+ </div>
+ <div className="px-4">
+ <div
+ className="relative space-y-2 overflow-hidden rounded px-4 py-4 pb-12 shadow-md"
+ style={{ background: '#404EED' }}
+ >
+ <a
+ href="https://discord.supabase.com"
+ target="_blank"
+ rel="noreferrer"
+ className="group dark block cursor-pointer"
+ >
+ <Image
+ className="absolute left-0 top-0 opacity-50 transition-opacity group-hover:opacity-40"
+ src={`${router.basePath}/img/support/discord-bg-small.jpg`}
+ layout="fill"
+ objectFit="cover"
+ alt="Discord illustration"
+ />
+ <Button
+ type="secondary"
+ size="tiny"
+ icon={<SVG src={`${router.basePath}/img/discord-icon.svg`} className="h-4 w-4" />}
+ >
+ <span style={{ color: '#404EED' }}>Join us on Discord</span>
+ </Button>
+ </a>
+ </div>
+ </div>
+ </div>
+ </div>
+ )
+}
diff --git a/apps/studio/components/layouts/ProjectLayout/LayoutHeader/HelpPanel/HelpPanel.utils.test.ts b/apps/studio/components/layouts/ProjectLayout/LayoutHeader/HelpPanel/HelpPanel.utils.test.ts
new file mode 100644
index 00000000000..95e640f0e38
--- /dev/null
+++ b/apps/studio/components/layouts/ProjectLayout/LayoutHeader/HelpPanel/HelpPanel.utils.test.ts
@@ -0,0 +1,57 @@
+import { describe, expect, it } from 'vitest'
+
+import { getSupportLinkQueryParams } from './HelpPanel.utils'
+
+describe('getSupportLinkQueryParams', () => {
+ it('returns { projectRef } when project has parent_project_ref', () => {
+ expect(
+ getSupportLinkQueryParams(
+ { parent_project_ref: 'main-project' },
+ { slug: 'my-org' },
+ 'router-ref'
+ )
+ ).toEqual({ projectRef: 'main-project' })
+ })
+
+ it('returns { projectRef } from routerRef when project has no parent_project_ref', () => {
+ expect(getSupportLinkQueryParams({}, { slug: 'my-org' }, 'router-ref')).toEqual({
+ projectRef: 'router-ref',
+ })
+ })
+
+ it('returns { projectRef } from routerRef when project is undefined', () => {
+ expect(getSupportLinkQueryParams(undefined, { slug: 'my-org' }, 'router-ref')).toEqual({
+ projectRef: 'router-ref',
+ })
+ })
+
+ it('returns { orgSlug } when no projectRef (no project, no routerRef)', () => {
+ expect(getSupportLinkQueryParams(undefined, { slug: 'my-org' }, undefined)).toEqual({
+ orgSlug: 'my-org',
+ })
+ })
+
+ it('returns { orgSlug } when project and routerRef are undefined but org has slug', () => {
+ expect(getSupportLinkQueryParams(undefined, { slug: 'acme' }, undefined)).toEqual({
+ orgSlug: 'acme',
+ })
+ })
+
+ it('returns undefined when project, org and routerRef give no ref', () => {
+ expect(getSupportLinkQueryParams(undefined, undefined, undefined)).toBeUndefined()
+ })
+
+ it('returns undefined when org has no slug and no projectRef', () => {
+ expect(getSupportLinkQueryParams(undefined, {}, undefined)).toBeUndefined()
+ })
+
+ it('returns undefined when org is undefined and no projectRef', () => {
+ expect(getSupportLinkQueryParams(undefined, undefined, undefined)).toBeUndefined()
+ })
+
+ it('prefers parent_project_ref over routerRef when both are present', () => {
+ expect(
+ getSupportLinkQueryParams({ parent_project_ref: 'parent-ref' }, { slug: 'org' }, 'router-ref')
+ ).toEqual({ projectRef: 'parent-ref' })
+ })
+})
diff --git a/apps/studio/components/layouts/ProjectLayout/LayoutHeader/HelpDropdown/HelpDropdown.utils.ts b/apps/studio/components/layouts/ProjectLayout/LayoutHeader/HelpPanel/HelpPanel.utils.ts
similarity index 100%
rename from apps/studio/components/layouts/ProjectLayout/LayoutHeader/HelpDropdown/HelpDropdown.utils.ts
rename to apps/studio/components/layouts/ProjectLayout/LayoutHeader/HelpPanel/HelpPanel.utils.ts
diff --git a/apps/studio/components/layouts/ProjectLayout/LayoutHeader/HelpDropdown/HelpSection.tsx b/apps/studio/components/layouts/ProjectLayout/LayoutHeader/HelpPanel/HelpSection.tsx
similarity index 95%
rename from apps/studio/components/layouts/ProjectLayout/LayoutHeader/HelpDropdown/HelpSection.tsx
rename to apps/studio/components/layouts/ProjectLayout/LayoutHeader/HelpPanel/HelpSection.tsx
index bc6a2468800..7aea2451dc4 100644
--- a/apps/studio/components/layouts/ProjectLayout/LayoutHeader/HelpDropdown/HelpSection.tsx
+++ b/apps/studio/components/layouts/ProjectLayout/LayoutHeader/HelpPanel/HelpSection.tsx
@@ -1,8 +1,8 @@
import type { SupportFormUrlKeys } from 'components/interfaces/Support/SupportForm.utils'
import { cn } from 'ui'
-import type { HelpOptionId } from './HelpDropdown.constants'
import { HelpOptionsList } from './HelpOptionsList'
+import type { HelpOptionId } from './HelpPanel.constants'
type HelpSectionProps = {
excludeIds?: HelpOptionId[]
diff --git a/apps/studio/components/layouts/ProjectLayout/LayoutHeader/LayoutHeader.tsx b/apps/studio/components/layouts/ProjectLayout/LayoutHeader/LayoutHeader.tsx
index 08f9f317bf2..ce5d2e78aeb 100644
--- a/apps/studio/components/layouts/ProjectLayout/LayoutHeader/LayoutHeader.tsx
+++ b/apps/studio/components/layouts/ProjectLayout/LayoutHeader/LayoutHeader.tsx
@@ -26,7 +26,7 @@ import { CommandMenuTriggerInput } from 'ui-patterns'
import { BreadcrumbsView } from './BreadcrumbsView'
import { FeedbackDropdown } from './FeedbackDropdown/FeedbackDropdown'
-import { HelpDropdown } from './HelpDropdown/HelpDropdown'
+import { HelpButton } from './HelpPanel/HelpButton'
import { HomeIcon } from './HomeIcon'
import { LocalVersionPopover } from './LocalVersionPopover'
import { MergeRequestButton } from './MergeRequestButton'
@@ -231,7 +231,7 @@ export const LayoutHeader = ({
'[&_.command-shortcut>div]:text-foreground-lighter'
)}
/>
- <HelpDropdown />
+ <HelpButton />
<AdvisorButton projectRef={projectRef} />
<AnimatePresence initial={false}>
{!!projectRef && (
@@ -257,7 +257,7 @@ export const LayoutHeader = ({
[&_.command-shortcut>div]:text-foreground-lighter
"
/>
- <HelpDropdown />
+ <HelpButton />
<AdvisorButton projectRef={projectRef} />
<AnimatePresence initial={false}>
{!!projectRef && (
diff --git a/apps/studio/components/layouts/ProjectLayout/LayoutSidebar/LayoutSidebarProvider.tsx b/apps/studio/components/layouts/ProjectLayout/LayoutSidebar/LayoutSidebarProvider.tsx
index f653c316d49..74aa05af224 100644
--- a/apps/studio/components/layouts/ProjectLayout/LayoutSidebar/LayoutSidebarProvider.tsx
+++ b/apps/studio/components/layouts/ProjectLayout/LayoutSidebar/LayoutSidebarProvider.tsx
@@ -1,22 +1,37 @@
-import { useRouter } from 'next/router'
-import { parseAsString, useQueryState } from 'nuqs'
-import { PropsWithChildren, useEffect } from 'react'
-
import { LOCAL_STORAGE_KEYS } from 'common'
-import { AdvisorPanel } from 'components/ui/AdvisorPanel/AdvisorPanel'
-import { AIAssistant } from 'components/ui/AIAssistantPanel/AIAssistant'
-import { EditorPanel } from 'components/ui/EditorPanel/EditorPanel'
import { useSendEventMutation } from 'data/telemetry/send-event-mutation'
import useLatest from 'hooks/misc/useLatest'
import { useLocalStorageQuery } from 'hooks/misc/useLocalStorage'
import { useSelectedOrganizationQuery } from 'hooks/misc/useSelectedOrganization'
import { useSelectedProjectQuery } from 'hooks/misc/useSelectedProject'
+import dynamic from 'next/dynamic'
+import { useRouter } from 'next/router'
+import { parseAsString, useQueryState } from 'nuqs'
+import { useEffect, type PropsWithChildren } from 'react'
import { useRegisterSidebar, useSidebarManagerSnapshot } from 'state/sidebar-manager-state'
+import { getSupportLinkQueryParams } from '../LayoutHeader/HelpPanel/HelpPanel.utils'
+
+const AdvisorPanel = dynamic(() =>
+ import('components/ui/AdvisorPanel/AdvisorPanel').then((m) => m.AdvisorPanel)
+)
+const AIAssistant = dynamic(() =>
+ import('components/ui/AIAssistantPanel/AIAssistant').then((m) => m.AIAssistant)
+)
+const EditorPanel = dynamic(() =>
+ import('components/ui/EditorPanel/EditorPanel').then((m) => m.EditorPanel)
+)
+const HelpPanel = dynamic(() =>
+ import('components/layouts/ProjectLayout/LayoutHeader/HelpPanel/HelpPanel').then(
+ (m) => m.HelpPanel
+ )
+)
+
export const SIDEBAR_KEYS = {
AI_ASSISTANT: 'ai-assistant',
EDITOR_PANEL: 'editor-panel',
ADVISOR_PANEL: 'advisor-panel',
+ HELP_PANEL: 'help-panel',
} as const
export const LayoutSidebarProvider = ({ children }: PropsWithChildren) => {
@@ -24,7 +39,7 @@ export const LayoutSidebarProvider = ({ children }: PropsWithChildren) => {
const { data: project } = useSelectedProjectQuery()
const { data: org } = useSelectedOrganizationQuery()
const { mutate: sendEvent } = useSendEventMutation()
- const { openSidebar, activeSidebar } = useSidebarManagerSnapshot()
+ const { openSidebar, closeSidebar, activeSidebar } = useSidebarManagerSnapshot()
const [sidebarURLParam, setSidebarUrlParam] = useQueryState('sidebar', parseAsString)
const [sidebarLocalStorage, setSidebarLocalStorage, { isSuccess: isLoadedLocalStorage }] =
@@ -36,6 +51,23 @@ export const LayoutSidebarProvider = ({ children }: PropsWithChildren) => {
useRegisterSidebar(SIDEBAR_KEYS.AI_ASSISTANT, () => <AIAssistant />, {}, 'i', !!project)
useRegisterSidebar(SIDEBAR_KEYS.EDITOR_PANEL, () => <EditorPanel />, {}, 'e', !!project)
useRegisterSidebar(SIDEBAR_KEYS.ADVISOR_PANEL, () => <AdvisorPanel />, {}, undefined, true)
+ useRegisterSidebar(
+ SIDEBAR_KEYS.HELP_PANEL,
+ () => (
+ <HelpPanel
+ onClose={() => closeSidebar(SIDEBAR_KEYS.HELP_PANEL)}
+ projectRef={project?.ref}
+ supportLinkQueryParams={getSupportLinkQueryParams(
+ project,
+ org,
+ router.query.ref as string | undefined
+ )}
+ />
+ ),
+ {},
+ undefined,
+ true
+ )
useEffect(() => {
if (!!project) {
diff --git a/apps/studio/components/layouts/ProjectLayout/LayoutSidebar/index.test.tsx b/apps/studio/components/layouts/ProjectLayout/LayoutSidebar/index.test.tsx
index 889e07bc124..8872548186b 100644
--- a/apps/studio/components/layouts/ProjectLayout/LayoutSidebar/index.test.tsx
+++ b/apps/studio/components/layouts/ProjectLayout/LayoutSidebar/index.test.tsx
@@ -1,10 +1,11 @@
import { act, screen, waitFor } from '@testing-library/react'
-import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest'
-
import { sidebarManagerState } from 'state/sidebar-manager-state'
import { render } from 'tests/helpers'
import { routerMock } from 'tests/lib/route-mock'
import { ResizablePanel, ResizablePanelGroup } from 'ui'
+import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest'
+
+import { MobileSheetProvider } from '../NavigationBar/MobileSheetContext'
import { LayoutSidebar } from './index'
import { LayoutSidebarProvider, SIDEBAR_KEYS } from './LayoutSidebarProvider'
@@ -109,7 +110,9 @@ describe('LayoutSidebar', () => {
<div />
</ResizablePanel>
<LayoutSidebarProvider>
- <LayoutSidebar />
+ <MobileSheetProvider>
+ <LayoutSidebar />
+ </MobileSheetProvider>
</LayoutSidebarProvider>
</ResizablePanelGroup>
)
diff --git a/apps/studio/components/layouts/ProjectLayout/LayoutSidebar/index.tsx b/apps/studio/components/layouts/ProjectLayout/LayoutSidebar/index.tsx
index 3e3161f0ce4..b8e61d94b51 100644
--- a/apps/studio/components/layouts/ProjectLayout/LayoutSidebar/index.tsx
+++ b/apps/studio/components/layouts/ProjectLayout/LayoutSidebar/index.tsx
@@ -1,5 +1,10 @@
+import { useBreakpoint } from 'common'
+import { useEffect } from 'react'
import { useSidebarManagerSnapshot } from 'state/sidebar-manager-state'
-import { ResizableHandle, ResizablePanel, cn } from 'ui'
+import { cn, ResizableHandle, ResizablePanel } from 'ui'
+import { MobileSheetNav } from 'ui-patterns'
+
+import { useMobileSheet } from '../NavigationBar/MobileSheetContext'
// Having these params as props as otherwise it's quite hard to visually check the sizes in DefaultLayout
// as react resizeable panels requires all these values to be valid to render correctly
@@ -14,10 +19,36 @@ export const LayoutSidebar = ({
maxSize = '50',
defaultSize = '30',
}: LayoutSidebarProps) => {
- const { activeSidebar } = useSidebarManagerSnapshot()
+ const { activeSidebar, closeActive } = useSidebarManagerSnapshot()
+ const isMobile = useBreakpoint('md')
+ const { content: mobileSheetContent, setContent: setMobileSheetContent } = useMobileSheet()
+
+ // On mobile the sidebar content is rendered in MobileSheetNav
+ useEffect(() => {
+ if (isMobile && activeSidebar?.component) {
+ setMobileSheetContent(activeSidebar.id)
+ } else {
+ setMobileSheetContent(null)
+ }
+ }, [isMobile, activeSidebar, setMobileSheetContent])
if (!activeSidebar?.component) return null
+ if (isMobile)
+ return (
+ <MobileSheetNav
+ open={mobileSheetContent !== null}
+ onOpenChange={(open: boolean) => {
+ if (!open) {
+ setMobileSheetContent(null)
+ closeActive()
+ }
+ }}
+ >
+ {activeSidebar?.component?.()}
+ </MobileSheetNav>
+ )
+
return (
<>
<ResizableHandle withHandle />
diff --git a/apps/studio/components/layouts/ProjectLayout/NavigationBar/MobileNavigationBar.tsx b/apps/studio/components/layouts/ProjectLayout/NavigationBar/MobileNavigationBar.tsx
index 04b87035fd3..15873138927 100644
--- a/apps/studio/components/layouts/ProjectLayout/NavigationBar/MobileNavigationBar.tsx
+++ b/apps/studio/components/layouts/ProjectLayout/NavigationBar/MobileNavigationBar.tsx
@@ -1,14 +1,12 @@
+import { useParams } from 'common'
+import { SidebarContent } from 'components/interfaces/Sidebar'
+import { IS_PLATFORM } from 'lib/constants'
import { Menu, Search } from 'lucide-react'
import Link from 'next/link'
import { useRouter } from 'next/router'
import { useState } from 'react'
-
-import { useParams } from 'common'
-import { SidebarContent } from 'components/interfaces/Sidebar'
-import { IS_PLATFORM } from 'lib/constants'
import { Button, cn } from 'ui'
-import { CommandMenuTrigger } from 'ui-patterns'
-import MobileSheetNav from 'ui-patterns/MobileSheetNav/MobileSheetNav'
+import { CommandMenuTrigger, MobileSheetNav } from 'ui-patterns'
export const ICON_SIZE = 20
export const ICON_STROKE_WIDTH = 1.5
diff --git a/apps/studio/components/layouts/ProjectLayout/NavigationBar/MobileSheetContext.tsx b/apps/studio/components/layouts/ProjectLayout/NavigationBar/MobileSheetContext.tsx
new file mode 100644
index 00000000000..72a6f76ff50
--- /dev/null
+++ b/apps/studio/components/layouts/ProjectLayout/NavigationBar/MobileSheetContext.tsx
@@ -0,0 +1,33 @@
+import type { PropsWithChildren } from 'react'
+import { createContext, useCallback, useContext, useState } from 'react'
+
+export type MobileSheetContentType = null | string
+
+type MobileSheetContextValue = {
+ content: MobileSheetContentType
+ setContent: (content: MobileSheetContentType) => void
+}
+
+const MobileSheetContext = createContext<MobileSheetContextValue | null>(null)
+
+export function MobileSheetProvider({ children }: PropsWithChildren) {
+ const [content, setContentState] = useState<MobileSheetContentType>(null)
+
+ const setContent = useCallback((next: MobileSheetContentType) => {
+ setContentState(next)
+ }, [])
+
+ return (
+ <MobileSheetContext.Provider value={{ content, setContent }}>
+ {children}
+ </MobileSheetContext.Provider>
+ )
+}
+
+export function useMobileSheet(): MobileSheetContextValue {
+ const ctx = useContext(MobileSheetContext)
+ if (!ctx) {
+ throw new Error('useMobileSheet must be used within MobileSheetProvider')
+ }
+ return ctx
+}
diff --git a/apps/studio/components/layouts/ProjectLayout/NavigationBar/MobileSheetNavLayout.tsx b/apps/studio/components/layouts/ProjectLayout/NavigationBar/MobileSheetNavLayout.tsx
new file mode 100644
index 00000000000..423a81f812a
--- /dev/null
+++ b/apps/studio/components/layouts/ProjectLayout/NavigationBar/MobileSheetNavLayout.tsx
@@ -0,0 +1,23 @@
+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/common/telemetry-constants.ts b/packages/common/telemetry-constants.ts
index 7286edec5fd..4eb26581df4 100644
--- a/packages/common/telemetry-constants.ts
+++ b/packages/common/telemetry-constants.ts
@@ -2320,7 +2320,7 @@ export interface SidebarOpenedEvent {
/**
* The sidebar panel that was opened, e.g. ai-assistant, editor-panel, advisor-panel
*/
- sidebar: 'ai-assistant' | 'editor-panel' | 'advisor-panel'
+ sidebar: 'ai-assistant' | 'editor-panel' | 'advisor-panel' | 'help-panel'
}
groups: TelemetryGroups
}
diff --git a/packages/ui-patterns/index.tsx b/packages/ui-patterns/index.tsx
index 1be06287121..f7ffdde0b60 100644
--- a/packages/ui-patterns/index.tsx
+++ b/packages/ui-patterns/index.tsx
@@ -16,6 +16,7 @@ export * from './src/FilterBar'
export * from './src/GlassPanel'
export * from './src/InnerSideMenu'
export * from './src/McpUrlBuilder'
+export * from './src/MobileSheetNav'
export * from './src/PageContainer'
export * from './src/PageHeader'
export * from './src/PageSection'
diff --git a/packages/ui-patterns/src/MobileSheetNav/MobileSheetNav.tsx b/packages/ui-patterns/src/MobileSheetNav/MobileSheetNav.tsx
index 6e06fc0621d..7749316d350 100644
--- a/packages/ui-patterns/src/MobileSheetNav/MobileSheetNav.tsx
+++ b/packages/ui-patterns/src/MobileSheetNav/MobileSheetNav.tsx
@@ -1,9 +1,6 @@
'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'
@@ -11,19 +8,8 @@ const MobileSheetNav: React.FC<{
children: React.ReactNode
open?: boolean
onOpenChange(open: boolean): void
-}> = ({ children, open = false, onOpenChange }) => {
- const router = useRouter()
- const { width } = useWindowSize()
-
- const pathWithoutQuery = router?.asPath?.split('?')?.[0]
- useEffect(() => {
- onOpenChange(false)
- }, [pathWithoutQuery])
-
- useEffect(() => {
- onOpenChange(false)
- }, [width])
-
+ className?: string
+}> = ({ children, open = false, onOpenChange, className }) => {
return (
<Sheet open={open} onOpenChange={onOpenChange}>
<SheetContent
@@ -31,7 +17,10 @@ const MobileSheetNav: React.FC<{
showClose={false}
size="full"
side="bottom"
- className={cn('rounded-t-lg overflow-hidden overflow-y-scroll h-[85dvh] md:max-h-[500px]')}
+ className={cn(
+ 'rounded-t-lg bg-background overflow-hidden overflow-y-scroll h-[85dvh] md:max-h-[500px]',
+ className
+ )}
>
<ErrorBoundary FallbackComponent={() => <CommandEmpty_Shadcn_ />}>{children}</ErrorBoundary>
</SheetContent>
@@ -39,4 +28,5 @@ const MobileSheetNav: React.FC<{
)
}
+export { MobileSheetNav }
export default MobileSheetNav
diff --git a/packages/ui-patterns/src/MobileSheetNav/index.ts b/packages/ui-patterns/src/MobileSheetNav/index.ts
index fd58868d481..06b0a825691 100644
--- a/packages/ui-patterns/src/MobileSheetNav/index.ts
+++ b/packages/ui-patterns/src/MobileSheetNav/index.ts
@@ -1 +1 @@
-export * from './MobileSheetNav'
+export { default as MobileSheetNav } from './MobileSheetNav'
\ No newline at end of file