mirror of
https://github.com/supabase/supabase.git
synced 2026-10-06 09:55:06 +03:00
## What kind of change does this PR introduce? bug fix + some ui polish on the docs code block ## What is the current behavior? line numbers scroll away with the code _ so you lose your place in any block wide enough to scroll _ the gutter is also see-through so scrolled code renders interleaved with the numbers ## What is the new behavior? - makes gutter sticky and stays pinned while the code scrolls (no rubber) - fixes gutter, row hover, and button backgrounds as opaque so nothing bleeds through - adds gutter right edge fades vs bg - adds right padding so line endings clear the buttons - adds press feedback on the shared in-house `Button` gated behind `motion-safe` | state | preview | | -------|------| | before | <img width="566" height="263" alt="image" src="https://github.com/user-attachments/assets/81778815-1f15-4ea5-a647-ed48418210e8" /> | | after | <img width="566" height="259" alt="image" src="https://github.com/user-attachments/assets/b7d770c5-4156-491f-93c8-b0d900b7dc85" /> | <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **UI Improvements** * Refined code block controls with consistent styling, active states, animated icons, and automatic copy-status reset. * Improved code block line-number presentation with hover effects, sticky gutters, spacing, shadows, and smoother horizontal scrolling. * Added smoother button transitions and a subtle pressed-state animation. * Respect reduced-motion preferences by disabling icon animations when requested. <!-- end of auto-generated comment: release notes by coderabbit.ai -->
224 lines
6.5 KiB
TypeScript
224 lines
6.5 KiB
TypeScript
'use client'
|
|
|
|
import { ArrowRightFromLine, Check, Copy, WrapText, type LucideIcon } from 'lucide-react'
|
|
import { useCallback, useEffect, useRef, useState, type MouseEvent } from 'react'
|
|
import { type ThemedToken } from 'shiki'
|
|
import { type NodeHover } from 'twoslash'
|
|
import { Button, cn, copyToClipboard, Tooltip, TooltipContent, TooltipTrigger } from 'ui'
|
|
|
|
export function AnnotatedSpan({
|
|
token,
|
|
annotations,
|
|
}: {
|
|
token: ThemedToken
|
|
annotations: Array<NodeHover>
|
|
}) {
|
|
const [open, setOpen] = useState(false)
|
|
|
|
const [isTouchDevice, setIsTouchDevice] = useState(false)
|
|
useEffect(() => {
|
|
const touchDevice = !window.matchMedia('(pointer: fine)').matches
|
|
setIsTouchDevice(touchDevice)
|
|
}, [])
|
|
|
|
const handleClick = useCallback(
|
|
(evt: MouseEvent) => {
|
|
if (isTouchDevice) {
|
|
evt.preventDefault()
|
|
evt.stopPropagation()
|
|
setOpen((open) => !open)
|
|
}
|
|
},
|
|
[isTouchDevice]
|
|
)
|
|
const onOpenChange = useCallback(
|
|
(open: boolean) => {
|
|
if (!isTouchDevice || !open) {
|
|
setOpen(open)
|
|
}
|
|
},
|
|
[isTouchDevice]
|
|
)
|
|
|
|
return (
|
|
<Tooltip open={open} onOpenChange={onOpenChange}>
|
|
<TooltipTrigger asChild onClick={handleClick}>
|
|
<button
|
|
tabIndex={0}
|
|
style={token.htmlStyle}
|
|
className={cn(
|
|
isTouchDevice &&
|
|
'underline underline-offset-4 decoration-dashed decoration-[rgba(from_currentColor_r_g_b/0.5)]'
|
|
)}
|
|
>
|
|
{token.content}
|
|
</button>
|
|
</TooltipTrigger>
|
|
<TooltipContent className="max-w-[min(80vw,400px)] p-0 divide-y">
|
|
{annotations.map((annotation, idx) => (
|
|
<Annotation key={idx} annotation={annotation} />
|
|
))}
|
|
</TooltipContent>
|
|
</Tooltip>
|
|
)
|
|
}
|
|
|
|
function Annotation({ annotation }: { annotation: NodeHover }) {
|
|
const { text, docs, tags } = annotation
|
|
return (
|
|
<div className="flex flex-col gap-2">
|
|
<code className={cn('block bg-200 p-2', (docs || tags) && 'border-b border-default')}>
|
|
{text}
|
|
</code>
|
|
{docs && <p className={cn('p-2', tags && 'border-b border-default')}>{docs}</p>}
|
|
{tags && (
|
|
<div className="p-2 flex flex-col">
|
|
{tags.map((tag, idx) => {
|
|
return (
|
|
<span key={idx}>
|
|
<code>@{tag[0]}</code> {tag[1]}
|
|
</span>
|
|
)
|
|
})}
|
|
</div>
|
|
)}
|
|
</div>
|
|
)
|
|
}
|
|
|
|
function CrossfadeIcon({
|
|
active,
|
|
activeIcon: ActiveIcon,
|
|
inactiveIcon: InactiveIcon,
|
|
}: {
|
|
active: boolean
|
|
activeIcon: LucideIcon
|
|
inactiveIcon: LucideIcon
|
|
}) {
|
|
const iconClass = (shown: boolean) =>
|
|
cn(
|
|
'absolute inset-0 m-auto text-lighter group-hover/btn:text-foreground',
|
|
'transition-[opacity,scale,filter,color] duration-300 [transition-timing-function:cubic-bezier(0.2,0,0,1)]',
|
|
'motion-reduce:transition-none',
|
|
shown ? 'opacity-100 scale-100 blur-none' : 'opacity-0 scale-[0.25] blur-[4px]'
|
|
)
|
|
|
|
return (
|
|
<span className="relative block size-3.5">
|
|
<ActiveIcon size={14} aria-hidden="true" className={iconClass(active)} />
|
|
<InactiveIcon size={14} aria-hidden="true" className={iconClass(!active)} />
|
|
</span>
|
|
)
|
|
}
|
|
|
|
export function CodeCopyButton({ className, content }: { className?: string; content: string }) {
|
|
const [copied, setCopied] = useState(false)
|
|
|
|
useEffect(() => {
|
|
if (!copied) return
|
|
|
|
const timeout = window.setTimeout(() => setCopied(false), 2000)
|
|
return () => window.clearTimeout(timeout)
|
|
}, [copied])
|
|
|
|
const handleCopy = async () => {
|
|
copyToClipboard(content, () => {
|
|
setCopied(true)
|
|
})
|
|
}
|
|
|
|
const resetStatus = () => {
|
|
setCopied(false)
|
|
}
|
|
|
|
return (
|
|
<>
|
|
<span className="sr-only" aria-live="polite">
|
|
{copied ? 'Code copied' : ''}
|
|
</span>
|
|
<Tooltip>
|
|
<TooltipTrigger asChild>
|
|
<Button
|
|
variant="outline"
|
|
tabIndex={0}
|
|
onClick={handleCopy}
|
|
onBlur={resetStatus}
|
|
className={cn(
|
|
'group/btn size-6 p-1 cursor-pointer bg-200 hover:border-strong',
|
|
copied && 'bg-[var(--btn-active)]',
|
|
'hover:bg-[var(--btn-active)]',
|
|
className
|
|
)}
|
|
aria-label="Copy code"
|
|
// Tooltip repeats the label; the description would read the name twice
|
|
aria-describedby={undefined}
|
|
>
|
|
<CrossfadeIcon active={copied} activeIcon={Check} inactiveIcon={Copy} />
|
|
</Button>
|
|
</TooltipTrigger>
|
|
<TooltipContent>Copy code</TooltipContent>
|
|
</Tooltip>
|
|
</>
|
|
)
|
|
}
|
|
|
|
export function CodeBlockControls({ content }: { content: string }) {
|
|
const [isWrapped, setIsWrapped] = useState(false)
|
|
// Empty until the first toggle, so nothing is announced on mount
|
|
const [wrapStatus, setWrapStatus] = useState('')
|
|
const wrapperRef = useRef<HTMLDivElement>(null)
|
|
|
|
const toggleWrap = useCallback(() => {
|
|
const newValue = !isWrapped
|
|
setIsWrapped(newValue)
|
|
setWrapStatus(newValue ? 'Word wrap enabled' : 'Word wrap disabled')
|
|
|
|
const codeBlock = wrapperRef.current?.closest('.shiki')
|
|
if (codeBlock) {
|
|
if (newValue) {
|
|
codeBlock.setAttribute('data-wrapped', 'true')
|
|
} else {
|
|
codeBlock.removeAttribute('data-wrapped')
|
|
}
|
|
}
|
|
}, [isWrapped])
|
|
|
|
return (
|
|
<div
|
|
ref={wrapperRef}
|
|
className={cn(
|
|
'opacity-0 flex group-hover:opacity-100 group-focus-within:opacity-100 absolute top-[9.5px] right-[9.5px] gap-1',
|
|
'[--btn-active:color-mix(in_srgb,var(--foreground)_4%,var(--background-200))]'
|
|
)}
|
|
>
|
|
<span className="sr-only" aria-live="polite">
|
|
{wrapStatus}
|
|
</span>
|
|
<Tooltip>
|
|
<TooltipTrigger asChild>
|
|
<Button
|
|
variant="outline"
|
|
tabIndex={0}
|
|
onClick={toggleWrap}
|
|
className={cn(
|
|
'group/btn size-6 p-1 cursor-pointer bg-200 hover:border-strong',
|
|
'hover:bg-[var(--btn-active)]'
|
|
)}
|
|
aria-label={isWrapped ? 'Disable word wrap' : 'Enable word wrap'}
|
|
// Tooltip repeats the label; the description would read the name twice
|
|
aria-describedby={undefined}
|
|
>
|
|
<CrossfadeIcon
|
|
active={isWrapped}
|
|
activeIcon={ArrowRightFromLine}
|
|
inactiveIcon={WrapText}
|
|
/>
|
|
</Button>
|
|
</TooltipTrigger>
|
|
<TooltipContent>{isWrapped ? 'Disable word wrap' : 'Enable word wrap'}</TooltipContent>
|
|
</Tooltip>
|
|
<CodeCopyButton content={content} />
|
|
</div>
|
|
)
|
|
}
|