linear-react-components-ui 1.1.2-beta.8 → 1.1.3-beta.0

package/lib/uitour/index.js

@@ -5,6 +5,7 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.default = void 0;
 var _react = _interopRequireWildcard(require("react"));
+var _reactDom = require("react-dom");
 var _buttons = _interopRequireWildcard(require("../buttons"));
 require("../assets/styles/uitour.scss");
 var _helpers = require("./helpers");
@@ -24,7 +25,8 @@ const UiTour = props => {
     showCloseButton = true,
     showBackButton = true,
     visible = true,
-    onFinish
+    onFinish,
+    onStepChange
   } = props;
   const [currentStep, setCurrentStep] = (0, _react.useState)(undefined);
   const [hasNextStep, setHasNextStep] = (0, _react.useState)(false);
@@ -35,6 +37,7 @@ const UiTour = props => {
   const [stepPosition, setStepPosition] = (0, _react.useState)(_helpers.STEP_POSITIONS.left);
   const stepRef = (0, _react.useRef)(null);
   const descriptionRef = (0, _react.useRef)(null);
+  const activatedEffects = (0, _react.useRef)([]);
   const handleNextStep = () => {
     if (hasNextStep) {
       const currentStepIndex = data.findIndex(item => item.id === (currentStep === null || currentStep === void 0 ? void 0 : currentStep.id));
@@ -88,6 +91,46 @@ const UiTour = props => {
     setShowTour(visible);
     setCurrentStep(step);
   };
+  const removePreviousElementsEffects = () => {
+    if (activatedEffects.current.length > 0) {
+      const effects = activatedEffects.current;
+      effects.forEach(ef => {
+        const element = document.getElementById(ef.elementId);
+        if (element) {
+          delete element.dataset.uitour;
+          activatedEffects.current = activatedEffects.current.filter(r => r.elementId !== ef.elementId);
+        }
+      });
+    }
+  };
+  const addElementEffect = (0, _react.useCallback)(elementEffect => {
+    const element = document.getElementById(elementEffect.elementId);
+    if (element) {
+      element.dataset.uitour = elementEffect.effect;
+      if (activatedEffects.current) activatedEffects.current.push(elementEffect);
+    }
+  }, []);
+  const showElementsEffects = currentData => {
+    if (currentData.effect) {
+      const {
+        effect,
+        targetId
+      } = currentData;
+      addElementEffect({
+        effect,
+        elementId: targetId
+      });
+    }
+    if (currentData.elementsEffects) {
+      let {
+        elementsEffects
+      } = currentData;
+      if (!Array.isArray(elementsEffects)) elementsEffects = [elementsEffects];
+      elementsEffects.forEach(ef => {
+        addElementEffect(ef);
+      });
+    }
+  };
   (0, _react.useEffect)(() => {
     if (currentStep) {
       const target = document.getElementById(currentStep.targetId);
@@ -113,6 +156,9 @@ const UiTour = props => {
             setIsLastStep(false);
         }
         getStepPosition(targetRect);
+        removePreviousElementsEffects();
+        showElementsEffects(data[currentStepIndex]);
+        if (onStepChange) onStepChange(target);
       }
       if (descriptionRef.current) {
         descriptionRef.current.innerHTML = currentStep.description;
@@ -151,8 +197,13 @@ const UiTour = props => {
       mutationObserver = null;
     };
   }, [visible, data]);
-  if (!showTour) return null;
-  return /*#__PURE__*/_react.default.createElement("div", {
+  (0, _react.useEffect)(() => {
+    if (!showTour && activatedEffects.current.length > 0) {
+      removePreviousElementsEffects();
+    }
+    if (showTour) document.body.style.overflow = 'hidden';else document.body.style.overflow = 'auto';
+  }, [showTour, activatedEffects.current.length]);
+  const component = (0, _react.useMemo)(() => /*#__PURE__*/_react.default.createElement("div", {
     className: "uitour-component"
   }, currentStep && /*#__PURE__*/_react.default.createElement("div", {
     ref: stepRef,
@@ -199,6 +250,8 @@ const UiTour = props => {
     visible: isLastStep,
     onClick: onCloseTour,
     customClass: "finish-button"
-  }))));
+  })))), [currentStep, stepPosition, stepDimensions, showCloseButton, onCloseTour, backButtonLabel, handleBackStep, hasBackStep, showBackButton, nextButtonLabel, handleNextStep, hasNextStep, isLastStep, finishButtonLabel, isLastStep, onCloseTour]);
+  if (!showTour) return null;
+  return /*#__PURE__*/(0, _reactDom.createPortal)(component, document.body);
 };
 var _default = exports.default = UiTour;

