PlentyONE Shop Docs

Appearance

web / useCustomer

Function: useCustomer() ​

useCustomer(): object

Defined in: apps/web/composables/useCustomer/useCustomer.ts:25

Returns ​

object

backToContactInformation() ​

backToContactInformation: () => boolean

Function to scroll back to contact information section in checkout and highlight it

Returns ​

boolean

always false to prevent default form submission

changePassword() ​

changePassword: (params) => Promise<boolean>

Function for changing the user password

Parameters ​

params ​

UserChangePasswordParams

Returns ​

Promise<boolean>

Example ​

ts
changePassword({
  oldPassword: 'oldPassword',
  password: 'newPassword',
  password2: 'newPassword',
});

emailValidationSchema ​

emailValidationSchema: TypedSchema<PartialObjectDeep<{ customerEmail: string; }, {}>, { customerEmail: string; }>

getSession() ​

getSession: () => Promise<void>

Gets the current user/cart session data.

Returns ​

Promise<void>

Deprecated ​

This method will be removed in future versions. Use useFetchSession().fetchSession() instead.

Example ​

ts
getSession();

isAuthorized ​

isAuthorized: Ref<boolean, boolean> = false

isGuest ​

isGuest: Ref<boolean, boolean> = false

loading ​

loading: Ref<boolean, boolean> = false

login() ​

login: (email, password) => Promise<boolean>

Function for user login.

Parameters ​

email ​

string

password ​

string

Returns ​

Promise<boolean>

Example ​

ts
login('user@example.com', 'password');

loginAsGuest() ​

loginAsGuest: (email) => Promise<void>

Function for login a user as guest

Parameters ​

email ​

string

Returns ​

Promise<void>

Example ​

ts
loginAsGuest('user@example.com');

logout() ​

logout: () => Promise<void>

Function for user logout.

Returns ​

Promise<void>

Example ​

ts
logout();

missingGuestCheckoutEmail ​

missingGuestCheckoutEmail: ComputedRef<boolean>

register() ​

register: (params) => Promise<null | UserChangeResponse>

Function for registering a user.

Parameters ​

params ​

RegisterParams

Returns ​

Promise<null | UserChangeResponse>

Example ​

ts
register({ email: 'example', password: 'example', 'cf-turnstile-response': '' });

setUser() ​

setUser: (user) => void

Function for setting user data

Parameters ​

user ​

null | User

Returns ​

void

Example ​

ts
setUser(user);

user ​

user: Ref<null | User, null | User>

validGuestEmail ​

validGuestEmail: Ref<boolean, boolean> = false

Description ​

Composable managing Customer data

Example ​

ts
const {
data, loading, isAuthorized, isGuest, privacyPolicy, setUser, getSession, login, logout, register, loginAsGuest,
setPrivacyPolicy, changePassword } = useCustomer();