Files
supabase/apps/studio/components/layouts/ProjectIntegrationsLayout.tsx
T
Danny WhiteandJoshen Lim 7d6995bbfe refactor(studio): clean up ProjectLayout title API (#43742)
## What kind of change does this PR introduce?

Refactor, cleanup, and docs update.

## What is the current behavior?

After the page-title rollout, `ProjectLayout` is still in a transitional
state:

- it accepts a deprecated `title` prop
- it still supports a separate `browserTitle.surface`
- wrapper layouts are split between passing `title` directly and passing
`browserTitle.section`

That makes the API harder to reason about than it needs to be, even
though the rendered titles are already correct.

## What is the new behavior?

This cleanup finishes the API simplification that came out of the
stacked PR review:

- wrapper layouts stay `title`-first for DX
- `ProjectLayout` no longer accepts `title`
- `product` is now the single source of truth for the project-surface
title segment
- `browserTitle` is now only used for extra browser-title metadata
(`entity`, `section`, `override`)
- the remaining project-scoped callers now pass `browserTitle.section`
when they need a section label
- docs now reflect the final pattern instead of the transitional one

Rendered page titles stay the same.

## Additional context

Checks run:

- `pnpm --filter studio exec vitest --run lib/page-title.test.ts
components/layouts/ProjectLayout/index.test.tsx`
- `pnpm --filter studio typecheck`
- `pnpm exec prettier --check ...` on touched files

This is intended as the post-rollout cleanup PR based on Joshen's review
feedback across the stacked title changes.

---------

Co-authored-by: Joshen Lim <joshenlimek@gmail.com>
2026-03-16 18:03:10 +11:00

156 lines
4.7 KiB
TypeScript

import { useQuery } from '@tanstack/react-query'
import { IS_PLATFORM, useFeatureFlags, useFlag, useParams } from 'common'
import { useInstalledIntegrations } from 'components/interfaces/Integrations/Landing/useInstalledIntegrations'
import { ProjectLayout } from 'components/layouts/ProjectLayout'
import AlertError from 'components/ui/AlertError'
import { ProductMenuItem } from 'components/ui/ProductMenu/ProductMenuItem'
import { useIsFeatureEnabled } from 'hooks/misc/useIsFeatureEnabled'
import { withAuth } from 'hooks/misc/withAuth'
import { useRouter } from 'next/router'
import { PropsWithChildren } from 'react'
import { Menu, Separator } from 'ui'
import { GenericSkeletonLoader } from 'ui-patterns'
import { marketplaceCategoriesQueryOptions } from '@/data/marketplace/integration-categories-query'
/**
* Layout component for the Integrations section
* Provides sidebar navigation for integrations
*/
export const ProjectIntegrationsLayout = withAuth(({ children }: PropsWithChildren) => {
const router = useRouter()
const segments = router.asPath.split('/')
// construct the page url to be used to determine the active state for the sidebar
const page = `${segments[3]}${segments[4] ? `/${segments[4]}` : ''}`
return (
<ProjectLayout
product="Integrations"
browserTitle={{ section: 'Integrations' }}
isBlocking={false}
productMenu={
<>
<IntegrationCategoriesMenu page={page} />
<Separator />
<InstalledIntegrationsMenu page={page} />
</>
}
>
{children}
</ProjectLayout>
)
})
const IntegrationCategoriesMenu = ({ page }: { page: string }) => {
const router = useRouter()
const { ref } = useParams()
const { hasLoaded: flagsLoaded } = useFeatureFlags()
const isMarketplaceEnabled = useFlag('marketplaceIntegrations')
const urlParams = new URLSearchParams(router.asPath.split('?')[1] || '')
const categoryParam = urlParams.get('category')
const pageKey = categoryParam || page
const { integrationsWrappers: showWrappers } = useIsFeatureEnabled(['integrations:wrappers'])
const { data: categories = [], isPending: isPendingCategories } = useQuery(
marketplaceCategoriesQueryOptions({ enabled: isMarketplaceEnabled })
)
const isLoading = IS_PLATFORM
? !flagsLoaded || (isMarketplaceEnabled && isPendingCategories)
: false
const allCategories = [
{
name: 'All',
key: 'integrations',
url: `/project/${ref}/integrations`,
pages: ['integrations'],
items: [],
},
...(showWrappers
? [
{
name: 'Wrappers',
key: 'wrapper',
url: `/project/${ref}/integrations?category=wrapper`,
items: [],
},
]
: []),
{
name: 'Postgres Modules',
key: 'postgres_extension',
url: `/project/${ref}/integrations?category=postgres_extension`,
items: [],
},
...categories.map((category) => ({
name: category.title,
key: category.slug,
url: `/project/${ref}/integrations?category=${category.slug}`,
items: [],
})),
]
return (
<div className="px-4 py-6 md:px-6">
<Menu.Group title={<span className="uppercase font-mono">Explore</span>} />
{isLoading ? (
<GenericSkeletonLoader />
) : (
<div>
{allCategories.map((item) => (
<ProductMenuItem key={item.key} isActive={pageKey === item.key} item={item} />
))}
</div>
)}
</div>
)
}
const InstalledIntegrationsMenu = ({ page }: { page: string }) => {
const { ref } = useParams()
const {
installedIntegrations: integrations,
error,
isLoading,
isSuccess,
isError,
} = useInstalledIntegrations()
const installedIntegrationItems = integrations.map((integration) => ({
name: integration.name,
label: integration.status,
key: `integrations/${integration.id}`,
url: `/project/${ref}/integrations/${integration.id}/overview`,
icon: (
<div className="relative w-6 h-6 bg-white border rounded flex items-center justify-center">
{integration.icon({ className: 'p-1' })}
</div>
),
items: [],
}))
return (
<div className="px-4 py-6 md:px-6">
<Menu.Group title={<span className="uppercase font-mono">Installed</span>} />
{isLoading && <GenericSkeletonLoader />}
{isError && (
<AlertError
showIcon={false}
error={error}
subject="Failed to retrieve installed integrations"
/>
)}
{isSuccess && (
<div>
{installedIntegrationItems.map((item) => (
<ProductMenuItem key={item.key} isActive={page === item.key} item={item} />
))}
</div>
)}
</div>
)
}