@enact/ui
Version:
A collection of simplified unstyled cross-platform UI components for Enact
77 lines (76 loc) • 4.06 kB
JavaScript
;
Object.defineProperty(exports, "__esModule", {
value: true
});
exports["default"] = exports.ComponentOverride = void 0;
var _react = require("react");
var _reactIs = require("react-is");
var _jsxRuntime = require("react/jsx-runtime");
var _excluded = ["component"];
/**
* A utility component that either clones or creates a component instance based on the
* incoming `component` prop value.
*
* This allows you to supply JSX as the component used in your prop
* allowing you to add your own properties. They'll get mixed onto the component when it's used in
* the parent component.
*
* @module ui/ComponentOverride
* @exports ComponentOverride
*/
/**
* Utility to either create or clone a component instance with the given set of props.
*
* `ComponentOverride` can be used to support props that either accept a type, (e.g. `Button`) or an
* element (e.g. `<Button customProp="value" />`) and return a new element which includes the
* remaining props specified.
*
* Example:
* ```
* const LabeledIconButton = ({iconComponent, label, ...rest}) => {
* return (
* <div {...rest}>
* <ComponentOverride
* component={iconComponent}
* icon="house"
* />
* <span>{label}</span>
* </div>
* );
* };
*
* // Usage
*
* // Only the props defined by LabeledIconButton will be passed to CustomIcon
* <LabeledIconButton
* label="Home"
* iconComponent={CustomIcon}
* />
*
* // The color prop along with props defined by LabeledIconButton will be passed to CustomIcon
* <LabeledIconButton
* label="Home"
* iconComponent={
* <CustomIcon color="green" />
* }
* />
* ```
*
* @class
* @memberof ui/ComponentOverride
* @ui
* @public
*/
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 ComponentOverride = exports.ComponentOverride = function ComponentOverride(_ref) {
var Component = _ref.component,
props = _objectWithoutProperties(_ref, _excluded);
return Component && ((0, _reactIs.isValidElementType)(Component) && /*#__PURE__*/(0, _jsxRuntime.jsx)(Component, _objectSpread({}, props)) || /*#__PURE__*/(0, _react.isValidElement)(Component) && (/*#__PURE__*/(0, _react.cloneElement)(Component, props))) || null;
};
var _default = exports["default"] = ComponentOverride;