@enact/limestone 1.3.0

package/Image/Image.js

@@ -0,0 +1,165 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports["default"] = exports.ImageDecorator = exports.ImageBase = exports.Image = void 0;
+var _kind = _interopRequireDefault(require("@enact/core/kind"));
+var _hoc = _interopRequireDefault(require("@enact/core/hoc"));
+var _Image = require("@enact/ui/Image");
+var _propTypes = _interopRequireDefault(require("@enact/core/internal/prop-types"));
+var _ForwardRef = _interopRequireDefault(require("@enact/ui/ForwardRef"));
+var _Pure = _interopRequireDefault(require("@enact/ui/internal/Pure"));
+var _resolution = require("@enact/ui/resolution");
+var _propTypes2 = _interopRequireDefault(require("prop-types"));
+var _compose = _interopRequireDefault(require("ramda/src/compose"));
+var _react = require("react");
+var _Skinnable = _interopRequireDefault(require("../Skinnable"));
+var _ImageModule = _interopRequireDefault(require("./Image.module.css"));
+var _jsxRuntime = require("react/jsx-runtime");
+var _excluded = ["css", "componentRef"];
+/**
+ * Provides Limestone styled Image component that supports multiple resolution sources.
+ *
+ * @example
+ * <Image src="https://dummyimage.com/64/e048e0/0011ff" style={{height: 64, width: 64}} />
+ *
+ * @module limestone/Image
+ * @exports Image
+ * @exports ImageBase
+ * @exports ImageDecorator
+ */
+/**
+ * A Limestone-styled image component without any behavior
+ *
+ * @class ImageBase
+ * @memberof limestone/Image
+ * @extends ui/Image.Image
+ * @ui
+ * @public
+ */
+function _interopRequireDefault(e) { return e && e.__esModule ? e : { "default": e }; }
+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; }
+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: 'Image',
+  propTypes: /** @lends limestone/Image.ImageBase.prototype */{
+    /**
+     * Called with a reference to the root component.
+     *
+     * When using {@link limestone/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 for Image
+     *
+     * @type {Object}
+     * @public
+     */
+    css: _propTypes2["default"].object
+  },
+  styles: {
+    css: _ImageModule["default"],
+    publicClassNames: ['image']
+  },
+  render: function render(_ref) {
+    var css = _ref.css,
+      componentRef = _ref.componentRef,
+      rest = _objectWithoutProperties(_ref, _excluded);
+    return _Image.ImageBase.inline(_objectSpread(_objectSpread({
+      draggable: 'false'
+    }, rest), {}, {
+      componentRef: componentRef,
+      css: css
+    }));
+  }
+});
+
+// This induces a render when there is a screen size change that has a corresponding image src value
+// associated with the new screen size. The render is kicked off by remembering the new image src.
+//
+// This hoc could (should) be rewritten at a later time to use a smarter context API and callbacks,
+// or something like pub/sub; each of which would be hooked together from the resolution.js that
+// would coordinate any screen size/orientation changes and emit events from there.
+//
+// This is ripe for refactoring, and could probably move into UI to be generalized, but that's for
+// another time. -B 2018-05-01
+var ResponsiveImageDecorator = (0, _hoc["default"])(function (config, Wrapped) {
+  // eslint-disable-next-line no-shadow
+  var ResponsiveImageDecorator = function ResponsiveImageDecorator(props) {
+    var _useState = (0, _react.useState)((0, _resolution.selectSrc)(props.src)),
+      _useState2 = _slicedToArray(_useState, 2),
+      setSrc = _useState2[1];
+    (0, _react.useEffect)(function () {
+      var handleResize = function handleResize() {
+        setSrc((0, _resolution.selectSrc)(props.src));
+      };
+      window.addEventListener('resize', handleResize);
+      return function () {
+        window.removeEventListener('resize', handleResize);
+      };
+    }, []); // eslint-disable-line react-hooks/exhaustive-deps
+
+    return /*#__PURE__*/(0, _jsxRuntime.jsx)(Wrapped, _objectSpread({}, props));
+  };
+  ResponsiveImageDecorator.displayName = 'ResponsiveImageDecorator';
+  ResponsiveImageDecorator.propTypes = {
+    src: _propTypes2["default"].oneOfType([_propTypes2["default"].string, _propTypes2["default"].object])
+  };
+  return ResponsiveImageDecorator;
+});
+
+/**
+ * Limestone-specific behaviors to apply to {@link limestone/Image.ImageBase|Image}.
+ *
+ * @hoc
+ * @memberof limestone/Image
+ * @mixes limestone/Skinnable.Skinnable
+ * @public
+ */
+var ImageDecorator = exports.ImageDecorator = (0, _compose["default"])((0, _ForwardRef["default"])({
+  prop: 'componentRef'
+}), _Pure["default"], ResponsiveImageDecorator, _Skinnable["default"]);
+
+/**
+ * A Limestone-styled image component
+ *
+ * ```
+ * <Image
+ *   src={{
+ *     'hd': 'https://dummyimage.com/64/e048e0/0011ff',
+ *     'fhd': 'https://dummyimage.com/128/e048e0/0011ff',
+ *     'uhd': 'https://dummyimage.com/256/e048e0/0011ff'
+ *   }}
+ * >
+ * ```
+ *
+ * @class Image
+ * @memberof limestone/Image
+ * @extends limestone/Image.ImageBase
+ * @mixes limestone/Image.ImageDecorator
+ * @ui
+ * @public
+ */
+var Image = exports.Image = ImageDecorator(ImageBase);
+var _default = exports["default"] = Image;

