Skip to content

feat: Introduce SidebarItem component to manage sidebar entry colla… #8150

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

feat: Introduce SidebarItem component to manage sidebar entry colla… #8150

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
3 changes: 3 additions & 0 deletions src/components/Layout/Sidebar/SidebarLink.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ interface SidebarLinkProps {
isExpanded?: boolean;
hideArrow?: boolean;
isPending: boolean;
onClick?: (event: React.MouseEvent<HTMLAnchorElement>) => void;
}

export function SidebarLink({
Expand All @@ -40,6 +41,7 @@ export function SidebarLink({
isExpanded,
hideArrow,
isPending,
onClick,
}: SidebarLinkProps) {
const ref = useRef<HTMLAnchorElement>(null);

Expand All @@ -64,6 +66,7 @@ export function SidebarLink({
title={title}
target={target}
passHref
onClick={onClick}
aria-current={selected ? 'page' : undefined}
className={cn(
'p-2 pe-2 w-full rounded-none lg:rounded-e-2xl text-start hover:bg-gray-5 dark:hover:bg-gray-80 relative flex items-center justify-between',
Expand Down
221 changes: 126 additions & 95 deletions src/components/Layout/Sidebar/SidebarRouteTree.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
* Copyright (c) Facebook, Inc. and its affiliates.
*/

import {useRef, useLayoutEffect, Fragment} from 'react';
import {useRef, useLayoutEffect, useState, useEffect, Fragment} from 'react';

import cn from 'classnames';
import {useRouter} from 'next/router';
Expand Down Expand Up @@ -78,6 +78,95 @@ function CollapseWrapper({
);
}

interface SidebarItemProps {
item: RouteItem;
level: number;
isForceExpanded: boolean;
breadcrumbs: RouteItem[];
slug: string;
pendingRoute: string | null;
}

function SidebarItem({
item,
level,
isForceExpanded,
breadcrumbs,
slug,
pendingRoute,
}: SidebarItemProps) {
const {path, title, routes, version, heading} = item;
const selected = slug === path;
const isBreadcrumb =
breadcrumbs.length > 1 && breadcrumbs[breadcrumbs.length - 1].path === path;

const [isCollapsed, setIsCollapsed] = useState(false);

const shouldBeExpanded = isForceExpanded || isBreadcrumb || selected;
const isExpanded = shouldBeExpanded && !isCollapsed;

useEffect(() => {
if (!selected) {
setIsCollapsed(false);
}
}, [selected]);

const handleClick = (event: React.MouseEvent<HTMLAnchorElement>) => {
if (selected) {
event.preventDefault();
setIsCollapsed((prev) => !prev);
}
};

if (!path || heading) {
return (
<SidebarRouteTree
level={level + 1}
isForceExpanded={isForceExpanded}
routeTree={{title, routes}}
breadcrumbs={[]}
/>
);
} else if (routes) {
return (
<li>
<SidebarLink
href={path}
isPending={pendingRoute === path}
selected={selected}
level={level}
title={title}
version={version}
isExpanded={isExpanded}
hideArrow={isForceExpanded}
onClick={handleClick}
/>
<CollapseWrapper duration={250} isExpanded={isExpanded}>
<SidebarRouteTree
isForceExpanded={isForceExpanded}
routeTree={{title, routes}}
breadcrumbs={breadcrumbs}
level={level + 1}
/>
</CollapseWrapper>
</li>
);
} else {
return (
<li>
<SidebarLink
isPending={pendingRoute === path}
href={path}
selected={selected}
level={level}
title={title}
version={version}
/>
</li>
);
}
}

export function SidebarRouteTree({
isForceExpanded,
breadcrumbs,
Expand All @@ -89,102 +178,44 @@ export function SidebarRouteTree({
const currentRoutes = routeTree.routes as RouteItem[];
return (
<ul>
{currentRoutes.map(
(
{
path,
title,
routes,
version,
heading,
hasSectionHeader,
sectionHeader,
},
index
) => {
const selected = slug === path;
let listItem = null;
if (!path || heading) {
// if current route item has no path and children treat it as an API sidebar heading
listItem = (
<SidebarRouteTree
level={level + 1}
isForceExpanded={isForceExpanded}
routeTree={{title, routes}}
breadcrumbs={[]}
/>
);
} else if (routes) {
// if route has a path and child routes, treat it as an expandable sidebar item
const isBreadcrumb =
breadcrumbs.length > 1 &&
breadcrumbs[breadcrumbs.length - 1].path === path;
const isExpanded = isForceExpanded || isBreadcrumb || selected;
listItem = (
<li key={`${title}-${path}-${level}-heading`}>
<SidebarLink
key={`${title}-${path}-${level}-link`}
href={path}
isPending={pendingRoute === path}
selected={selected}
level={level}
title={title}
version={version}
isExpanded={isExpanded}
hideArrow={isForceExpanded}
/>
<CollapseWrapper duration={250} isExpanded={isExpanded}>
<SidebarRouteTree
isForceExpanded={isForceExpanded}
routeTree={{title, routes}}
breadcrumbs={breadcrumbs}
level={level + 1}
/>
</CollapseWrapper>
</li>
);
} else {
// if route has a path and no child routes, treat it as a sidebar link
listItem = (
<li key={`${title}-${path}-${level}-link`}>
<SidebarLink
isPending={pendingRoute === path}
href={path}
selected={selected}
level={level}
title={title}
version={version}
{currentRoutes.map((item, index) => {
const {path, title, hasSectionHeader, sectionHeader} = item;
if (hasSectionHeader) {
let sectionHeaderText =
sectionHeader != null
? sectionHeader.replace('{{version}}', siteConfig.version)
: '';
return (
<Fragment key={`${sectionHeaderText}-${level}-separator`}>
{index !== 0 && (
<li
role="separator"
className="mt-4 mb-2 ms-5 border-b border-border dark:border-border-dark"
/>
</li>
);
}
if (hasSectionHeader) {
let sectionHeaderText =
sectionHeader != null
? sectionHeader.replace('{{version}}', siteConfig.version)
: '';
return (
<Fragment key={`${sectionHeaderText}-${level}-separator`}>
{index !== 0 && (
<li
role="separator"
className="mt-4 mb-2 ms-5 border-b border-border dark:border-border-dark"
/>
)}
<h3
className={cn(
'mb-1 text-sm font-bold ms-5 text-tertiary dark:text-tertiary-dark',
index !== 0 && 'mt-2'
)}>
{sectionHeaderText}
</h3>
</Fragment>
);
} else {
return listItem;
}
)}
<h3
className={cn(
'mb-1 text-sm font-bold ms-5 text-tertiary dark:text-tertiary-dark',
index !== 0 && 'mt-2'
)}>
{sectionHeaderText}
</h3>
</Fragment>
);
} else {
return (
<SidebarItem
key={`${title}-${path}-${level}-item`}
item={item}
level={level}
isForceExpanded={isForceExpanded}
breadcrumbs={breadcrumbs}
slug={slug}
pendingRoute={pendingRoute}
/>
);
}
)}
})}
</ul>
);
}