woocommerce/plugins/woocommerce-blocks/assets/js/base/components/cart-checkout/shipping-rates-control-package/package-rates.tsx

98 lines
2.8 KiB
TypeScript

/**
* External dependencies
*/
import { useState, useEffect } from '@wordpress/element';
import { RadioControl } from '@woocommerce/blocks-components';
import type { CartShippingPackageShippingRate } from '@woocommerce/types';
import { usePrevious } from '@woocommerce/base-hooks';
/**
* Internal dependencies
*/
import { renderPackageRateOption } from './render-package-rate-option';
import type { PackageRateRenderOption } from '../shipping-rates-control-package/types';
interface PackageRates {
onSelectRate: ( selectedRateId: string ) => void;
rates: CartShippingPackageShippingRate[];
renderOption?: PackageRateRenderOption | undefined;
className?: string;
noResultsMessage: JSX.Element;
selectedRate: CartShippingPackageShippingRate | undefined;
disabled?: boolean;
// Should the selected rate be highlighted.
highlightChecked?: boolean;
}
const PackageRates = ( {
className = '',
noResultsMessage,
onSelectRate,
rates,
renderOption = renderPackageRateOption,
selectedRate,
disabled = false,
highlightChecked = false,
}: PackageRates ): JSX.Element => {
const selectedRateId = selectedRate?.rate_id || '';
const previousSelectedRateId = usePrevious( selectedRateId );
// Store selected rate ID in local state so shipping rates changes are shown in the UI instantly.
const [ selectedOption, setSelectedOption ] = useState( () => {
if ( selectedRateId ) {
return selectedRateId;
}
// Default to first rate if no rate is selected.
if ( rates.length > 0 ) {
return rates[ 0 ].rate_id;
}
} );
// Update the selected option if cart state changes in the data store.
useEffect( () => {
if (
selectedRateId &&
selectedRateId !== previousSelectedRateId &&
selectedRateId !== selectedOption
) {
setSelectedOption( selectedRateId );
}
}, [ selectedRateId, selectedOption, previousSelectedRateId ] );
// Update the selected option if there is no rate selected on mount.
useEffect( () => {
// The useState callback run only once, so we need this to update it right fetching new rates.
if ( ! selectedOption && rates.length > 0 ) {
setSelectedOption( rates[ 0 ].rate_id );
onSelectRate( rates[ 0 ].rate_id );
}
}, [ onSelectRate, rates, selectedOption ] );
// Update the data store when the local selected rate changes.
useEffect( () => {
if ( selectedOption ) {
onSelectRate( selectedOption );
}
}, [ onSelectRate, selectedOption ] );
if ( rates.length === 0 ) {
return noResultsMessage;
}
return (
<RadioControl
className={ className }
onChange={ ( value: string ) => {
setSelectedOption( value );
onSelectRate( value );
} }
highlightChecked={ highlightChecked }
disabled={ disabled }
selected={ selectedOption }
options={ rates.map( renderOption ) }
/>
);
};
export default PackageRates;