Documentation home pagelight logodark logo
  • Support
  • Dashboard
  • Dashboard
useChangeEmail()
Welcome
Getting Started
Products
Platform
Reference
Blog
  • Overview
Backend Services
  • Authentication
  • Storage
  • AI
Client Libraries
  • Javascript
  • React
  • Next.js
  • Vue
    • NhostClient
    • useAccessToken()
    • useAuthenticated()
    • useAuthenticationStatus()
    • useChangeEmail()
    • useChangePassword()
    • useDecodedAccessToken()
    • useFileUpload()
    • useFileUploadItem()
    • useHasuraClaim()
    • useHasuraClaims()
    • useMultipleFilesUpload()
    • useNhostClient()
    • useProviderLink()
    • useResetPassword()
    • useSendVerificationEmail()
    • useSignInAnonymous()
    • useSignInEmailPassword()
    • useSignInEmailPasswordless()
    • useSignInPAT()
    • useSignInSmsPasswordless()
    • useSignOut()
    • useSignUpEmailPassword()
    • useUserAvatarUrl()
    • useUserData()
    • useUserDefaultRole()
    • useUserDisplayName()
    • useUserEmail()
    • useUserId()
    • useUserIsAnonymous()
    • useUserLocale()
    • useUserRoles()
    • useAddSecurityKey()
    • useElevateSecurityKeyEmail()
    • useSignInEmailSecurityKey()
    • useSignUpEmailSecurityKey()
    • useSignInEmailOTP()
    • useSignInIdToken()
    • useLinkIdToken()
    • useSignInSecurityKey()
  • React Native
CLI
  • Commands

useChangeEmail()

Use the composable useChangeEmail to change email for the user.

const { changeEmail, isLoading, needsEmailVerification, isError, error } =
  useChangeEmail()

watchEffect(() => {
  console.log(
    isLoading.value,
    needsEmailVerification.value,
    isError.value,
    error.value
  )
})

const handleFormSubmit = async (e) => {
  e.preventDefault()

  await changeEmail('new@example.com')
}

​
Parameters


options optional NestedRefOfValue<undefined | ChangeEmailOptions>


Was this page helpful?

Suggest editsRaise issue
useAuthenticationStatus()useChangePassword()
twittergithublinkedin
Powered by Mintlify
On this page
  • Parameters