Files
supabase/apps/studio/components/interfaces/ProjectAPIDocs/FirstLevelNav.tsx
Alaister Young 5f533247e1 Update docs url to env var (#38772)
* Update Supabase docs URLs to use env variable

Co-authored-by: a <a@alaisteryoung.com>

* Refactor: Use DOCS_URL constant for documentation links

This change centralizes documentation links using a new DOCS_URL constant, improving maintainability and consistency.

Co-authored-by: a <a@alaisteryoung.com>

* Refactor: Use DOCS_URL constant for all documentation links

This change replaces hardcoded documentation URLs with a centralized constant, improving maintainability and consistency.

Co-authored-by: a <a@alaisteryoung.com>

* replace more instances

* ci: Autofix updates from GitHub workflow

* remaining instances

* fix duplicate useRouter

---------

Co-authored-by: Cursor Agent <cursoragent@cursor.com>
Co-authored-by: alaister <10985857+alaister@users.noreply.github.com>
2025-09-26 10:16:33 +00:00

206 lines
7.4 KiB
TypeScript

import { useParams } from 'common'
import Link from 'next/link'
import { Fragment } from 'react'
import SVG from 'react-inlinesvg'
import { useEdgeFunctionsQuery } from 'data/edge-functions/edge-functions-query'
import { useOpenAPISpecQuery } from 'data/open-api/api-spec-query'
import { useBucketsQuery } from 'data/storage/buckets-query'
import { useIsFeatureEnabled } from 'hooks/misc/useIsFeatureEnabled'
import { BASE_PATH, DOCS_URL } from 'lib/constants'
import { Book, BookOpen } from 'lucide-react'
import { useAppStateSnapshot } from 'state/app-state'
import { Button } from 'ui'
import { navigateToSection } from './Content/Content.utils'
import { DOCS_CONTENT, DOCS_MENU } from './ProjectAPIDocs.constants'
const Separator = () => <div className="border-t !mt-3 pb-1 mx-3" />
const FirstLevelNav = () => {
const { ref } = useParams()
const snap = useAppStateSnapshot()
const {
projectAuthAll: authEnabled,
projectStorageAll: storageEnabled,
projectEdgeFunctionAll: edgeFunctionsEnabled,
realtimeAll: realtimeEnabled,
} = useIsFeatureEnabled([
'project_auth:all',
'project_storage:all',
'project_edge_function:all',
'realtime:all',
])
const docsMenu = DOCS_MENU.filter((item) => {
if (item.key === 'user-management') return authEnabled
if (item.key === 'storage') return storageEnabled
if (item.key === 'edge-functions') return edgeFunctionsEnabled
if (item.key === 'realtime') return realtimeEnabled
return true
})
const { data } = useOpenAPISpecQuery({ projectRef: ref })
const tables = data?.tables ?? []
const functions = data?.functions ?? []
const { data: buckets } = useBucketsQuery({ projectRef: ref })
const { data: edgeFunctions } = useEdgeFunctionsQuery({ projectRef: ref })
return (
<>
<div className="px-2 py-4 border-b">
{docsMenu.map((item) => {
const isActive = snap.activeDocsSection[0] === item.key
const sections = Object.values(DOCS_CONTENT).filter(
(snippet) => snippet.category === item.key
)
// [Joshen] Need to find the right UI component for accessbility
return (
<Fragment key={item.key}>
<div
className={`cursor-pointer text-sm py-2 px-3 rounded-md transition ${
isActive ? 'bg-surface-300' : ''
}`}
onClick={() => snap.setActiveDocsSection([item.key])}
>
{item.name}
</div>
{isActive && sections.length > 0 && (
<div className="space-y-2 py-2">
{sections.map((section) => (
<p
key={section.key}
title={section.title}
className="text-sm text-foreground-light px-4 hover:text-foreground transition cursor-pointer"
onClick={() => {
snap.setActiveDocsSection([item.key])
navigateToSection(section.key)
}}
>
{section.title}
</p>
))}
{item.key === 'entities' && (
<>
{tables.length > 0 && <Separator />}
{tables.map((table) => (
<p
key={table.name}
title={table.name}
className="text-sm text-foreground-light px-4 hover:text-foreground transition cursor-pointer"
onClick={() => snap.setActiveDocsSection([item.key, table.name])}
>
{table.name}
</p>
))}
</>
)}
{item.key === 'stored-procedures' && (
<>
{functions.length > 0 && <Separator />}
{functions.map((fn) => (
<p
key={fn.name}
title={fn.name}
className="text-sm text-foreground-light px-4 hover:text-foreground transition cursor-pointer"
onClick={() => snap.setActiveDocsSection([item.key, fn.name])}
>
{fn.name}
</p>
))}
</>
)}
{item.key === 'storage' && (
<>
{(buckets ?? []).length > 0 && <Separator />}
{(buckets ?? []).map((bucket) => (
<p
key={bucket.name}
title={bucket.name}
className="text-sm text-foreground-light px-4 hover:text-foreground transition cursor-pointer"
onClick={() => snap.setActiveDocsSection([item.key, bucket.name])}
>
{bucket.name}
</p>
))}
</>
)}
{item.key === 'edge-functions' && (
<>
{(edgeFunctions ?? []).length > 0 && <Separator />}
{(edgeFunctions ?? []).map((fn) => (
<p
key={fn.name}
title={fn.name}
className="text-sm text-foreground-light px-4 hover:text-foreground transition cursor-pointer"
onClick={() => snap.setActiveDocsSection([item.key, fn.name])}
>
{fn.name}
</p>
))}
</>
)}
</div>
)}
</Fragment>
)
})}
</div>
<div className="px-2 py-4 border-b">
<Button
block
asChild
type="text"
size="small"
icon={
<SVG
src={`${BASE_PATH}/img/graphql.svg`}
style={{ width: `${16}px`, height: `${16}px` }}
className="text-foreground"
preProcessor={(code) => code.replace(/svg/, 'svg class="m-auto text-color-inherit"')}
/>
}
onClick={() => snap.setShowProjectApiDocs(false)}
>
<Link className="!justify-start" href={`/project/${ref}/api/graphiql`}>
GraphiQL
</Link>
</Button>
<Button block asChild type="text" size="small" icon={<BookOpen />}>
<Link
href={`${DOCS_URL}/guides/graphql`}
target="_blank"
rel="noreferrer"
className="!justify-start"
>
GraphQL guide
</Link>
</Button>
</div>
<div className="px-2 py-4">
<Button block asChild type="text" size="small" icon={<Book />}>
<Link href={`${DOCS_URL}`} target="_blank" rel="noreferrer" className="!justify-start">
Documentation
</Link>
</Button>
<Button block asChild type="text" size="small" icon={<BookOpen />}>
<Link
href={`${DOCS_URL}/guides/api`}
target="_blank"
rel="noreferrer"
className="!justify-start"
>
REST guide
</Link>
</Button>
</div>
</>
)
}
export default FirstLevelNav