## Description - Added support for multiple highlights in walkthrough - Corrected walkthrough events for each feature walkthrough - Added fix for the walkthrough dismissal in case of empty/no schema feature #### PR fixes following issue(s) Fixes #25417 Fixes #25416 #### Media > A video or a GIF is preferred. when using Loom, don’t embed because it looks like it’s a GIF. instead, just link to the video > > #### Type of change > Please delete options that are not relevant. - Bug fix (non-breaking change which fixes an issue) - New feature (non-breaking change which adds functionality) - Breaking change (fix or feature that would cause existing functionality to not work as expected) - Chore (housekeeping or task changes that don't impact user perception) - This change requires a documentation update > > > ## Testing > #### How Has This Been Tested? > Please describe the tests that you ran to verify your changes. Also list any relevant details for your test configuration. > Delete anything that is not relevant - [ ] Manual - [ ] Jest - [ ] Cypress > > #### Test Plan > Add Testsmith test cases links that relate to this PR > > #### Issues raised during DP testing > Link issues raised during DP testing for better visiblity and tracking (copy link from comments dropped on this PR) > > > ## Checklist: #### Dev activity - [ ] My code follows the style guidelines of this project - [ ] I have performed a self-review of my own code - [ ] I have commented my code, particularly in hard-to-understand areas - [ ] I have made corresponding changes to the documentation - [ ] My changes generate no new warnings - [ ] I have added tests that prove my fix is effective or that my feature works - [ ] New and existing unit tests pass locally with my changes - [ ] PR is being merged under a feature flag #### QA activity: - [ ] [Speedbreak features](https://github.com/appsmithorg/TestSmith/wiki/Guidelines-for-test-plans#speedbreakers-) have been covered - [ ] Test plan covers all impacted features and [areas of interest](https://github.com/appsmithorg/TestSmith/wiki/Guidelines-for-test-plans#areas-of-interest-) - [ ] Test plan has been peer reviewed by project stakeholders and other QA members - [ ] Manually tested functionality on DP - [ ] We had an implementation alignment call with stakeholders post QA Round 2 - [ ] Cypress test cases have been added and approved by SDET/manual QA - [ ] Added `Test Plan Approved` label after Cypress tests were reviewed - [ ] Added `Test Plan Approved` label after JUnit tests were reviewed --------- Co-authored-by: “sneha122” <“sneha@appsmith.com”>
94 lines
2.6 KiB
TypeScript
94 lines
2.6 KiB
TypeScript
import React, { lazy, useEffect, useState, Suspense } from "react";
|
|
import type { FeatureParams } from "./walkthroughContext";
|
|
import { DEFAULT_DELAY } from "./walkthroughContext";
|
|
import WalkthroughContext from "./walkthroughContext";
|
|
import { createPortal } from "react-dom";
|
|
import { hideIndicator } from "pages/Editor/GuidedTour/utils";
|
|
import { retryPromise } from "utils/AppsmithUtils";
|
|
import { useLocation } from "react-router-dom";
|
|
import AnalyticsUtil from "utils/AnalyticsUtil";
|
|
|
|
const WalkthroughRenderer = lazy(() => {
|
|
return retryPromise(
|
|
() =>
|
|
import(
|
|
/* webpackChunkName: "walkthrough-renderer" */ "./walkthroughRenderer"
|
|
),
|
|
);
|
|
});
|
|
|
|
const LoadingFallback = () => null;
|
|
|
|
export default function Walkthrough({ children }: any) {
|
|
const [activeWalkthrough, setActiveWalkthrough] =
|
|
useState<FeatureParams | null>();
|
|
const [feature, setFeature] = useState<FeatureParams[]>([]);
|
|
const location = useLocation();
|
|
|
|
const pushFeature = (value: FeatureParams) => {
|
|
const alreadyExists = feature.some((f) => f.targetId === value.targetId);
|
|
if (!alreadyExists) {
|
|
if (Array.isArray(value)) {
|
|
setFeature((e) => [...e, ...value]);
|
|
} else {
|
|
setFeature((e) => [...e, value]);
|
|
}
|
|
}
|
|
updateActiveWalkthrough();
|
|
};
|
|
|
|
const popFeature = (triggeredFrom?: string) => {
|
|
hideIndicator();
|
|
const eventParams = activeWalkthrough?.eventParams || {};
|
|
if (triggeredFrom) {
|
|
eventParams.from = triggeredFrom;
|
|
}
|
|
AnalyticsUtil.logEvent("WALKTHROUGH_DISMISSED", eventParams);
|
|
if (activeWalkthrough && activeWalkthrough.onDismiss) {
|
|
activeWalkthrough.onDismiss();
|
|
}
|
|
setFeature((e) => {
|
|
e.shift();
|
|
return [...e];
|
|
});
|
|
};
|
|
|
|
const updateActiveWalkthrough = () => {
|
|
if (feature.length > 0) {
|
|
const highlightArea = document.getElementById(feature[0].targetId);
|
|
setActiveWalkthrough(null);
|
|
if (highlightArea) {
|
|
setTimeout(() => {
|
|
setActiveWalkthrough(feature[0]);
|
|
}, feature[0].delay || DEFAULT_DELAY);
|
|
}
|
|
} else {
|
|
setActiveWalkthrough(null);
|
|
}
|
|
};
|
|
|
|
useEffect(() => {
|
|
if (feature.length > -1) updateActiveWalkthrough();
|
|
}, [feature.length, location]);
|
|
|
|
return (
|
|
<WalkthroughContext.Provider
|
|
value={{
|
|
pushFeature,
|
|
popFeature,
|
|
feature,
|
|
isOpened: !!activeWalkthrough,
|
|
}}
|
|
>
|
|
{children}
|
|
{activeWalkthrough &&
|
|
createPortal(
|
|
<Suspense fallback={<LoadingFallback />}>
|
|
<WalkthroughRenderer {...activeWalkthrough} />
|
|
</Suspense>,
|
|
document.body,
|
|
)}
|
|
</WalkthroughContext.Provider>
|
|
);
|
|
}
|