PlentyONE Shop Docs

Appearance

web / useAddressForm

Function: useAddressForm() ​

useAddressForm(type): object

Defined in: apps/web/app/composables/useAddressForm/useAddressForm.ts:5

Parameters ​

type ​

AddressType

Returns ​

object

add ​

add: Ref<boolean, boolean> = false

addressToEdit ​

addressToEdit: Ref<Address, Address>

addressToSave ​

addressToSave: Ref<Address, Address>

defaultFormValues ​

defaultFormValues: Ref<Partial<Address>, Partial<Address>>

hasCompany ​

hasCompany: Ref<boolean, boolean> = false

isLoading ​

isLoading: Ref<boolean, boolean> = false

open ​

open: Ref<boolean, boolean> = false

refreshAddressDependencies() ​

refreshAddressDependencies: () => Promise<void>

Returns ​

Promise<void>

save() ​

save: () => Promise<boolean>

Returns ​

Promise<boolean>

setInitialState() ​

setInitialState: () => void

Returns ​

void

validationSchema ​

validationSchema: TypedSchema<{ apartment?: string; city?: string; companyName?: string; country?: string; firstName?: string; lastName?: string; primary?: boolean; state?: string; streetName?: string; vatNumber?: string; zipCode?: string; }, { apartment: string; city: string; companyName?: string; country: string; firstName?: string; lastName?: string; primary: boolean; state: string; streetName: string; vatNumber?: string; zipCode: string; }>