Skip to content

Defer Charts docs runtime until interaction #1131

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
tannerlinsley merged 1 commit into from
Aug 9, 2026
+37 −38
Merged

Defer Charts docs runtime until interaction #1131

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 5 additions & 3 deletions src/components/charts/ChartsCatalogDocExample.client.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,23 +13,25 @@ const LazyExampleWorkbench = React.lazy(() =>

export function ChartsCatalogDocExampleClient({
caseId,
edit,
fallback,
height,
source,
title,
}: {
caseId: string
edit: boolean
fallback: React.ReactNode
height: number
source: 'hidden' | 'collapsed' | 'expanded'
title?: string
}) {
const [definition, setDefinition] = React.useState<ExampleDefinition>()
const [editing, setEditing] = React.useState(source === 'expanded')
const [editing, setEditing] = React.useState(edit)

React.useEffect(() => {
setEditing(source === 'expanded')
}, [caseId, source])
setEditing(edit)
}, [caseId, edit])

React.useEffect(() => {
let cancelled = false
Expand Down
64 changes: 30 additions & 34 deletions src/components/charts/ChartsCatalogDocExample.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
import { ClientOnly } from '@tanstack/react-router'
import * as React from 'react'
import { ChartsCatalogPreview } from './ChartsCatalogPreview'
import { Button } from '~/components/ds/ui'

const LazyChartsCatalogDocExample = React.lazy(() =>
import('./ChartsCatalogDocExample.client').then((module) => ({
Expand All @@ -19,45 +20,30 @@ export function ChartsCatalogDocExample({
source?: 'hidden' | 'collapsed' | 'expanded'
title?: string
}) {
const containerRef = React.useRef<HTMLElement>(null)
const [shouldLoad, setShouldLoad] = React.useState(false)
const [activation, setActivation] = React.useState<{
caseId: string
edit: boolean
}>()
const isActive = activation?.caseId === caseId
const fallback = (
<ChartsCatalogDocExampleFallback
caseId={caseId}
height={height}
onEdit={() => setActivation({ caseId, edit: true })}
onRun={() => setActivation({ caseId, edit: false })}
source={source}
title={title}
/>
)

React.useEffect(() => {
const container = containerRef.current
if (shouldLoad || !container) return

if (!('IntersectionObserver' in window)) {
setShouldLoad(true)
return
}

const observer = new IntersectionObserver(
(entries) => {
if (!entries.some((entry) => entry.isIntersecting)) return
setShouldLoad(true)
observer.disconnect()
},
{ rootMargin: '320px 0px' },
)
observer.observe(container)
return () => observer.disconnect()
}, [shouldLoad])

return (
<section ref={containerRef} className="not-prose my-5">
{shouldLoad ? (
<section className="not-prose my-5">
{isActive ? (
<ClientOnly fallback={fallback}>
<React.Suspense fallback={fallback}>
<LazyChartsCatalogDocExample
caseId={caseId}
edit={activation.edit}
fallback={fallback}
height={height}
source={source}
Expand All @@ -75,11 +61,15 @@ export function ChartsCatalogDocExample({
function ChartsCatalogDocExampleFallback({
caseId,
height,
onEdit,
onRun,
source,
title,
}: {
caseId: string
height: number
onEdit: () => void
onRun: () => void
source: 'hidden' | 'collapsed' | 'expanded'
title?: string
}) {
Expand All @@ -90,19 +80,25 @@ function ChartsCatalogDocExampleFallback({
className="overflow-hidden rounded-lg border border-border-default bg-background-default"
data-chart-example={caseId}
>
{source !== 'hidden' ? (
<div className="flex min-h-10 items-center justify-between gap-3 border-b border-border-default px-3">
<div
className={`flex min-h-10 items-center gap-3 border-b border-border-default px-2 ${source === 'hidden' ? 'justify-end' : 'justify-between pl-3'}`}
>
{source !== 'hidden' ? (
<span className="min-w-0 truncate font-ds-mono text-xs text-text-muted">
{label}
</span>
<a
className="shrink-0 text-xs font-medium text-text-secondary hover:text-text-primary"
href={`/charts/catalog/charts/${caseId}`}
>
Open example
</a>
) : null}
<div className="flex shrink-0 items-center gap-1">
{source !== 'hidden' ? (
<Button type="button" variant="ghost" size="xs" onClick={onEdit}>
Edit
</Button>
) : null}
<Button type="button" variant="primary" size="xs" onClick={onRun}>
Run
</Button>
</div>
) : null}
</div>
<div aria-label={`${label} chart preview`} role="img" style={{ height }}>
<ChartsCatalogPreview caseId={caseId} className="p-8" family="" />
</div>
Expand Down
3 changes: 2 additions & 1 deletion tests/charts-catalog-frame-embedding.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -163,7 +163,8 @@ test('chart example comments retain a useful static document', () => {
assert.match(html, /data-chart-example="01-line-gaps"/)
assert.match(html, /data-catalog-preview-case="01-line-gaps"/)
assert.match(html, /height:480px/)
assert.match(html, /Open example/)
assert.match(html, />Edit</)
assert.match(html, />Run</)
Comment on lines +166 to +167

@coderabbitai coderabbitai Bot Aug 9, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🎯 Functional Correctness | 🟠 Major | 🏗️ Heavy lift

Add an interactive activation test.

renderToStaticMarkup cannot execute these controls. It does not verify that passive rendering avoids loading the live client. It does not verify that Run or Edit activates the client with the selected mode.

Add a client-side component test that confirms passive rendering performs no client load, then confirms each explicit action activates the client. The PR objective requires this behavior.

🤖 Prompt for AI Agents 
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@tests/charts-catalog-frame-embedding.test.ts` around lines 166 - 167, Extend
the chart catalog embedding tests around the existing HTML assertions with an
interactive client-component test: verify passive rendering does not load the
live client, then trigger the Run and Edit controls separately and verify each
loads the client with its corresponding selected mode. Use the existing test
setup and client-loading symbols rather than relying on renderToStaticMarkup for
activation behavior.

assert.doesNotMatch(html, /<iframe/)
})

Expand Down
Loading