> ## Documentation Index
> Fetch the complete documentation index at: https://docs.shipmobilefast.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Overview
> Ship Mobile Fast comes with pre-built authentication flows using Expo's SecureStore and your choice of authentication providers.
## Features
Users can sign in with their email and password.
We have Google and Apple OAuth support.
Sending a magic link to the user's email address
If your users forget their password, they can reset it.
Users can verify their email address in the app.
## How to use?
Currently implemented and fully supported.
```js {1} theme={null}
import { useAuth } from '@/context/SupabaseProvider';
const {
user,
session,
initialized,
signOut,
signIn,
signUp,
sendMagicLink,
signInWithGoogle,
signInWithApple,
createSessionFromUrl,
handleShowPassword,
isLoading,
error,
isAuthenticated,
showPassword,
handleError,
sendNewPasswordLink,
setNewPassword,
} = useAuth();
```
## Auth Functions
To sign in with email/password, use the `signIn` function.
```js theme={null}
signIn('email@example.com', 'password');
```
To sign up with email/password, use the `signUp` function.
```js theme={null}
signUp('email@example.com', 'password');
```
To sign in with Google, use the `signInWithGoogle` function.
```js theme={null}
signInWithGoogle();
```
To sign in with Apple, use the `signInWithApple` function.
```js theme={null}
signInWithApple();
```
To create a session from a URL, use the `createSessionFromUrl` function.
Magic happens here. Don't change this.
To handle show password on the password input, use the `handleShowPassword` function.
```js theme={null}
handleShowPassword();
```
To handle errors, use the `handleError` function.
```js theme={null}
handleError(error);
```
To send a new password link, use the `sendNewPasswordLink` function.
```js theme={null}
sendNewPasswordLink('email@example.com');
```
To set a new password, use the `setNewPassword` function.
```js theme={null}
setNewPassword('newPassword');
```
To sign out, use the `signOut` function.
```js theme={null}
signOut();
```
To send a magic link, use the `sendMagicLink` function.
```js theme={null}
sendMagicLink('email@example.com');
```
### Props
| Value | Type | Description | |
| ---------------------- | ---------------------------------------------------- | ----------------------------------------------- | --------------------------- |
| `user` | `UserMetaData \| null` | Contains current authenticated user information | |
| `session` | `Session \| null` | Contains active session information | |
| `initialized` | `boolean` | Indicates if auth state has been initialized | |
| `signOut` | `() => Promise` | Signs out the current user | |
| `signIn` | `(email: string, password: string) => Promise` | Signs in user with email/password | |
| `signUp` | `(email: string, password: string) => Promise` | Creates a new user account | |
| `sendMagicLink` | `(email: string) => Promise` | Sends a magic link to user's email | |
| `signInWithGoogle` | `() => Promise` | Initiates Google OAuth sign in | |
| `signInWithApple` | `() => Promise` | Initiates Apple OAuth sign in | |
| `createSessionFromUrl` | `(url: string) => Promise` | Creates session from URL | |
| `handleShowPassword` | `() => void` | Toggles password visibility | |
| `isLoading` | `boolean` | Indicates if auth operation is in progress | |
| `error` | `Error \| null` | Contains error information if any | |
| `isAuthenticated` | `boolean` | Indicates if user is authenticated | |
| `showPassword` | `boolean` | Controls password visibility state | |
| `handleError` | \`(error: AuthError | Error) => void\` | Handles auth-related errors |
| `sendNewPasswordLink` | `(email: string) => Promise` | Sends password reset link | |
| `setNewPassword` | `(password: string) => Promise` | Sets new password | |
Coming soon.