Papermark is the open-source DocSend alternative and secure data rooms with built-in analytics and custom domains.
feat: add page breadcrumbs
Marc Seitze3c28e4ad141
diff --git a/components/datarooms/dataroom-breadcrumb.tsx b/components/datarooms/dataroom-breadcrumb.tsxindex 7017c15a..5ac90f8a 100644--- a/components/datarooms/dataroom-breadcrumb.tsx+++ b/components/datarooms/dataroom-breadcrumb.tsx@@ -5,14 +5,24 @@ import React, { useMemo } from "react";import {Breadcrumb,+ BreadcrumbEllipsis,BreadcrumbItem,BreadcrumbLink,BreadcrumbList,BreadcrumbPage,BreadcrumbSeparator,} from "@/components/ui/breadcrumb";+import {+ DropdownMenu,+ DropdownMenuContent,+ DropdownMenuItem,+ DropdownMenuTrigger,+} from "@/components/ui/dropdown-menu";-import { useDataroomFolderWithParents } from "@/lib/swr/use-dataroom";+import {+ useDataroom,+ useDataroomFolderWithParents,+} from "@/lib/swr/use-dataroom";function BreadcrumbComponentBase({name,@@ -21,7 +31,8 @@ function BreadcrumbComponentBase({name: string[];dataroomId: string;}) {- const { folders: folderNames } = useDataroomFolderWithParents({+ const { dataroom } = useDataroom();+ const { folders } = useDataroomFolderWithParents({name,dataroomId,});@@ -29,37 +40,88 @@ function BreadcrumbComponentBase({return (<Breadcrumb><BreadcrumbList>- <BreadcrumbItem key={"root"}>+ <BreadcrumbItem><BreadcrumbLink asChild>- <Link href={`/datarooms/${dataroomId}/documents`}>Home</Link>+ <Link href="/datarooms">Datarooms</Link></BreadcrumbLink></BreadcrumbItem>- {folderNames &&- folderNames.map((item, index: number, array) => {- return (- <React.Fragment key={index}>- <BreadcrumbSeparator />- {index === array.length - 1 ? (- <BreadcrumbItem>- <BreadcrumbPage className="capitalize">- {item.name}- </BreadcrumbPage>- </BreadcrumbItem>- ) : (- <BreadcrumbItem>- <BreadcrumbLink asChild>+ <BreadcrumbSeparator />+ <BreadcrumbItem>+ <BreadcrumbLink asChild>+ <Link href={`/datarooms/${dataroomId}`}>+ {dataroom?.name || "Loading..."}+ </Link>+ </BreadcrumbLink>+ </BreadcrumbItem>+ <BreadcrumbSeparator />+ <BreadcrumbItem>+ <BreadcrumbLink asChild>+ <Link href={`/datarooms/${dataroomId}/documents`}>Documents</Link>+ </BreadcrumbLink>+ </BreadcrumbItem>+ {folders && folders.length > 0 && <BreadcrumbSeparator />}+ {folders && folders.length > 2 ? (+ <>+ <BreadcrumbItem>+ <DropdownMenu>+ <DropdownMenuTrigger className="flex items-center gap-1">+ <BreadcrumbEllipsis className="h-4 w-4" />+ </DropdownMenuTrigger>+ <DropdownMenuContent align="start">+ {folders.slice(0, -2).map((folder, index) => (+ <DropdownMenuItem key={index}><Link- href={`/datarooms/${dataroomId}/documents${item.path}`}- className="capitalize"+ href={`/datarooms/${dataroomId}/documents${folder.path}`}+ className="w-full">- {item.name}+ {folder.name}</Link>- </BreadcrumbLink>- </BreadcrumbItem>+ </DropdownMenuItem>+ ))}+ </DropdownMenuContent>+ </DropdownMenu>+ </BreadcrumbItem>+ <BreadcrumbSeparator />+ <BreadcrumbItem>+ <BreadcrumbLink asChild>+ <Link+ href={`/datarooms/${dataroomId}/documents${folders[folders.length - 2].path}`}+ className="max-w-[200px] truncate"+ >+ {folders[folders.length - 2].name}+ </Link>+ </BreadcrumbLink>+ </BreadcrumbItem>+ <BreadcrumbSeparator />+ <BreadcrumbItem>+ <BreadcrumbPage className="max-w-[200px] truncate">+ {folders[folders.length - 1].name}+ </BreadcrumbPage>+ </BreadcrumbItem>+ </>+ ) : (+ folders?.map((folder, index) => (+ <React.Fragment key={index}>+ <BreadcrumbItem>+ {index === folders.length - 1 ? (+ <BreadcrumbPage className="max-w-[200px] truncate">+ {folder.name}+ </BreadcrumbPage>+ ) : (+ <BreadcrumbLink asChild>+ <Link+ href={`/datarooms/${dataroomId}/documents${folder.path}`}+ className="max-w-[200px] truncate"+ >+ {folder.name}+ </Link>+ </BreadcrumbLink>)}- </React.Fragment>- );- })}+ </BreadcrumbItem>+ {index < folders.length - 1 && <BreadcrumbSeparator />}+ </React.Fragment>+ ))+ )}</BreadcrumbList></Breadcrumb>);diff --git a/components/layouts/app.tsx b/components/layouts/app.tsxindex a2970226..e9f91e26 100644--- a/components/layouts/app.tsx+++ b/components/layouts/app.tsx@@ -1,25 +1,12 @@import { AppSidebar } from "@/components/sidebar/app-sidebar";-import {- Breadcrumb,- BreadcrumbItem,- BreadcrumbLink,- BreadcrumbList,- BreadcrumbPage,- BreadcrumbSeparator,-} from "../ui/breadcrumb";import { Separator } from "../ui/separator";import { SidebarInset, SidebarTrigger } from "../ui/sidebar";import { SidebarProvider } from "../ui/sidebar";+import { AppBreadcrumb } from "./breadcrumb";import TrialBanner from "./trial-banner";-export default function AppLayout({- breadcrumbs,- children,-}: {- breadcrumbs?: { title: string; href: string }[];- children: React.ReactNode;-}) {+export default function AppLayout({ children }: { children: React.ReactNode }) {return (<SidebarProvider><div className="flex flex-1 flex-col gap-x-1 bg-gray-50 dark:bg-black lg:flex-row">@@ -28,43 +15,13 @@ export default function AppLayout({<header className="flex h-10 shrink-0 items-center gap-2"><div className="flex items-center gap-2 px-4"><SidebarTrigger className="-ml-1" />- {breadcrumbs && (- <>- <Separator orientation="vertical" className="mr-2 h-4" />- <Breadcrumb>- <BreadcrumbList>- {breadcrumbs.length > 1 &&- breadcrumbs.slice(0, -1).map((breadcrumb, index) => (- <BreadcrumbItem- key={index}- className="hidden md:block"- >- <BreadcrumbLink href={breadcrumb.href}>- {breadcrumb.title}- </BreadcrumbLink>- </BreadcrumbItem>- ))}- {breadcrumbs.length > 1 && (- <BreadcrumbSeparator className="hidden md:block" />- )}- <BreadcrumbItem>- <BreadcrumbPage>- {breadcrumbs[breadcrumbs.length - 1].title}- </BreadcrumbPage>- </BreadcrumbItem>- </BreadcrumbList>- </Breadcrumb>- </>- )}+ <Separator orientation="vertical" className="mr-2 h-4" />+ <AppBreadcrumb /></div></header>{/* Trial banner shown only on trial */}<TrialBanner />- <main className="flex-1">- {/* <div className="overflow-y-auto rounded-xl bg-white ring-1 ring-gray-200 dark:border-none dark:bg-gray-900 dark:ring-gray-800"> */}- {children}- {/* </div> */}- </main>+ <main className="flex-1">{children}</main></SidebarInset></div></SidebarProvider>diff --git a/components/layouts/breadcrumb.tsx b/components/layouts/breadcrumb.tsxnew file mode 100644index 00000000..a3d1c05f--- /dev/null+++ b/components/layouts/breadcrumb.tsx@@ -0,0 +1,346 @@+import Link from "next/link";+import { useRouter } from "next/router";++import { useMemo } from "react";++import { BreadcrumbComponent as DataroomBreadcrumb } from "@/components/datarooms/dataroom-breadcrumb";+import {+ Breadcrumb,+ BreadcrumbEllipsis,+ BreadcrumbItem,+ BreadcrumbLink,+ BreadcrumbList,+ BreadcrumbPage,+ BreadcrumbSeparator,+} from "@/components/ui/breadcrumb";+import {+ DropdownMenu,+ DropdownMenuContent,+ DropdownMenuItem,+ DropdownMenuTrigger,+} from "@/components/ui/dropdown-menu";++import { useDataroom } from "@/lib/swr/use-dataroom";+import { useDocument } from "@/lib/swr/use-document";+import { useFolderWithParents } from "@/lib/swr/use-folders";++const FOLDERS_TO_DISPLAY = 1; // Only show the last folder in the path++const SingleDocumentBreadcrumb = ({ documentId }: { documentId: string }) => {+ const { document } = useDocument();+ const { folders } = useFolderWithParents({+ name: document?.folder?.path ? [document.folder.path] : [],+ });++ return (+ <Breadcrumb>+ <BreadcrumbList>+ <BreadcrumbItem>+ <BreadcrumbLink asChild>+ <Link href="/documents">Documents</Link>+ </BreadcrumbLink>+ </BreadcrumbItem>+ <BreadcrumbSeparator />+ {folders && folders.length > FOLDERS_TO_DISPLAY ? (+ <>+ <BreadcrumbItem>+ <DropdownMenu>+ <DropdownMenuTrigger className="flex items-center gap-1">+ <BreadcrumbEllipsis className="h-4 w-4" />+ </DropdownMenuTrigger>+ <DropdownMenuContent align="start">+ {folders.slice(0, -1).map((folder, index) => (+ <DropdownMenuItem key={index}>+ <Link+ href={`/documents/tree${folder.path}`}+ className="w-full"+ >+ {folder.name}+ </Link>+ </DropdownMenuItem>+ ))}+ </DropdownMenuContent>+ </DropdownMenu>+ </BreadcrumbItem>+ <BreadcrumbSeparator />+ <BreadcrumbItem>+ <BreadcrumbLink asChild>+ <Link+ href={`/documents/tree${folders[folders.length - 1].path}`}+ className="max-w-[200px] truncate"+ >+ {folders[folders.length - 1].name}+ </Link>+ </BreadcrumbLink>+ </BreadcrumbItem>+ <BreadcrumbSeparator key={`sep-last`} />+ </>+ ) : (+ folders?.map((folder, index) => (+ <>+ <BreadcrumbItem key={`item-${index}`}>+ <BreadcrumbLink asChild>+ <Link+ href={`/documents/tree${folder.path}`}+ className="max-w-[200px] truncate"+ >+ {folder.name}+ </Link>+ </BreadcrumbLink>+ </BreadcrumbItem>+ <BreadcrumbSeparator key={`sep-${index}`} />+ </>+ ))+ )}+ {document && (+ <BreadcrumbItem>+ <BreadcrumbPage className="max-w-[200px] truncate">+ {document.name}+ </BreadcrumbPage>+ </BreadcrumbItem>+ )}+ </BreadcrumbList>+ </Breadcrumb>+ );+};++const SingleDataroomBreadcrumb = ({ path }: { path: string }) => {+ const { dataroom } = useDataroom();++ const title = useMemo(() => {+ switch (path) {+ case "/datarooms/[id]/documents":+ return "Documents";+ case "/datarooms/[id]/settings":+ return "Settings";+ case "/datarooms/[id]/branding":+ return "Branding";+ case "/datarooms/[id]/permissions":+ return "Permissions";+ case "/datarooms/[id]/analytics":+ return "Analytics";+ default:+ return dataroom?.name || "Loading...";+ }+ }, [path, dataroom]);++ return (+ <Breadcrumb>+ <BreadcrumbList>+ <BreadcrumbItem>+ <BreadcrumbLink asChild>+ <Link href="/datarooms">Datarooms</Link>+ </BreadcrumbLink>+ </BreadcrumbItem>+ <BreadcrumbSeparator />+ <BreadcrumbItem>+ <BreadcrumbLink asChild>+ <Link href={`/datarooms/${dataroom?.id}`}>{dataroom?.name}</Link>+ </BreadcrumbLink>+ </BreadcrumbItem>+ <BreadcrumbSeparator />+ <BreadcrumbItem>+ <BreadcrumbPage>{title}</BreadcrumbPage>+ </BreadcrumbItem>+ </BreadcrumbList>+ </Breadcrumb>+ );+};++const SettingsBreadcrumb = () => {+ const router = useRouter();+ const path = router.pathname;++ const settingsTitle = useMemo(() => {+ switch (path) {+ case "/settings/general":+ return "General";+ case "/settings/people":+ return "People";+ case "/settings/domains":+ return "Domains";+ case "/settings/presets":+ return "Presets";+ case "/settings/billing":+ return "Billing";+ case "/settings/tokens":+ return "API Tokens";+ case "/settings/webhooks":+ return "Webhooks";+ case "/settings/incoming-webhooks":+ return "Incoming Webhooks";+ case "/settings/branding":+ return "Branding";+ default:+ return "Settings";+ }+ }, [path]);++ return (+ <Breadcrumb>+ <BreadcrumbList>+ <BreadcrumbItem>+ <BreadcrumbLink asChild>+ <Link href="/settings">Settings</Link>+ </BreadcrumbLink>+ </BreadcrumbItem>+ <BreadcrumbSeparator />+ <BreadcrumbItem>+ <BreadcrumbPage>{settingsTitle}</BreadcrumbPage>+ </BreadcrumbItem>+ </BreadcrumbList>+ </Breadcrumb>+ );+};++const DocumentsBreadcrumb = () => {+ const router = useRouter();+ const { name } = router.query as { name: string[] };++ const { folders } = useFolderWithParents({ name });++ return (+ <Breadcrumb>+ <BreadcrumbList>+ <BreadcrumbItem>+ <BreadcrumbLink asChild>+ <Link href="/documents">Documents</Link>+ </BreadcrumbLink>+ </BreadcrumbItem>+ <BreadcrumbSeparator />+ {folders && folders.length > 2 ? (+ <>+ <BreadcrumbItem>+ <DropdownMenu>+ <DropdownMenuTrigger className="flex items-center gap-1">+ <BreadcrumbEllipsis className="h-4 w-4" />+ </DropdownMenuTrigger>+ <DropdownMenuContent align="start">+ {folders.slice(0, -2).map((folder, index) => (+ <DropdownMenuItem key={index}>+ <Link+ href={`/documents/tree${folder.path}`}+ className="w-full"+ >+ {folder.name}+ </Link>+ </DropdownMenuItem>+ ))}+ </DropdownMenuContent>+ </DropdownMenu>+ </BreadcrumbItem>+ <BreadcrumbSeparator />+ <BreadcrumbItem>+ <BreadcrumbLink asChild>+ <Link+ href={`/documents/tree${folders[folders.length - 2].path}`}+ className="max-w-[200px] truncate"+ >+ {folders[folders.length - 2].name}+ </Link>+ </BreadcrumbLink>+ </BreadcrumbItem>+ <BreadcrumbSeparator />+ <BreadcrumbItem>+ <BreadcrumbPage className="max-w-[200px] truncate">+ {folders[folders.length - 1].name}+ </BreadcrumbPage>+ </BreadcrumbItem>+ </>+ ) : (+ folders?.map((folder, index) => (+ <>+ <BreadcrumbItem key={`item-${index}`}>+ {index === folders.length - 1 ? (+ <BreadcrumbPage className="max-w-[200px] truncate">+ {folder.name}+ </BreadcrumbPage>+ ) : (+ <BreadcrumbLink asChild>+ <Link+ href={`/documents/tree${folder.path}`}+ className="max-w-[200px] truncate"+ >+ {folder.name}+ </Link>+ </BreadcrumbLink>+ )}+ </BreadcrumbItem>+ {index < folders.length - 1 && <BreadcrumbSeparator />}+ </>+ ))+ )}+ </BreadcrumbList>+ </Breadcrumb>+ );+};++export const AppBreadcrumb = () => {+ const router = useRouter();+ const path = router.pathname;+ const { id } = router.query as {+ id?: string;+ };++ const breadcrumb = useMemo(() => {+ // Settings routes+ if (path.startsWith("/settings")) {+ return <SettingsBreadcrumb />;+ }++ // Root documents route+ if (path === "/documents") {+ return (+ <Breadcrumb>+ <BreadcrumbList>+ <BreadcrumbItem>+ <BreadcrumbPage>Documents</BreadcrumbPage>+ </BreadcrumbItem>+ </BreadcrumbList>+ </Breadcrumb>+ );+ }++ // Document tree routes+ if (path === "/documents/tree/[...name]") {+ return <DocumentsBreadcrumb />;+ }++ // Single document route+ if (path === "/documents/[id]" && id) {+ return <SingleDocumentBreadcrumb documentId={id} />;+ }++ // Dataroom document routes+ if (path === "/datarooms/[id]/documents" && id) {+ return <DataroomBreadcrumb />;+ }++ // Dataroom document routes+ if (path === "/datarooms/[id]/documents/[...name]" && id) {+ return <DataroomBreadcrumb />;+ }++ // Single dataroom route+ if (path.startsWith("/datarooms/[id]") && id) {+ return <SingleDataroomBreadcrumb path={path} />;+ }++ // Root datarooms route+ if (path === "/datarooms") {+ return (+ <Breadcrumb>+ <BreadcrumbList>+ <BreadcrumbItem>+ <BreadcrumbPage>Datarooms</BreadcrumbPage>+ </BreadcrumbItem>+ </BreadcrumbList>+ </Breadcrumb>+ );+ }++ return null;+ }, [path, id]);++ return breadcrumb;+};diff --git a/components/sidebar/nav-main.tsx b/components/sidebar/nav-main.tsxindex 8564afd0..2e083e50 100644--- a/components/sidebar/nav-main.tsx+++ b/components/sidebar/nav-main.tsx@@ -1,5 +1,7 @@"use client";+import Link from "next/link";+import { ChevronRight, type LucideIcon } from "lucide-react";import {@@ -39,7 +41,7 @@ export function NavMain({}) {return (<SidebarGroup>- <SidebarMenu>+ <SidebarMenu className="space-y-0.5 text-foreground">{items.map((item) => (<Collapsible key={item.title} asChild defaultOpen={item.isActive}><SidebarMenuItem@@ -49,10 +51,10 @@ export function NavMain({)}><SidebarMenuButton asChild tooltip={item.title}>- <a href={item.url}>+ <Link href={item.url} className="p-2"><item.icon /><span>{item.title}</span>- </a>+ </Link></SidebarMenuButton>{item.items?.length ? (<>diff --git a/components/sidebar/team-switcher.tsx b/components/sidebar/team-switcher.tsxindex 170fd211..ae984b20 100644--- a/components/sidebar/team-switcher.tsx+++ b/components/sidebar/team-switcher.tsx@@ -63,7 +63,7 @@ export function TeamSwitcher({<div className="grid flex-1 text-left text-sm leading-tight"><span className="truncate">{activeTeam.name}</span><span className="truncate text-xs font-semibold capitalize">- {isTrial ? "Data Room Trial" : plan}+ {isTrial ? "Data Room Trial" : null}</span></div><ChevronsUpDown className="ml-auto" />diff --git a/lib/types.ts b/lib/types.tsindex 4e9218d7..6f9b184c 100644--- a/lib/types.ts+++ b/lib/types.ts@@ -33,6 +33,11 @@ export interface DocumentWithLinksAndLinkCountAndViewCount extends Document {export interface DocumentWithVersion extends Document {versions: DocumentVersion[];+ folder: {+ name: string;+ path: string;+ };+ hasPageLinks: boolean;}export interface LinkWithViews extends Link {diff --git a/pages/api/teams/[teamId]/documents/[id]/index.ts b/pages/api/teams/[teamId]/documents/[id]/index.tsindex 566f3fe6..2d3051cd 100644--- a/pages/api/teams/[teamId]/documents/[id]/index.ts+++ b/pages/api/teams/[teamId]/documents/[id]/index.ts@@ -38,6 +38,12 @@ export default async function handle(orderBy: { createdAt: "desc" },take: 1,},+ folder: {+ select: {+ name: true,+ path: true,+ },+ },},},});