@twreporter/react-components 8.11.0 → 8.12.0-rc.0

package/CHANGELOG.md

@@ -3,6 +3,40 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [8.12.0-rc.0](https://github.com/twreporter/twreporter-npm-packages/compare/@twreporter/react-components@8.11.1...@twreporter/react-components@8.12.0-rc.0) (2022-08-10)
+
+
+### Bug Fixes
+
+* **react-components:** add callback as dep of use-font-observer-hook ([9f91ce9](https://github.com/twreporter/twreporter-npm-packages/commit/9f91ce928b0e94c8b29600f44438ea37f45e5c03))
+
+
+### Features
+
+* **react-components:** add NotoSansTC fontface ([046cdb5](https://github.com/twreporter/twreporter-npm-packages/commit/046cdb501b5133fb120cf66401929145ad2c79da))
+* **react-components:** add use-font-face-observer hook ([f2ffa6d](https://github.com/twreporter/twreporter-npm-packages/commit/f2ffa6d9215737046d246aa34dd468a2ff0d15f2))
+* **react-components:** export font files as `fontGCSFiles` ([a8b940c](https://github.com/twreporter/twreporter-npm-packages/commit/a8b940c796dc039cb769f09b8d6bcc0002a22bcf))
+
+
+
+
+
+## [8.11.1](https://github.com/twreporter/twreporter-npm-packages/compare/@twreporter/react-components@8.11.1-rc.0...@twreporter/react-components@8.11.1) (2022-08-09)
+
+**Note:** Version bump only for package @twreporter/react-components
+
+
+
+
+
+## [8.11.1-rc.0](https://github.com/twreporter/twreporter-npm-packages/compare/@twreporter/react-components@8.11.0...@twreporter/react-components@8.11.1-rc.0) (2022-07-27)
+
+**Note:** Version bump only for package @twreporter/react-components
+
+
+
+
+
 # [8.11.0](https://github.com/twreporter/twreporter-npm-packages/compare/@twreporter/react-components@8.11.0-rc.0...@twreporter/react-components@8.11.0) (2022-07-21)
 
 **Note:** Version bump only for package @twreporter/react-components

package/lib/hook/index.js

@@ -9,13 +9,22 @@ Object.defineProperty(exports, "useOutsideClick", {
     return _useOutsideClick["default"];
   }
 });
+Object.defineProperty(exports, "useFontFaceObserver", {
+  enumerable: true,
+  get: function get() {
+    return _useFontFaceObserver["default"];
+  }
+});
 exports["default"] = void 0;
 
 var _useOutsideClick = _interopRequireDefault(require("./use-outside-click"));
 
+var _useFontFaceObserver = _interopRequireDefault(require("./use-font-face-observer"));
+
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { "default": obj }; }
 
 var _default = {
-  useOutsideClick: _useOutsideClick["default"]
+  useOutsideClick: _useOutsideClick["default"],
+  useFontFaceObserver: _useFontFaceObserver["default"]
 };
 exports["default"] = _default;

package/lib/hook/use-font-face-observer.js

@@ -0,0 +1,65 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports["default"] = void 0;
+
+var _react = require("react");
+
+var _fontfaceobserverEs = _interopRequireDefault(require("fontfaceobserver-es"));
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { "default": obj }; }
+
+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 = 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 useFontFaceObserver = function useFontFaceObserver() {
+  var fontFaces = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : [];
+  var callback = arguments.length > 1 ? arguments[1] : undefined;
+
+  var _useState = (0, _react.useState)(false),
+      _useState2 = _slicedToArray(_useState, 2),
+      isResolved = _useState2[0],
+      setIsResolved = _useState2[1];
+
+  var fontFacesString = JSON.stringify(fontFaces);
+  (0, _react.useEffect)(function () {
+    var promises = JSON.parse(fontFacesString).map(function (_ref) {
+      var family = _ref.family,
+          weight = _ref.weight,
+          style = _ref.style,
+          stretch = _ref.stretch;
+      return new _fontfaceobserverEs["default"](family, {
+        weight: weight,
+        style: style,
+        stretch: stretch
+      }).load('測試文字');
+    });
+    Promise.all(promises).then(function () {
+      if (typeof callback !== 'function') {
+        return;
+      }
+
+      callback();
+      return setIsResolved(true);
+    })["catch"](function (e) {
+      // eslint-disable-next-line no-console
+      console.error("An error occurred during font loading");
+      console.log(e);
+    });
+  }, [fontFacesString, callback]);
+  return isResolved;
+};
+
+var _default = useFontFaceObserver;
+exports["default"] = _default;

package/lib/side-bar/index.js

@@ -14,12 +14,12 @@ var _react = _interopRequireDefault(require("react"));
 
 var _hoistNonReactStatics = _interopRequireDefault(require("hoist-non-react-statics"));
 
-var _smoothscroll = _interopRequireDefault(require("smoothscroll"));
-
 var _reactWaypoint = require("react-waypoint");
 
 var _get = _interopRequireDefault(require("lodash/get"));
 
+var _smoothScroll = _interopRequireDefault(require("@twreporter/core/lib/utils/smooth-scroll"));
+
 var _excluded = ["children"];
 
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { "default": obj }; }
@@ -185,8 +185,7 @@ function decorateSideBar(DecoratedComponent) {
         var node = this.moduleMap[moduleID];
 
         if (node) {
-          // scroll to the section
-          return (0, _smoothscroll["default"])(node.offsetTop);
+          (0, _smoothScroll["default"])(node.offsetTop);
         }
 
         return null;

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

@@ -7,17 +7,19 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports["default"] = void 0;
 
+var _react = _interopRequireDefault(require("react"));
+
 var _propTypes = _interopRequireDefault(require("prop-types"));
 
-var _react = _interopRequireDefault(require("react"));
+var _memoizeOne = _interopRequireDefault(require("memoize-one"));
 
-var _get = _interopRequireDefault(require("lodash/get"));
+var _reactWaypoint = require("react-waypoint");
 
-var _indexOf = _interopRequireDefault(require("lodash/indexOf"));
+var _smoothScroll = _interopRequireDefault(require("@twreporter/core/lib/utils/smooth-scroll"));
 
-var _memoizeOne = _interopRequireDefault(require("memoize-one"));
+var _get = _interopRequireDefault(require("lodash/get"));
 
-var _smoothscroll = _interopRequireDefault(require("smoothscroll"));
+var _indexOf = _interopRequireDefault(require("lodash/indexOf"));
 
 var _some = _interopRequireDefault(require("lodash/some"));
 
@@ -25,8 +27,6 @@ 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); }
@@ -420,7 +420,7 @@ _defineProperty(Anchor, "defaultProps", {
   topOffset: '30%'
 });
 
-var smoothScrollDuration = 500;
+var defaultScrollDuration = 500;
 
 var TableOfContents = /*#__PURE__*/function (_React$PureComponent2) {
   _inherits(TableOfContents, _React$PureComponent2);
@@ -462,10 +462,12 @@ var TableOfContents = /*#__PURE__*/function (_React$PureComponent2) {
 
   }, {
     key: "_handleAnchorClick",
-    value: function _handleAnchorClick(anchorID) {
+    value: function _handleAnchorClick(anchorID, callback) {
       var _this4 = this;
 
-      var manager = this.props.manager;
+      var _this$props2 = this.props,
+          manager = _this$props2.manager,
+          scrollDuration = _this$props2.scrollDuration;
       var anchors = manager.anchors;
 
       _.some(anchors, function (anchor) {
@@ -474,8 +476,12 @@ var TableOfContents = /*#__PURE__*/function (_React$PureComponent2) {
             highlightAnchor: anchor
           }, function () {
             manager.toStopAutoUpdateHighlightAnchor = true;
-            (0, _smoothscroll["default"])(anchor.getViewportTop(), smoothScrollDuration, function () {
-              return manager.toStopAutoUpdateHighlightAnchor = false;
+            (0, _smoothScroll["default"])(anchor.getViewportTop(), scrollDuration || defaultScrollDuration, function () {
+              manager.toStopAutoUpdateHighlightAnchor = false;
+
+              if (callback) {
+                callback();
+              }
             });
           });
 
@@ -488,9 +494,9 @@ var TableOfContents = /*#__PURE__*/function (_React$PureComponent2) {
   }, {
     key: "render",
     value: function render() {
-      var _this$props2 = this.props,
-          manager = _this$props2.manager,
-          render = _this$props2.render;
+      var _this$props3 = this.props,
+          manager = _this$props3.manager,
+          render = _this$props3.render;
       var highlightAnchor = this.state.highlightAnchor;
       var anchors = manager.anchors;
       var orderedAnchors = manager.memoizeSortAnchorsByViewportTop(anchors);
@@ -519,7 +525,8 @@ _defineProperty(TableOfContents, "propTypes", {
    *  @param {?Anchor} highlightAnchor
    *  @param {Function} handleAnchorClick - callback function for handling clicking anchor
    */
-  render: _propTypes["default"].func
+  render: _propTypes["default"].func,
+  scrollDuration: _propTypes["default"].number
 });
 
 var _default = {

package/lib/text/utils/webfonts.js

@@ -0,0 +1,67 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports["default"] = void 0;
+
+var _font = require("@twreporter/core/lib/constants/font");
+
+var _forEach = _interopRequireDefault(require("lodash/forEach"));
+
+var _keys = _interopRequireDefault(require("lodash/keys"));
+
+var _reduce = _interopRequireDefault(require("lodash/reduce"));
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { "default": obj }; }
+
+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 _ = {
+  forEach: _forEach["default"],
+  keys: _keys["default"],
+  reduce: _reduce["default"]
+};
+var baseGCSDir = 'https://www.twreporter.org/assets/font/';
+var fileExt = '.woff2';
+
+var gcsFontFolder = _defineProperty({}, _font.fonts.notoSansTC, 'NotoSansTC');
+
+var fontWeightKeys = _.keys(_font.fontWeight); // add @font-face to global style to use self-hosted font for performance reasons, to be more precise please check the issue below:
+// https://twreporter-org.atlassian.net/browse/TWREPORTER-318?atlOrigin=eyJpIjoiNjg4OTQ2MWU2MGIxNGEzMGE0NDY2ZDNmZGRhOWExZDEiLCJwIjoiaiJ9
+
+
+var getFontFaces = function getFontFaces(_ref) {
+  var font = _ref.font,
+      folder = _ref.folder;
+
+  var fontFaceCSSTemplate = function fontFaceCSSTemplate(_ref2) {
+    var fontWeightKey = _ref2.fontWeightKey;
+    return "\n    @font-face {\n      font-family: \"".concat(font, "\";\n      font-weight: ").concat(_font.fontWeight[fontWeightKey], ";\n      font-display: swap;\n      src: url(\"").concat(baseGCSDir).concat(folder, "/").concat(fontWeightKey).concat(fileExt, "\");\n    }\n  ");
+  };
+
+  return _.reduce(fontWeightKeys, function (fontFaces, fontWeightKey) {
+    return fontFaces + fontFaceCSSTemplate({
+      fontWeightKey: fontWeightKey
+    });
+  }, '');
+};
+
+var fontFaces = _defineProperty({}, _font.fonts.notoSansTC, getFontFaces({
+  font: _font.fonts.notoSansTC,
+  folder: gcsFontFolder[_font.fonts.notoSansTC]
+}));
+
+var fontGCSFiles = [];
+
+_.forEach(fontFaces, function (fontFace, font) {
+  _.forEach(fontWeightKeys, function (fontWeightKey) {
+    fontGCSFiles.push("".concat(baseGCSDir).concat(gcsFontFolder[font], "/").concat(fontWeightKey).concat(fileExt));
+  });
+});
+
+var _default = {
+  fontFaces: fontFaces,
+  fontGCSFiles: fontGCSFiles
+};
+exports["default"] = _default;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@twreporter/react-components",
-  "version": "8.11.0",
+  "version": "8.12.0-rc.0",
   "main": "lib/index.js",
   "repository": "https://github.com/twreporter/twreporter-npm-packages.git",
   "author": "twreporter <developer@twreporter.org>",
@@ -15,8 +15,9 @@
     "chromatic": "npx chromatic --exit-zero-on-changes"
   },
   "dependencies": {
-    "@twreporter/core": "^1.4.1",
+    "@twreporter/core": "^1.5.0-rc.0",
     "@twreporter/redux": "^7.2.2",
+    "fontfaceobserver-es": "^3.3.3",
     "hoist-non-react-statics": "^2.3.1",
     "lodash": "^4.0.0",
     "memoize-one": "^5.0.5",
@@ -26,7 +27,6 @@
     "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": [
@@ -44,5 +44,5 @@
     "babel-loader": "^8.2.4",
     "chromatic": "^6.5.4"
   },
-  "gitHead": "22127d74e0d0433e87b427aed82394972cade963"
+  "gitHead": "1581b4cbe2575efda67131f0d6954cb7dfd3a82d"
 }