Files
supabase/studio/components/interfaces/ProjectAPIDocs/FirstLevelNav.tsx
T
Joshen LimandTerry Sutton 94f5fc5a61 Feat/api side panel (#17880)
* Demo api side panel

* Add docs for storage and edge functions

* Add content

* fix

* Add scroll to logic

* Add storage docs

* Add docs URLs

* Add connecting to project section in getting started

* Link back to docs site for product + resource specific docs

* Add entry points into API side panel for table editor, auth users and storage

* Add entry points into API side panel for edge functions

* Beef up feature preview modal with content

* Fix asset path

* Address several feedback

* Addressing more feedback

* Shift GraphiQL page to database if new api docs flag enabled

* Spelling

* Wording changes

* Spacing and wording

* Fix small issues

* Fix

* Update key showing toggle button

---------

Co-authored-by: Terry Sutton <saltcod@gmail.com>
2023-10-05 13:30:12 +08:00

148 lines
5.7 KiB
TypeScript

import { useParams } from 'common'
import Link from 'next/link'
import { Fragment } from 'react'
import { Button, IconBook, IconBookOpen } from 'ui'
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 { useAppStateSnapshot } from 'state/app-state'
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 { 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">
{DOCS_MENU.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-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-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-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-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-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">
<Link passHref href="https://supabase.com/docs">
<Button block asChild type="text" size="small" icon={<IconBook />}>
<a target="_blank" rel="noreferrer" className="!justify-start">
Documentation
</a>
</Button>
</Link>
<Link passHref href="https://supabase.com/docs/guides/api">
<Button block asChild type="text" size="small" icon={<IconBookOpen />}>
<a target="_blank" rel="noreferrer" className="!justify-start">
API Reference
</a>
</Button>
</Link>
</div>
</>
)
}
export default FirstLevelNav