@atlaskit/onboarding

Version:
An onboarding spotlight introduces new features to users through focused messages or multi-step tours.
159 lines (155 loc) • 8.68 kB
JavaScript
"use strict";

var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
var _typeof = require("@babel/runtime/helpers/typeof");
Object.defineProperty(exports, "__esModule", {
  value: true
});
exports.default = exports.TargetConsumer = exports.SpotlightContext = exports.SpotlightConsumer = void 0;
var _classCallCheck2 = _interopRequireDefault(require("@babel/runtime/helpers/classCallCheck"));
var _createClass2 = _interopRequireDefault(require("@babel/runtime/helpers/createClass"));
var _possibleConstructorReturn2 = _interopRequireDefault(require("@babel/runtime/helpers/possibleConstructorReturn"));
var _getPrototypeOf2 = _interopRequireDefault(require("@babel/runtime/helpers/getPrototypeOf"));
var _inherits2 = _interopRequireDefault(require("@babel/runtime/helpers/inherits"));
var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
var _react = _interopRequireWildcard(require("react"));
var _memoizeOne = _interopRequireDefault(require("memoize-one"));
var _noop = _interopRequireDefault(require("@atlaskit/ds-lib/noop"));
var _exitingPersistence = _interopRequireDefault(require("@atlaskit/motion/exiting-persistence"));
var _fadeIn = _interopRequireDefault(require("@atlaskit/motion/fade-in"));
var _portal = _interopRequireDefault(require("@atlaskit/portal/portal"));
var _blanket = _interopRequireDefault(require("../styled/blanket"));
function _interopRequireWildcard(e, t) { if ("function" == typeof WeakMap) var r = new WeakMap(), n = new WeakMap(); return (_interopRequireWildcard = function _interopRequireWildcard(e, t) { if (!t && e && e.__esModule) return e; var o, i, f = { __proto__: null, default: e }; if (null === e || "object" != _typeof(e) && "function" != typeof e) return f; if (o = t ? n : r) { if (o.has(e)) return o.get(e); o.set(e, f); } for (var _t in e) "default" !== _t && {}.hasOwnProperty.call(e, _t) && ((i = (o = Object.defineProperty) && Object.getOwnPropertyDescriptor(e, _t)) && (i.get || i.set) ? o(f, _t, i) : f[_t] = e[_t]); return f; })(e, t); }
function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { (0, _defineProperty2.default)(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
function _callSuper(t, o, e) { return o = (0, _getPrototypeOf2.default)(o), (0, _possibleConstructorReturn2.default)(t, _isNativeReflectConstruct() ? Reflect.construct(o, e || [], (0, _getPrototypeOf2.default)(t).constructor) : o.apply(t, e)); }
function _isNativeReflectConstruct() { try { var t = !Boolean.prototype.valueOf.call(Reflect.construct(Boolean, [], function () {})); } catch (t) {} return (_isNativeReflectConstruct = function _isNativeReflectConstruct() { return !!t; })(); }
var dest = /*#__PURE__*/(0, _react.createContext)(undefined);
var TargetConsumer = exports.TargetConsumer = dest.Consumer;
var TargetProvider = dest.Provider;
var SpotlightContext = exports.SpotlightContext = /*#__PURE__*/(0, _react.createContext)({
  opened: _noop.default,
  closed: _noop.default,
  targets: {}
});
var SpotlightStateConsumer = exports.SpotlightConsumer = SpotlightContext.Consumer;
var SpotlightStateProvider = SpotlightContext.Provider;

// eslint-disable-next-line @atlaskit/volt-strict-mode/no-multiple-exports

var Container = function Container(_ref) {
  var Wrapper = _ref.component,
    children = _ref.children;
  return /*#__PURE__*/_react.default.createElement(Wrapper, null, children);
};

/**
 * __Spotlight manager__
 *
 * A spotlight manager manages the visibility of spotlights used to introduce new features to users through focused messages or multi-step tours.
 *
 * - [Examples](https://atlassian.design/components/onboarding/examples)
 * - [Code](https://atlassian.design/components/onboarding/code)
 * - [Usage](https://atlassian.design/components/onboarding/usage)
 *
 * @deprecated Use `@atlaskit/spotlight` instead.
 */
// eslint-disable-next-line @repo/internal/react/no-class-components, @atlaskit/volt-strict-mode/no-multiple-exports
var SpotlightManager = exports.default = /*#__PURE__*/function (_PureComponent) {
  function SpotlightManager() {
    var _this;
    (0, _classCallCheck2.default)(this, SpotlightManager);
    for (var _len = arguments.length, args = new Array(_len), _key = 0; _key < _len; _key++) {
      args[_key] = arguments[_key];
    }
    _this = _callSuper(this, SpotlightManager, [].concat(args));
    (0, _defineProperty2.default)(_this, "state", {
      spotlightCount: 0,
      targets: {}
    });
    /*
     * When enabling React Streaming in Confluence, a
     * "This Suspense boundary received an update before it finished hydrating. This caused the boundary to switch to client rendering"
     * error happens.
     * This is to fix this error by wrapping the state update in startTransition as suggested by React: https://react.dev/errors/421?invariant=421
     */
    (0, _defineProperty2.default)(_this, "getTargetRef", function (name) {
      return function (element) {
        (0, _react.startTransition)(function () {
          _this.setState(function (state) {
            return {
              targets: _objectSpread(_objectSpread({}, state.targets), {}, (0, _defineProperty2.default)({}, name, element || undefined))
            };
          });
        });
      };
    });
    (0, _defineProperty2.default)(_this, "spotlightOpen", function () {
      _this.setState(function (state) {
        return {
          spotlightCount: state.spotlightCount + 1
        };
      });
    });
    (0, _defineProperty2.default)(_this, "spotlightClose", function () {
      _this.setState(function (state) {
        return {
          spotlightCount: state.spotlightCount - 1
        };
      });
    });
    (0, _defineProperty2.default)(_this, "getStateProviderValue", (0, _memoizeOne.default)(function (targets) {
      return {
        opened: _this.spotlightOpen,
        closed: _this.spotlightClose,
        targets: targets
      };
    }));
    return _this;
  }
  (0, _inherits2.default)(SpotlightManager, _PureComponent);
  return (0, _createClass2.default)(SpotlightManager, [{
    key: "componentDidMount",
    value: function componentDidMount() {
      if (typeof process !== 'undefined' && process.env.NODE_ENV !== 'production' && !process.env.CI) {
        if (this.props.component) {
          // eslint-disable-next-line no-console
          console.warn("Atlaskit: The SpotlightManager 'component' prop is deprecated. Please wrap the SpotlightManager in the component instead.");
        }
      }
    }
  }, {
    key: "render",
    value: function render() {
      var _this$props = this.props,
        blanketIsTinted = _this$props.blanketIsTinted,
        children = _this$props.children,
        Tag = _this$props.component,
        onBlanketClicked = _this$props.onBlanketClicked;
      var isActive = this.state.spotlightCount > 0;
      return /*#__PURE__*/_react.default.createElement(SpotlightStateProvider, {
        value: this.getStateProviderValue(this.state.targets)
      }, /*#__PURE__*/_react.default.createElement(TargetProvider, {
        value: this.getTargetRef
      }, /*#__PURE__*/_react.default.createElement(Container, {
        component: Tag || _react.default.Fragment
      }, /*#__PURE__*/_react.default.createElement(_exitingPersistence.default, null, isActive && /*#__PURE__*/_react.default.createElement(_fadeIn.default, {
        duration: "medium"
      }, function (_ref2) {
        var ref = _ref2.ref,
          className = _ref2.className,
          style = _ref2.style;
        return /*#__PURE__*/_react.default.createElement(_portal.default, {
          zIndex: 700
        }, /*#__PURE__*/_react.default.createElement(_blanket.default, {
          ref: ref
          // eslint-disable-next-line @atlaskit/ui-styling-standard/no-classname-prop
          ,
          className: className,
          style: style,
          isTinted: blanketIsTinted,
          onBlanketClicked: onBlanketClicked
        }));
      })), children)));
    }
  }]);
}(_react.PureComponent);
(0, _defineProperty2.default)(SpotlightManager, "defaultProps", {
  blanketIsTinted: true
});