78 lines
2.3 KiB
TypeScript
78 lines
2.3 KiB
TypeScript
/**
|
|
* External dependencies
|
|
*/
|
|
import { applyFilters } from '@wordpress/hooks';
|
|
import { useEffect } from '@wordpress/element';
|
|
import { triggerExitPageCesSurvey } from '@woocommerce/customer-effort-score';
|
|
import {
|
|
LayoutContextProvider,
|
|
getLayoutContextValue,
|
|
} from '@woocommerce/admin-layout';
|
|
import QueryString, { parse } from 'qs';
|
|
|
|
/**
|
|
* Internal dependencies
|
|
*/
|
|
import { PaymentRecommendations } from '../payments';
|
|
import { ShippingRecommendations } from '../shipping';
|
|
import { EmbeddedBodyProps } from './embedded-body-props';
|
|
import { StoreAddressTour } from '../guided-tours/store-address-tour';
|
|
import './style.scss';
|
|
|
|
type QueryParams = EmbeddedBodyProps;
|
|
|
|
function isWPPage(
|
|
params: QueryParams | QueryString.ParsedQs
|
|
): params is QueryParams {
|
|
return ( params as QueryParams ).page !== undefined;
|
|
}
|
|
|
|
const EMBEDDED_BODY_COMPONENT_LIST: React.ElementType[] = [
|
|
PaymentRecommendations,
|
|
ShippingRecommendations,
|
|
StoreAddressTour,
|
|
];
|
|
|
|
/**
|
|
* This component is appended to the bottom of the WooCommerce non-react pages (like settings).
|
|
* You can add a component by writing a Fill component from slot-fill with the `embedded-body-layout` name.
|
|
*
|
|
* Each Fill component receives QueryParams, consisting of a page, tab, and section string.
|
|
*/
|
|
export const EmbeddedBodyLayout = () => {
|
|
useEffect( () => {
|
|
triggerExitPageCesSurvey();
|
|
}, [] );
|
|
|
|
const query = parse( location.search.substring( 1 ) );
|
|
let queryParams: QueryParams = { page: '', tab: '' };
|
|
if ( isWPPage( query ) ) {
|
|
queryParams = query;
|
|
}
|
|
/**
|
|
* Filter an array of body components for WooCommerce non-react pages.
|
|
*
|
|
* @filter woocommerce_admin_embedded_layout_components
|
|
* @param {Array.<Node>} embeddedBodyComponentList Array of body components.
|
|
* @param {Object} query url query parameters.
|
|
*/
|
|
const componentList = applyFilters(
|
|
'woocommerce_admin_embedded_layout_components',
|
|
EMBEDDED_BODY_COMPONENT_LIST,
|
|
queryParams
|
|
) as React.ElementType< EmbeddedBodyProps >[];
|
|
|
|
return (
|
|
<LayoutContextProvider value={ getLayoutContextValue( [ 'page' ] ) }>
|
|
<div
|
|
className="woocommerce-embedded-layout__primary"
|
|
id="woocommerce-embedded-layout__primary"
|
|
>
|
|
{ componentList.map( ( Comp, index ) => {
|
|
return <Comp key={ index } { ...queryParams } />;
|
|
} ) }
|
|
</div>
|
|
</LayoutContextProvider>
|
|
);
|
|
};
|