Documentation home pagelight logodark logo
  • Support
  • Dashboard
  • Dashboard
Next.js
useSignOut()
Documentation
Reference
Guides
  • Documentation
  • Documentation
  • Community
  • Blog
  • API Documentation
    • Overview
    Backend Services
    • Authentication
    • Storage
    GraphQL
    • AI
    Client Libraries
    • JavaScript
    • React
    • Next.js
      • NhostClient
      • <SignedIn />
      • <SignedOut />
      • createServerSideClient()
      • getNhostSession()
      • useAccessToken()
      • useAddSecurityKey()
      • useAuthenticated()
      • useAuthenticationStatus()
      • useChangeEmail()
      • useChangePassword()
      • useConfigMfa()
      • useDecodedAccessToken()
      • useFileUpload()
      • useFileUploadItem()
      • useHasuraClaim()
      • useHasuraClaims()
      • useMultipleFilesUpload()
      • useNhostClient()
      • useProviderLink()
      • useResetPassword()
      • useSendVerificationEmail()
      • useSignInAnonymous()
      • useSignInEmailPassword()
      • useSignInEmailPasswordless()
      • useSignInEmailSecurityKey()
      • useSignInPAT()
      • useSignInSmsPasswordless()
      • useSignOut()
      • useSignUpEmailPassword()
      • useSignUpEmailSecurityKeyEmail()
      • useElevateSecurityKeyEmail()
      • useUserAvatarUrl()
      • useUserData()
      • useUserDefaultRole()
      • useUserDisplayName()
      • useUserEmail()
      • useUserId()
      • useUserIsAnonymous()
      • useUserLocale()
      • useUserRoles()
    • Vue
    Next.js

    useSignOut()

    Use the hook useSignOut to sign out the user.

    import { useSignOut, useAuthenticated } from '@nhost/react'
    
    const Component = () => {
      const { signOut } = useSignOut()
      const isAuthenticated = useAuthenticated()
    
      if (isAuthenticated) {
        return <button onClick={() => signOut()}>Sign Out</button>
      }
    
      return <div>Not authenticated</div>
    }
    

    ​
    Parameters


    stateAll required boolean


    useSignInSmsPasswordless()useSignUpEmailPassword()
    twittergithublinkedin
    Powered by Mintlify
    On this page
    • Parameters