PlentyONE Shop Docs

Appearance

web / useCheckout

Function: useCheckout() ​

useCheckout(cacheKey): object

Defined in: apps/web/app/composables/useCheckout/useCheckout.ts:15

Parameters ​

cacheKey ​

string = ''

Returns ​

anyAddressFormIsOpen ​

anyAddressFormIsOpen: ComputedRef<boolean>

backToFormEditing() ​

backToFormEditing: () => boolean

Returns ​

boolean

billingSkeleton ​

billingSkeleton: Ref<boolean, boolean> = true

cart ​

cart: Ref<Cart, Cart>

cartIsEmpty ​

cartIsEmpty: ComputedRef<boolean>

cartLoading ​

cartLoading: Ref<boolean, boolean>

clearCartItems() ​

clearCartItems: () => void

Returns ​

void

Description ​

Function for clearing cart items from state.

Example ​

ts
clearCartItems()

combineShippingAndBilling ​

combineShippingAndBilling: Ref<boolean, boolean> = true

getCart() ​

getCart: () => Promise<void>

Returns ​

Promise<void>

Deprecated ​

Use useFetchSession.fetchSession() instead

hasBillingAddress ​

hasBillingAddress: ComputedRef<boolean>

hasShippingAddress ​

hasShippingAddress: ComputedRef<boolean>

init ​

init: Ref<boolean, boolean> = false

persistBillingAddress() ​

persistBillingAddress: () => Promise<void>

Returns ​

Promise<void>

persistShippingAddress() ​

persistShippingAddress: () => Promise<void>

Returns ​

Promise<void>

scrollToBillingAddress() ​

scrollToBillingAddress: () => void

Returns ​

void

scrollToShippingAddress() ​

scrollToShippingAddress: () => void

Returns ​

void

setBillingSkeleton() ​

setBillingSkeleton: (loading) => void

Parameters ​

loading ​

boolean

Returns ​

void

setShippingSkeleton() ​

setShippingSkeleton: (loading) => void

Parameters ​

loading ​

boolean

Returns ​

void

shippingSkeleton ​

shippingSkeleton: Ref<boolean, boolean> = true

showBillingAddressSection ​

showBillingAddressSection: Ref<boolean, boolean> = false

validateTerms() ​

validateTerms: () => boolean

Returns ​

boolean