@enact/ui
Version:
A collection of simplified unstyled cross-platform UI components for Enact
178 lines (176 loc) • 9.32 kB
JavaScript
;
Object.defineProperty(exports, "__esModule", {
value: true
});
exports["default"] = exports.PlaceholderControllerDecorator = exports.PlaceholderContext = void 0;
var _handle = require("@enact/core/handle");
var _hoc = _interopRequireDefault(require("@enact/core/hoc"));
var _WithRef = require("@enact/core/internal/WithRef");
var _util = require("@enact/core/util");
var _Registry = _interopRequireDefault(require("@enact/core/internal/Registry"));
var _react = require("react");
var _jsxRuntime = require("react/jsx-runtime");
function _interopRequireDefault(e) { return e && e.__esModule ? e : { "default": e }; }
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) { _defineProperty(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 _defineProperty(e, r, t) { return (r = _toPropertyKey(r)) in e ? Object.defineProperty(e, r, { value: t, enumerable: !0, configurable: !0, writable: !0 }) : e[r] = t, e; }
function _classCallCheck(a, n) { if (!(a instanceof n)) throw new TypeError("Cannot call a class as a function"); }
function _defineProperties(e, r) { for (var t = 0; t < r.length; t++) { var o = r[t]; o.enumerable = o.enumerable || !1, o.configurable = !0, "value" in o && (o.writable = !0), Object.defineProperty(e, _toPropertyKey(o.key), o); } }
function _createClass(e, r, t) { return r && _defineProperties(e.prototype, r), t && _defineProperties(e, t), Object.defineProperty(e, "prototype", { writable: !1 }), e; }
function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == typeof i ? i : i + ""; }
function _toPrimitive(t, r) { if ("object" != typeof t || !t) return t; var e = t[Symbol.toPrimitive]; if (void 0 !== e) { var i = e.call(t, r || "default"); if ("object" != typeof i) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === r ? String : Number)(t); }
function _callSuper(t, o, e) { return o = _getPrototypeOf(o), _possibleConstructorReturn(t, _isNativeReflectConstruct() ? Reflect.construct(o, e || [], _getPrototypeOf(t).constructor) : o.apply(t, e)); }
function _possibleConstructorReturn(t, e) { if (e && ("object" == typeof e || "function" == typeof e)) return e; if (void 0 !== e) throw new TypeError("Derived constructors may only return object or undefined"); return _assertThisInitialized(t); }
function _assertThisInitialized(e) { if (void 0 === e) throw new ReferenceError("this hasn't been initialised - super() hasn't been called"); return e; }
function _isNativeReflectConstruct() { try { var t = !Boolean.prototype.valueOf.call(Reflect.construct(Boolean, [], function () {})); } catch (t) {} return (_isNativeReflectConstruct = function _isNativeReflectConstruct() { return !!t; })(); }
function _getPrototypeOf(t) { return _getPrototypeOf = Object.setPrototypeOf ? Object.getPrototypeOf.bind() : function (t) { return t.__proto__ || Object.getPrototypeOf(t); }, _getPrototypeOf(t); }
function _inherits(t, e) { if ("function" != typeof e && null !== e) throw new TypeError("Super expression must either be null or a function"); t.prototype = Object.create(e && e.prototype, { constructor: { value: t, writable: !0, configurable: !0 } }), Object.defineProperty(t, "prototype", { writable: !1 }), e && _setPrototypeOf(t, e); }
function _setPrototypeOf(t, e) { return _setPrototypeOf = Object.setPrototypeOf ? Object.setPrototypeOf.bind() : function (t, e) { return t.__proto__ = e, t; }, _setPrototypeOf(t, e); } /**
* Default config for `PlaceholderControllerDecorator`.
*
* @memberof ui/Placeholder.PlaceholderControllerDecorator
* @hocconfig
* @public
*/
var defaultConfig = {
/**
* The bounds of the container represented by an object with `height` and `width` members.
*
* If the container is a static size, this can be specified at design-time to avoid calculating
* the bounds at run-time (the default behavior).
*
* @type {Object}
* @default null
* @memberof ui/Placeholder.PlaceholderControllerDecorator.defaultConfig
*/
bounds: null,
/**
* Event callback which indicates that the viewport has scrolled and placeholders should be
* notified.
*
* @type {String}
* @default onScroll
* @memberof ui/Placeholder.PlaceholderControllerDecorator.defaultConfig
*/
notify: 'onScroll',
/**
* Multiplier used with the wrapped component's height and width to determine the threshold for
* replacing the placeholder component with the true component.
*
* @type {Number}
* @default 1.5
* @memberof ui/Placeholder.PlaceholderControllerDecorator.defaultConfig
*/
thresholdFactor: 1.5
};
var PlaceholderContext = exports.PlaceholderContext = /*#__PURE__*/(0, _react.createContext)();
/**
* A higher-order component (HOC) that renders placeholder components.
*
* Components are rendered based on their position relative to the `'scrollTop'` from the
* `'onScroll'`'s parameter. They are not unmounted once rendered.
*
* @class PlaceholderControllerDecorator
* @memberof ui/Placeholder
* @hoc
* @public
*/
var PlaceholderControllerDecorator = exports.PlaceholderControllerDecorator = (0, _hoc["default"])(defaultConfig, function (config, Wrapped) {
var _Class;
var bounds = config.bounds,
notify = config.notify,
thresholdFactor = config.thresholdFactor;
var WrappedWithRef = (0, _WithRef.WithRef)(Wrapped);
return _Class = /*#__PURE__*/function (_Component) {
function _Class(props) {
var _this;
_classCallCheck(this, _Class);
_this = _callSuper(this, _Class, [props]);
_this.bounds = null;
_this.leftThreshold = -1;
_this.node = null;
_this.topThreshold = -1;
_this.registry = _Registry["default"].create(_this.handleRegister.bind(_this));
_this.notifyAll = function (topThreshold, leftThreshold) {
_this.registry.notify({
leftThreshold: leftThreshold,
topThreshold: topThreshold
});
};
// queue up notifications when placeholders are first created
_this.notifyAllJob = new _util.Job(_this.notifyAll, 32);
_this.handle = _handle.handle.bind(_this);
_this.handleNotify = _this.handle((0, _handle.forward)(notify), function (_ref) {
var scrollLeft = _ref.scrollLeft,
scrollTop = _ref.scrollTop;
_this.setThresholds(scrollTop, scrollLeft);
});
_this.nodeRef = /*#__PURE__*/(0, _react.createRef)();
return _this;
}
_inherits(_Class, _Component);
return _createClass(_Class, [{
key: "componentDidMount",
value: function componentDidMount() {
this.setBounds();
this.setThresholds(0, 0);
}
}, {
key: "componentWillUnmount",
value: function componentWillUnmount() {
this.notifyAllJob.stop();
}
}, {
key: "setBounds",
value: function setBounds() {
if (bounds != null) {
this.bounds = Object.assign({}, bounds);
} else {
this.node = this.nodeRef.current;
this.bounds = {
height: this.node.offsetHeight,
width: this.node.offsetWidth
};
}
}
}, {
key: "handleRegister",
value: function handleRegister(ev) {
if (ev.action === 'register') {
// do not notify until we've initialized the thresholds
if (this.topThreshold !== -1 && this.leftThreshold !== -1) {
this.notifyAllJob.start(this.topThreshold, this.leftThreshold);
}
}
}
}, {
key: "setThresholds",
value: function setThresholds(top, left) {
var _this$bounds = this.bounds,
height = _this$bounds.height,
width = _this$bounds.width;
var topThreshold = height * thresholdFactor + top;
var leftThreshold = width * thresholdFactor + left;
if (this.topThreshold < topThreshold || this.leftThreshold < leftThreshold) {
this.notifyAll(topThreshold, leftThreshold);
this.topThreshold = topThreshold;
this.leftThreshold = leftThreshold;
}
}
}, {
key: "render",
value: function render() {
var props = Object.assign({}, this.props);
if (notify) props[notify] = this.handleNotify;
return /*#__PURE__*/(0, _jsxRuntime.jsx)(PlaceholderContext, {
value: this.registry.register,
children: /*#__PURE__*/(0, _jsxRuntime.jsx)(WrappedWithRef, _objectSpread(_objectSpread({}, props), {}, {
outermostRef: this.nodeRef,
referrerName: "Placeholder"
}))
});
}
}]);
}(_react.Component), _Class.displayName = 'PlaceholderControllerDecorator', _Class;
});
var _default = exports["default"] = PlaceholderControllerDecorator;