Replace 'isPreview' with 'isEditor' when it refers to the editor (#1276)

* Replace 'isPreview' with 'isEditor' in several places

* Explicitly set props to true

* Add missing propTypes

Author: Aljullu

assets/js/blocks/active-filters/block.js

@@ -5,6 +5,7 @@ import { __ } from '@wordpress/i18n';
 import { useQueryStateByKey } from '@woocommerce/base-hooks';
 import { useMemo, Fragment } from '@wordpress/element';
 import classnames from 'classnames';
+import PropTypes from 'prop-types';
 
 /**
  * Internal dependencies
@@ -19,7 +20,7 @@ import ActiveAttributeFilters from './active-attribute-filters';
  */
 const ActiveFiltersBlock = ( {
 	attributes: blockAttributes,
-	isPreview = false,
+	isEditor = false,
 } ) => {
 	const [ productAttributes, setProductAttributes ] = useQueryStateByKey(
 		'attributes',
@@ -65,7 +66,7 @@ const ActiveFiltersBlock = ( {
 		);
 	};
 
-	if ( ! hasFilters() && ! isPreview ) {
+	if ( ! hasFilters() && ! isEditor ) {
 		return null;
 	}
 
@@ -77,12 +78,12 @@ const ActiveFiltersBlock = ( {
 
 	return (
 		<Fragment>
-			{ ! isPreview && blockAttributes.heading && (
+			{ ! isEditor && blockAttributes.heading && (
 				<TagName>{ blockAttributes.heading }</TagName>
 			) }
 			<div className="wc-block-active-filters">
 				<ul className={ listClasses }>
-					{ isPreview ? (
+					{ isEditor ? (
 						<Fragment>
 							{ renderRemovableListItem(
 								__( 'Size', 'woo-gutenberg-products-block' ),
@@ -115,4 +116,15 @@ const ActiveFiltersBlock = ( {
 	);
 };
 
+ActiveFiltersBlock.propTypes = {
+	/**
+	 * The attributes for this block.
+	 */
+	attributes: PropTypes.object.isRequired,
+	/**
+	 * Whether it's in the editor or frontend display.
+	 */
+	isEditor: PropTypes.bool,
+};
+
 export default ActiveFiltersBlock;

assets/js/blocks/active-filters/edit.js

@@ -82,7 +82,7 @@ const Edit = ( { attributes, setAttributes } ) => {
 				onChange={ ( value ) => setAttributes( { heading: value } ) }
 			/>
 			<Disabled>
-				<Block attributes={ attributes } isPreview />
+				<Block attributes={ attributes } isEditor={ true } />
 			</Disabled>
 		</div>
 	);

assets/js/blocks/price-filter/block.js

@@ -10,11 +10,12 @@ import { Fragment, useCallback, useState, useEffect } from '@wordpress/element';
 import PriceSlider from '@woocommerce/base-components/price-slider';
 import { CURRENCY } from '@woocommerce/settings';
 import { useDebouncedCallback } from 'use-debounce';
+import PropTypes from 'prop-types';
 
 /**
  * Component displaying a price filter.
  */
-const PriceFilterBlock = ( { attributes, isPreview = false } ) => {
+const PriceFilterBlock = ( { attributes, isEditor = false } ) => {
 	const [ minPriceQuery, setMinPriceQuery ] = useQueryStateByKey(
 		'min_price'
 	);
@@ -103,7 +104,7 @@ const PriceFilterBlock = ( { attributes, isPreview = false } ) => {
 
 	return (
 		<Fragment>
-			{ ! isPreview && attributes.heading && (
+			{ ! isEditor && attributes.heading && (
 				<TagName>{ attributes.heading }</TagName>
 			) }
 			<div className="wc-block-price-slider">
@@ -126,4 +127,15 @@ const PriceFilterBlock = ( { attributes, isPreview = false } ) => {
 	);
 };
 
+PriceFilterBlock.propTypes = {
+	/**
+	 * The attributes for this block.
+	 */
+	attributes: PropTypes.object.isRequired,
+	/**
+	 * Whether it's in the editor or frontend display.
+	 */
+	isEditor: PropTypes.bool,
+};
+
 export default PriceFilterBlock;

assets/js/blocks/price-filter/edit.js

@@ -167,7 +167,7 @@ export default function( { attributes, setAttributes } ) {
 						}
 					/>
 					<Disabled>
-						<Block attributes={ attributes } isPreview />
+						<Block attributes={ attributes } isEditor={ true } />
 					</Disabled>
 				</div>
 			) }

assets/js/blocks/product-search/block.js

@@ -152,7 +152,7 @@ class ProductSearchBlock extends Component {
 	}
 
 	render() {
-		if ( this.props.isPreview ) {
+		if ( this.props.isEditor ) {
 			return this.renderEdit();
 		}
 
@@ -170,9 +170,9 @@ ProductSearchBlock.propTypes = {
 	 */
 	instanceId: PropTypes.number,
 	/**
-	 * Whether this is the block preview or frontend display.
+	 * Whether it's in the editor or frontend display.
 	 */
-	isPreview: PropTypes.bool,
+	isEditor: PropTypes.bool,
 	/**
 	 * A callback to update attributes.
 	 */

assets/js/blocks/product-search/index.js

@@ -113,7 +113,7 @@ registerBlockType( 'woocommerce/product-search', {
 						/>
 					</PanelBody>
 				</InspectorControls>
-				<Block { ...props } isPreview />
+				<Block { ...props } isEditor={ true } />
 			</Fragment>
 		);
 	},