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

162 lines
2.8 KiB
JavaScript

/**
* External dependencies
*/
import { __ } from '@wordpress/i18n';
import { InnerBlocks } from '@wordpress/block-editor';
import { registerBlockType } from '@wordpress/blocks';
import { getSetting } from '@woocommerce/settings';
import { isFeaturePluginBuild } from '@woocommerce/block-settings';
import { Icon, starEmpty } from '@wordpress/icons';
/**
* Internal dependencies
*/
import './style.scss';
import { example } from './example';
import { Edit } from './edit';
/**
* Register and run the "Featured Product" block.
*/
registerBlockType( 'woocommerce/featured-product', {
apiVersion: 2,
title: __( 'Featured Product', 'woo-gutenberg-products-block' ),
icon: {
src: (
<Icon
icon={ starEmpty }
className="wc-block-editor-components-block-icon"
/>
),
},
category: 'woocommerce',
keywords: [ __( 'WooCommerce', 'woo-gutenberg-products-block' ) ],
description: __(
'Visually highlight a product or variation and encourage prompt action.',
'woo-gutenberg-products-block'
),
supports: {
align: [ 'wide', 'full' ],
html: false,
color: true,
...( isFeaturePluginBuild() && {
__experimentalBorder: {
color: true,
radius: true,
width: true,
__experimentalSkipSerialization: false,
},
} ),
},
example,
attributes: {
/**
* Alignment of content inside block.
*/
contentAlign: {
type: 'string',
default: 'center',
},
/**
* Percentage opacity of overlay.
*/
dimRatio: {
type: 'number',
default: 50,
},
/**
* Toggle for edit mode in the block preview.
*/
editMode: {
type: 'boolean',
default: true,
},
/**
* Focus point for the background image
*/
focalPoint: {
type: 'object',
},
/**
* A fixed height for the block.
*/
height: {
type: 'number',
default: getSetting( 'default_height', 500 ),
},
/**
* ID for a custom image, overriding the product's featured image.
*/
mediaId: {
type: 'number',
default: 0,
},
/**
* URL for a custom image, overriding the product's featured image.
*/
mediaSrc: {
type: 'string',
default: '',
},
/**
* Text for the product link.
*/
linkText: {
type: 'string',
default: __( 'Shop now', 'woo-gutenberg-products-block' ),
},
/**
* The product ID to display.
*/
productId: {
type: 'number',
},
/**
* Show the product description.
*/
showDesc: {
type: 'boolean',
default: true,
},
/**
* Show the product price.
*/
showPrice: {
type: 'boolean',
default: true,
},
/**
* Product preview.
*/
previewProduct: {
type: 'object',
default: null,
},
},
/**
* Renders and manages the block.
*
* @param {Object} props Props to pass to block.
*/
edit: Edit,
/**
* Block content is rendered in PHP, not via save function.
*/
save() {
return <InnerBlocks.Content />;
},
} );