package/Image/Image.module.css

@@ -0,0 +1,5 @@
+.image {
+  margin: 0 1rem;
+  width: 15rem;
+  height: 10rem;
+}

package/Image/package.json

@@ -0,0 +1,3 @@
+{
+	"main": "Image.js"
+}

package/Image/tests/Image-specs.js

@@ -0,0 +1,62 @@
+"use strict";
+
+require("@testing-library/jest-dom");
+var _react = require("@testing-library/react");
+var _Image = _interopRequireDefault(require("../Image"));
+var _jsxRuntime = require("react/jsx-runtime");
+function _interopRequireDefault(e) { return e && e.__esModule ? e : { "default": e }; }
+var src = {
+  hd: 'https://placehold.co/200x200',
+  fhd: 'https://placehold.co/300x300',
+  uhd: 'https://placehold.co/600x600'
+};
+describe('Image', function () {
+  test('should select a src', function () {
+    (0, _react.render)(/*#__PURE__*/(0, _jsxRuntime.jsx)(_Image["default"], {
+      src: src
+    }));
+    var image = _react.screen.getAllByRole('img')[1];
+
+    // dispatching resize event for code coverage purposes
+    (0, _react.fireEvent)(window, new Event('resize'));
+    var actual = image.getAttribute('src');
+    var expected = 'https://placehold.co/300x300';
+    expect(actual).toBe(expected);
+  });
+  test('should return a DOM node reference for `componentRef`', function () {
+    var ref = jest.fn();
+    (0, _react.render)(/*#__PURE__*/(0, _jsxRuntime.jsx)(_Image["default"], {
+      ref: ref,
+      src: src
+    }));
+    var expected = 'DIV';
+    var actual = ref.mock.calls[0][0].nodeName;
+    expect(actual).toBe(expected);
+  });
+  test('should render image with sizing \'fill\'', function () {
+    (0, _react.render)(/*#__PURE__*/(0, _jsxRuntime.jsx)(_Image["default"], {
+      src: src
+    }));
+    var image = _react.screen.getAllByRole('img')[0];
+    var expected = "image fill";
+    expect(image).toHaveClass(expected);
+  });
+  test('should render image with sizing \'fit\'', function () {
+    (0, _react.render)(/*#__PURE__*/(0, _jsxRuntime.jsx)(_Image["default"], {
+      src: src,
+      sizing: "fit"
+    }));
+    var image = _react.screen.getAllByRole('img')[0];
+    var expected = "image fit";
+    expect(image).toHaveClass(expected);
+  });
+  test('should render image with sizing \'none\'', function () {
+    (0, _react.render)(/*#__PURE__*/(0, _jsxRuntime.jsx)(_Image["default"], {
+      src: src,
+      sizing: "none"
+    }));
+    var image = _react.screen.getAllByRole('img')[0];
+    var expected = "image";
+    expect(image).toHaveClass(expected);
+  });
+});

package/ImageItem/ImageItem.d.ts

