PLAT-109381: Reduce the ImageItem render time

packages/ui/ImageItem/ImageItem.js

@@ -1,3 +1,7 @@
+/*  eslint-disable react-hooks/rules-of-hooks */
+/*  eslint-disable react-hooks/exhaustive-deps */
+// To use `React.useMemo` in a kind, the above eslint rules have been disabled.
+
 /**
  * Unstyled image item components and behaviors to be customized by a theme or application.
  *
@@ -14,13 +18,18 @@ import ComponentOverride from '../ComponentOverride';
 import Image from '../Image';
 import {Cell, Column, Row} from '../Layout';
 
+import  {MemoPropsContextConsumer, MemoPropsDecorator, MemoPropsThemeContextConsumer, MemoPropsThemeDecorator} from './MemoPropsDecorator';
+
 import componentCss from './ImageItem.module.less';
 
 // Adapts ComponentOverride to work within Cell since both use the component prop
 function ImageOverride ({imageComponent, ...rest}) {
-	return ComponentOverride({
-		component: imageComponent,
-		...rest
+	return MemoPropsContextConsumer((context) => {
+		return ComponentOverride({
+			...rest,
+			component: imageComponent,
+			src: context && context.src
+		});
 	});
 }
 
@@ -36,14 +45,6 @@ const ImageItemBase = kind({
 	name: 'ui:ImageItem',
 
 	propTypes: /** @lends ui/ImageItem.ImageItem.prototype */ {
-		/**
-		 * The caption displayed with the image.
-		 *
-		 * @type {Node}
-		 * @public
-		 */
-		children: PropTypes.node,
-
 		/**
 		 * Customizes the component by mapping the supplied collection of CSS class names to the
 		 * corresponding internal elements and states of this component.
@@ -94,16 +95,7 @@ const ImageItemBase = kind({
 		 * @default false
 		 * @public
 		 */
-		selected: PropTypes.bool,
-
-		/**
-		 * String value or Object of values used to determine which image will appear on a specific
-		 * screenSize.
-		 *
-		 * @type {String|Object}
-		 * @public
-		 */
-		src: PropTypes.oneOfType([PropTypes.string, PropTypes.object])
+		selected: PropTypes.bool
 	},
 
 	defaultProps: {
@@ -112,6 +104,8 @@ const ImageItemBase = kind({
 		selected: false
 	},
 
+	functional: true,
+
 	styles: {
 		css: componentCss,
 		className: 'imageItem',
@@ -123,42 +117,94 @@ const ImageItemBase = kind({
 			selected,
 			horizontal: orientation === 'horizontal',
 			vertical: orientation === 'vertical'
-		})
+		}),
+		memoizedImageCell: ({css, imageComponent, orientation, placeholder}) => {
+			const isHorizontal = orientation === 'horizontal';
+
+			return React.useMemo(() => {
+				return (
+					<Cell
+						className={css.image}
+						component={ImageOverride}
+						imageComponent={imageComponent}
+						key="image"
+						placeholder={placeholder}
+						shrink={isHorizontal}
+					/>
+				);
+				// eslint-disable-next-line react-hooks/exhaustive-deps
+			}, [css.image, imageComponent, isHorizontal, placeholder]);
+		},
+		memoizedChildrenCell: ({css, orientation}) => {
+			const isHorizontal = orientation === 'horizontal';
+
+			return React.useMemo(() => {
+				return (
+					<Cell
+						// eslint-disable-next-line no-undefined
+						align={isHorizontal ? 'center' : undefined}
+						className={css.caption}
+						key="children"
+						shrink={!isHorizontal}
+					>
+						{MemoPropsContextConsumer((context) => {
+							return context && context.children;
+						})}
+					</Cell>
+				);
+			}, [css.caption, isHorizontal]);
+		}
 	},
 
