wix-style-react/dist/src/common/ScrollableContainer/ScrollableContainer.js

wix-style-react

"use strict";

var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");

var _typeof = require("@babel/runtime/helpers/typeof");

Object.defineProperty(exports, "__esModule", {
  value: true
});
exports["default"] = void 0;

var _extends2 = _interopRequireDefault(require("@babel/runtime/helpers/extends"));

var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));

var _objectWithoutProperties2 = _interopRequireDefault(require("@babel/runtime/helpers/objectWithoutProperties"));

var _react = _interopRequireWildcard(require("react"));

var _propTypes = _interopRequireDefault(require("prop-types"));

var _throttle = _interopRequireDefault(require("lodash/throttle"));

var _scrollAreaLogic = require("./scrollAreaLogic");

var _extractAttributes = require("../../utils/extractAttributes");

var _excluded = ["dataHook", "className", "style", "children", "onScrollAreaChanged", "onScrollChanged", "scrollThrottleWait"];

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 ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); if (enumerableOnly) { symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; }); } keys.push.apply(keys, symbols); } return keys; }

function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = arguments[i] != null ? arguments[i] : {}; if (i % 2) { ownKeys(Object(source), true).forEach(function (key) { (0, _defineProperty2["default"])(target, key, source[key]); }); } else if (Object.getOwnPropertyDescriptors) { Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)); } else { ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } } return target; }

var ScrollableContainer = /*#__PURE__*/(0, _react.forwardRef)(function ScrollableContainer(_ref, ref) {
  var dataHook = _ref.dataHook,
      className = _ref.className,
      style = _ref.style,
      children = _ref.children,
      onScrollAreaChanged = _ref.onScrollAreaChanged,
      onScrollChanged = _ref.onScrollChanged,
      scrollThrottleWait = _ref.scrollThrottleWait,
      restProps = (0, _objectWithoutProperties2["default"])(_ref, _excluded);
  var elementRef = (0, _react.useRef)(null); // In case a ref was passed from outside we should use it so allow the parent access to the dom node as well.

  var scrollContainerElement = ref || elementRef;
  var scrollAreaY = (0, _react.useRef)('');
  var handleScrollAreaChanged = (0, _react.useCallback)((0, _throttle["default"])(function (_ref2) {
    var target = _ref2.target;
    var newScrollAreaY = (0, _scrollAreaLogic.getScrollAreaY)(target);

    if (scrollAreaY.current !== newScrollAreaY) {
      scrollAreaY.current = newScrollAreaY;
      onScrollAreaChanged({
        target: target,
        area: {
          y: newScrollAreaY
        }
      });
    }
  }, scrollThrottleWait, {
    trailing: true
  }), [onScrollAreaChanged, scrollThrottleWait]);
  var handleScrollChanged = (0, _react.useCallback)((0, _throttle["default"])(function (e) {
    return onScrollChanged(e);
  }, scrollThrottleWait, {
    trailing: true
  }), [onScrollChanged, scrollThrottleWait]);
  (0, _react.useEffect)(function () {
    // Registering to the scroll event only if the relevant handlers were provided
    var scrollableElement = scrollContainerElement.current;

    if (onScrollAreaChanged) {
      scrollableElement.addEventListener('scroll', handleScrollAreaChanged); // We trigger a call to this handler to expose the initial scroll area to registering consumers

      handleScrollAreaChanged({
        target: scrollableElement
      });
    }

    if (onScrollChanged) {
      scrollableElement.addEventListener('scroll', handleScrollChanged);
    }

    return function () {
      // Unregistering from relevant events on component unmount
      if (onScrollAreaChanged) {
        handleScrollAreaChanged.cancel();
        scrollableElement.removeEventListener('scroll', handleScrollAreaChanged);
      }

      if (onScrollChanged) {
        handleScrollChanged.cancel();
        scrollableElement.removeEventListener('scroll', handleScrollChanged);
      }
    };
  }, [handleScrollChanged, handleScrollAreaChanged, onScrollChanged, onScrollAreaChanged, scrollContainerElement]);

  var stl = _objectSpread({
    height: 'inherit',
    width: 'inherit',
    overflowY: 'auto'
  }, style);

  return /*#__PURE__*/_react["default"].createElement("div", (0, _extends2["default"])({
    "data-hook": dataHook,
    className: className,
    style: stl,
    ref: scrollContainerElement
  }, (0, _extractAttributes.extractDataAttributes)(restProps)), children);
});
ScrollableContainer.propTypes = {
  /* The wait time value the scroll event will be throttled by */
  scrollThrottleWait: _propTypes["default"].number,

  /** A Handler for scroll area changes, will trigger only when the user scrolls to a different area of
   * the container, see signature for possible areas
   *
   * ##### Signature:
   * `function({area: {y: AreaY, x: AreaX}, target: HTMLElement}) => void`
   *
   * `AreaY`: top | middle | bottom | none
   *
   * `AreaX`: start | middle | end | none (not implemented yet)
   */
  onScrollAreaChanged: _propTypes["default"].func,

  /** A Generic Handler for scroll changes with throttling
   * ##### Signature:
   * function({target: HTMLElement}) => void
   */
  onScrollChanged: _propTypes["default"].func
};
ScrollableContainer.defaultProps = {
  scrollThrottleWait: 100
};
var _default = ScrollableContainer;
exports["default"] = _default;