useAuth Hook

The useAuth hook provides access to authentication state and actions from any component within the AuthProvider.

Basic Usage#

TSX

Return Values#

user#

The current user object, or null if not authenticated.

TSX

isAuthenticated#

Boolean indicating if user is authenticated (non-guest).

TSX

isGuest#

Boolean indicating if current session is a guest.

TSX

isLoading#

Boolean indicating if auth state is being fetched.

TSX

error#

Error object if authentication failed.

TSX

Function to trigger login redirect or modal.

TSX

logout#

Function to log out the user.

TSX

mutate#

SWR mutate function to manually revalidate auth state.

TSX

loginWithCredentials#

Function to log in with email/password.

TSX

Examples#

TSX

Protected Component#

TSX

Role-Based Access#

TSX

Guest Upgrade Prompt#

TSX

Logout with Confirmation#

TSX

TypeScript#

Custom User Type#

TSX

Full Return Type#

TypeScript

Requirements#

The useAuth hook must be used within an AuthProvider:

TSX