woocommerce/plugins/woocommerce-blocks/assets/js/blocks/featured-product/block.js

380 lines
9.6 KiB
JavaScript

/**
* External dependencies
*/
import { __ } from '@wordpress/i18n';
import apiFetch from '@wordpress/api-fetch';
import {
AlignmentToolbar,
BlockControls,
InspectorControls,
MediaUpload,
MediaUploadCheck,
PanelColorSettings,
RichText,
withColors,
} from '@wordpress/editor';
import {
Button,
IconButton,
PanelBody,
Placeholder,
RangeControl,
ResizableBox,
Spinner,
ToggleControl,
Toolbar,
withSpokenMessages,
} from '@wordpress/components';
import classnames from 'classnames';
import { Component, Fragment } from '@wordpress/element';
import { compose } from '@wordpress/compose';
import { debounce, isObject } from 'lodash';
import PropTypes from 'prop-types';
/**
* Internal dependencies
*/
import ProductControl from '../../components/product-control';
import {
getImageSrcFromProduct,
getImageIdFromProduct,
} from '../../utils/products';
/**
* The min-height for the block content.
*/
const MIN_HEIGHT = wc_product_block_data.min_height;
/**
* Generate a style object given either a product object or URL to an image.
*
* @param {object|string} url A product object as returned from the API, or an image URL.
* @return {object} A style object with a backgroundImage set (if a valid image is provided).
*/
function backgroundImageStyles( url ) {
// If `url` is an object, it's actually a product.
if ( isObject( url ) ) {
url = getImageSrcFromProduct( url );
}
if ( url ) {
return { backgroundImage: `url(${ url })` };
}
return {};
}
/**
* Convert the selected ratio to the correct background class.
*
* @param {number} ratio Selected opacity from 0 to 100.
* @return {string} The class name, if applicable (not used for ratio 0 or 50).
*/
function dimRatioToClass( ratio ) {
return ratio === 0 || ratio === 50 ?
null :
`has-background-dim-${ 10 * Math.round( ratio / 10 ) }`;
}
/**
* Component to handle edit mode of "Featured Product".
*/
class FeaturedProduct extends Component {
constructor() {
super( ...arguments );
this.state = {
product: false,
loaded: false,
};
this.debouncedGetProduct = debounce( this.getProduct.bind( this ), 200 );
}
componentDidMount() {
this.getProduct();
}
componentDidUpdate( prevProps ) {
if ( prevProps.attributes.productId !== this.props.attributes.productId ) {
this.debouncedGetProduct();
}
}
getProduct() {
const { productId } = this.props.attributes;
if ( ! productId ) {
// We've removed the selected product, or no product is selected yet.
this.setState( { product: false, loaded: true } );
return;
}
apiFetch( {
path: `/wc-pb/v3/products/${ productId }`,
} )
.then( ( product ) => {
this.setState( { product, loaded: true } );
} )
.catch( () => {
this.setState( { product: false, loaded: true } );
} );
}
getInspectorControls() {
const {
attributes,
setAttributes,
overlayColor,
setOverlayColor,
} = this.props;
return (
<InspectorControls key="inspector">
<PanelBody
title={ __( 'Product', 'woo-gutenberg-products-block' ) }
initialOpen={ false }
>
<ProductControl
selected={ attributes.productId || 0 }
onChange={ ( value = [] ) => {
const id = value[ 0 ] ? value[ 0 ].id : 0;
setAttributes( { productId: id, mediaId: 0, mediaSrc: '' } );
} }
/>
</PanelBody>
<PanelBody title={ __( 'Content', 'woo-gutenberg-products-block' ) }>
<ToggleControl
label={ __( 'Show description', 'woo-gutenberg-products-block' ) }
checked={ attributes.showDesc }
onChange={ () => setAttributes( { showDesc: ! attributes.showDesc } ) }
/>
<ToggleControl
label={ __( 'Show price', 'woo-gutenberg-products-block' ) }
checked={ attributes.showPrice }
onChange={ () => setAttributes( { showPrice: ! attributes.showPrice } ) }
/>
</PanelBody>
<PanelColorSettings
title={ __( 'Overlay', 'woo-gutenberg-products-block' ) }
colorSettings={ [
{
value: overlayColor.color,
onChange: setOverlayColor,
label: __( 'Overlay Color', 'woo-gutenberg-products-block' ),
},
] }
>
<RangeControl
label={ __( 'Background Opacity', 'woo-gutenberg-products-block' ) }
value={ attributes.dimRatio }
onChange={ ( ratio ) => setAttributes( { dimRatio: ratio } ) }
min={ 0 }
max={ 100 }
step={ 10 }
/>
</PanelColorSettings>
</InspectorControls>
);
}
renderEditMode() {
const { attributes, debouncedSpeak, setAttributes } = this.props;
const onDone = () => {
setAttributes( { editMode: false } );
debouncedSpeak(
__(
'Showing Featured Product block preview.',
'woo-gutenberg-products-block'
)
);
};
return (
<Placeholder
icon="star-filled"
label={ __( 'Featured Product', 'woo-gutenberg-products-block' ) }
className="wc-block-featured-product"
>
{ __(
'Visually highlight a product and encourage prompt action',
'woo-gutenberg-products-block'
) }
<div className="wc-block-handpicked-products__selection">
<ProductControl
selected={ attributes.productId || 0 }
onChange={ ( value = [] ) => {
const id = value[ 0 ] ? value[ 0 ].id : 0;
setAttributes( { productId: id, mediaId: 0, mediaSrc: '' } );
} }
/>
<Button isDefault onClick={ onDone }>
{ __( 'Done', 'woo-gutenberg-products-block' ) }
</Button>
</div>
</Placeholder>
);
}
render() {
const { attributes, isSelected, overlayColor, setAttributes } = this.props;
const {
contentAlign,
dimRatio,
editMode,
height,
linkText,
showDesc,
showPrice,
} = attributes;
const { loaded, product } = this.state;
const classes = classnames(
'wc-block-featured-product',
{
'is-selected': isSelected,
'is-loading': ! product && ! loaded,
'is-not-found': ! product && loaded,
'has-background-dim': dimRatio !== 0,
},
dimRatioToClass( dimRatio ),
contentAlign !== 'center' && `has-${ contentAlign }-content`
);
const mediaId = attributes.mediaId || getImageIdFromProduct( product );
const style = !! product ?
backgroundImageStyles( attributes.mediaSrc || product ) :
{};
if ( overlayColor.color ) {
style.backgroundColor = overlayColor.color;
}
const onResizeStop = ( event, direction, elt ) => {
setAttributes( { height: parseInt( elt.style.height ) } );
};
return (
<Fragment>
<BlockControls>
<AlignmentToolbar
value={ contentAlign }
onChange={ ( nextAlign ) => {
setAttributes( { contentAlign: nextAlign } );
} }
/>
<Toolbar
controls={ [
{
icon: 'edit',
title: __( 'Edit' ),
onClick: () => setAttributes( { editMode: ! editMode } ),
isActive: editMode,
},
] }
/>
<MediaUploadCheck>
<Toolbar>
<MediaUpload
onSelect={ ( media ) => {
setAttributes( { mediaId: media.id, mediaSrc: media.url } );
} }
allowedTypes={ [ 'image' ] }
value={ mediaId }
render={ ( { open } ) => (
<IconButton
className="components-toolbar__control"
label={ __( 'Edit media' ) }
icon="format-image"
onClick={ open }
/>
) }
/>
</Toolbar>
</MediaUploadCheck>
</BlockControls>
{ ! attributes.editMode && this.getInspectorControls() }
{ editMode ? (
this.renderEditMode()
) : (
<Fragment>
{ !! product ? (
<ResizableBox
className={ classes }
size={ { height } }
minHeight={ MIN_HEIGHT }
enable={ { bottom: true } }
onResizeStop={ onResizeStop }
style={ style }
>
<div className="wc-block-featured-product__wrapper">
<h2 className="wc-block-featured-product__title">
{ product.name }
</h2>
{ showDesc && (
<div
className="wc-block-featured-product__description"
dangerouslySetInnerHTML={ {
__html: product.short_description,
} }
/>
) }
{ showPrice && (
<div
className="wc-block-featured-product__price"
dangerouslySetInnerHTML={ { __html: product.price_html } }
/>
) }
<div className="wc-block-featured-product__link wp-block-button">
<RichText
value={ linkText }
onChange={ ( value ) => setAttributes( { linkText: value } ) }
formattingControls={ [ 'bold', 'italic', 'strikethrough' ] }
className="wp-block-button__link"
keepPlaceholderOnFocus
/>
</div>
</div>
</ResizableBox>
) : (
<Placeholder
className="wc-block-featured-product"
icon="star-filled"
label={ __( 'Featured Product', 'woo-gutenberg-products-block' ) }
>
{ ! loaded ? (
<Spinner />
) : (
__( 'No product is selected.', 'woo-gutenberg-products-block' )
) }
</Placeholder>
) }
</Fragment>
) }
</Fragment>
);
}
}
FeaturedProduct.propTypes = {
/**
* The attributes for this block.
*/
attributes: PropTypes.object.isRequired,
/**
* Whether this block is currently active.
*/
isSelected: PropTypes.bool.isRequired,
/**
* The register block name.
*/
name: PropTypes.string.isRequired,
/**
* A callback to update attributes.
*/
setAttributes: PropTypes.func.isRequired,
// from withColors
overlayColor: PropTypes.object,
setOverlayColor: PropTypes.func.isRequired,
// from withSpokenMessages
debouncedSpeak: PropTypes.func.isRequired,
};
export default compose( [
withColors( { overlayColor: 'background-color' } ),
withSpokenMessages,
] )( FeaturedProduct );