Skip to content

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

fix(docs): codetabs file tabs (#50811)

Anthony Lio12a1fd542790
diff --git a/apps/docs/features/directives/CodeSample.client.tsx b/apps/docs/features/directives/CodeSample.client.tsx
index 9e39a2c1701..8e6f2c15a9f 100644
--- a/apps/docs/features/directives/CodeSample.client.tsx
+++ b/apps/docs/features/directives/CodeSample.client.tsx
@@ -1,10 +1,49 @@
'use client'
import Link from 'next/link'
-import { useState, type PropsWithChildren } from 'react'
-import { DropdownMenu, DropdownMenuContent, DropdownMenuItem, DropdownMenuTrigger } from 'ui'
+import { type PropsWithChildren, type ReactNode } from 'react'
+import {
+ cn,
+ DropdownMenu,
+ DropdownMenuContent,
+ DropdownMenuItem,
+ DropdownMenuTrigger,
+ IconGitHubSolid,
+} from 'ui'
import { Admonition } from 'ui-patterns/Admonition'
+interface CodeSampleWrapperProps {
+ source: string | URL | (string | URL)[]
+}
+
+interface MultipleSourcesProps {
+ sources: (string | URL)[]
+}
+
+interface SingleSourceProps {
+ source: string | URL
+}
+
+interface SourceFrameProps {
+ footer: ReactNode
+}
+
+const SOURCE_FOOTER_CLASSES = cn(
+ 'not-prose absolute right-0 bottom-0 z-1 flex h-8 w-29.25 items-center gap-2 px-3 whitespace-nowrap',
+ 'text-xs text-foreground-lighter no-underline transition-colors hover:text-foreground',
+ 'focus-inset rounded-md'
+)
+
+const SOURCE_NOTCH_OUTLINE =
+ 'M0 39.5A7.5 7.5 0 0 0 7.5 32V16A8.5 8.5 0 0 1 16 7.5H117A7.5 7.5 0 0 0 124.5 0'
+
+const SOURCE_NOTCH_FOCUS_RING = 'M0 41A9 9 0 0 0 9 32V16A7 7 0 0 1 16 9H117A9 9 0 0 0 126 0'
+
+const getSourcePath = (source: string | URL): string => {
+ const [, org, repo, , , ...path] = new URL(source).pathname.split('/')
+ return `${org}/${repo}/${path.join('/')}`
+}
+
export function CodeSampleDummy() {
return (
<Admonition type="caution" title="Local development warning">
@@ -21,7 +60,7 @@ export function CodeSampleWrapper({
* A GitHub URL to the source code file.
*/
source: _source,
-}: PropsWithChildren<{ source: string | URL | (string | URL)[] }>) {
+}: PropsWithChildren<CodeSampleWrapperProps>) {
const source = Array.isArray(_source) ? _source : [_source]
if (source.length === 1) {
@@ -35,46 +74,78 @@ export function CodeSampleWrapper({
return <>{children}</>
}
-function MultipleSources({ children, sources }: PropsWithChildren<{ sources: (string | URL)[] }>) {
+function MultipleSources({ children, sources }: PropsWithChildren<MultipleSourcesProps>) {
return (
- <>
+ <SourceFrame
+ footer={
+ <DropdownMenu>
+ <DropdownMenuTrigger asChild>
+ <button tabIndex={0} className={SOURCE_FOOTER_CLASSES}>
+ <IconGitHubSolid size={14} aria-hidden />
+ View source
+ </button>
+ </DropdownMenuTrigger>
+ <DropdownMenuContent align="start">
+ {sources.map((source) => (
+ <DropdownMenuItem
+ key={source.toString()}
+ onSelect={() => window.open(source.toString(), '_blank', 'noopener noreferrer')}
+ >
+ {getSourcePath(source)}
+ </DropdownMenuItem>
+ ))}
+ </DropdownMenuContent>
+ </DropdownMenu>
+ }
+ >
{children}
- <DropdownMenu>
- <DropdownMenuTrigger asChild>
- <button
- tabIndex={0}
- className="block -mt-4 mb-4 ml-auto text-foreground-lighter text-sm focus-visible:outline-hidden focus-visible:underline"
- >
- View sources
- </button>
- </DropdownMenuTrigger>
- <DropdownMenuContent align="end">
- {sources.map((source) => (
- <DropdownMenuItem
- key={source.toString()}
- onSelect={() => window.open(source.toString(), '_blank', 'noopener noreferrer')}
- >
- ...{source.toString().split('/').slice(-2).join('/')}
- </DropdownMenuItem>
- ))}
- </DropdownMenuContent>
- </DropdownMenu>
- </>
+ </SourceFrame>
)
}
-function SingleSource({ children, source }: PropsWithChildren<{ source: string | URL }>) {
+function SingleSource({ children, source }: PropsWithChildren<SingleSourceProps>) {
return (
- <>
+ <SourceFrame
+ footer={
+ <Link
+ href={source.toString()}
+ target="_blank"
+ rel="noopener noreferrer"
+ className={SOURCE_FOOTER_CLASSES}
+ >
+ <IconGitHubSolid size={14} aria-hidden />
+ View source
+ </Link>
+ }
+ >
{children}
- <Link
- href={source.toString()}
- target="_blank"
- rel="noopener noreferrer"
- className="block -mt-5 mb-4 text-right no-underline text-foreground-lighter text-sm"
+ </SourceFrame>
+ )
+}
+
+function SourceFrame({ children, footer }: PropsWithChildren<SourceFrameProps>) {
+ return (
+ <div className="group/source code-sample-source shiki-wrapper relative w-full [&_.shiki]:pb-8 [&_.shiki]:shadow-none!">
+ <div className="codeblock-drop-shadow relative has-[.code-scroll:focus-visible]:z-1">
+ {children}
+ </div>
+ <svg
+ aria-hidden
+ width="125"
+ height="40"
+ viewBox="0 0 125 40"
+ fill="none"
+ className="pointer-events-none absolute right-0 bottom-0 z-1 overflow-visible"
>
- View source
- </Link>
- </>
+ <path d={SOURCE_NOTCH_OUTLINE} className="stroke-background-200" />
+ <path d={SOURCE_NOTCH_OUTLINE} className="stroke-border" />
+ <path
+ d={SOURCE_NOTCH_FOCUS_RING}
+ strokeWidth={2}
+ className="hidden stroke-ring group-has-[.code-scroll:focus-visible]/source:inline"
+ />
+ </svg>
+ {footer}
+ </div>
)
}
diff --git a/apps/docs/features/directives/CodeTabs.components.tsx b/apps/docs/features/directives/CodeTabs.components.tsx
index 3dd9e429743..21ee142894e 100644
--- a/apps/docs/features/directives/CodeTabs.components.tsx
+++ b/apps/docs/features/directives/CodeTabs.components.tsx
@@ -1,5 +1,10 @@
-import { type PropsWithChildren } from 'react'
-import { cn } from 'ui'
+import { Children, isValidElement, type PropsWithChildren } from 'react'
+import { cn, TabsIndicator, TabsList, Tabs as TabsRoot, TabsTrigger } from 'ui'
+
+interface CodeTabPanelProps {
+ id: string
+ label?: string
+}
export function NamedCodeBlock({ name, children }: PropsWithChildren<{ name: string }>) {
return (
@@ -14,7 +19,9 @@ export function NamedCodeBlock({ name, children }: PropsWithChildren<{ name: str
className={cn(
'relative z-1 -mb-px flex w-fit items-center px-3 py-2',
'rounded-t-lg border border-b-0 border-default bg-200',
- 'text-xs text-foreground'
+ 'text-xs text-foreground',
+ 'after:absolute after:bottom-0 after:-right-2 after:size-2',
+ 'after:bg-(image:--tab-flare-right)'
)}
>
{name}
@@ -23,3 +30,53 @@ export function NamedCodeBlock({ name, children }: PropsWithChildren<{ name: str
</div>
)
}
+
+export function CodeTabs({ children }: PropsWithChildren) {
+ const tabs = Children.toArray(children).filter(isValidElement<CodeTabPanelProps>)
+
+ return (
+ <TabsRoot
+ defaultValue={tabs[0]?.props.id}
+ className="group/code-tabs shiki-wrapper w-full isolate [&_.shiki]:my-0!"
+ >
+ <TabsList
+ className={cn(
+ 'not-prose relative z-1 -mb-px border-b-0 overflow-x-auto no-scrollbar has-focus-visible:z-2',
+ 'has-[[data-tab-indicator]]:after:hidden'
+ )}
+ >
+ {tabs.map((tab) => (
+ <TabsTrigger
+ key={tab.props.id}
+ value={tab.props.id}
+ className="relative z-1 rounded-md py-2 text-xs data-[state=active]:shadow-none"
+ >
+ <span className="px-3">{tab.props.label ?? tab.props.id}</span>
+ </TabsTrigger>
+ ))}
+ <TabsIndicator
+ className={cn(
+ 'top-0 h-auto rounded-t-lg border border-b-0 border-default bg-200',
+ 'before:absolute before:bottom-0 before:-left-2 before:size-2',
+ 'before:transition-opacity before:duration-150 before:ease-move motion-reduce:before:transition-none',
+ 'group-has-[[role=tab]:first-child[data-state=active]]/code-tabs:before:opacity-0',
+ 'before:bg-(image:--tab-flare-left)',
+ 'after:absolute after:bottom-0 after:-right-2 after:size-2',
+ 'after:bg-(image:--tab-flare-right)'
+ )}
+ />
+ </TabsList>
+ <span aria-hidden className="relative z-1 block h-0">
+ <span
+ className={cn(
+ 'absolute left-0 top-0 size-2 border-l border-default bg-200 opacity-0',
+ 'transition-opacity duration-150 ease-move motion-reduce:transition-none',
+ 'group-has-[[role=tab]:first-child[data-state=active]]/code-tabs:opacity-100',
+ 'group-has-[[role=tab]:first-child[data-state=active]]/code-tabs:duration-400'
+ )}
+ />
+ </span>
+ {children}
+ </TabsRoot>
+ )
+}
diff --git a/apps/docs/features/directives/CodeTabs.test.ts b/apps/docs/features/directives/CodeTabs.test.ts
index c69d8199be5..fec4eac5a58 100644
--- a/apps/docs/features/directives/CodeTabs.test.ts
+++ b/apps/docs/features/directives/CodeTabs.test.ts
@@ -6,7 +6,7 @@ import { codeTabsRemark } from './CodeTabs'
import { fromDocsMarkdown } from './utils.server'
describe('CodeTabs', () => {
- it('should wrap code blocks in Tabs and TabPanel', () => {
+ it('should wrap code blocks in CodeTabs and TabPanel', () => {
const mdx = `
<$CodeTabs>
@@ -26,7 +26,7 @@ console.log('Hello, world!');
expect(output).toEqual(
`
-<Tabs listClassNames="flex-nowrap overflow-x-auto -mb-6">
+<CodeTabs>
<TabPanel id="a.js" label="a.js">
\`\`\`js name=a.js
console.log('Hello, world!');
@@ -38,7 +38,7 @@ console.log('Hello, world!');
console.log('Hello, world!');
\`\`\`
</TabPanel>
-</Tabs>
+</CodeTabs>
`.trimStart()
)
})
diff --git a/apps/docs/features/directives/CodeTabs.ts b/apps/docs/features/directives/CodeTabs.ts
index 6fc79271f70..dcbda7aa5fc 100644
--- a/apps/docs/features/directives/CodeTabs.ts
+++ b/apps/docs/features/directives/CodeTabs.ts
@@ -85,14 +85,8 @@ function replaceCodeTabs(node: MdxJsxFlowElement, ancestors: Array<Parent>) {
)
const tabsWrapper: MdxJsxFlowElement = {
type: 'mdxJsxFlowElement',
- name: 'Tabs',
- attributes: [
- {
- type: 'mdxJsxAttribute',
- name: 'listClassNames',
- value: 'flex-nowrap overflow-x-auto -mb-6',
- },
- ],
+ name: 'CodeTabs',
+ attributes: [],
children: remappedChildren,
}
diff --git a/apps/docs/features/docs/MdxBase.shared.tsx b/apps/docs/features/docs/MdxBase.shared.tsx
index 3e52104405c..2fcdd21c165 100644
--- a/apps/docs/features/docs/MdxBase.shared.tsx
+++ b/apps/docs/features/docs/MdxBase.shared.tsx
@@ -24,7 +24,7 @@ import Table from '~/components/Table'
import { TerraformProviderSchema } from '~/components/TerraformProviderSchema'
import { WrapperDashboardIntegration } from '~/components/WrapperDashboardIntegration'
import { CodeSampleDummy, CodeSampleWrapper } from '~/features/directives/CodeSample.client'
-import { NamedCodeBlock } from '~/features/directives/CodeTabs.components'
+import { CodeTabs, NamedCodeBlock } from '~/features/directives/CodeTabs.components'
import { MdxAnchor } from '~/features/docs/MdxAnchor'
import { Accordion, AccordionItem } from '~/features/ui/Accordion'
import { CodeBlock } from '~/features/ui/CodeBlock/CodeBlock'
@@ -87,6 +87,7 @@ const components = {
ButtonCard,
CodeSampleDummy,
CodeSampleWrapper,
+ CodeTabs,
ComputeDiskLimitsTable,
CustomContent,
ContentListings,
diff --git a/apps/docs/features/ui/CodeBlock/CodeBlock.tsx b/apps/docs/features/ui/CodeBlock/CodeBlock.tsx
index 538a2dea08b..5c19b28757a 100644
--- a/apps/docs/features/ui/CodeBlock/CodeBlock.tsx
+++ b/apps/docs/features/ui/CodeBlock/CodeBlock.tsx
@@ -59,7 +59,8 @@ export async function CodeBlock({
className={cn(
'shiki',
'group',
- 'relative',
+ 'relative has-[.code-scroll:focus-visible]:z-1',
+ 'has-[.code-scroll:focus-visible]:outline-2 has-[.code-scroll:focus-visible]:outline-ring',
'not-prose',
'w-full',
compact ? 'border-0 my-0!' : 'border border-default rounded-lg shadow-codeblock',
@@ -73,7 +74,7 @@ export async function CodeBlock({
'code-scroll',
'w-full overflow-x-auto overscroll-x-none',
!compact && 'rounded-lg',
- 'focus-visible:outline-hidden focus-visible:ring-2 focus-visible:ring-ring'
+ 'focus-visible:outline-hidden'
)}
role="group"
aria-roledescription="code block"
diff --git a/apps/docs/styles/code-block.css b/apps/docs/styles/code-block.css
index b70345df653..7db2cf9c248 100644
--- a/apps/docs/styles/code-block.css
+++ b/apps/docs/styles/code-block.css
@@ -12,7 +12,7 @@
}
/* Code blocks need margin applied when in content container */
-.prose :where(.shiki:not(.shiki-wrapper *), .shiki-wrapper) {
+.prose :where(.shiki, .shiki-wrapper):where(:not(.shiki-wrapper *)) {
margin-block: 2rem;
}
@@ -35,6 +35,7 @@
--code-highlight-color: #232323;
--shadow-codeblock:
0 0 0 0 var(--border-default), 0 1px 2px 0 rgba(0, 0, 0, 0.3), 0 1px 3px 0 rgba(0, 0, 0, 0.3);
+ --drop-shadow-codeblock: drop-shadow(0 1px 1px rgba(0, 0, 0, 0.5));
}
[data-theme='light'],
.light {
@@ -111,3 +112,29 @@
.shadow-codeblock {
box-shadow: var(--shadow-codeblock, none);
}
+
+.shiki-wrapper {
+ --tab-flare-ring:
+ transparent 6.75px, var(--border-color-default) 7.25px, var(--border-color-default) 7.75px,
+ transparent 8.25px;
+ --tab-flare-fill: transparent 6.75px, var(--background-color-200) 7.25px;
+ --tab-flare-left:
+ radial-gradient(circle at 0 0, var(--tab-flare-ring)),
+ radial-gradient(circle at 0 0, var(--tab-flare-fill));
+ --tab-flare-right:
+ radial-gradient(circle at 100% 0, var(--tab-flare-ring)),
+ radial-gradient(circle at 100% 0, var(--tab-flare-fill));
+}
+
+.codeblock-drop-shadow {
+ filter: var(--drop-shadow-codeblock, none);
+}
+
+.code-sample-source .shiki {
+ mask:
+ linear-gradient(#000 0 0),
+ url("data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' width='127' height='42'%3E%3Cpath d='M0 40A8 8 0 0 0 8 32V16A8 8 0 0 1 16 8H117A8 8 0 0 0 125 0H127V42H0Z'/%3E%3C/svg%3E")
+ right -2px bottom -2px / 127px 42px no-repeat;
+ mask-composite: exclude;
+ mask-clip: no-clip;
+}
diff --git a/apps/www/components/CodeTabs/CodeTabs.components.tsx b/apps/www/components/CodeTabs/CodeTabs.components.tsx
deleted file mode 100644
index 3e0dc5ba46e..00000000000
--- a/apps/www/components/CodeTabs/CodeTabs.components.tsx
+++ /dev/null
@@ -1,21 +0,0 @@
-import type { PropsWithChildren } from 'react'
-
-import { cn } from 'ui'
-
-export function NamedCodeBlock({ name, children }: PropsWithChildren<{ name: string }>) {
- return (
- <div className="shiki-wrapper w-full space-y-2">
- <h6
- className={cn(
- 'w-fit flex items-center text-center',
- 'shadow-xs rounded-sm border border-stronger bg-selection',
- 'px-2.5 py-1',
- 'text-xs text-foreground'
- )}
- >
- {name}
- </h6>
- {children}
- </div>
- )
-}
diff --git a/apps/www/components/CodeTabs/index.ts b/apps/www/components/CodeTabs/index.ts
index 3366febfa06..15d81c21c0c 100644
--- a/apps/www/components/CodeTabs/index.ts
+++ b/apps/www/components/CodeTabs/index.ts
@@ -1,2 +1 @@
-export { NamedCodeBlock } from './CodeTabs.components'
export { preprocessMdxWithCodeTabs } from './utils'
diff --git a/apps/www/lib/mdx/mdxComponents.tsx b/apps/www/lib/mdx/mdxComponents.tsx
index c35930d122e..a906ee369e6 100644
--- a/apps/www/lib/mdx/mdxComponents.tsx
+++ b/apps/www/lib/mdx/mdxComponents.tsx
@@ -18,7 +18,6 @@ import BlogCollapsible from '~/components/Blog/BlogCollapsible'
import DeveloperGrowthChart from '~/components/Charts/DeveloperGrowthChart'
import Chart from '~/components/Charts/PGCharts'
import CodeBlock from '~/components/CodeBlock/CodeBlock'
-import { NamedCodeBlock } from '~/components/CodeTabs'
import ImageFadeStack from '~/components/ImageFadeStack'
import ImageGrid from '~/components/ImageGrid'
import InlineCodeTag from '~/components/InlineCode'
@@ -68,7 +67,6 @@ export default function mdxComponents(type?: 'blog' | 'lp' | undefined) {
CodeBlock,
Tabs,
TabPanel,
- NamedCodeBlock,
CH,
h1: (props: any) => <Heading {...props} tag="h1" />,
h2: (props: any) => <Heading {...props} tag="h2" />,