Skip to content

Commit 13a46b7

Browse files
authored
portal: Update SDK Reference breadcrumbs UI (#8662)
1 parent b9d93e4 commit 13a46b7

3 files changed

Lines changed: 37 additions & 17 deletions

File tree

apps/portal/src/app/references/components/TDoc/PageLayout.tsx

Lines changed: 24 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -52,12 +52,27 @@ export function getTDocPage(options: {
5252
// category pages
5353
if (docSlug in subgroups) {
5454
return (
55-
<CategoryPage
56-
doc={doc}
57-
packageSlug={packageSlug}
58-
slug={docSlug as keyof typeof subgroups}
59-
version={version}
60-
/>
55+
<div>
56+
<Breadcrumb
57+
crumbs={[
58+
{
59+
href: `/references/${packageSlug}/${version}`,
60+
name: sdkTitle,
61+
},
62+
{
63+
href: `/references/${packageSlug}/${version}/${docSlug}`,
64+
name: docSlug,
65+
},
66+
]}
67+
/>
68+
69+
<CategoryPage
70+
doc={doc}
71+
packageSlug={packageSlug}
72+
slug={docSlug as keyof typeof subgroups}
73+
version={version}
74+
/>
75+
</div>
6176
);
6277
}
6378

@@ -74,7 +89,7 @@ export function getTDocPage(options: {
7489
crumbs={[
7590
{
7691
href: `/references/${packageSlug}/${version}`,
77-
name: "References",
92+
name: sdkTitle,
7893
},
7994
{
8095
href: `/references/${packageSlug}/${version}/${selectedDoc.name}`,
@@ -209,8 +224,8 @@ async function IndexContent(props: {
209224

210225
return (
211226
<div>
212-
<Heading anchorId="reference" level={1}>
213-
{props.sdkTitle} Reference
227+
<Heading anchorId="reference" level={1} className="mb-6 mt-2">
228+
{props.sdkTitle}
214229
</Heading>
215230

216231
<div className="flex flex-col gap-3">

apps/portal/src/components/Layouts/DocLayout.tsx

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,11 @@ export function DocLayout(props: DocLayoutProps) {
4646
"hidden xl:flex",
4747
)}
4848
>
49-
<DocSidebar {...props.sideBar} header={props.sidebarHeader} />
49+
<DocSidebar
50+
{...props.sideBar}
51+
header={props.sidebarHeader}
52+
className="pt-1"
53+
/>
5054
</aside>
5155
)}
5256
<div className="sticky top-sticky-top-height z-stickyMobileSidebar border-b bg-card/50 backdrop-blur-xl p-4 xl:hidden -mx-4">
@@ -57,12 +61,7 @@ export function DocLayout(props: DocLayoutProps) {
5761
data-no-llm={props.noLLM}
5862
data-noindex={props.noIndex}
5963
>
60-
<div className="grow xl:mt-6">
61-
<h5 className="mb-2 text-sm text-muted-foreground">
62-
{props.sideBar.name}
63-
</h5>
64-
{props.children}
65-
</div>
64+
<div className="grow xl:mt-6">{props.children}</div>
6665
<div className="mt-16 xl:mt-20">
6766
<PageFooter
6867
editPageButton={props.editPageButton}

apps/portal/src/components/others/Sidebar.tsx

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,11 +51,17 @@ type ReferenceSideBarProps = {
5151
onLinkClick?: () => void;
5252
header?: React.ReactNode;
5353
name: string;
54+
className?: string;
5455
};
5556

5657
export function DocSidebar(props: ReferenceSideBarProps) {
5758
return (
58-
<div className="flex h-full flex-col pb-10 pt-6 text-muted-foreground text-sm">
59+
<div
60+
className={cn(
61+
"flex h-full flex-col pb-10 pt-6 text-muted-foreground text-sm",
62+
props.className,
63+
)}
64+
>
5965
{/* Side bar Name */}
6066
{props.header}
6167
<ul className="styled-scrollbar transform-gpu space-y-1">

0 commit comments

Comments
 (0)