package/lib/uitour/types.d.ts

@@ -1,11 +1,18 @@
 import { STEP_POSITIONS } from './helpers.js';
 
+type Effect = 'hover' | 'focus' | 'blur' | 'active' | 'selected';
+type ElementEffect = {
+    elementId: string;
+    effect: Effect;
+};
 type UITourData = {
     id: string | number;
     targetId: string;
+    effect?: Effect;
     title: string;
     description: string;
     position?: keyof typeof STEP_POSITIONS;
+    elementsEffects?: ElementEffect | ElementEffect[];
 };
 interface CurrentStep extends UITourData {
     number: number;
@@ -25,6 +32,7 @@ interface IUITourProps {
     showBackButton?: boolean;
     visible?: boolean;
     onFinish: (value: boolean) => void;
+    onStepChange?: (target: HTMLElement) => void;
 }
 
-export type { CurrentStep, IUITourProps, StepDimensions, UITourData };
+export type { CurrentStep, Effect, ElementEffect, IUITourProps, StepDimensions, UITourData };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "linear-react-components-ui",
-  "version": "1.1.2-beta.8",
+  "version": "1.1.3-beta.0",
   "description": "Linear Sistemas ReactJs Components",
   "main": "lib/index.js",
   "module": "lib/index.cjs",
@@ -9,7 +9,7 @@
     "lib:types": "NODE_OPTIONS='--max-old-space-size=16384' tsup --dts-only --dts --external react",
     "demo": "node scripts/start.js",
     "demo:prod": "webpack --config ./config/webpack.config.js --mode production",
-    "check:js": "eslint ./src/** --ext=.jsx,.js,.tsx,.ts",
+    "check:js": "eslint ./src/** --ext=.jsx,.js,.tsx,.ts --cache",
     "deploy:heroku": "npm run demo:prod && cd demo && git commit -am 'Deploy' && git push heroku master",
     "deploy:vercel": "npm run demo:prod && vercel --prod demo",
     "publish:npm": "npm run lib && npm publish",
@@ -43,7 +43,7 @@
   "dependencies": {
     "@types/react-dom": "18.0.5",
     "attach-dom-events": "1.0.0",
-    "browserslist": "4.18.1",
+    "browserslist": "4.23.0",
     "history": "5.0.0",
     "imask": "6.4.3",
     "init": "0.1.2",
@@ -54,7 +54,7 @@
     "react-router-dom": "6.21.3",
     "react-syntax-highlighter": "15.5.0",
     "semver": "7.5.4",
-    "uuid": "3.3.3"
+    "uuid": "9.0.1"
   },
   "devDependencies": {
     "@babel/cli": "7.23.9",
@@ -65,7 +65,7 @@
     "@babel/preset-react": "7.18.6",
     "@babel/preset-typescript": "7.23.3",
     "@svgr/webpack": "8.1.0",
-    "@swc/core": "1.3.29",
+    "@swc/core": "1.4.13",
     "@testing-library/jest-dom": "5.16.5",
     "@testing-library/react": "14.1.2",
     "@testing-library/user-event": "14.4.3",

package/.tool-versions

@@ -1 +0,0 @@
-nodejs 10.16.0