Skip to content

OrderCancelForm container

The OrderCancelForm container provides a cancellation form that allows users to select reasons for canceling an order and perform the cancellation operation.

OrderCancelForm container

OrderCancelForm container

Configurations

The `OrderCancelForm container provides the following configuration options:

OptionsTypeReq?Description
orderRefstringYesID of the order to be canceled.
pickerPropsPickerPropsNoConfiguration for the picker used to display and select the reason for order cancellation.
submitButtonPropsButtonPropsNoConfiguration for the button used to submit the order cancellation.
cancelReasonsPickerOption[]YesAn array of reasons available for order cancellation.

Example

The OrderCancelForm container is not directly integrated within the boilerplate, but it is delivered as part of the OrderStatus container. However, the OrderCancelForm container can also be used independently to create custom implementations.

Here’s an integration example from the drop-in component development environment:

provider.render(OrderCancelForm, {
orderRef: "",
pickerProps: {} <PickerProps>,
submitButtonProps: {} <ButtonProps>,
cancelReasons: [] <PickerOption[]>,
})(containerWrapper);