Skip to content

Commit e10317d

Browse files
Add semantic breadcrumbs to chart collections (#1466)
* Add semantic breadcrumbs to chart examples * Escape chart breadcrumb JSON-LD script content * Add semantic breadcrumbs to chart collections
1 parent 4c3a336 commit e10317d

4 files changed

Lines changed: 78 additions & 9 deletions

File tree

‎src/components/charts/ChartsCatalogPages.tsx‎

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
import { Breadcrumbs } from '~/components/Breadcrumbs'
2-
import { getChartBreadcrumbItems } from '~/utils/chart-breadcrumbs'
2+
import {
3+
getChartBreadcrumbItems,
4+
getChartCollectionBreadcrumbItems,
5+
} from '~/utils/chart-breadcrumbs'
36
import {
47
ArrowsOutSimpleIcon,
58
ArrowUpRightIcon,
@@ -65,14 +68,10 @@ export function ChartsCatalog({
6568
<CatalogSurface>
6669
{collection ? (
6770
<header className="mb-6 max-w-2xl">
68-
<Link
69-
className="text-sm text-text-muted hover:text-action-primary"
70-
preload={false}
71-
search={true}
72-
to="/charts/catalog"
73-
>
74-
All examples
75-
</Link>
71+
<Breadcrumbs
72+
section="Catalog"
73+
items={getChartCollectionBreadcrumbItems(collection)}
74+
/>
7675
<h1 className="mt-2 font-ds-display text-3xl font-bold tracking-tight text-text-primary">
7776
{collection.title}
7877
</h1>

‎src/routes/_library/charts.catalog.collections.$collectionId.tsx‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
import { getChartCollectionBreadcrumbJsonLd } from '~/utils/chart-breadcrumbs'
12
import { createFileRoute, notFound } from '@tanstack/react-router'
23
import { ChartsCatalog } from '~/components/charts/ChartsCatalogPages'
34
import { isChartsCatalogCaseId } from '~/utils/charts-catalog'
@@ -17,6 +18,16 @@ export const Route = createFileRoute(
1718
},
1819
component: ChartsCatalogCollectionRoute,
1920
head: ({ loaderData }) => ({
21+
scripts: loaderData
22+
? [
23+
{
24+
type: 'application/ld+json',
25+
children: JSON.stringify(
26+
getChartCollectionBreadcrumbJsonLd(loaderData.collection),
27+
).replaceAll('<', '\\u003c'),
28+
},
29+
]
30+
: [],
2031
meta: seo({
2132
title: loaderData
2233
? `${loaderData.collection.title} | TanStack Charts`

‎src/utils/chart-breadcrumbs.ts‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,3 +37,34 @@ export function getChartBreadcrumbJsonLd(chart: ChartBreadcrumbData) {
3737
})),
3838
}
3939
}
40+
41+
export function getChartCollectionBreadcrumbItems(collection: {
42+
id: string
43+
title: string
44+
}): Array<BreadcrumbItem> {
45+
return [
46+
{ label: 'Catalog', to: '/charts/catalog', search: true, preload: false },
47+
{
48+
label: collection.title,
49+
to: `/charts/catalog/collections/${collection.id}`,
50+
},
51+
]
52+
}
53+
54+
export function getChartCollectionBreadcrumbJsonLd(collection: {
55+
id: string
56+
title: string
57+
}) {
58+
return {
59+
'@context': 'https://schema.org',
60+
'@type': 'BreadcrumbList',
61+
itemListElement: getChartCollectionBreadcrumbItems(collection).map(
62+
(item, index) => ({
63+
'@type': 'ListItem',
64+
position: index + 1,
65+
name: item.label,
66+
item: canonicalUrl(item.to),
67+
}),
68+
),
69+
}
70+
}

‎tests/chart-breadcrumbs.test.ts‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@ import assert from 'node:assert/strict'
22
import { test } from 'node:test'
33
import {
44
getChartBreadcrumbItems,
5+
getChartCollectionBreadcrumbItems,
6+
getChartCollectionBreadcrumbJsonLd,
57
getChartBreadcrumbJsonLd,
68
} from '../src/utils/chart-breadcrumbs'
79
Object.assign(globalThis, { __TANSTACK_SITE_URL__: 'https://tanstack.com' })
@@ -32,3 +34,29 @@ test('chart hierarchy includes only known collections and keeps navigation optio
3234
assert.equal(getChartBreadcrumbItems({ ...chart, collection }).length, 2)
3335
}
3436
})
37+
38+
test('collection trail returns to the complete catalog while schema stays canonical', () => {
39+
const collection = { id: 'shadcn', title: 'shadcn/ui Charts' }
40+
const items = getChartCollectionBreadcrumbItems(collection)
41+
assert.equal(items[0].to, '/charts/catalog')
42+
assert.equal(items[0].search, true)
43+
assert.equal(items[0].preload, false)
44+
assert.equal(items[1].label, collection.title)
45+
assert.deepEqual(
46+
getChartCollectionBreadcrumbJsonLd(collection).itemListElement,
47+
[
48+
{
49+
'@type': 'ListItem',
50+
position: 1,
51+
name: 'Catalog',
52+
item: 'https://tanstack.com/charts/catalog',
53+
},
54+
{
55+
'@type': 'ListItem',
56+
position: 2,
57+
name: 'shadcn/ui Charts',
58+
item: 'https://tanstack.com/charts/catalog/collections/shadcn',
59+
},
60+
],
61+
)
62+
})

0 commit comments

Comments
 (0)