Merge pull request #112 from JadeMaveric/guided-tour

Guided tour
samay-app · Mar 21, 2021 · 25a4f4a · 25a4f4a
2 parents 6ac3273 + d29f4c7
commit 25a4f4a
Show file tree

Hide file tree

Showing 3 changed files with 89 additions and 17 deletions.
diff --git a/package.json b/package.json
@@ -54,6 +54,7 @@
     "react-dom": "16.13.1",
     "react-firebaseui": "^4.1.0",
     "react-github-corner": "^2.5.0",
+    "react-joyride": "^2.3.0",
     "react-redux": "^7.2.2",
     "redux": "^4.0.5",
     "redux-devtools-extension": "^2.13.8",
@@ -92,4 +93,4 @@
     "ts-jest": "^26.4.4",
     "typescript": "^4.1.3"
   }
-}
+}
diff --git a/pages/poll/create.tsx b/pages/poll/create.tsx
@@ -12,8 +12,9 @@ import {
   OverlayTrigger,
   Tooltip,
 } from "react-bootstrap";
-import { InfoCircleFill } from "react-bootstrap-icons";
+import { InfoCircleFill, QuestionCircleFill } from "react-bootstrap-icons";
 import { useState } from "react";
+import Joyride, { CallBackProps, STATUS, Step } from "react-joyride";
 import Layout from "../../src/components/Layout";
 import ResponseMessage from "../../src/components/ResponseMessage";
 import { encrypt } from "../../src/helpers/helpers";
@@ -45,6 +46,43 @@ const Create = (): JSX.Element => {
     msg: "",
   });
 
+  const [tourRun, setTourRun] = useState<boolean>(false);
+
+  // Run automatically for first time users
+  if (typeof window !== "undefined") {
+    if (localStorage.visited !== "true") {
+      localStorage.setItem("visited", "true");
+      setTourRun(true);
+    }
+  }
+
+  const tourSteps: Step[] = [
+    {
+      disableBeacon: true,
+      target: "#formPlainTextTitle",
+      content: "Give your event the memorable title it deserves.",
+    },
+    {
+      target: "#formPlainTextDescription",
+      content:
+        "Add a description to let your invitees know what this is all about.",
+    },
+    {
+      target: ".rat-AvailableTimes_buttons",
+      content:
+        "Are you an early planner? Use these button to schedule in the future. (ps: Time travel powers not included)",
+    },
+    {
+      target: ".rat-Slider_component",
+      content:
+        "Click and drag to create a time slot. You can create more than one. These will be the choices that are generated in the poll",
+    },
+    {
+      target: ".create-poll-btn",
+      content: "Click here when you're all done to get a sharable link",
+    },
+  ];
+
   const handleTitleChange = (e: React.ChangeEvent<HTMLInputElement>): void => {
     const { value } = e.target;
     setTitle(value);
@@ -136,8 +174,37 @@ const Create = (): JSX.Element => {
     }
   };
 
+  const handleStartTour = (): void => {
+    setTourRun(true);
+  };
+
+  const handleJoyrideCallback = (data: CallBackProps): void => {
+    const { status, type } = data;
+    const finishedStatuses: string[] = [STATUS.FINISHED, STATUS.SKIPPED];
+
+    if (finishedStatuses.includes(status) || type === "beacon") {
+      setTourRun(false);
+    }
+  };
+
   return (
     <Layout>
+      <Joyride
+        callback={handleJoyrideCallback}
+        steps={tourSteps}
+        run={tourRun}
+        continuous
+        showSkipButton
+        showProgress
+        debug={process.env.NODE_ENV === "development"}
+        spotlightClicks
+        styles={{
+          buttonClose: { visibility: "hidden" },
+          options: {
+            primaryColor: "#101010",
+          },
+        }}
+      />
       <Container className="rm-poll-container" fluid>
         <Row className="jumbo-row">
           <div className="jumbo-col-black col-sm-4">
@@ -174,6 +241,10 @@ const Create = (): JSX.Element => {
               >
                 <InfoCircleFill className="timezone-info-icon" />
               </OverlayTrigger>
+              <QuestionCircleFill
+                className="tour-start-icon"
+                onClick={handleStartTour}
+              />
             </Jumbotron>
           </div>
           <div className="col-sm-8">
@@ -191,17 +262,17 @@ const Create = (): JSX.Element => {
                 {!disabled ? (
                   `Create Poll`
                 ) : (
-                    <>
-                      <Spinner
-                        as="span"
-                        animation="border"
-                        size="sm"
-                        role="status"
-                        aria-hidden="true"
-                        className="rm-button-spinner"
-                      />
-                    </>
-                  )}
+                  <>
+                    <Spinner
+                      as="span"
+                      animation="border"
+                      size="sm"
+                      role="status"
+                      aria-hidden="true"
+                      className="rm-button-spinner"
+                    />
+                  </>
+                )}
               </Button>
               <ResponseMessage
                 response={response}

diff --git a/src/styles/index.css b/src/styles/index.css
@@ -359,11 +359,11 @@ h4 {
   border-bottom: 3px solid #d3d3d3 !important;
 }
 
-.timezone-info-icon {
+.timezone-info-icon, .tour-start-icon {
   width: 1.3rem;
   height: 1.3rem;
   color: #e0e0e0;
-  margin-top: 2rem;
+  margin: 2rem 0.25rem 0rem 0.25rem;
 }
 
 @media (min-width: 0) and (max-width: 992px) {
@@ -375,10 +375,10 @@ h4 {
     font-size: 1.5rem !important;
   }
 
-  .timezone-info-icon {
+  .timezone-info-icon, .tour-start-icon {
     width: 1rem;
     height: 1rem;
-    margin-top: 1rem;
+    margin: 1rem 0.125rem 0rem 0.125rem;
   }
 }