@enact/ui/ForwardRef/ForwardRef.js

A collection of simplified unstyled cross-platform UI components for Enact

"use strict";

Object.defineProperty(exports, "__esModule", {
  value: true
});
exports["default"] = exports.ForwardRef = void 0;
var _hoc = _interopRequireDefault(require("@enact/core/hoc"));
var _propTypes = _interopRequireDefault(require("prop-types"));
var _jsxRuntime = require("react/jsx-runtime");
var _excluded = ["ref"];
/**
 * A higher-order component interface for `ref` forwarding.
 *
 * @module ui/ForwardRef
 * @exports	ForwardRef
 */
/**
 * Default config for {@link ui/ForwardRef.ForwardRef}.
 *
 * @memberof ui/ForwardRef.ForwardRef
 * @hocconfig
 */
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 _objectWithoutProperties(e, t) { if (null == e) return {}; var o, r, i = _objectWithoutPropertiesLoose(e, t); if (Object.getOwnPropertySymbols) { var n = Object.getOwnPropertySymbols(e); for (r = 0; r < n.length; r++) o = n[r], -1 === t.indexOf(o) && {}.propertyIsEnumerable.call(e, o) && (i[o] = e[o]); } return i; }
function _objectWithoutPropertiesLoose(r, e) { if (null == r) return {}; var t = {}; for (var n in r) if ({}.hasOwnProperty.call(r, n)) { if (-1 !== e.indexOf(n)) continue; t[n] = r[n]; } return t; }
var defaultConfig = {
  /**
   * The prop name to pass the ref callback
   *
   * @type {String}
   * @default 'forwardRef'
   * @memberof ui/ForwardRef.ForwardRef.defaultConfig
   */
  prop: 'forwardRef'
};

/**
 * A higher-order component that adapts [`React.forwardRef`](https://react.dev/reference/react/forwardRef)
 * to be chainable with other HOCs.
 *
 * The following examples are equivalent:
 *
 * ```
 * import ForwardRef from '@enact/ui/ForwardRef';
 * import Component from './Component';
 *
 * React.forwardRef((props, ref) => (
 * 	<Component {...props} setMyRef={ref} />
 * ));
 * ForwardRef({prop: 'setMyRef'}, Component);
 * ```
 *
 * @class ForwardRef
 * @memberof ui/ForwardRef
 * @hoc
 * @public
 */
var ForwardRef = exports.ForwardRef = (0, _hoc["default"])(defaultConfig, function (config, Wrapped) {
  var prop = config.prop;

  // eslint-disable-next-line no-shadow
  var ForwardRef = function ForwardRef(props) {
    var _props$ref = props.ref,
      ref = _props$ref === void 0 ? null : _props$ref,
      rest = _objectWithoutProperties(props, _excluded);
    var withRef = _objectSpread(_objectSpread({}, rest), {}, _defineProperty({}, prop, ref));
    return /*#__PURE__*/(0, _jsxRuntime.jsx)(Wrapped, _objectSpread({}, withRef));
  };
  ForwardRef.propTypes = {
    /**
     * Forwards a reference to the DOM element.
     *
     * @type {Object}
     * @private
     */
    ref: _propTypes["default"].shape({
      current: _propTypes["default"].any
    })
  };
  ForwardRef.displayName = 'ForwardRef';
  return ForwardRef;
});
var _default = exports["default"] = ForwardRef;