Split Full Cart sidebar totals into several components (https://github.com/woocommerce/woocommerce-blocks/pull/1885)

This commit is contained in:
Albert Juhé Lluveras 2020-03-06 13:27:54 +01:00 committed by GitHub
parent 1942491822
commit 427a229591
10 changed files with 396 additions and 175 deletions

View File

@ -1,2 +1,8 @@
export { default as SubtotalsItem } from './subtotals-item';
export { default as TotalsCouponCodeInput } from './totals-coupon-code-input';
export { default as TotalsDiscountItem } from './totals-discount-item';
export { default as TotalsFeesItem } from './totals-fees-item';
export { default as TotalsFooterItem } from './totals-footer-item';
export { default as TotalsItem } from './totals-item';
export { default as TotalsShippingItem } from './totals-shipping-item';
export { default as TotalsTaxesItem } from './totals-taxes-item';

View File

@ -0,0 +1,39 @@
/**
* External dependencies
*/
import { __ } from '@wordpress/i18n';
import { DISPLAY_CART_PRICES_INCLUDING_TAX } from '@woocommerce/block-settings';
import PropTypes from 'prop-types';
/**
* Internal dependencies
*/
import TotalsItem from '../totals-item';
const SubtotalsItem = ( { currency, values } ) => {
const { total_items: totalItems, total_items_tax: totalItemsTax } = values;
const itemsValue = parseInt( totalItems, 10 );
const itemsTaxValue = parseInt( totalItemsTax, 10 );
return (
<TotalsItem
currency={ currency }
label={ __( 'Subtotal', 'woo-gutenberg-products-block' ) }
value={
DISPLAY_CART_PRICES_INCLUDING_TAX
? itemsValue + itemsTaxValue
: itemsValue
}
/>
);
};
SubtotalsItem.propTypes = {
currency: PropTypes.object.isRequired,
values: PropTypes.shape( {
total_items: PropTypes.string,
total_items_tax: PropTypes.string,
} ).isRequired,
};
export default SubtotalsItem;

View File

@ -0,0 +1,97 @@
/**
* External dependencies
*/
import { __, sprintf } from '@wordpress/i18n';
import { DISPLAY_CART_PRICES_INCLUDING_TAX } from '@woocommerce/block-settings';
import LoadingMask from '@woocommerce/base-components/loading-mask';
import Chip from '@woocommerce/base-components/chip';
import PropTypes from 'prop-types';
/**
* Internal dependencies
*/
import TotalsItem from '../totals-item';
const TotalsDiscountItem = ( {
cartCoupons = [],
currency,
isRemovingCoupon,
removeCoupon,
values,
} ) => {
const {
total_discount: totalDiscount,
total_discount_tax: totalDiscountTax,
} = values;
const discountValue = parseInt( totalDiscount, 10 );
if ( ! discountValue && cartCoupons.length === 0 ) {
return null;
}
const discountTaxValue = parseInt( totalDiscountTax, 10 );
return (
<TotalsItem
currency={ currency }
description={
cartCoupons.length !== 0 && (
<LoadingMask
screenReaderLabel={ __(
'Removing coupon…',
'woo-gutenberg-products-block'
) }
isLoading={ isRemovingCoupon }
showSpinner={ false }
>
<ul className="wc-block-cart-coupon-list">
{ cartCoupons.map( ( cartCoupon ) => (
<Chip
key={ 'coupon-' + cartCoupon.code }
className="wc-block-cart-coupon-list__item"
text={ cartCoupon.code }
screenReaderText={ sprintf(
/* Translators: %s Coupon code. */
__(
'Coupon: %s',
'woo-gutenberg-products-block'
),
cartCoupon.code
) }
disabled={ isRemovingCoupon }
onRemove={ () => {
removeCoupon( cartCoupon.code );
} }
radius="large"
/>
) ) }
</ul>
</LoadingMask>
)
}
label={ __( 'Discount', 'woo-gutenberg-products-block' ) }
value={
( DISPLAY_CART_PRICES_INCLUDING_TAX
? discountValue + discountTaxValue
: discountValue ) * -1
}
/>
);
};
TotalsDiscountItem.propTypes = {
cartCoupons: PropTypes.arrayOf(
PropTypes.shape( {
code: PropTypes.string.isRequired,
} )
),
currency: PropTypes.object.isRequired,
isRemovingCoupon: PropTypes.bool.isRequired,
removeCoupon: PropTypes.func.isRequired,
values: PropTypes.shape( {
total_discount: PropTypes.string,
total_discount_tax: PropTypes.string,
} ).isRequired,
};
export default TotalsDiscountItem;

View File

@ -0,0 +1,50 @@
/**
* External dependencies
*/
import { __ } from '@wordpress/i18n';
import {
DISPLAY_CART_PRICES_INCLUDING_TAX,
SHIPPING_ENABLED,
} from '@woocommerce/block-settings';
import PropTypes from 'prop-types';
/**
* Internal dependencies
*/
import TotalsItem from '../totals-item';
const TotalsFeesItem = ( { currency, values } ) => {
if ( ! SHIPPING_ENABLED ) {
return null;
}
const { total_fees: totalFees, total_fees_tax: totalFeesTax } = values;
const feesValue = parseInt( totalFees, 10 );
if ( ! feesValue ) {
return null;
}
const feesTaxValue = parseInt( totalFeesTax, 10 );
return (
<TotalsItem
currency={ currency }
label={ __( 'Fees', 'woo-gutenberg-products-block' ) }
value={
DISPLAY_CART_PRICES_INCLUDING_TAX
? feesValue + feesTaxValue
: feesValue
}
/>
);
};
TotalsFeesItem.propTypes = {
currency: PropTypes.object.isRequired,
values: PropTypes.shape( {
total_fees: PropTypes.string,
total_fees_tax: PropTypes.string,
} ).isRequired,
};
export default TotalsFeesItem;

View File

@ -0,0 +1,59 @@
/**
* External dependencies
*/
import { __ } from '@wordpress/i18n';
import { DISPLAY_CART_PRICES_INCLUDING_TAX } from '@woocommerce/block-settings';
import { __experimentalCreateInterpolateElement } from 'wordpress-element';
import FormattedMonetaryAmount from '@woocommerce/base-components/formatted-monetary-amount';
import PropTypes from 'prop-types';
/**
* Internal dependencies
*/
import TotalsItem from '../totals-item';
import './style.scss';
const TotalsFooterItem = ( { currency, values } ) => {
const { total_price: totalPrice, total_tax: totalTax } = values;
return (
<TotalsItem
className="wc-block-totals-footer-item"
currency={ currency }
label={ __( 'Total', 'woo-gutenberg-products-block' ) }
value={ parseInt( totalPrice, 10 ) }
description={
DISPLAY_CART_PRICES_INCLUDING_TAX && (
<p className="wc-block-totals-footer-item-tax">
{ __experimentalCreateInterpolateElement(
__(
'Including <TaxAmount/> in taxes',
'woo-gutenberg-products-block'
),
{
TaxAmount: (
<FormattedMonetaryAmount
className="wc-block-totals-footer-item-tax-value"
currency={ currency }
displayType="text"
value={ parseInt( totalTax, 10 ) }
/>
),
}
) }
</p>
)
}
/>
);
};
TotalsFooterItem.propTypes = {
currency: PropTypes.object.isRequired,
values: PropTypes.shape( {
total_price: PropTypes.string,
total_tax: PropTypes.string,
} ).isRequired,
};
export default TotalsFooterItem;

View File

@ -0,0 +1,15 @@
.wc-block-totals-footer-item {
.wc-block-totals-table-item__value,
.wc-block-totals-table-item__label {
color: #000;
font-size: 1.25em;
}
.wc-block-totals-table-item__label {
font-weight: normal;
}
.wc-block-totals-footer-item-tax {
margin-bottom: 0;
}
}

View File

@ -0,0 +1,66 @@
/**
* External dependencies
*/
import { __ } from '@wordpress/i18n';
import {
DISPLAY_CART_PRICES_INCLUDING_TAX,
SHIPPING_ENABLED,
} from '@woocommerce/block-settings';
import ShippingCalculator from '@woocommerce/base-components/shipping-calculator';
import ShippingLocation from '@woocommerce/base-components/shipping-location';
import PropTypes from 'prop-types';
/**
* Internal dependencies
*/
import TotalsItem from '../totals-item';
const TotalsShippingItem = ( {
currency,
shippingAddress,
updateShippingAddress,
values,
} ) => {
if ( ! SHIPPING_ENABLED ) {
return null;
}
const {
total_shipping: totalShipping,
total_shipping_tax: totalShippingTax,
} = values;
const shippingValue = parseInt( totalShipping, 10 );
const shippingTaxValue = parseInt( totalShippingTax, 10 );
return (
<TotalsItem
currency={ currency }
description={
<>
<ShippingLocation address={ shippingAddress } />
<ShippingCalculator
address={ shippingAddress }
setAddress={ updateShippingAddress }
/>
</>
}
label={ __( 'Shipping', 'woo-gutenberg-products-block' ) }
value={
DISPLAY_CART_PRICES_INCLUDING_TAX
? shippingValue + shippingTaxValue
: shippingValue
}
/>
);
};
TotalsShippingItem.propTypes = {
currency: PropTypes.object.isRequired,
shippingAddress: PropTypes.object,
updateShippingAddress: PropTypes.func,
values: PropTypes.shape( {
total_shipping: PropTypes.string,
total_shipping_tax: PropTypes.string,
} ).isRequired,
};
export default TotalsShippingItem;

View File

@ -0,0 +1,31 @@
/**
* External dependencies
*/
import { __ } from '@wordpress/i18n';
import PropTypes from 'prop-types';
/**
* Internal dependencies
*/
import TotalsItem from '../totals-item';
const TotalsTaxesItem = ( { currency, values } ) => {
const { total_tax: totalTax } = values;
return (
<TotalsItem
currency={ currency }
label={ __( 'Taxes', 'woo-gutenberg-products-block' ) }
value={ parseInt( totalTax, 10 ) }
/>
);
};
TotalsTaxesItem.propTypes = {
currency: PropTypes.object.isRequired,
values: PropTypes.shape( {
total_tax: PropTypes.string,
} ).isRequired,
};
export default TotalsTaxesItem;

View File

@ -3,17 +3,18 @@
* External dependencies
*/
import PropTypes from 'prop-types';
import { sprintf, __ } from '@wordpress/i18n';
import { __ } from '@wordpress/i18n';
import { useState, useEffect } from '@wordpress/element';
import {
SubtotalsItem,
TotalsFeesItem,
TotalsCouponCodeInput,
TotalsItem,
TotalsDiscountItem,
TotalsFooterItem,
TotalsShippingItem,
TotalsTaxesItem,
} from '@woocommerce/base-components/totals';
import ShippingRatesControl from '@woocommerce/base-components/shipping-rates-control';
import ShippingCalculator from '@woocommerce/base-components/shipping-calculator';
import ShippingLocation from '@woocommerce/base-components/shipping-location';
import LoadingMask from '@woocommerce/base-components/loading-mask';
import Chip from '@woocommerce/base-components/chip';
import {
COUPONS_ENABLED,
SHIPPING_ENABLED,
@ -25,7 +26,6 @@ import FormattedMonetaryAmount from '@woocommerce/base-components/formatted-mone
import { decodeEntities } from '@wordpress/html-entities';
import { useStoreCartCoupons, useShippingRates } from '@woocommerce/base-hooks';
import classnames from 'classnames';
import { __experimentalCreateInterpolateElement } from 'wordpress-element';
/**
* Internal dependencies
@ -131,109 +131,7 @@ const Cart = ( {
return setShowShippingCosts( false );
}, [ isShippingCalculatorEnabled, isShippingCostHidden, shippingAddress ] );
/**
* Given an API response with cart totals, generates an array of rows to display in the Cart block.
*
* @return {Object[]} Values to display in the cart block.
*/
const getTotalRowsConfig = () => {
const totalItems = parseInt( cartTotals.total_items, 10 );
const totalItemsTax = parseInt( cartTotals.total_items_tax, 10 );
const totalRowsConfig = [
{
label: __( 'Subtotal', 'woo-gutenberg-products-block' ),
value: DISPLAY_CART_PRICES_INCLUDING_TAX
? totalItems + totalItemsTax
: totalItems,
},
];
const totalFees = parseInt( cartTotals.total_fees, 10 );
if ( totalFees > 0 ) {
const totalFeesTax = parseInt( cartTotals.total_fees_tax, 10 );
totalRowsConfig.push( {
label: __( 'Fees', 'woo-gutenberg-products-block' ),
value: DISPLAY_CART_PRICES_INCLUDING_TAX
? totalFees + totalFeesTax
: totalFees,
} );
}
const totalDiscount = parseInt( cartTotals.total_discount, 10 );
if ( totalDiscount > 0 || cartCoupons.length !== 0 ) {
const totalDiscountTax = parseInt(
cartTotals.total_discount_tax,
10
);
// @todo The remove coupon button is a placeholder - replace with new
// chip component.
totalRowsConfig.push( {
label: __( 'Discount', 'woo-gutenberg-products-block' ),
value:
( DISPLAY_CART_PRICES_INCLUDING_TAX
? totalDiscount + totalDiscountTax
: totalDiscount ) * -1,
description: cartCoupons.length !== 0 && (
<LoadingMask
screenReaderLabel={ __(
'Removing coupon…',
'woo-gutenberg-products-block'
) }
isLoading={ isRemovingCoupon }
showSpinner={ false }
>
<ul className="wc-block-cart-coupon-list">
{ cartCoupons.map( ( cartCoupon ) => (
<Chip
key={ 'coupon-' + cartCoupon.code }
className="wc-block-cart-coupon-list__item"
text={ cartCoupon.code }
screenReaderText={ sprintf(
/* Translators: %s Coupon code. */
__(
'Coupon: %s',
'woo-gutenberg-products-block'
),
cartCoupon.code
) }
disabled={ isRemovingCoupon }
onRemove={ () => {
removeCoupon( cartCoupon.code );
} }
radius="large"
/>
) ) }
</ul>
</LoadingMask>
),
} );
}
if ( SHIPPING_ENABLED && isShippingCalculatorEnabled ) {
const totalShipping = parseInt( cartTotals.total_shipping, 10 );
const totalShippingTax = parseInt(
cartTotals.total_shipping_tax,
10
);
totalRowsConfig.push( {
label: __( 'Shipping', 'woo-gutenberg-products-block' ),
value: DISPLAY_CART_PRICES_INCLUDING_TAX
? totalShipping + totalShippingTax
: totalShipping,
description: (
<>
<ShippingLocation address={ shippingAddress } />
<ShippingCalculator
address={ shippingAddress }
setAddress={ updateShippingAddress }
/>
</>
),
} );
}
return totalRowsConfig;
};
const totalsCurrency = getCurrencyFromPriceResponse( cartTotals );
const totalRowsConfig = getTotalRowsConfig();
const cartClassName = classnames( 'wc-block-cart', {
'wc-block-cart--is-loading': isLoading,
@ -257,16 +155,28 @@ const Cart = ( {
'woo-gutenberg-products-block'
) }
</h2>
{ totalRowsConfig.map(
( { label, value, description } ) => (
<TotalsItem
key={ label }
currency={ totalsCurrency }
label={ label }
value={ value }
description={ description }
/>
)
<SubtotalsItem
currency={ totalsCurrency }
values={ cartTotals }
/>
<TotalsFeesItem
currency={ totalsCurrency }
values={ cartTotals }
/>
<TotalsDiscountItem
cartCoupons={ cartCoupons }
currency={ totalsCurrency }
isRemovingCoupon={ isRemovingCoupon }
removeCoupon={ removeCoupon }
values={ cartTotals }
/>
{ isShippingCalculatorEnabled && (
<TotalsShippingItem
currency={ totalsCurrency }
shippingAddress={ shippingAddress }
updateShippingAddress={ updateShippingAddress }
values={ cartTotals }
/>
) }
{ showShippingCosts && (
<fieldset className="wc-block-cart__shipping-options-fieldset">
@ -286,14 +196,9 @@ const Cart = ( {
</fieldset>
) }
{ ! DISPLAY_CART_PRICES_INCLUDING_TAX && (
<TotalsItem
className="wc-block-cart__total-tax"
<TotalsTaxesItem
currency={ totalsCurrency }
label={ __(
'Taxes',
'woo-gutenberg-products-block'
) }
value={ parseInt( cartTotals.total_tax, 10 ) }
values={ cartTotals }
/>
) }
{ COUPONS_ENABLED && (
@ -302,41 +207,9 @@ const Cart = ( {
isLoading={ isApplyingCoupon }
/>
) }
<TotalsItem
className="wc-block-cart__totals-footer"
<TotalsFooterItem
currency={ totalsCurrency }
label={ __(
'Total',
'woo-gutenberg-products-block'
) }
value={ parseInt( cartTotals.total_price, 10 ) }
description={
DISPLAY_CART_PRICES_INCLUDING_TAX && (
<p className="wc-block-cart__totals-footer-tax">
{ __experimentalCreateInterpolateElement(
__(
'Including <TaxAmount/> in taxes',
'woo-gutenberg-products-block'
),
{
TaxAmount: (
<FormattedMonetaryAmount
className="wc-block-cart__totals-footer-tax-value"
currency={
totalsCurrency
}
displayType="text"
value={ parseInt(
cartTotals.total_tax,
10
) }
/>
),
}
) }
</p>
)
}
values={ cartTotals }
/>
<CheckoutButton />
</CardBody>

View File

@ -45,21 +45,6 @@
opacity: 0.8;
}
}
.wc-block-cart__totals-footer {
.wc-block-totals-table-item__value,
.wc-block-totals-table-item__label {
color: #000;
font-size: 1.25em;
}
.wc-block-totals-table-item__label {
font-weight: normal;
}
.wc-block-cart__totals-footer-tax {
margin-bottom: 0;
}
}
// Added extra class and label for specificity.
fieldset.wc-block-cart__shipping-options-fieldset {
background-color: transparent;