Skip to content

Papermark is the open-source DocSend alternative and secure data rooms with built-in analytics and custom domains.

feat: add feedback question to pagesviewer

Marc Seitze2af99beb2d5
diff --git a/components/view/PagesViewer.tsx b/components/view/PagesViewer.tsx
index e70fdcf7..b0fb44df 100644
--- a/components/view/PagesViewer.tsx
+++ b/components/view/PagesViewer.tsx
@@ -8,6 +8,8 @@ import Toolbar from "./toolbar";
import { Brand, DataroomBrand } from "@prisma/client";
import { useRouter } from "next/router";
import { PoweredBy } from "./powered-by";
+import Question from "./question";
+import { cn } from "@/lib/utils";
const DEFAULT_PRELOADED_IMAGES_NUM = 10;
@@ -24,6 +26,7 @@ export default function PagesViewer({
dataroomId,
setDocumentData,
showPoweredByBanner,
+ feedback,
}: {
pages: { file: string; pageNumber: string; embeddedLinks: string[] }[];
linkId: string;
@@ -37,9 +40,16 @@ export default function PagesViewer({
dataroomId?: string;
setDocumentData?: (data: any) => void;
showPoweredByBanner?: boolean;
+ feedback: {
+ id: string;
+ enabled: boolean;
+ data: { question: string; type: string };
+ } | null;
}) {
const router = useRouter();
const numPages = pages.length;
+ const numPagesWithFeedback =
+ feedback && feedback.enabled ? numPages + 1 : numPages;
const pageQuery = router.query.p ? Number(router.query.p) : 1;
const [pageNumber, setPageNumber] = useState<number>(() =>
@@ -50,6 +60,8 @@ export default function PagesViewer({
new Array(numPages).fill(false),
);
+ const [submittedFeedback, setSubmittedFeedback] = useState<boolean>(false);
+
const startTimeRef = useRef(Date.now());
const pageNumberRef = useRef<number>(pageNumber);
const visibilityRef = useRef<boolean>(true);
@@ -66,8 +78,10 @@ export default function PagesViewer({
startTimeRef.current = Date.now(); // Reset start time when the page becomes visible again
} else {
visibilityRef.current = false;
- const duration = Date.now() - startTimeRef.current;
- trackPageView(duration);
+ if (pageNumber <= numPages) {
+ const duration = Date.now() - startTimeRef.current;
+ trackPageView(duration);
+ }
}
};
@@ -76,19 +90,19 @@ export default function PagesViewer({
return () => {
document.removeEventListener("visibilitychange", handleVisibilityChange);
};
- }, []); // track page view when the page becomes visible or hidden on mount and unmount
+ }, [pageNumber, numPages]); // track page view when the page becomes visible or hidden on mount and unmount
useEffect(() => {
startTimeRef.current = Date.now();
return () => {
- if (visibilityRef.current) {
+ if (visibilityRef.current && pageNumber <= numPages) {
// Only track the page view if the page is visible
const duration = Date.now() - startTimeRef.current;
trackPageView(duration);
}
};
- }, [pageNumber]); // Track page view when the page number changes
+ }, [pageNumber, numPages]); // Track page view when the page number changes
useEffect(() => {
setLoadedImages((prev) =>
@@ -127,12 +141,14 @@ export default function PagesViewer({
// Navigate to previous page
const goToPreviousPage = () => {
if (pageNumber <= 1) return;
+ if (pageNumber === numPagesWithFeedback)
+ return setPageNumber(pageNumber - 1);
setPageNumber(pageNumber - 1);
};
// Navigate to next page and preload next image
const goToNextPage = () => {
- if (pageNumber >= numPages) return;
+ if (pageNumber >= numPagesWithFeedback) return;
preloadImage(DEFAULT_PRELOADED_IMAGES_NUM - 1 + pageNumber); // Preload the next image
setPageNumber(pageNumber + 1);
};
@@ -169,7 +185,7 @@ export default function PagesViewer({
<>
<Nav
pageNumber={pageNumber}
- numPages={numPages}
+ numPages={numPagesWithFeedback}
assistantEnabled={assistantEnabled}
allowDownload={allowDownload}
brand={brand}
@@ -186,7 +202,10 @@ export default function PagesViewer({
<button
onClick={goToPreviousPage}
disabled={pageNumber == 1}
- className="absolute left-0 h-[calc(100vh - 64px)] px-2 py-24 z-20"
+ className={cn(
+ "absolute left-0 h-[calc(100vh - 64px)] px-2 py-24 z-20",
+ pageNumber == 1 && "hidden",
+ )}
>
<span className="sr-only">Previous</span>
<div className="bg-gray-950/50 hover:bg-gray-950/75 rounded-full relative flex items-center justify-center p-1">
@@ -198,8 +217,11 @@ export default function PagesViewer({
</button>
<button
onClick={goToNextPage}
- disabled={pageNumber >= numPages}
- className="absolute right-0 h-[calc(100vh - 64px)] px-2 py-24 z-20"
+ disabled={pageNumber >= numPagesWithFeedback}
+ className={cn(
+ "absolute right-0 h-[calc(100vh - 64px)] px-2 py-24 z-20",
+ pageNumber >= numPagesWithFeedback && "hidden",
+ )}
>
<span className="sr-only">Next</span>
<div className="bg-gray-950/50 hover:bg-gray-950/75 rounded-full relative flex items-center justify-center p-1">
@@ -211,47 +233,60 @@ export default function PagesViewer({
</button>
<div className="flex justify-center mx-auto relative h-full w-full">
- {pages && loadedImages[pageNumber - 1] ? (
- pages.map((page, index) => {
- // contains cloudfront.net in the file path, then use img tag otherwise use next/image
- if (page.file.toLowerCase().includes("files.papermark.io")) {
+ {pageNumber <= numPages &&
+ (pages && loadedImages[pageNumber - 1] ? (
+ pages.map((page, index) => {
+ // contains cloudfront.net in the file path, then use img tag otherwise use next/image
+ if (page.file.toLowerCase().includes("files.papermark.io")) {
+ return (
+ <img
+ key={index}
+ className={`object-contain mx-auto ${
+ pageNumber - 1 === index ? "block" : "hidden"
+ }`}
+ src={
+ loadedImages[index]
+ ? page.file
+ : "https://www.papermark.io/_static/blank.gif"
+ }
+ alt={`Page ${index + 1}`}
+ fetchPriority={loadedImages[index] ? "high" : "auto"}
+ />
+ );
+ }
+
return (
- <img
+ <Image
key={index}
className={`object-contain mx-auto ${
pageNumber - 1 === index ? "block" : "hidden"
}`}
- src={
- loadedImages[index]
- ? page.file
- : "https://www.papermark.io/_static/blank.gif"
- }
+ src={loadedImages[index] ? page.file : BlankImg}
alt={`Page ${index + 1}`}
- fetchPriority={loadedImages[index] ? "high" : "auto"}
+ priority={loadedImages[index] ? true : false}
+ fill
+ sizes="(max-width: 768px) 100vw, (max-width: 1200px) 75vw, 50vw"
+ quality={100}
/>
);
- }
-
- return (
- <Image
- key={index}
- className={`object-contain mx-auto ${
- pageNumber - 1 === index ? "block" : "hidden"
- }`}
- src={loadedImages[index] ? page.file : BlankImg}
- alt={`Page ${index + 1}`}
- priority={loadedImages[index] ? true : false}
- fill
- sizes="(max-width: 768px) 100vw, (max-width: 1200px) 75vw, 50vw"
- quality={100}
- />
- );
- })
- ) : (
- <LoadingSpinner className="h-20 w-20 text-foreground" />
- )}
+ })
+ ) : (
+ <LoadingSpinner className="h-20 w-20 text-foreground" />
+ ))}
+ {feedback &&
+ feedback.enabled &&
+ pageNumber === numPagesWithFeedback ? (
+ <div className="flex items-center justify-center">
+ <Question
+ feedback={feedback}
+ viewId={viewId}
+ submittedFeedback={submittedFeedback}
+ setSubmittedFeedback={setSubmittedFeedback}
+ />
+ </div>
+ ) : null}
</div>
- {feedbackEnabled ? (
+ {feedbackEnabled && pageNumber !== numPagesWithFeedback ? (
<Toolbar viewId={viewId} pageNumber={pageNumber} />
) : null}
{showPoweredByBanner ? <PoweredBy linkId={linkId} /> : null}
diff --git a/components/view/question.tsx b/components/view/question.tsx
new file mode 100644
index 00000000..5aaae0b1
--- /dev/null
+++ b/components/view/question.tsx
@@ -0,0 +1,113 @@
+import { STAGGER_CHILD_VARIANTS } from "@/lib/constants";
+import { cn } from "@/lib/utils";
+import { motion } from "framer-motion";
+import { ThumbsDownIcon, ThumbsUpIcon } from "lucide-react";
+import { useState } from "react";
+
+export default function Question({
+ feedback,
+ viewId,
+ submittedFeedback,
+ setSubmittedFeedback,
+}: {
+ feedback: { id: string; data: { question: string; type: string } };
+ viewId: string;
+ submittedFeedback: boolean;
+ setSubmittedFeedback: (submittedFeedback: boolean) => void;
+}) {
+ const [answer, setAnswer] = useState<"yes" | "no" | "">("");
+
+ const handleQuestionSubmit = async (answer: string) => {
+ };
+
+ if (submittedFeedback) {
+ return (
+ <motion.div
+ className="z-10 mx-5 flex flex-col items-center space-y-10 text-center sm:mx-auto"
+ variants={{
+ hidden: { opacity: 0, scale: 0.95 },
+ show: {
+ opacity: 1,
+ scale: 1,
+ transition: {
+ staggerChildren: 0.2,
+ },
+ },
+ }}
+ initial="hidden"
+ animate="show"
+ exit="hidden"
+ transition={{ duration: 0.3, type: "spring" }}
+ >
+ <motion.div
+ variants={STAGGER_CHILD_VARIANTS}
+ className="flex flex-col items-center space-y-10 text-center"
+ >
+ <h1 className="font-display max-w-lg text-3xl font-semibold transition-colors sm:text-4xl text-white">
+ Thanks for your feedback!
+ </h1>
+ </motion.div>
+ </motion.div>
+ );
+ }
+
+ return (
+ <motion.div
+ className="z-10 mx-5 flex flex-col items-center space-y-10 text-center sm:mx-auto"
+ variants={{
+ hidden: { opacity: 0, scale: 0.95 },
+ show: {
+ opacity: 1,
+ scale: 1,
+ transition: {
+ staggerChildren: 0.2,
+ },
+ },
+ }}
+ initial="hidden"
+ animate="show"
+ exit="hidden"
+ transition={{ duration: 0.3, type: "spring" }}
+ >
+ <motion.div
+ variants={STAGGER_CHILD_VARIANTS}
+ className="flex flex-col items-center space-y-10 text-center"
+ >
+ <h1 className="font-display max-w-xl text-3xl font-semibold transition-colors sm:text-4xl text-white">
+ {feedback.data.question}
+ </h1>
+ </motion.div>
+ <motion.div
+ variants={STAGGER_CHILD_VARIANTS}
+ className="grid w-full max-w-md grid-cols-1 divide-border text-white rounded-md border border-border md:grid-cols-2 md:divide-x md:divide-y-0 divide-y"
+ >
+ <button
+ onClick={() => handleQuestionSubmit("yes")}
+ className={cn(
+ "flex flex-col items-center justify-center overflow-hidden p-5 space-y-5 transition-colors hover:text-black hover:bg-gray-200 hover:dark:bg-gray-800 md:p-10 min-h-[200px]",
+ answer === "yes" ? "bg-gray-200 dark:bg-gray-800" : "",
+ )}
+ >
+ <ThumbsUpIcon
+ className="h-auto pointer-events-none w-12 sm:w-12"
+ strokeWidth={1}
+ />
+ <p>Yes</p>
+ </button>
+ <button
+ onClick={() => handleQuestionSubmit("no")}
+ className={cn(
+ "flex flex-col items-center justify-center overflow-hidden p-5 space-y-5 transition-colors hover:text-black hover:bg-gray-200 hover:dark:bg-gray-800 md:p-10 min-h-[200px]",
+ answer === "no" ? "bg-gray-200 dark:bg-gray-800" : "",
+ )}
+ >
+ <ThumbsDownIcon
+ className="h-auto pointer-events-none w-12 sm:w-12"
+ strokeWidth={1}
+ />
+ <p>No</p>
+ </button>
+ </motion.div>
+ </motion.div>
+ );
+}
diff --git a/components/view/view-data.tsx b/components/view/view-data.tsx
index 75c6c2fc..a9c61479 100644
--- a/components/view/view-data.tsx
+++ b/components/view/view-data.tsx
@@ -45,6 +45,7 @@ export default function ViewData({
versionNumber={document.versions[0].versionNumber}
brand={brand}
showPoweredByBanner={showPoweredByBanner}
+ feedback={document.feedback}
/>
) : (
<PDFViewer
diff --git a/lib/types.ts b/lib/types.ts
index da332e81..bdae4369 100644
--- a/lib/types.ts
+++ b/lib/types.ts
@@ -51,6 +51,14 @@ export interface LinkWithDocument extends Link {
team: {
plan: string;
} | null;
+ feedback: {
+ id: string;
+ enabled: boolean;
+ data: {
+ question: string;
+ type: string;
+ };
+ } | null;
};
}
diff --git a/pages/api/links/[id]/index.ts b/pages/api/links/[id]/index.ts
index f979e3ce..2b7a9373 100644
--- a/pages/api/links/[id]/index.ts
+++ b/pages/api/links/[id]/index.ts
@@ -44,6 +44,13 @@ export default async function handle(
plan: true,
},
},
+ feedback: {
+ select: {
+ id: true,
+ enabled: true,
+ data: true,
+ },
+ },
versions: {
where: { isPrimary: true },
select: {
diff --git a/pages/api/links/domains/[...domainSlug].ts b/pages/api/links/domains/[...domainSlug].ts
index 3f67dfdd..93b0c3f3 100644
--- a/pages/api/links/domains/[...domainSlug].ts
+++ b/pages/api/links/domains/[...domainSlug].ts
@@ -60,6 +60,13 @@ export default async function handle(
},
take: 1,
},
+ feedback: {
+ select: {
+ id: true,
+ enabled: true,
+ data: true,
+ },
+ },
},
},
},