The Postgres development platform. Supabase gives you a dedicated Postgres database to build your web, mobile, and AI applications.
TypeScript aialternativeauthdatabasedenoembeddingsexamplefirebasenextjsoauth2pgvectorpostgispostgrespostgresqlpostgrestrealtimesupabasevectorswebsockets
fix(docs): guides sidebar a11y elements (#49942)
Anthony Liobdd4b8d36946
diff --git a/apps/docs/components/Navigation/NavigationMenu/NavigationMenuGuideListItems.tsx b/apps/docs/components/Navigation/NavigationMenu/NavigationMenuGuideListItems.tsxindex 3e26b1f62ff..89b64e78b9d 100644--- a/apps/docs/components/Navigation/NavigationMenu/NavigationMenuGuideListItems.tsx+++ b/apps/docs/components/Navigation/NavigationMenu/NavigationMenuGuideListItems.tsx@@ -43,9 +43,10 @@ const ContentAccordionLink = React.memo(function ContentAccordionLink(props: anyconst { resolvedTheme } = useTheme()const activeItem = props.subItem.url === pathnameconst activeItemRef = useRef<HTMLLIElement>(null)+ const hasChildren = props.subItem.items && props.subItem.items.length > 0const isChildActive =- props.subItem.items &&+ hasChildren &&props.subItem.items.some((child: NavAccordionItem) => hasActiveDescendant(child, pathname))const LinkContainer = (props) => {@@ -73,16 +74,8 @@ const ContentAccordionLink = React.memo(function ContentAccordionLink(props: any}})return (- <>- {props.subItemIndex === 0 && (- <>- <div className="h-px w-full bg-border my-3"></div>- <span className="font-mono text-xs uppercase text-foreground font-medium tracking-wider">- {props.parent.name}- </span>- </>- )}- {props.subItem.items && props.subItem.items.length > 0 ? (+ <li ref={!hasChildren && activeItem ? activeItemRef : null}>+ {hasChildren ? (<Accordion.Rootcollapsibletype="single"@@ -115,67 +108,60 @@ const ContentAccordionLink = React.memo(function ContentAccordionLink(props: any</span></Accordion.Trigger><Accordion.Content className="transition data-open:animate-slide-down data-closed:animate-slide-up ml-2">- {props.subItem.items- .filter((subItem) => subItem.enabled !== false)- .map((subSubItem) => {- if (subSubItem.items && subSubItem.items.length > 0) {+ <ul>+ {props.subItem.items+ .filter((subItem) => subItem.enabled !== false)+ .map((subSubItem) => {+ if (subSubItem.items && subSubItem.items.length > 0) {+ return <ContentAccordionLink key={subSubItem.name} subItem={subSubItem} />+ }+return (- <ContentAccordionLink- key={subSubItem.name}- subItem={subSubItem}- subItemIndex={-1}- parent={props.subItem}- />+ <li key={`${props.subItem.name}-${subSubItem.url}`}>+ <Link+ href={`${subSubItem.url}`}+ className={[+ 'cursor-pointer transition text-sm',+ subSubItem.url === pathname+ ? 'text-brand-link'+ : 'hover:text-brand-link text-foreground-lighter',+ ].join(' ')}+ >+ {subSubItem.name}+ </Link>+ </li>)- }-- return (- <li key={`${props.subItem.name}-${subSubItem.url}`}>- <Link- href={`${subSubItem.url}`}- className={[- 'cursor-pointer transition text-sm',- subSubItem.url === pathname- ? 'text-brand-link'- : 'hover:text-brand-link text-foreground-lighter',- ].join(' ')}- >- {subSubItem.name}- </Link>- </li>- )- })}+ })}+ </ul></Accordion.Content></Accordion.Item></Accordion.Root>) : (- <li key={props.subItem.name} ref={activeItem ? activeItemRef : null}>- <LinkContainer- url={props.subItem.url}- className={[- 'flex items-center gap-2',- 'cursor-pointer transition text-sm',- activeItem- ? 'text-brand-link font-medium'- : 'hover:text-foreground text-foreground-lighter',- ].join(' ')}- parent={props.subItem.parent}- >- <div className="flex items-center gap-2">- {props.subItem.icon && (- <Image- alt={props.subItem.name}- src={`${props.subItem.icon}${!resolvedTheme?.includes('dark') ? '-light' : ''}.svg`}- width={15}- height={15}- />- )}- {props.subItem.name}- </div>- </LinkContainer>- </li>+ <LinkContainer+ url={props.subItem.url}+ className={[+ 'flex items-center gap-2',+ 'cursor-pointer transition text-sm',+ activeItem+ ? 'text-brand-link font-medium'+ : 'hover:text-foreground text-foreground-lighter',+ ].join(' ')}+ parent={props.subItem.parent}+ >+ <div className="flex items-center gap-2">+ {props.subItem.icon && (+ <Image+ alt={props.subItem.name}+ src={`${props.subItem.icon}${!resolvedTheme?.includes('dark') ? '-light' : ''}.svg`}+ width={15}+ height={15}+ />+ )}+ {props.subItem.name}+ </div>+ </LinkContainer>)}- </>+ </li>)})@@ -210,7 +196,7 @@ const Content = (props) => {}return (- <ul className={['relative w-full flex flex-col gap-0 pb-5'].join(' ')}>+ <div className="relative w-full flex flex-col gap-0 pb-5"><Link href={menu.url ?? ''}><div className="flex items-center gap-3 my-3 text-brand-link"><MenuIconPicker icon={menu.icon} />@@ -218,33 +204,35 @@ const Content = (props) => {</div></Link>- {menu.items- .filter((item) => item.enabled !== false)- .map((x) => {- return (- <div key={x.name}>- {x.items && x.items.length > 0 ? (+ <ul data-testid="docs-guide-navigation-list" className="flex flex-col gap-0">+ {menu.items.map((x) => {+ if (x.enabled === false) return null++ if (x.items && x.items.length > 0) {+ const enabledItems = x.items.filter((item) => item.enabled !== false)+ if (enabledItems.length === 0) return null++ return (+ <li key={x.name}><div className="flex flex-col gap-2.5">- {x.items- .filter((item) => item.enabled !== false)- .map((subItem, subItemIndex) => {- return (- <ContentAccordionLink- key={subItem.name}- subItem={subItem}- subItemIndex={subItemIndex}- parent={x}- />- )+ <div className="h-px w-full bg-border my-3"></div>+ <span className="font-mono text-xs uppercase text-foreground font-medium tracking-wider">+ {x.name}+ </span>+ <ul className="flex flex-col gap-2.5">+ {enabledItems.map((subItem) => {+ return <ContentAccordionLink key={subItem.name} subItem={subItem} />})}+ </ul></div>- ) : x.url ? (- <ContentLink url={x.url} icon={x.icon} name={x.name} key={x.name} />- ) : null}- </div>- )+ </li>+ )+ }++ return x.url ? <ContentLink url={x.url} icon={x.icon} name={x.name} key={x.name} /> : null})}- </ul>+ </ul>+ </div>)}diff --git a/e2e/docs/utils/resolve-docs-scope.test.ts b/e2e/docs/utils/resolve-docs-scope.test.tsnew file mode 100644index 00000000000..15eadef1560--- /dev/null+++ b/e2e/docs/utils/resolve-docs-scope.test.ts@@ -0,0 +1,31 @@+import assert from 'node:assert/strict'+import test from 'node:test'+import { fileURLToPath } from 'node:url'++import {+ GUIDE_LIST_COMPONENT,+ GUIDE_LIST_COMPONENT_PAGES,+ resolveDocsScope,+} from './resolve-docs-scope.ts'++const repoRoot = fileURLToPath(new URL('../../..', import.meta.url))++test('maps a guide list component change to its sample pages', async () => {+ const result = await resolveDocsScope({+ changedFiles: [GUIDE_LIST_COMPONENT],+ repoRoot,+ })++ assert.deepEqual(result.pages, [...GUIDE_LIST_COMPONENT_PAGES].sort())+ assert.equal(result.skip, false)+})++test('ignores unrelated docs component changes', async () => {+ const result = await resolveDocsScope({+ changedFiles: ['apps/docs/components/Navigation/NavigationMenu/NavigationMenu.constants.ts'],+ repoRoot,+ })++ assert.deepEqual(result.pages, [])+ assert.equal(result.skip, true)+})diff --git a/e2e/docs/utils/resolve-docs-scope.ts b/e2e/docs/utils/resolve-docs-scope.tsindex 2c5325cbac9..1a5f66ba488 100644--- a/e2e/docs/utils/resolve-docs-scope.ts+++ b/e2e/docs/utils/resolve-docs-scope.ts@@ -19,6 +19,14 @@ const PARTIALS_PREFIX = 'apps/docs/content/_partials/'const DOCS_GUIDES_URL_PREFIX = '/docs/guides/'const DOCS_TROUBLESHOOTING_URL_PREFIX = '/docs/guides/troubleshooting/'const FEDERATED_CONTENT_SOURCES_DIR = 'apps/docs/scripts/federated-content/sources'+export const GUIDE_LIST_COMPONENT =+ 'apps/docs/components/Navigation/NavigationMenu/NavigationMenuGuideListItems.tsx'++export const GUIDE_LIST_COMPONENT_PAGES = [+ '/docs/guides/getting-started/api-keys',+ '/docs/guides/getting-started/quickstarts/nextjs',+ '/docs/guides/integrations/build-a-supabase-oauth-integration/oauth-scopes',+]const PARTIAL_PATH_RE = /<\$Partial\b[\s\S]*?\bpath\s*=\s*"([^"]+)"[\s\S]*?\/?>/gconst SOURCE_SECTION_RE = /\bsection:\s*'([^']+)'/g@@ -246,9 +254,15 @@ export async function resolveDocsScope(const maxPages = options.maxPages ?? MAX_SCOPED_PAGESconst pages = new Set<string>()+ const requiredPages = new Set<string>()const changedPartials: string[] = []for (const file of options.changedFiles) {+ if (normalizeRepoPath(file) === GUIDE_LIST_COMPONENT) {+ for (const page of GUIDE_LIST_COMPONENT_PAGES) requiredPages.add(page)+ continue+ }+const page = changedFileToPagePath(file)if (page) {pages.add(page)@@ -271,7 +285,13 @@ export async function resolveDocsScope(}}- const sorted = [...pages].sort().slice(0, maxPages)+ const selectedRequiredPages = [...requiredPages].sort().slice(0, maxPages)+ const remainingSlots = Math.max(0, maxPages - selectedRequiredPages.length)+ const selectedPages = [...pages]+ .filter((page) => !requiredPages.has(page))+ .sort()+ .slice(0, remainingSlots)+ const sorted = [...selectedRequiredPages, ...selectedPages].sort()return {pages: sorted,