mirror of
https://github.com/supabase/supabase.git
synced 2026-09-22 13:37:53 +08:00
42f1401769
## What kind of change does this PR introduce? bug fix a11y `ExapndableVideo` ## What is the current behavior? `ExpandableVideo` blurred thumbnail has `alt="Video guide preview"` sitting behind an overlay that already reads "Watch video guide" making screen readers announcing the same thing twice ## What is the new behavior? - adds an optional `videoTitle` prop that names the video once and feeds both the button's `aria-label` and the player's `title`. ## Test 1. visit `/docs/guides/functions` <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit - **Enhancements** - Video previews in guides now display the relevant guide title. - Partner introduction videos now include a descriptive title. - Video controls and embedded players provide more specific accessibility labels when titles are available. - Preview images without meaningful alternative text are treated as decorative to reduce redundant screen-reader output. - **Bug Fixes** - Guide titles with Markdown formatting now appear as clean, readable text in video labels. <!-- end of auto-generated comment: release notes by coderabbit.ai -->
159 lines
4.9 KiB
TypeScript
159 lines
4.9 KiB
TypeScript
'use client'
|
|
|
|
import { Feedback } from '~/components/Feedback'
|
|
import { useSendTelemetryEvent } from '~/lib/telemetry'
|
|
import { askAiUrls, isFeatureEnabled, useCopyMarkdownFromUrl } from 'common'
|
|
import { Chatgpt, Claude } from 'icons'
|
|
import { Check, Copy, Sparkles } from 'lucide-react'
|
|
import Link from 'next/link'
|
|
import { usePathname } from 'next/navigation'
|
|
import { cn } from 'ui'
|
|
import { ExpandableVideo } from 'ui-patterns/ExpandableVideo'
|
|
import { Toc, TOCItems, TOCScrollArea } from 'ui-patterns/Toc'
|
|
|
|
import { useTocAnchors } from '../features/docs/GuidesMdx.state'
|
|
|
|
interface TOCHeader {
|
|
id?: string
|
|
text: string
|
|
link: string
|
|
level: number
|
|
}
|
|
|
|
function AiTools({ className }: { className?: string }) {
|
|
const path = usePathname()
|
|
const sendTelemetryEvent = useSendTelemetryEvent()
|
|
const { copied, copyMarkdown } = useCopyMarkdownFromUrl()
|
|
const urls = askAiUrls(`https://supabase.com/docs${path}`)
|
|
|
|
function handleAgentSetupClick() {
|
|
sendTelemetryEvent({ action: 'agent_setup_clicked' })
|
|
}
|
|
|
|
async function handleCopy() {
|
|
const ok = await copyMarkdown(`/docs${path}.md`, {
|
|
fallback: () => document.getElementById('sb-docs-guide-main-article')?.innerHTML ?? '',
|
|
})
|
|
if (ok) {
|
|
sendTelemetryEvent({ action: 'copy_as_markdown_clicked', properties: { pageType: 'guide' } })
|
|
}
|
|
}
|
|
|
|
return (
|
|
<section className={cn(className)} aria-labelledby="ai-tools-title">
|
|
<h3
|
|
id="ai-tools-title"
|
|
className="block font-mono uppercase text-xs text-foreground-light mb-3"
|
|
>
|
|
AI Tools
|
|
</h3>
|
|
<div className="flex flex-col gap-2">
|
|
<Link
|
|
href="/guides/ai-tools"
|
|
onClick={handleAgentSetupClick}
|
|
className="flex items-center gap-1.5 text-xs text-foreground-lighter hover:text-foreground transition-colors"
|
|
>
|
|
<Sparkles size={14} strokeWidth={1.5} />
|
|
Connect your AI agent
|
|
</Link>
|
|
<button
|
|
tabIndex={0}
|
|
onClick={handleCopy}
|
|
className="flex cursor-pointer items-center gap-1.5 text-xs text-foreground-lighter hover:text-foreground text-left transition-colors"
|
|
>
|
|
{copied ? (
|
|
<Check size={14} strokeWidth={1.5} className="text-brand" aria-hidden />
|
|
) : (
|
|
<Copy size={14} strokeWidth={1.5} aria-hidden />
|
|
)}
|
|
{copied ? 'Copied!' : 'Copy as Markdown'}
|
|
</button>
|
|
<span className="sr-only" role="status">
|
|
{copied ? 'Copied to clipboard' : ''}
|
|
</span>
|
|
<a
|
|
href={urls.chatgpt}
|
|
target="_blank"
|
|
onClick={() =>
|
|
sendTelemetryEvent({
|
|
action: 'ask_ai_clicked',
|
|
properties: { agent: 'chatgpt', pageType: 'guide' },
|
|
})
|
|
}
|
|
rel="noreferrer noopener"
|
|
className="flex items-center gap-1.5 text-xs text-foreground-lighter hover:text-foreground transition-colors"
|
|
>
|
|
<Chatgpt size={14} aria-hidden />
|
|
Ask ChatGPT
|
|
</a>
|
|
<a
|
|
href={urls.claude}
|
|
target="_blank"
|
|
onClick={() =>
|
|
sendTelemetryEvent({
|
|
action: 'ask_ai_clicked',
|
|
properties: { agent: 'claude', pageType: 'guide' },
|
|
})
|
|
}
|
|
rel="noreferrer noopener"
|
|
className="flex items-center gap-1.5 text-xs text-foreground-lighter hover:text-foreground transition-colors"
|
|
>
|
|
<Claude size={14} aria-hidden />
|
|
Ask Claude
|
|
</a>
|
|
</div>
|
|
</section>
|
|
)
|
|
}
|
|
|
|
const GuidesSidebar = ({
|
|
className,
|
|
video,
|
|
videoTitle,
|
|
hideToc,
|
|
}: {
|
|
className?: string
|
|
video?: string
|
|
videoTitle?: string
|
|
hideToc?: boolean
|
|
}) => {
|
|
const pathname = usePathname()
|
|
const { toc } = useTocAnchors()
|
|
const showFeedback = isFeatureEnabled('feedback:docs')
|
|
const tocVideoPreview = `https://img.youtube.com/vi/${video}/0.jpg`
|
|
|
|
return (
|
|
<div className={cn('thin-scrollbar overflow-y-auto h-fit', 'px-px', className)}>
|
|
<div className="w-full relative border-l flex flex-col gap-6 lg:gap-8 px-2 h-fit">
|
|
{video && (
|
|
<div className="relative pl-5">
|
|
<ExpandableVideo imgUrl={tocVideoPreview} videoId={video} videoTitle={videoTitle} />
|
|
</div>
|
|
)}
|
|
{showFeedback && (
|
|
<div className="pl-5">
|
|
<Feedback key={pathname} />
|
|
</div>
|
|
)}
|
|
<div className="pl-5">
|
|
<AiTools key={pathname} />
|
|
</div>
|
|
{!hideToc && toc.length !== 0 && (
|
|
<Toc className="-ml-[calc(0.25rem+6px)]">
|
|
<h3 className="inline-flex items-center gap-1.5 font-mono text-xs uppercase text-foreground pl-[calc(1.5rem+6px)]">
|
|
On this page
|
|
</h3>
|
|
<TOCScrollArea>
|
|
<TOCItems items={toc} />
|
|
</TOCScrollArea>
|
|
</Toc>
|
|
)}
|
|
</div>
|
|
</div>
|
|
)
|
|
}
|
|
|
|
export default GuidesSidebar
|
|
export { GuidesSidebar }
|
|
export type { TOCHeader }
|