Skip to content
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.

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

Add breadcrumbs #1759

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
118 changes: 118 additions & 0 deletions templates/demo-store/app/components/Breadcrumbs.tsx
@@ -0,0 +1,118 @@
import React from 'react';
import {Link, type UIMatch, useMatches} from '@remix-run/react';

import {IconCaret} from '~/components';

const SEPARATOR = '/';

type PageData = {
hideBreadcrumbs: boolean;
pageType: string;
pageName: string;
};

export function Breadcrumbs() {
const matches: UIMatch<any>[] = useMatches();
const deepestRoute = matches.at(-1);
const splitURL = deepestRoute?.pathname.split('/') || [];
const {pageType, pageName, hideBreadcrumbs} = getPageData(splitURL[1]);

if (hideBreadcrumbs) return null;

const pages = [{path: '/', name: 'Home'}];

if (splitURL[1]) {
pages.push({
path: `/${splitURL[1]}`,
name: pageName,
});

if (splitURL[2]) {
pages.push({
path: `/${splitURL[2]}`,
name: `${
deepestRoute?.data?.[pageType]?.title ||
getCapitalizeString(splitURL[2])
}`,
});
}
}

const mobilePage = pages[pages.length - 2];

return (
<nav className="text-sm px-4 md:px-12 py-1">
<div className="flex md:hidden items-center">
<Link
className="flex items-center hover:text-primary"
to={mobilePage.path}
>
<IconCaret className="pl-2 text-primary/80" direction={'right'} />
<span className="text-primary/70">{mobilePage.name}</span>
</Link>
</div>
<ol className="hidden md:flex items-center">
{pages.map((page, index) => {
const currentPage = index === pages.length - 1;
return (
<li className="flex items-center" key={page.path}>
{index !== 0 ? (
<span className="px-2 text-primary/80 hover:text-primary">
{SEPARATOR}
</span>
) : null}
{currentPage ? (
<span className="text-primary/80">{page.name}</span>
) : (
<span className="text-primary/70 hover:text-primary">
<Link to={page.path}>{page.name}</Link>
</span>
)}
</li>
);
})}
</ol>
</nav>
);
}

function getCapitalizeString(text: string): string {
return text.charAt(0).toUpperCase() + text.slice(1);
}

function getPageData(path: string): PageData {
const pageData: PageData = {
hideBreadcrumbs: false,
pageType: '',
pageName: getCapitalizeString(path),
};

switch (path) {
case 'collections':
pageData.pageType = 'collection';
break;

case 'products':
pageData.pageType = 'product';
break;

case 'policies':
pageData.pageType = 'policy';
break;

case 'journal':
pageData.pageType = 'article';
break;

case 'pages':
pageData.pageType = 'page';
break;

// homepage
case '':
pageData.hideBreadcrumbs = true;
break;
}

return pageData;
}
2 changes: 2 additions & 0 deletions templates/demo-store/app/components/Layout.tsx
Expand Up @@ -22,6 +22,7 @@ import {
Cart,
CartLoading,
Link,
Breadcrumbs,
} from '~/components';
import {
type EnhancedMenu,
Expand Down Expand Up @@ -53,6 +54,7 @@ export function Layout({children, layout}: LayoutProps) {
{headerMenu && layout?.shop.name && (
<Header title={layout.shop.name} menu={headerMenu} />
)}
<Breadcrumbs />
<main role="main" id="mainContent" className="flex-grow">
{children}
</main>
Expand Down
1 change: 1 addition & 0 deletions templates/demo-store/app/components/index.ts
Expand Up @@ -19,6 +19,7 @@ export {FeaturedCollections} from './FeaturedCollections';
export {Hero} from './Hero';
export {SortFilter} from './SortFilter';
export {Grid} from './Grid';
export {Breadcrumbs} from './Breadcrumbs';
export {FeaturedProducts} from './FeaturedProducts';
export {AddToCartButton} from './AddToCartButton';
export * from './Icon';