@commercelayer/react-components
Version:
The Official Commerce Layer React Components
39 lines (38 loc) • 1.1 kB
TypeScript
import { type JSX } from 'react';
import type { DefaultChildrenType } from '../../typings/globals';
import type { QueryPageSize } from '@commercelayer/sdk';
interface Props {
children: DefaultChildrenType;
/**
* Customer type
*/
isGuest?: boolean;
/**
* The page size
* default: 10
*/
addressesPageSize?: QueryPageSize;
}
/**
* Main container for the Customers components.
* It stores - in its context - the details of an active customer, if present.
*
* It also accept a `isGuest` prop to define if no customer is currently set as active.
*
* <span title='Requirements' type='warning'>
* Must be a child of the `<CommerceLayer>` component.
* </span>
* <span title='Children' type='info'>
* `<CustomerField>`,
* `<CustomerInput>`,
* `<SaveCustomerButton>`,
* `<AddressesContainer>`,
* `<AddressesEmpty>`,
* `<CustomerPaymentSource>`,
* `<CustomerPaymentSourceEmpty>`,
* `<PaymentMethodsContainer>`,
* `<OrdersList>`
* </span>
*/
export declare function CustomerContainer(props: Props): JSX.Element;
export default CustomerContainer;