@alpaca-editor/core 1.0.0 → 1.0.3764-editor-mono

package/dist/tour/preview-tour.js

@@ -0,0 +1,93 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getPreviewTourSteps = getPreviewTourSteps;
+const jsx_runtime_1 = require("react/jsx-runtime");
+function getPreviewTourSteps({ editContext, nextStep, stopTour, waitForElement, delay, }) {
+    const tourSteps = {
+        "start-tour": {
+            title: "Welcome to the Preview Tour!",
+            description: "I'll guide you through the preview and explain how to use its essential features.",
+            prepareAction: async () => {
+                editContext?.openSplashScreen();
+            },
+            buttons: [
+                {
+                    label: ((0, jsx_runtime_1.jsxs)("div", { className: "flex items-center gap-2", children: [(0, jsx_runtime_1.jsx)("i", { className: "pi pi-play" }), " Start Tour"] })),
+                    onClick: () => {
+                        nextStep("comment");
+                    },
+                    className: "button button-primary mt-2",
+                },
+                {
+                    label: ((0, jsx_runtime_1.jsxs)("div", { className: "flex items-center gap-2", children: [(0, jsx_runtime_1.jsx)("i", { className: "pi pi-times" }), " No thanks"] })),
+                    onClick: () => {
+                        stopTour();
+                    },
+                    className: "button button-secondary mt-2",
+                },
+            ],
+        },
+        comment: {
+            description: (0, jsx_runtime_1.jsx)(jsx_runtime_1.Fragment, { children: "Click here to add a comment to the page" }),
+            focusElement: "#add-comment",
+            nextStep: "commentContextMenu",
+            buttons: [
+                {
+                    label: ((0, jsx_runtime_1.jsxs)(jsx_runtime_1.Fragment, { children: [(0, jsx_runtime_1.jsx)("i", { className: "pi pi-arrow-right" }), " Next"] })),
+                    onClick: () => nextStep("commentContextMenu"),
+                },
+            ],
+        },
+        commentContextMenu: {
+            description: ((0, jsx_runtime_1.jsx)(jsx_runtime_1.Fragment, { children: "You can also select text and add a comment from the context menu " })),
+            focusElement: "[data-testid='pageEditoriframe']",
+            waitForUserInput: async () => {
+                await waitForElement(".p-contextmenu-enter-done");
+                await delay(1000);
+            },
+            nextStep: "approveMenu",
+            bubblePosition: "left",
+        },
+        approveMenu: {
+            description: (0, jsx_runtime_1.jsx)(jsx_runtime_1.Fragment, { children: "Approve or reject the page here " }),
+            focusElement: "#actions-menu",
+            waitForUserInput: async () => {
+                await waitForElement("#approveReview");
+                await delay(2000);
+            },
+            nextStep: "closeTour",
+            bubblePosition: "left",
+        },
+        closeTour: {
+            description: (0, jsx_runtime_1.jsx)(jsx_runtime_1.Fragment, { children: "Congratulations! You have completed the tour." }),
+            buttons: [
+                {
+                    label: ((0, jsx_runtime_1.jsxs)(jsx_runtime_1.Fragment, { children: [(0, jsx_runtime_1.jsx)("i", { className: "pi pi-check" }), " Finish Tour"] })),
+                    onClick: () => stopTour(),
+                    className: "button button-primary mt-2",
+                },
+            ],
+        },
+        congratulations: {
+            title: "Congratulations!",
+            description: "You have completed the tour and are ready to start editing!",
+            buttons: [
+                {
+                    label: ((0, jsx_runtime_1.jsxs)(jsx_runtime_1.Fragment, { children: [(0, jsx_runtime_1.jsx)("i", { className: "pi pi-check" }), " Finish Tour"] })),
+                    onClick: () => stopTour(),
+                    className: "button button-primary mt-2",
+                },
+            ],
+        },
+        error: {
+            description: "Oops, something went wrong.",
+            buttons: [
+                {
+                    label: ((0, jsx_runtime_1.jsxs)(jsx_runtime_1.Fragment, { children: [(0, jsx_runtime_1.jsx)("i", { className: "pi pi-check" }), " Close"] })),
+                    onClick: () => stopTour(),
+                },
+            ],
+        },
+    };
+    return tourSteps;
+}