@twreporter/react-components 8.5.0-rc.1

package/lib/table-of-contents/index.js

@@ -0,0 +1,532 @@
+"use strict";
+
+function _typeof(obj) { "@babel/helpers - typeof"; if (typeof Symbol === "function" && typeof Symbol.iterator === "symbol") { _typeof = function _typeof(obj) { return typeof obj; }; } else { _typeof = function _typeof(obj) { return obj && typeof Symbol === "function" && obj.constructor === Symbol && obj !== Symbol.prototype ? "symbol" : typeof obj; }; } return _typeof(obj); }
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports["default"] = void 0;
+
+var _propTypes = _interopRequireDefault(require("prop-types"));
+
+var _react = _interopRequireDefault(require("react"));
+
+var _get = _interopRequireDefault(require("lodash/get"));
+
+var _indexOf = _interopRequireDefault(require("lodash/indexOf"));
+
+var _memoizeOne = _interopRequireDefault(require("memoize-one"));
+
+var _smoothscroll = _interopRequireDefault(require("smoothscroll"));
+
+var _some = _interopRequireDefault(require("lodash/some"));
+
+var _sortBy = _interopRequireDefault(require("lodash/sortBy"));
+
+var _debounce = _interopRequireDefault(require("lodash/debounce"));
+
+var _reactWaypoint = require("react-waypoint");
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { "default": obj }; }
+
+function _inherits(subClass, superClass) { if (typeof superClass !== "function" && superClass !== null) { throw new TypeError("Super expression must either be null or a function"); } subClass.prototype = Object.create(superClass && superClass.prototype, { constructor: { value: subClass, writable: true, configurable: true } }); if (superClass) _setPrototypeOf(subClass, superClass); }
+
+function _setPrototypeOf(o, p) { _setPrototypeOf = Object.setPrototypeOf || function _setPrototypeOf(o, p) { o.__proto__ = p; return o; }; return _setPrototypeOf(o, p); }
+
+function _createSuper(Derived) { var hasNativeReflectConstruct = _isNativeReflectConstruct(); return function _createSuperInternal() { var Super = _getPrototypeOf(Derived), result; if (hasNativeReflectConstruct) { var NewTarget = _getPrototypeOf(this).constructor; result = Reflect.construct(Super, arguments, NewTarget); } else { result = Super.apply(this, arguments); } return _possibleConstructorReturn(this, result); }; }
+
+function _possibleConstructorReturn(self, call) { if (call && (_typeof(call) === "object" || typeof call === "function")) { return call; } else if (call !== void 0) { throw new TypeError("Derived constructors may only return object or undefined"); } return _assertThisInitialized(self); }
+
+function _assertThisInitialized(self) { if (self === void 0) { throw new ReferenceError("this hasn't been initialised - super() hasn't been called"); } return self; }
+
+function _isNativeReflectConstruct() { if (typeof Reflect === "undefined" || !Reflect.construct) return false; if (Reflect.construct.sham) return false; if (typeof Proxy === "function") return true; try { Boolean.prototype.valueOf.call(Reflect.construct(Boolean, [], function () {})); return true; } catch (e) { return false; } }
+
+function _getPrototypeOf(o) { _getPrototypeOf = Object.setPrototypeOf ? Object.getPrototypeOf : function _getPrototypeOf(o) { return o.__proto__ || Object.getPrototypeOf(o); }; return _getPrototypeOf(o); }
+
+function _classCallCheck(instance, Constructor) { if (!(instance instanceof Constructor)) { throw new TypeError("Cannot call a class as a function"); } }
+
+function _defineProperties(target, props) { for (var i = 0; i < props.length; i++) { var descriptor = props[i]; descriptor.enumerable = descriptor.enumerable || false; descriptor.configurable = true; if ("value" in descriptor) descriptor.writable = true; Object.defineProperty(target, descriptor.key, descriptor); } }
+
+function _createClass(Constructor, protoProps, staticProps) { if (protoProps) _defineProperties(Constructor.prototype, protoProps); if (staticProps) _defineProperties(Constructor, staticProps); return Constructor; }
+
+function _defineProperty(obj, key, value) { if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
+
+var _ = {
+  debounce: _debounce["default"],
+  get: _get["default"],
+  indexOf: _indexOf["default"],
+  some: _some["default"],
+  sortBy: _sortBy["default"]
+};
+/**
+ *  TOCManager is a bridge between `Anchor` and `TableOfContents`.
+ *  It provides APIs to make them communicate with each others.
+ *  For instances, `TOCManager` provides `Anchor`s for `TableOfContents`,
+ *  hence, `TableOfContents` could know how to render correspoding labels and
+ *  know how to handle those labels clicked(scroll to that `Anchor`).
+ */
+
+var TOCManager = /*#__PURE__*/function () {
+  /**
+   *  @constructs
+   *  @param {Object} props
+   *  @param {Anchor[]} [props.anchors=[]] - anchors of table of contents
+   *  @param {Anchor} [props.highlightAnchor=null] - it indicates which anchor is entering the viewport and should be highlighted
+   *  @param {TableOfContents} [props.toc=null] - table of contents
+   *  @param {boolean} [props.toStopAutoUpdateHighlightAnchor=false] - it stops automatically updating highlight anchor
+   */
+  function TOCManager() {
+    var _this = this;
+
+    var _ref = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {},
+        _ref$anchors = _ref.anchors,
+        _anchors = _ref$anchors === void 0 ? [] : _ref$anchors,
+        _ref$highlightAnchor = _ref.highlightAnchor,
+        highlightAnchor = _ref$highlightAnchor === void 0 ? null : _ref$highlightAnchor,
+        _ref$toc = _ref.toc,
+        toc = _ref$toc === void 0 ? null : _ref$toc,
+        _ref$toStopAutoUpdate = _ref.toStopAutoUpdateHighlightAnchor,
+        toStopAutoUpdateHighlightAnchor = _ref$toStopAutoUpdate === void 0 ? false : _ref$toStopAutoUpdate;
+
+    _classCallCheck(this, TOCManager);
+
+    _defineProperty(this, "renderTOC", _.debounce(function () {
+      if (_this._toc instanceof TableOfContents) {
+        _this._toc.forceUpdate();
+      }
+    }, 100));
+
+    _defineProperty(this, "updateHighlightAnchor", _.debounce(function () {
+      // sort the anchors by the distance to viewport top in ascending order.
+      // the reason to sort anchors is because CSS styles(like flex order) might
+      // change the anchors' position.
+      var anchors = _this.memoizeSortAnchorsByViewportTop(_this._anchors);
+
+      if (anchors.length === 0) {
+        return;
+      } // viewport is above first anchor
+
+
+      var firstAnchor = anchors[0];
+
+      if (firstAnchor.currentPosition === TOCManager.position.below) {
+        _this.highlightAnchor = null;
+        return;
+      } // viewport is below last anchor
+
+
+      var lastAnchor = anchors[anchors.length - 1];
+
+      if (lastAnchor.currentPosition === TOCManager.position.above) {
+        _this.highlightAnchor = lastAnchor;
+        return;
+      }
+
+      _.some(anchors, function (anchor, index) {
+        var curAnchor = anchor;
+        var nextAnchor = anchors[index + 1];
+
+        if ( // anchor[i] is inside the viewport
+        curAnchor.currentPosition === TOCManager.position.inside || curAnchor.currentPosition === TOCManager.position.above && nextAnchor instanceof Anchor && nextAnchor.currentPosition === TOCManager.position.below) {
+          _this.highlightAnchor = curAnchor;
+          return true;
+        }
+
+        return false;
+      });
+    }, 100));
+
+    _defineProperty(this, "memoizeSortAnchorsByViewportTop", (0, _memoizeOne["default"])(this.sortAnchorsByViewportTop));
+
+    this._anchors = _anchors;
+    this._highlightAnchor = highlightAnchor;
+    this._toc = toc;
+    this._toStopAutoUpdateHighlightAnchor = toStopAutoUpdateHighlightAnchor;
+  }
+  /**
+   *  use `Array.concat` to add `Anchor` into array
+   *
+   *  @method
+   *  @param {Anchor} anchor - an instance of `Anchor`
+   *  @returns
+   */
+
+
+  _createClass(TOCManager, [{
+    key: "addAnchor",
+    value: function addAnchor(anchor) {
+      if (anchor instanceof Anchor) {
+        // we don't use `this._anchors.push(anchor)` here.
+        // Instead, we use `concat` function to create a new array.
+        // The reason why we create a new array is because
+        // we want to make `TableOfContents(PureComponent)` re-render
+        this._anchors = this._anchors.concat(anchor);
+      }
+    }
+    /**
+     *  Re-render `TableOfContents` if needed.
+     *  Use debounce for optimizing rendering performance.
+     *  @returns
+     */
+
+  }, {
+    key: "sortAnchorsByViewportTop",
+    value:
+    /**
+     *  Sort anchors by the distance to viewport top in ascending order.
+     *  @param {Anchor[]} anchors
+     *  @returns {Anchor[]}
+     */
+    function sortAnchorsByViewportTop(anchors) {
+      return _.sortBy(anchors, function (anchor) {
+        return anchor.getViewportTop();
+      });
+    }
+    /**
+     *  Use memoize to improve performance
+     */
+
+  }, {
+    key: "highlightAnchor",
+    get:
+    /**
+     *  This a getter function.
+     *  @method
+     *  @return {Anchor} - the anchor is highlighted
+     */
+    function get() {
+      return this._highlightAnchor;
+    }
+    /**
+     *  This is a setter function.
+     *  @method
+     *  @return {undefined}
+     */
+    ,
+    set:
+    /**
+     *  This is a setter function.
+     *  It indicates which anchor is entering the viewport
+     *  and should be highlighted in the table of contents.
+     *  @method
+     *  @param {Anchor} anchor - an instance of `Anchor`
+     *  @returns
+     */
+    function set(anchor) {
+      if (anchor instanceof Anchor) {
+        this._highlightAnchor = anchor;
+      }
+
+      if (this._toc instanceof TableOfContents) {
+        this._toc.setHighlightAnchor(anchor);
+      }
+    }
+  }, {
+    key: "anchors",
+    get:
+    /**
+     *  This is a getter function.
+     *  @method
+     *  @returns {Anchor[]}
+     */
+    function get() {
+      return this._anchors;
+    }
+    /**
+     *  This is a setter function.
+     *  @method
+     *  @returns
+     */
+    ,
+    set: function set(anchors) {
+      this._anchors = anchors;
+    }
+  }, {
+    key: "toc",
+    get:
+    /**
+     *  This is a getter function.
+     *  @method
+     *  @returns {TableOfContents}
+     */
+    function get() {
+      return this._toc;
+    }
+    /**
+     *  This is a setter function.
+     *  @method
+     *  @returns
+     */
+    ,
+    set: function set(toc) {
+      this._toc = toc;
+    }
+  }, {
+    key: "toStopAutoUpdateHighlightAnchor",
+    get:
+    /**
+     *  This is a getter function.
+     *  @method
+     *  @returns {boolean}
+     */
+    function get() {
+      return this._toStopAutoUpdateHighlightAnchor;
+    },
+    set: function set(toStopAutoUpdateHighlightAnchor) {
+      this._toStopAutoUpdateHighlightAnchor = toStopAutoUpdateHighlightAnchor;
+    }
+  }]);
+
+  return TOCManager;
+}();
+
+_defineProperty(TOCManager, "position", {
+  above: _reactWaypoint.Waypoint.above,
+  below: _reactWaypoint.Waypoint.below,
+  inside: _reactWaypoint.Waypoint.inside,
+  invisible: _reactWaypoint.Waypoint.invisible
+});
+
+var Anchor = /*#__PURE__*/function (_React$PureComponent) {
+  _inherits(Anchor, _React$PureComponent);
+
+  var _super = _createSuper(Anchor);
+
+  function Anchor(props) {
+    var _this2;
+
+    _classCallCheck(this, Anchor);
+
+    _this2 = _super.call(this, props);
+    _this2._ref = /*#__PURE__*/_react["default"].createRef();
+    _this2.getViewportTop = _this2._getViewportTop.bind(_assertThisInitialized(_this2));
+    _this2.handleOnPositionChange = _this2._handleOnPositionChange.bind(_assertThisInitialized(_this2));
+    _this2.currentPosition = TOCManager.position.invisible;
+    var manager = props.manager;
+    manager.addAnchor(_assertThisInitialized(_this2));
+    manager.renderTOC();
+    return _this2;
+  }
+  /**
+   *  @returns {number} - the distance between the top edge of anchor and the top of window
+   */
+
+
+  _createClass(Anchor, [{
+    key: "_getViewportTop",
+    value: function _getViewportTop() {
+      try {
+        if (typeof window !== 'undefined' && this._ref.current) {
+          var scrollY = window.scrollY;
+
+          var _this$_ref$current$ge = this._ref.current.getBoundingClientRect(),
+              _this$_ref$current$ge2 = _this$_ref$current$ge.top,
+              top = _this$_ref$current$ge2 === void 0 ? 0 : _this$_ref$current$ge2;
+
+          return scrollY + top;
+        }
+      } catch (e) {
+        console.warn("Anchor(id: ".concat(this.props.id, ").getViewportTop occurs error"), e);
+        console.warn('Return default value: 0');
+      }
+
+      return 0;
+    }
+    /**
+     *  @param {Object} [posObj={}]
+     *  @param {string} [posObj.currentPosition=''] - it could be one of
+     *  Waypoint.below, Waypoint.above, Waypoint.inside and Waypoint.invisible
+     *
+     *  @returns
+     */
+
+  }, {
+    key: "_handleOnPositionChange",
+    value: function _handleOnPositionChange() {
+      var posObj = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
+      var manager = this.props.manager;
+      this.currentPosition = posObj.currentPosition;
+
+      if (manager.toStopAutoUpdateHighlightAnchor) {
+        return;
+      }
+
+      manager.updateHighlightAnchor();
+    }
+    /**
+     *  This is a getter function.
+     *  @method
+     *  @returns {string} - id of anchor
+     */
+
+  }, {
+    key: "anchorID",
+    get: function get() {
+      return this.props.id;
+    }
+    /**
+     *  This is a getter function.
+     *  @method
+     *  @returns {string} - label of anchor
+     */
+
+  }, {
+    key: "anchorLable",
+    get: function get() {
+      return this.props.label;
+    }
+  }, {
+    key: "render",
+    value: function render() {
+      var _this$props = this.props,
+          bottomOffset = _this$props.bottomOffset,
+          className = _this$props.className,
+          children = _this$props.children,
+          id = _this$props.id,
+          topOffset = _this$props.topOffset;
+      return (
+        /*#__PURE__*/
+        // set fireOnRapidScroll=false since we are not using `onEnter` and  `onLeave`
+        _react["default"].createElement(_reactWaypoint.Waypoint, {
+          bottomOffset: bottomOffset,
+          topOffset: topOffset,
+          onPositionChange: this.handleOnPositionChange,
+          fireOnRapidScroll: false
+        }, /*#__PURE__*/_react["default"].createElement("div", {
+          id: id,
+          className: className,
+          ref: this._ref
+        }, children))
+      );
+    }
+  }]);
+
+  return Anchor;
+}(_react["default"].PureComponent);
+
+_defineProperty(Anchor, "propTypes", {
+  className: _propTypes["default"].string,
+  children: _propTypes["default"].node,
+  manager: _propTypes["default"].instanceOf(TOCManager).isRequired,
+  id: _propTypes["default"].string.isRequired,
+  label: _propTypes["default"].string.isRequired,
+  bottomOffset: _propTypes["default"].oneOfType([_propTypes["default"].string, _propTypes["default"].number]),
+  topOffset: _propTypes["default"].oneOfType([_propTypes["default"].string, _propTypes["default"].number])
+});
+
+_defineProperty(Anchor, "defaultProps", {
+  className: '',
+  bottomOffset: '69%',
+  topOffset: '30%'
+});
+
+var smoothScrollDuration = 500;
+
+var TableOfContents = /*#__PURE__*/function (_React$PureComponent2) {
+  _inherits(TableOfContents, _React$PureComponent2);
+
+  var _super2 = _createSuper(TableOfContents);
+
+  function TableOfContents(props) {
+    var _this3;
+
+    _classCallCheck(this, TableOfContents);
+
+    _this3 = _super2.call(this, props);
+    var manager = props.manager;
+    _this3.state = {
+      highlightAnchor: manager.highlightAnchor
+    };
+    _this3.setHighlightAnchor = _this3._setHighlightAnchor.bind(_assertThisInitialized(_this3));
+    _this3.handleAnchorClick = _this3._handleAnchorClick.bind(_assertThisInitialized(_this3));
+    manager.toc = _assertThisInitialized(_this3);
+    return _this3;
+  }
+  /**
+   *  @param {Anchor} anchor - anchor to highlight
+   *  @returns
+   */
+
+
+  _createClass(TableOfContents, [{
+    key: "_setHighlightAnchor",
+    value: function _setHighlightAnchor(anchor) {
+      this.setState({
+        highlightAnchor: anchor
+      });
+    }
+    /**
+     *  @param {string} anchorID - id of clicked anchor
+     *  @returns
+     */
+
+  }, {
+    key: "_handleAnchorClick",
+    value: function _handleAnchorClick(anchorID) {
+      var _this4 = this;
+
+      var manager = this.props.manager;
+      var anchors = manager.anchors;
+
+      _.some(anchors, function (anchor) {
+        if (anchorID === anchor.anchorID) {
+          _this4.setState({
+            highlightAnchor: anchor
+          }, function () {
+            manager.toStopAutoUpdateHighlightAnchor = true;
+            (0, _smoothscroll["default"])(anchor.getViewportTop(), smoothScrollDuration, function () {
+              return manager.toStopAutoUpdateHighlightAnchor = false;
+            });
+          });
+
+          return true;
+        }
+
+        return false;
+      });
+    }
+  }, {
+    key: "render",
+    value: function render() {
+      var _this$props2 = this.props,
+          manager = _this$props2.manager,
+          render = _this$props2.render;
+      var highlightAnchor = this.state.highlightAnchor;
+      var anchors = manager.anchors;
+      var orderedAnchors = manager.memoizeSortAnchorsByViewportTop(anchors);
+
+      if (typeof render === 'function') {
+        return render(orderedAnchors, highlightAnchor, this.handleAnchorClick);
+      }
+
+      return null;
+    }
+  }]);
+
+  return TableOfContents;
+}(_react["default"].PureComponent);
+/**
+ *  @module TOC
+ */
+
+
+_defineProperty(TableOfContents, "propTypes", {
+  manager: _propTypes["default"].instanceOf(TOCManager).isRequired,
+
+  /**
+   *  @callback
+   *  @param {Anchor[]} anchors
+   *  @param {?Anchor} highlightAnchor
+   *  @param {Function} handleAnchorClick - callback function for handling clicking anchor
+   */
+  render: _propTypes["default"].func
+});
+
+var _default = {
+  Manager: TOCManager,
+  React: {
+    Anchor: Anchor,
+    TableOfContents: TableOfContents
+  }
+};
+exports["default"] = _default;

package/lib/utils/link-with-params.js

@@ -0,0 +1,27 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports["default"] = linkWithParams;
+
+var _url = _interopRequireDefault(require("url"));
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { "default": obj }; }
+
+/**
+ * @param { string } originalUrl - The original url
+ * @param { Object } params - search params to be set
+ * @return { string } originalUrl with search params
+ */
+function linkWithParams(originalUrl, params) {
+  var urlObj = new URL(originalUrl);
+
+  for (var key in params) {
+    if (params[key]) {
+      urlObj.searchParams.set(key, params[key]);
+    }
+  }
+
+  return _url["default"].format(urlObj);
+}

package/package.json

@@ -0,0 +1,33 @@
+{
+  "name": "@twreporter/react-components",
+  "version": "8.5.0-rc.1",
+  "main": "lib/index.js",
+  "repository": "https://github.com/twreporter/twreporter-npm-packages.git",
+  "author": "twreporter <developer@twreporter.org>",
+  "license": "MIT",
+  "scripts": {
+    "clean": "make clean",
+    "build": "make build",
+    "dev": "make dev",
+    "prepublishOnly": "make build"
+  },
+  "dependencies": {
+    "@twreporter/core": "^1.2.1",
+    "@twreporter/redux": "^7.2.0",
+    "hoist-non-react-statics": "^2.3.1",
+    "lodash": "^4.0.0",
+    "memoize-one": "^5.0.5",
+    "prop-types": "^15.0.0",
+    "react": "^16.3.0",
+    "react-redux": "^6.0.0",
+    "react-router-dom": "^5.1.2",
+    "react-transition-group": "^2.0.0",
+    "react-waypoint": "^9.0.2",
+    "smoothscroll": "^0.3.0",
+    "styled-components": "^4.0.0"
+  },
+  "files": [
+    "lib"
+  ],
+  "gitHead": "62a706e2369ff578eecd86c24aa5549516227c22"
+}