@enact/ui
Version:
A collection of simplified unstyled cross-platform UI components for Enact
144 lines (141 loc) • 8.44 kB
JavaScript
;
Object.defineProperty(exports, "__esModule", {
value: true
});
exports.useMeasurable = exports["default"] = exports.Measurable = void 0;
var _hoc = _interopRequireDefault(require("@enact/core/hoc"));
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 _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 _createForOfIteratorHelper(r, e) { var t = "undefined" != typeof Symbol && r[Symbol.iterator] || r["@@iterator"]; if (!t) { if (Array.isArray(r) || (t = _unsupportedIterableToArray(r)) || e && r && "number" == typeof r.length) { t && (r = t); var _n = 0, F = function F() {}; return { s: F, n: function n() { return _n >= r.length ? { done: !0 } : { done: !1, value: r[_n++] }; }, e: function e(r) { throw r; }, f: F }; } throw new TypeError("Invalid attempt to iterate non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); } var o, a = !0, u = !1; return { s: function s() { t = t.call(r); }, n: function n() { var r = t.next(); return a = r.done, r; }, e: function e(r) { u = !0, o = r; }, f: function f() { try { a || null == t["return"] || t["return"](); } finally { if (u) throw o; } } }; }
function _slicedToArray(r, e) { return _arrayWithHoles(r) || _iterableToArrayLimit(r, e) || _unsupportedIterableToArray(r, e) || _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(r, a) { if (r) { if ("string" == typeof r) return _arrayLikeToArray(r, a); var t = {}.toString.call(r).slice(8, -1); return "Object" === t && r.constructor && (t = r.constructor.name), "Map" === t || "Set" === t ? Array.from(r) : "Arguments" === t || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(t) ? _arrayLikeToArray(r, a) : void 0; } }
function _arrayLikeToArray(r, a) { (null == a || a > r.length) && (a = r.length); for (var e = 0, n = Array(a); e < a; e++) n[e] = r[e]; return n; }
function _iterableToArrayLimit(r, l) { var t = null == r ? null : "undefined" != typeof Symbol && r[Symbol.iterator] || r["@@iterator"]; if (null != t) { var e, n, i, u, a = [], f = !0, o = !1; try { if (i = (t = t.call(r)).next, 0 === l) { if (Object(t) !== t) return; f = !1; } else for (; !(f = (e = i.call(t)).done) && (a.push(e.value), a.length !== l); f = !0); } catch (r) { o = !0, n = r; } finally { try { if (!f && null != t["return"] && (u = t["return"](), Object(u) !== u)) return; } finally { if (o) throw n; } } return a; } }
function _arrayWithHoles(r) { if (Array.isArray(r)) return r; } /* global ResizeObserver, MutationObserver */ /**
* A higher-order component that adds the ability to measure nodes conveniently.
*
* @module ui/Measurable
* @exports Measurable
*/ /**
* Default config for {@link ui/Measurable.Measurable}.
*
* @memberof ui/Measurable.Measurable
* @hocconfig
*/
var defaultConfig = {
/**
* Configures the prop name to pass the measurement object.
*
* @type {String}
* @default 'measurement'
* @memberof ui/Measurable.Measurable.defaultConfig
*/
measurementProp: 'measurement',
/**
* Configures the prop name to pass a function to capture a reference to the element to measure.
*
* @type {String}
* @default 'forwardRef'
* @memberof ui/Measurable.Measurable.defaultConfig
*/
refProp: 'forwardRef'
};
var useMeasurable = exports.useMeasurable = function useMeasurable() {
var _useState = (0, _react.useState)(),
_useState2 = _slicedToArray(_useState, 2),
measurement = _useState2[0],
setMeasurement = _useState2[1];
var ref = (0, _react.useRef)(null);
(0, _react.useLayoutEffect)(function () {
var refToMeasure = ref.current;
if (!refToMeasure) {
return;
}
// Support for ResizeObserver
if (typeof ResizeObserver === 'function') {
var resizeObserver = new ResizeObserver(function (entries) {
entries.forEach(function (entry) {
if (entry.target === refToMeasure) {
// we want to measure including the padding, hence refers to `target` instead of `contentRect`
setMeasurement(entry.target.getBoundingClientRect());
}
});
});
resizeObserver.observe(refToMeasure);
return function () {
resizeObserver.disconnect(refToMeasure);
resizeObserver = null;
};
// Fallback support for MutationObserver
} else if (typeof MutationObserver === 'function') {
var mutationObserver = new MutationObserver(function (mutationsList) {
var _iterator = _createForOfIteratorHelper(mutationsList),
_step;
try {
for (_iterator.s(); !(_step = _iterator.n()).done;) {
var mutation = _step.value;
if (mutation.type === 'childList') {
setMeasurement(mutation.target.getBoundingClientRect());
} else if (mutation.type === 'attributes' && (mutation.attributeName === 'style' || mutation.attributeName === 'class')) {
setMeasurement(refToMeasure.getBoundingClientRect());
}
}
} catch (err) {
_iterator.e(err);
} finally {
_iterator.f();
}
});
mutationObserver.observe(refToMeasure, {
attributes: true,
childList: true,
subtree: true
});
return function () {
mutationObserver.disconnect();
mutationObserver = null;
};
}
}, [] // disconnect on unmount
);
return {
ref: ref,
measurement: measurement
};
};
/**
* A higher-order component that adds the ability to measure a referenced node and get that value
* back as a prop.
*
* Applying `Measurable` to a component will pass two additional props: function to fetch the `ref`
* and the measurement object (currently this executes `getBoundingClientRect` returning its full
* complement of properties). Both prop names are configurable through the HOC config object.
*
* Changes to the referenced node will result in new measurements being returned as props. That
* being said, it probably is not wise to use this during animation as it may cause unwanted
* performance issues.
*
* @see https://reactjs.org/docs/hooks-faq.html#how-can-i-measure-a-dom-node
* @class Measurable
* @memberof ui/Measurable
* @hoc
* @public
*/
var Measurable = exports.Measurable = (0, _hoc["default"])(defaultConfig, function (configHoc, Wrapped) {
return function MeasurableHoc(props) {
// Take the config from Measurable and insert it into a fresh instance of defineMeasurable
var _useMeasurable = useMeasurable(),
ref = _useMeasurable.ref,
measurement = _useMeasurable.measurement;
var measurementProps = _defineProperty(_defineProperty({}, configHoc.refProp, ref), configHoc.measurementProp, measurement);
return /*#__PURE__*/(0, _jsxRuntime.jsx)(Wrapped, _objectSpread(_objectSpread({}, props), measurementProps));
};
});
var _default = exports["default"] = Measurable;