-	render: ({children, css, imageComponent, orientation, placeholder, src, ...rest}) => {
+	render: ({className, memoizedChildrenCell, memoizedImageCell, orientation, ...rest}) => {
+		delete rest.css;
+		delete rest.imageComponent;
+		delete rest.placeholder;
 		delete rest.selected;
 
 		const isHorizontal = orientation === 'horizontal';
 		const Component = isHorizontal ? Row : Column;
 
 		return (
-			<Component {...rest}>
-				<Cell
-					className={css.image}
-					component={ImageOverride}
-					imageComponent={imageComponent}
-					placeholder={placeholder}
-					shrink={isHorizontal}
-					src={src}
-				/>
-				{children ? (
-					<Cell
-						className={css.caption}
-						shrink={!isHorizontal}
-						// eslint-disable-next-line no-undefined
-						align={isHorizontal ? 'center' : undefined}
-					>
-						{children}
-					</Cell>
-				) : null}
-			</Component>
+			<div {...rest} className={className}>
+				{React.useMemo(() => {
+					return (
+						<Component>
+							{[memoizedImageCell, memoizedChildrenCell]}
+						</Component>
+					);
+				}, [Component])}
+			</div>
 		);
 	}
 });
 
-export default ImageItemBase;
+const ImageItem = MemoPropsDecorator({filter: ['children', 'src']})(ImageItemBase);
+
+/**
+ * The caption displayed with the image.
+ *
+ * @name children
+ * @memberof ui/ImageItem.ImageItemBase.prototype
+ * @type {Node}
+ * @public
+ */
+
+/**
+ * String value or Object of values used to determine which image will appear on a specific
+ * screenSize.
+ *
+ * @name src
+ * @memberof ui/ImageItem.ImageItemBase.prototype
+ * @type {String|Object}
+ * @public
+ */
+
+export default ImageItem;
 export {
-	ImageItemBase as ImageItem,
-	ImageItemBase
+	ImageItem,
+	ImageItemBase,
+	MemoPropsDecorator,
+	MemoPropsThemeContextConsumer,
+	MemoPropsThemeDecorator
 };

packages/ui/ImageItem/ImageItem.module.less

@@ -2,24 +2,25 @@
 //
 .imageItem {
 	box-sizing: border-box;
+	height: 100%;
 
 	.image {
 		display: block; // leaving this to prevent whitespace between inline-block elements
 		margin: 0;
 	}
-	
+
 	.caption,
 	&.selected {
 		/* Public Class Names */
 	}
-	
+
 	&.horizontal {
 		.image {
 			width: 25%;
 			height: 100%;
 		}
 	}
-	
+
 	&.vertical {
 		.image {
 			width: 100%;

packages/ui/ImageItem/MemoPropsDecorator.js

@@ -0,0 +1,61 @@
+import hoc from '@enact/core/hoc';
+import pick from 'ramda/src/pick';
+import omit from 'ramda/src/omit';
+import React from 'react';
+
+const MemoPropsThemeContext = React.createContext();
+const MemoPropsContext = React.createContext();
+
+const defaultConfig = {
+	filter: []
+};
+
+const MemoPropsDecorator = hoc(defaultConfig, (config, Wrapped) => {
+	const {filter} = config;
+
+	// eslint-disable-next-line no-shadow
+	function MemoPropsDecorator (props) {
+		const picked = pick(filter, props) || {};
+		const omitted = omit(filter, props) || {};
+
+		return (
+			<MemoPropsContext.Provider value={picked}>
+				<Wrapped {...omitted} />
+			</MemoPropsContext.Provider>
+		);
+	}
+
+	return MemoPropsDecorator;
+});
+
+const MemoPropsThemeDecorator = hoc((config, Wrapped) => {
+	// eslint-disable-next-line no-shadow
+	function MemoPropsThemeDecorator (props) {
+		return (
+			<MemoPropsThemeContext.Provider value={props}>
+				<Wrapped {...props} />
+			</MemoPropsThemeContext.Provider>
+		);
+	}
+
+	return MemoPropsThemeDecorator;
+});
+
+const ContextConsumer = (Context) => (fn) => { // eslint-disable-line enact/display-name
+	return (
+		<Context.Consumer>
+			{fn}
+		</Context.Consumer>
+	);
+};
+
+const MemoPropsContextConsumer = ContextConsumer(MemoPropsContext);
+const MemoPropsThemeContextConsumer = ContextConsumer(MemoPropsThemeContext);
+
+export default MemoPropsThemeContext;
+export {
+	MemoPropsContextConsumer,
+	MemoPropsDecorator,
+	MemoPropsThemeContextConsumer,
+	MemoPropsThemeDecorator
+};