@@ -0,0 +1,134 @@
+// Type definitions for limestone/ImageItem
+
+import { MarqueeControllerProps as limestone_Marquee_MarqueeControllerProps } from "limestone/Marquee";
+import { SpottableProps as spotlight_Spottable_SpottableProps } from "@enact/spotlight/Spottable";
+import { SkinnableProps as limestone_Skinnable_SkinnableProps } from "limestone/Skinnable";
+import { ImageItemProps as ui_ImageItem_ImageItemProps } from "@enact/ui/ImageItem";
+import * as React from "react";
+
+type Omit<T, K extends keyof T> = Pick<T, Exclude<keyof T, K>>;
+type Merge<M, N> = Omit<M, Extract<keyof M, keyof N>> & N;
+
+export interface ImageItemBaseProps extends ui_ImageItem_ImageItemProps {
+  /**
+   * Centers the primary caption and label in vertical orientation.
+   */
+  centered?: boolean;
+  /**
+   * The primary caption displayed with the image.
+   */
+  children?: string | React.ReactNode;
+  /**
+ * 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:
+ * *  `caption`  - The caption component class
+ * *  `fullImage`  - Applied when  `orientation`  prop is  `vertical`  without  `label`  and  `children`
+ * *  `horizontal`  - Applied when  `orientation`  prop is  `horizontal`
+ * *  `image`  - The image component class
+ * *  `imageIcon`  - The image icon component class
+ * *  `imageItem`  - The image item component class
+ * *  `label`  - The secondary caption component class
+ * *  `selected`  - Applied when  `selected`  prop is  `true`
+ * *  `selectionIcon`  - The icon component class for default selection component
+ * *  `vertical`  - Applied when  `orientation`  prop is  `vertical`
+ */
+  css?: object;
+  /**
+   * The voice control intent.
+   */
+  "data-webos-voice-intent"?: string;
+  /**
+   * Disable ImageItem and becomes non-interactive.
+   */
+  disabled?: boolean;
+  /**
+   * A secondary caption displayed with the image.
+   */
+  label?: string | React.ReactNode;
+  /**
+   * The layout orientation of the component.
+   */
+  orientation?: "horizontal" | "vertical";
+  /**
+ * Placeholder image used while   
+is loaded.
+ */
+  placeholder?: string;
+  /**
+ * Applies a selected visual effect to the image, but only if  `showSelection` 
+is also  `true` .
+ */
+  selected?: boolean;
+  /**
+ * The custom selection component to render. A component can be a stateless functional
+component,  `kind()`  or React component. The following is an example with custom selection
+kind.
+ * 
+ * Usage:
+ * ```
+const SelectionComponent = kind({
+	render: () => <div>custom selection component</div>
+});
+
+<ImageItem selectionComponent={SelectionComponent} />
+```
+ */
+  selectionComponent?: Function;
+  /**
+   * Shows a selection component with a centered icon. When  `selected`  is true, a check mark is shown.
+   */
+  showSelection?: boolean;
+  /**
+ * Source for the image.
+String value or Object of values used to determine which image will appear on
+a specific screenSize.
+ */
+  src?: string | object;
+  /**
+   * Changes the image from a scale  `1:1`  to  `16:9`  in horizontal orientation.
+   */
+  wideImage?: boolean;
+}
+/**
+ * A Limestone styled base component for   .
+ */
+
+export class ImageItemBase extends React.Component<
+  Merge<React.HTMLProps<HTMLElement>, ImageItemBaseProps>
+> {}
+
+export interface ImageItemDecoratorProps
+  extends Merge<
+    Merge<
+      limestone_Marquee_MarqueeControllerProps,
+      spotlight_Spottable_SpottableProps
+    >,
+    limestone_Skinnable_SkinnableProps
+  > {}
+export function ImageItemDecorator<P>(
+  Component: React.ComponentType<P> | string,
+): React.ComponentType<P & ImageItemDecoratorProps>;
+
+export interface ImageItemProps
+  extends Merge<ImageItemBaseProps, ImageItemDecoratorProps> {}
+/**
+ * A limestone-styled image item, Marquee and Spottable applied.
+ * 
+ * Usage:
+ * ```
+<ImageItem
+  src="https://placehold.co/100x100/9037ab/ffffff/png?text=Image0"
+  label="A secondary caption"
+>
+	The primary caption for the image
+</ImageItem>
+```
+ */
+
+export class ImageItem extends React.Component<
+  Merge<React.HTMLProps<HTMLElement>, ImageItemProps>
+> {}
+
+export default ImageItem;