@commercelayer/react-components
Version:
The Official Commerce Layer React Components
32 lines (31 loc) • 1.19 kB
TypeScript
import { type ReactNode, type JSX } from 'react';
import type { CustomFieldMessageError } from '../../reducers/AddressReducer';
interface Props extends Omit<JSX.IntrinsicElements['form'], 'onSubmit'> {
children: ReactNode;
reset?: boolean;
errorClassName?: string;
fieldEvent?: 'blur' | 'change';
/**
* Callback to customize the error message for a specific field. Called for each error in the form.
*/
customFieldMessageError?: CustomFieldMessageError;
}
/**
* Form container for creating or editing an order related shipping address.
*
* It accept:
* - a `reset` prop to define if current form needs to be reset over a defined boolean condition.
* - a `errorClassName` prop to define children input and select classnames assigned in case of validation error.
*
* <span title='Requirements' type='warning'>
* Must be a child of the `<AddressesContainer>` component.
* </span>
* <span title='Children' type='info'>
* `<AddressInput>`,
* `<AddressCountrySelector>`,
* `<AddressStateSelector>`,
* `<SaveAddressesButton>`
* </span>
*/
export declare function ShippingAddressForm(props: Props): JSX.Element;
export default ShippingAddressForm;