@enact/ui
Version:
A collection of simplified unstyled cross-platform UI components for Enact
245 lines (242 loc) • 9.3 kB
JavaScript
;
Object.defineProperty(exports, "__esModule", {
value: true
});
exports["default"] = exports.ImageDecorator = exports.ImageBase = exports.Image = void 0;
var _kind = _interopRequireDefault(require("@enact/core/kind"));
var _propTypes = _interopRequireDefault(require("@enact/core/internal/prop-types"));
var _propTypes2 = _interopRequireDefault(require("prop-types"));
var _compose = _interopRequireDefault(require("ramda/src/compose"));
var _warning = _interopRequireDefault(require("warning"));
var _resolution = require("../resolution");
var _ForwardRef = _interopRequireDefault(require("../ForwardRef"));
var _ImageModule = _interopRequireDefault(require("./Image.module.css"));
var _jsxRuntime = require("react/jsx-runtime");
var _excluded = ["alt", "aria-label", "bgImage", "children", "componentRef", "css", "imgSrc", "onError", "onLoad", "style"];
/**
* An unstyled image component to be customized by a theme or application.
*
* @module ui/Image
* @exports Image
* @exports ImageBase
* @exports ImageDecorator
*/
/**
* A basic image component designed to display images conditionally based on screen size.
*
* This component does not have a default size, therefore the image will not show unless a size is
* specified using a CSS `className` or inline `style`.
*
* Example:
* ```
* const src = {
* 'hd': 'http://lorempixel.com/64/64/city/1/',
* 'fhd': 'http://lorempixel.com/128/128/city/1/',
* 'uhd': 'http://lorempixel.com/256/256/city/1/'
* };
*
* <Image className={css.myImage} src={src} sizing="fill" />
* ```
*
* `ui/Image` is based on the `div` element, but it uses `img` to provide `onError` and `onLoad`
* events. The image that you see on screen is a `background-image` from the `div` element, not the
* `img` element.
*
* > If you need a naturally sized image, you can use the native `<img>` element instead.
*
* @class ImageBase
* @memberof ui/Image
* @ui
* @public
*/
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 ImageBase = exports.ImageBase = (0, _kind["default"])({
name: 'ui:Image',
propTypes: /** @lends ui/Image.ImageBase.prototype */{
/**
* String value for the alt attribute of the image.
*
* @type {String}
* @public
*/
alt: _propTypes2["default"].string,
/**
* The aria-label for the image.
*
* If unset, it defaults to the value of `alt`.
*
* @type {String}
* @public
* @memberof ui/Image.Image.prototype
*/
'aria-label': _propTypes2["default"].string,
/**
* Node for the children of an `Image`. Useful for overlays.
*
* @type {Node}
* @public
*/
children: _propTypes2["default"].node,
/**
* Called with a reference to the root component.
*
* When using {@link ui/Image.Image}, the `ref` prop is forwarded to this component
* as `componentRef`.
*
* @type {Object|Function}
* @public
*/
componentRef: _propTypes["default"].ref,
/**
* Customizes the component by mapping the supplied collection of CSS class names to the
* corresponding internal elements and states of this component.
*
* The following classes are supported:
*
* * `image` - The root component class
* * `fit` - Applied when `sizing` prop is `fit`
* * `fill` - Applied when `sizing` prop is `fill`
*
* @type {Object}
* @public
*/
css: _propTypes2["default"].object,
/**
* Called if the image has an error.
*
* @type {Function}
* @public
*/
onError: _propTypes2["default"].func,
/**
* Called once the image is loaded.
*
* @type {Function}
* @public
*/
onLoad: _propTypes2["default"].func,
/**
* A placeholder image to be displayed before the image is loaded.
*
* For performance purposes, it should be pre-loaded or be a data url. If `src` is
* unset, this value will be used as the `background-image`.
*
* @type {String}
* @default ''
* @public
*/
placeholder: _propTypes2["default"].string,
/**
* Used to set the `background-size` of an `Image`.
*
* * `'fill'` - sets `background-size: cover`
* * `'fit'` - sets `background-size: contain`
* * `'none'` - uses the image's natural size
*
* @type {String}
* @default 'fill'
* @public
*/
sizing: _propTypes2["default"].oneOf(['fit', 'fill', 'none']),
/**
* String value or Object of values used to determine which image will appear on
* a specific screenSize.
*
* @type {String|Object}
* @public
*/
src: _propTypes2["default"].oneOfType([_propTypes2["default"].string, _propTypes2["default"].object])
},
defaultProps: {
placeholder: '',
sizing: 'fill'
},
styles: {
css: _ImageModule["default"],
className: 'image',
publicClassNames: true
},
computed: {
bgImage: function bgImage(_ref) {
var placeholder = _ref.placeholder,
src = _ref.src;
var imageSrc = (0, _resolution.selectSrc)(src) || placeholder;
process.env.NODE_ENV !== "production" ? (0, _warning["default"])(imageSrc, 'Image requires that either the "placeholder" or "src" props be specified.') : void 0;
if (!imageSrc) return null;
return placeholder && imageSrc !== placeholder ? "url(\"".concat(imageSrc, "\"), url(\"").concat(placeholder, "\")") : "url(\"".concat(imageSrc, "\")");
},
className: function className(_ref2) {
var _className = _ref2.className,
sizing = _ref2.sizing,
styler = _ref2.styler;
return sizing !== 'none' ? styler.append(sizing) : _className;
},
imgSrc: function imgSrc(_ref3) {
var src = _ref3.src;
return (0, _resolution.selectSrc)(src) || null;
}
},
render: function render(_ref4) {
var alt = _ref4.alt,
ariaLabel = _ref4['aria-label'],
bgImage = _ref4.bgImage,
children = _ref4.children,
componentRef = _ref4.componentRef,
css = _ref4.css,
imgSrc = _ref4.imgSrc,
onError = _ref4.onError,
onLoad = _ref4.onLoad,
style = _ref4.style,
rest = _objectWithoutProperties(_ref4, _excluded);
delete rest.placeholder;
delete rest.sizing;
delete rest.src;
return /*#__PURE__*/(0, _jsxRuntime.jsxs)("div", _objectSpread(_objectSpread({
role: "img"
}, rest), {}, {
"aria-label": ariaLabel || alt,
ref: componentRef,
style: _objectSpread(_objectSpread({}, style), {}, {
backgroundImage: bgImage
}),
children: [children, /*#__PURE__*/(0, _jsxRuntime.jsx)("img", {
className: css.img,
src: imgSrc,
alt: alt,
onLoad: onLoad,
onError: onError
})]
}));
}
});
/**
* A higher-order component that adds behaviors to an {@link ui/Image.ImageBase|ImageBase}.
*
* @hoc
* @memberof ui/Image
* @mixes ui/ForwardRef.ForwardRef
* @public
*/
var ImageDecorator = exports.ImageDecorator = (0, _compose["default"])((0, _ForwardRef["default"])({
prop: 'componentRef'
}));
/**
* A minimally styled Image ready for customization by a theme.
*
* @class Image
* @memberof ui/Image
* @extends ui/Image.ImageBase
* @mixes ui/Image.ImageDecorator
* @omit componentRef
* @ui
* @public
*/
var Image = exports.Image = ImageDecorator(ImageBase);
var _default = exports["default"] = Image;