Centralizes all item related requests to the Checkout API.
This repository contains experimental code for VTEX Checkout and should not be used in production.
This code is "experimental" for various reasons:
- Some are not tested as rigorously as the main code.
- Some are tested but not maintained.
- It can suffer from significant changes (breaking changes) without further notice.
Use it at your own risk! �
Any kind of item manipulation should be made through this component. This ensures that each interaction with the Checkout API happens in succession, avoiding concurrency issues.
This repository is an adapter of @vtex/order-items to be used inside VTEX IO apps. For documentation on the API, please refer to the provided package docs.
Use the function useOrderItems to get access to the API methods. Your component must be contained in a OrderItemsProvider, which in turn must be contained in a OrderFormProvider.
import { OrderFormProvider, useOrderForm } from 'vtex.order-manager/OrderForm'
import { OrderItemsProvider, useOrderItems } from 'vtex.order-items/OrderItems'
const MainComponent: FunctionComponent = () => (
<OrderFormProvider>
<OrderItemsProvider>
<MyComponent />
</OrderItemsProvider>
</OrderFormProvider>
)
const MyComponent: FunctionComponent = () => {
const { orderForm: { items } } = useOrderForm()
const { updateQuantity, removeItem } = useOrderItems()
// ...
}Thanks goes to these wonderful people (emoji key):
This project follows the all-contributors specification. Contributions of any kind are welcome!
Upcoming documentation: