linear-react-components-ui 1.0.2 → 1.0.3-beta.1

package/lib/uitour/index.js

@@ -1,65 +1,89 @@
 "use strict";
 
 function _typeof(obj) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (obj) { return typeof obj; } : function (obj) { return obj && "function" == typeof Symbol && obj.constructor === Symbol && obj !== Symbol.prototype ? "symbol" : typeof obj; }, _typeof(obj); }
+
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.default = void 0;
+
 var _react = _interopRequireWildcard(require("react"));
+
 var _buttons = _interopRequireWildcard(require("../buttons"));
+
 require("../assets/styles/uitour.scss");
+
 var _helpers = require("./helpers");
+
 function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function _getRequireWildcardCache(nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
+
 function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || _typeof(obj) !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
+
 function _extends() { _extends = Object.assign ? Object.assign.bind() : function (target) { for (var i = 1; i < arguments.length; i++) { var source = arguments[i]; for (var key in source) { if (Object.prototype.hasOwnProperty.call(source, key)) { target[key] = source[key]; } } } return target; }; return _extends.apply(this, arguments); }
+
 function _slicedToArray(arr, i) { return _arrayWithHoles(arr) || _iterableToArrayLimit(arr, i) || _unsupportedIterableToArray(arr, i) || _nonIterableRest(); }
+
 function _nonIterableRest() { throw new TypeError("Invalid attempt to destructure non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); }
+
 function _unsupportedIterableToArray(o, minLen) { if (!o) return; if (typeof o === "string") return _arrayLikeToArray(o, minLen); var n = Object.prototype.toString.call(o).slice(8, -1); if (n === "Object" && o.constructor) n = o.constructor.name; if (n === "Map" || n === "Set") return Array.from(o); if (n === "Arguments" || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(n)) return _arrayLikeToArray(o, minLen); }
-function _arrayLikeToArray(arr, len) { if (len == null || len > arr.length) len = arr.length; for (var i = 0, arr2 = new Array(len); i < len; i++) arr2[i] = arr[i]; return arr2; }
-function _iterableToArrayLimit(arr, i) { var _i = null == arr ? null : "undefined" != typeof Symbol && arr[Symbol.iterator] || arr["@@iterator"]; if (null != _i) { var _s, _e, _x, _r, _arr = [], _n = !0, _d = !1; try { if (_x = (_i = _i.call(arr)).next, 0 === i) { if (Object(_i) !== _i) return; _n = !1; } else for (; !(_n = (_s = _x.call(_i)).done) && (_arr.push(_s.value), _arr.length !== i); _n = !0); } catch (err) { _d = !0, _e = err; } finally { try { if (!_n && null != _i.return && (_r = _i.return(), Object(_r) !== _r)) return; } finally { if (_d) throw _e; } } return _arr; } }
+
+function _arrayLikeToArray(arr, len) { if (len == null || len > arr.length) len = arr.length; for (var i = 0, arr2 = new Array(len); i < len; i++) { arr2[i] = arr[i]; } return arr2; }
+
+function _iterableToArrayLimit(arr, i) { var _i = arr == null ? null : typeof Symbol !== "undefined" && arr[Symbol.iterator] || arr["@@iterator"]; if (_i == null) return; var _arr = []; var _n = true; var _d = false; var _s, _e; try { for (_i = _i.call(arr); !(_n = (_s = _i.next()).done); _n = true) { _arr.push(_s.value); if (i && _arr.length === i) break; } } catch (err) { _d = true; _e = err; } finally { try { if (!_n && _i["return"] != null) _i["return"](); } finally { if (_d) throw _e; } } return _arr; }
+
 function _arrayWithHoles(arr) { if (Array.isArray(arr)) return arr; }
+
 var UiTour = function UiTour(props) {
   var data = props.data,
-    nextButtonLabel = props.nextButtonLabel,
-    backButtonLabel = props.backButtonLabel,
-    finishButtonLabel = props.finishButtonLabel,
-    _props$showCloseButto = props.showCloseButton,
-    showCloseButton = _props$showCloseButto === void 0 ? true : _props$showCloseButto,
-    _props$showBackButton = props.showBackButton,
-    showBackButton = _props$showBackButton === void 0 ? true : _props$showBackButton,
-    _props$visible = props.visible,
-    visible = _props$visible === void 0 ? true : _props$visible,
-    onFinish = props.onFinish;
+      nextButtonLabel = props.nextButtonLabel,
+      backButtonLabel = props.backButtonLabel,
+      finishButtonLabel = props.finishButtonLabel,
+      _props$showCloseButto = props.showCloseButton,
+      showCloseButton = _props$showCloseButto === void 0 ? true : _props$showCloseButto,
+      _props$showBackButton = props.showBackButton,
+      showBackButton = _props$showBackButton === void 0 ? true : _props$showBackButton,
+      _props$visible = props.visible,
+      visible = _props$visible === void 0 ? true : _props$visible,
+      onFinish = props.onFinish;
+
   var _useState = (0, _react.useState)(undefined),
-    _useState2 = _slicedToArray(_useState, 2),
-    currentStep = _useState2[0],
-    setCurrentStep = _useState2[1];
+      _useState2 = _slicedToArray(_useState, 2),
+      currentStep = _useState2[0],
+      setCurrentStep = _useState2[1];
+
   var _useState3 = (0, _react.useState)(false),
-    _useState4 = _slicedToArray(_useState3, 2),
-    hasNextStep = _useState4[0],
-    setHasNextStep = _useState4[1];
+      _useState4 = _slicedToArray(_useState3, 2),
+      hasNextStep = _useState4[0],
+      setHasNextStep = _useState4[1];
+
   var _useState5 = (0, _react.useState)(false),
-    _useState6 = _slicedToArray(_useState5, 2),
-    hasBackStep = _useState6[0],
-    setHasBackStep = _useState6[1];
+      _useState6 = _slicedToArray(_useState5, 2),
+      hasBackStep = _useState6[0],
+      setHasBackStep = _useState6[1];
+
   var _useState7 = (0, _react.useState)(false),
-    _useState8 = _slicedToArray(_useState7, 2),
-    isLastStep = _useState8[0],
-    setIsLastStep = _useState8[1];
+      _useState8 = _slicedToArray(_useState7, 2),
+      isLastStep = _useState8[0],
+      setIsLastStep = _useState8[1];
+
   var _useState9 = (0, _react.useState)(null),
-    _useState10 = _slicedToArray(_useState9, 2),
-    stepDimensions = _useState10[0],
-    setStepDimensions = _useState10[1];
+      _useState10 = _slicedToArray(_useState9, 2),
+      stepDimensions = _useState10[0],
+      setStepDimensions = _useState10[1];
+
   var _useState11 = (0, _react.useState)(visible),
-    _useState12 = _slicedToArray(_useState11, 2),
-    showTour = _useState12[0],
-    setShowTour = _useState12[1];
+      _useState12 = _slicedToArray(_useState11, 2),
+      showTour = _useState12[0],
+      setShowTour = _useState12[1];
+
   var _useState13 = (0, _react.useState)(_helpers.STEP_POSITIONS.left),
-    _useState14 = _slicedToArray(_useState13, 2),
-    stepPosition = _useState14[0],
-    setStepPosition = _useState14[1];
+      _useState14 = _slicedToArray(_useState13, 2),
+      stepPosition = _useState14[0],
+      setStepPosition = _useState14[1];
+
   var stepRef = (0, _react.useRef)(null);
   var descriptionRef = (0, _react.useRef)(null);
+
   var handleNextStep = function handleNextStep() {
     if (hasNextStep) {
       var currentStepIndex = data.findIndex(function (item) {
@@ -70,6 +94,7 @@ var UiTour = function UiTour(props) {
         return item.id === nextStep.id;
       });
       var target = document.getElementById(nextStep.targetId);
+
       if (target) {
         setCurrentStep(_extends({}, nextStep, {
           number: nextStepIndex + 1
@@ -77,6 +102,7 @@ var UiTour = function UiTour(props) {
       }
     }
   };
+
   var handleBackStep = function handleBackStep() {
     if (hasBackStep) {
       var currentStepIndex = data.findIndex(function (item) {
@@ -87,6 +113,7 @@ var UiTour = function UiTour(props) {
         return item.id === backStep.id;
       });
       var target = document.getElementById(backStep.targetId);
+
       if (target) {
         setCurrentStep(_extends({}, backStep, {
           number: backStepIndex + 1
@@ -94,14 +121,17 @@ var UiTour = function UiTour(props) {
       }
     }
   };
+
   var onCloseTour = function onCloseTour() {
     setShowTour(false);
     if (onFinish) onFinish(true);
   };
+
   var getStepPosition = function getStepPosition(target) {
     if (stepRef.current) {
       var stepRect = stepRef.current.getBoundingClientRect();
       var windowWidth = window.innerWidth;
+
       if (stepRect.right >= windowWidth || (currentStep === null || currentStep === void 0 ? void 0 : currentStep.position) === _helpers.STEP_POSITIONS.right) {
         setStepPosition(_helpers.STEP_POSITIONS.right);
         setStepDimensions({
@@ -117,9 +147,11 @@ var UiTour = function UiTour(props) {
       }
     }
   };
+
   (0, _react.useEffect)(function () {
     if (currentStep) {
       var target = document.getElementById(currentStep.targetId);
+
       if (target) {
         var targetRect = target.getBoundingClientRect();
         var currentStepIndex = data.findIndex(function (item) {
@@ -127,24 +159,29 @@ var UiTour = function UiTour(props) {
         });
         var lastDataIndex = data.length - 1;
         var initialDataIndex = 0;
+
         switch (currentStepIndex) {
           case lastDataIndex:
             setHasNextStep(false);
             setHasBackStep(true);
             setIsLastStep(true);
             break;
+
           case initialDataIndex:
             setHasNextStep(true);
             setIsLastStep(false);
             setHasBackStep(false);
             break;
+
           default:
             setHasNextStep(true);
             setHasBackStep(true);
             setIsLastStep(false);
         }
+
         getStepPosition(targetRect);
       }
+
       if (descriptionRef.current) {
         descriptionRef.current.innerHTML = currentStep.description;
       }
@@ -153,9 +190,11 @@ var UiTour = function UiTour(props) {
   (0, _react.useEffect)(function () {
     if (data && visible) {
       var initialNumber = 1;
+
       var initialStep = _extends({}, data[0], {
         number: initialNumber
       });
+
       setShowTour(visible);
       setCurrentStep(initialStep);
     }
@@ -210,5 +249,6 @@ var UiTour = function UiTour(props) {
     customClass: "finish-button"
   }))));
 };
+
 var _default = UiTour;
 exports.default = _default;

package/lib/uitour/types.d.ts

@@ -1,6 +1,6 @@
 import { STEP_POSITIONS } from './helpers.js';
 
-type UITourData = {
+declare type UITourData = {
     id: string | number;
     targetId: string;
     title: string;

package/lib/uitour/uitour.spec.js

@@ -0,0 +1,176 @@
+"use strict";
+
+var _react = _interopRequireDefault(require("react"));
+
+var _propTypes = _interopRequireDefault(require("prop-types"));
+
+require("@testing-library/jest-dom");
+
+require("babel-polyfill");
+
+var _react2 = require("@testing-library/react");
+
+var _ = _interopRequireDefault(require("."));
+
+var _helpers = require("./helpers");
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+var data = [{
+  id: '1',
+  targetId: 'uitour-teste',
+  title: 'Título',
+  description: 'Lorem ipsum dolor sit <strong>amet</strong> consectetur adipisicing elit.'
+}, {
+  id: '2',
+  targetId: 'uitour-button',
+  title: 'Botão',
+  description: 'Lorem ipsum, dolor sit adipisicing elit. Repellendus, fuga.'
+}];
+var backButtonLabel = 'Voltar';
+var nextButtonLabel = 'Avançar';
+var finishButtonLabel = 'Finalizar';
+
+var UiTourMock = function UiTourMock(_ref) {
+  var onFinish = _ref.onFinish,
+      visible = _ref.visible,
+      showCloseButton = _ref.showCloseButton,
+      showBackButton = _ref.showBackButton;
+  return /*#__PURE__*/_react.default.createElement("div", null, /*#__PURE__*/_react.default.createElement("h1", {
+    style: {
+      width: 100
+    },
+    id: "uitour-teste"
+  }, "Teste UiTour"), /*#__PURE__*/_react.default.createElement("button", {
+    id: "uitour-button"
+  }, "Teste button"), /*#__PURE__*/_react.default.createElement(_.default, {
+    data: data,
+    backButtonLabel: backButtonLabel,
+    nextButtonLabel: nextButtonLabel,
+    finishButtonLabel: finishButtonLabel,
+    onFinish: onFinish,
+    showCloseButton: showCloseButton,
+    showBackButton: showBackButton,
+    visible: visible
+  }));
+};
+
+UiTourMock.propTypes = {
+  onFinish: _propTypes.default.func,
+  visible: _propTypes.default.bool,
+  showCloseButton: _propTypes.default.bool,
+  showBackButton: _propTypes.default.bool
+};
+UiTourMock.defaultProps = {
+  onFinish: undefined,
+  visible: true,
+  showCloseButton: true,
+  showBackButton: true
+};
+describe('UiTour', function () {
+  it('should render correctly', function () {
+    var _render = (0, _react2.render)( /*#__PURE__*/_react.default.createElement(UiTourMock, null)),
+        container = _render.container;
+
+    var uitourComponent = container.querySelector('.uitour-component');
+    expect(container.firstChild).toContainElement(uitourComponent);
+  });
+  it('should go to next step', function () {
+    var _render2 = (0, _react2.render)( /*#__PURE__*/_react.default.createElement(UiTourMock, null)),
+        container = _render2.container;
+
+    var nextButton = container.querySelector('.next-button');
+
+    _react2.fireEvent.click(nextButton);
+
+    expect(container.querySelector('.content .number')).toHaveTextContent('2');
+  });
+  it('should execute callback on finish and close', function () {
+    var mockFinish = jest.fn();
+
+    var _render3 = (0, _react2.render)( /*#__PURE__*/_react.default.createElement(UiTourMock, {
+      onFinish: mockFinish
+    })),
+        container = _render3.container;
+
+    var nextButton = container.querySelector('.next-button');
+
+    _react2.fireEvent.click(nextButton);
+
+    var finishButton = container.querySelector('.finish-button');
+
+    _react2.fireEvent.click(finishButton);
+
+    expect(mockFinish).toHaveBeenCalledTimes(1);
+    expect(container.querySelector('.uitour-component')).not.toBeInTheDocument();
+  });
+  it('should step render aside target position', function () {
+    var _render4 = (0, _react2.render)( /*#__PURE__*/_react.default.createElement(UiTourMock, null)),
+        container = _render4.container;
+
+    var targetRect = container.querySelector('#uitour-teste');
+    var targetDimensions = targetRect.getBoundingClientRect();
+    var stepDimensions = container.querySelector('.uitour-component .step');
+    expect(stepDimensions.style.left).toBe("".concat(targetDimensions.left + targetDimensions.width + _helpers.ARROW_WIDTH, "px"));
+    expect(stepDimensions.style.top).toBe("".concat(targetDimensions.top - _helpers.ARROW_HEIGHT, "px"));
+  });
+  it('should render with backButtonLabel', function () {
+    var _render5 = (0, _react2.render)( /*#__PURE__*/_react.default.createElement(UiTourMock, null)),
+        getByText = _render5.getByText;
+
+    expect(getByText(backButtonLabel)).toBeInTheDocument();
+  });
+  it('should render with nextButtonLabel', function () {
+    var _render6 = (0, _react2.render)( /*#__PURE__*/_react.default.createElement(UiTourMock, null)),
+        getByText = _render6.getByText;
+
+    expect(getByText(nextButtonLabel)).toBeInTheDocument();
+  });
+  it('should render with finishButtonLabel', function () {
+    var _render7 = (0, _react2.render)( /*#__PURE__*/_react.default.createElement(UiTourMock, null)),
+        container = _render7.container,
+        getByText = _render7.getByText;
+
+    var nextButton = container.querySelector('.next-button');
+
+    _react2.fireEvent.click(nextButton);
+
+    expect(getByText(finishButtonLabel)).toBeInTheDocument();
+  });
+  it('should render close button', function () {
+    var _render8 = (0, _react2.render)( /*#__PURE__*/_react.default.createElement(UiTourMock, null)),
+        container = _render8.container;
+
+    expect(container.querySelector('.close-button')).toBeInTheDocument();
+  });
+  it('should not render close button', function () {
+    var _render9 = (0, _react2.render)( /*#__PURE__*/_react.default.createElement(UiTourMock, {
+      showCloseButton: false
+    })),
+        container = _render9.container;
+
+    expect(container.querySelector('.close-button')).not.toBeInTheDocument();
+  });
+  it('should render back button', function () {
+    var _render10 = (0, _react2.render)( /*#__PURE__*/_react.default.createElement(UiTourMock, null)),
+        getByText = _render10.getByText;
+
+    expect(getByText(backButtonLabel)).toBeInTheDocument();
+  });
+  it('should not render back button', function () {
+    var _render11 = (0, _react2.render)( /*#__PURE__*/_react.default.createElement(UiTourMock, {
+      showBackButton: false
+    })),
+        container = _render11.container;
+
+    expect(container.querySelector('.back-button')).not.toBeInTheDocument();
+  });
+  it('should not visible', function () {
+    var _render12 = (0, _react2.render)( /*#__PURE__*/_react.default.createElement(UiTourMock, {
+      visible: false
+    })),
+        container = _render12.container;
+
+    expect(container.querySelector('.uitour-component')).not.toBeInTheDocument();
+  });
+});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "linear-react-components-ui",
-  "version": "1.0.2",
+  "version": "1.0.3-beta.1",
   "description": "Linear Sistemas ReactJs Components",
   "main": "lib/index.js",
   "module": "lib/index.cjs",