Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/donavon/use-firebase-auth
A custom React Hook that provides a declarative interface for Firebase Auth.
https://github.com/donavon/use-firebase-auth
firebase firebase-auth hooks react reactjs
Last synced: about 2 months ago
JSON representation
A custom React Hook that provides a declarative interface for Firebase Auth.
- Host: GitHub
- URL: https://github.com/donavon/use-firebase-auth
- Owner: donavon
- License: mit
- Created: 2019-02-17T18:16:12.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2023-03-03T10:11:33.000Z (almost 2 years ago)
- Last Synced: 2024-10-12T08:11:18.855Z (2 months ago)
- Topics: firebase, firebase-auth, hooks, react, reactjs
- Language: JavaScript
- Homepage:
- Size: 1.29 MB
- Stars: 78
- Watchers: 4
- Forks: 11
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# @use-firebase/auth
A custom React Hook that provides a declarative interface for Firebase Auth.
[](https://badge.fury.io/js/%40use-firebase%2Fauth)
[](#contributors)
## Installation
```bash
$ npm i @use-firebase/auth
```
or
```bash
$ yarn add @use-firebase/auth
```
## Usage
The Auth package requires that you install App as a dependency and that you wrap your App in both
`` and `` as shown here.
```jsx
import React from 'react';
import { FirebaseAppProvider } from '@use-firebase/app';
import { FirebaseAuthProvider } from '@use-firebase/auth';
import App from './App';
import config from './data/firebaseConfig';
const FirebaseApp = () => (
);
export default FirebaseApp;
```
This provides the global context that `useFirebaseAuth` needs. Now you can use `useFirebaseAuth`
anywhere in your App.
Initially, you will probably want to display either a Sign In screen if not signed in.
You can detect if you are signed in like this.
```jsx
import { useFirebaseAuth } from '@use-firebase/auth';
const App = () => {
const { isSignedIn } = useFirebaseAuth();
return (
{isSignedIn ? : }
);
};
export default App;
```
Here we either render the `AuthenticatedApp` or the `NonAuthenticatedApp` component.
The `NonAuthenticatedApp` would be where we render the sign in page.
Here's an example sign in page with a button that allows the user
to sign in with their Google credentials.
```jsx
import { useFirebaseAuth, AuthProvider } from '@use-firebase/auth';
const NonAuthenticatedApp = () => {
const { signIn, signInError, createAuthProvider } = useFirebaseAuth();
const onSignIn = authProvider => {
const provider = createAuthProvider(authProvider);
signIn(provider);
};
return (
Please Sign In
onSignIn(AuthProvider.GOOGLE)}>
Sign In with Google
{signInError &&
{signInError.code}
{signInError.message}
}
);
};
```
It redirects to the authentication page of the provider—Google in this case.
After the user is authenticated, you will be redirected back to your app where
`isSignedIn` will be `true` and the `AuthenticatedApp` component will be rendered.
If there was an error for any reason, `signInError` will be non-null.
If you would rather use a popup, instead of a redirect, replace `onSignIn` with this.
```js
const onSignIn = authProvider => {
const provider = createAuthProvider(authProvider);
signIn(provider, { method: 'signInWithPopup' });
};
```
One the user has been sucessfully authenticated, you will want to display an authenticated
experience, Here is a sample `AuthenticatedApp` component that displayed the user's name
and image. It also renders a sign out button.
```jsx
import { useFirebaseAuth } from '@use-firebase/auth';
const AuthenticatedApp = () => {
const { user, signOut } = useFirebaseAuth();
const { displayName, photoURL } = user;
return (
Welcome {displayName}
Sign Out
);
};
```
You will note that it destructures two things from the call to `useFirebaseAuth`:
`user` (a user object) and `signOut` (a function to sign out).
## API
An import from `@use-firebase/auth` provides
`FirebaseAuthProvider`, `useFirebaseAuth`, and `AuthProvider`.
### FirebaseAuthProvider
You must wrap your `App` in `FirebaseAuthProvider` like this.
```jsx
```
It provides context for `useFirebaseAuth`.
### useFirebaseAuth
`useFirebaseAuth` is a custom hook that returns a session object every time that the authentication
state changes.
A session object has the following properties.
| Parameter | Description |
| :------------------- | :--------------------------------------------------------------------------- |
| `loading` | Set to `true` if the rest of the session properties are indeterminate. |
| `isSignedIn` | Set to `true` if the user is signed in. |
| `user` | A `user` object if signed in, otherwise an empty object. See below. |
| `signInError` | The error from the previous `signIn` attempt or `null` if it was a success. |
| `createAuthProvider` | A function that returns a `provider` instance given an enum `AuthProvider` value. |
| `signIn` | A function that will take the user on the sign in journey. If successful, `isSignedIn` will be to `false`. See below for details. |
| `signOut` | A function that will sign the user out. If successful, `isSignedIn` will be to `false`. |
#### user
`user` is a user object with the following properties.
| Parameter | Description |
| :-------------- | :------------------------------------------------------------------------------------------------------------- |
| `uid` | A unique identifier for the user. |
| `displayName` | The user's full name. |
| `photoURL` | A URL to the user's image. May not be included for all providers. |
| `email` | The user's email address. May not be included for all providers. |
| `emailVerified` | `true` if the email is verified. |
| `isAnonymous` | `true` if the authenticaion method was `ANONYMOUS`. |
| `phoneNumber` | The user's phone number. May not be included for all providers. |
#### createAuthProvider
Call `createAuthProvider` with one of the `AuthProvider` enum values.
It returns a `provider` instance that you can pass to `signIn`
See the [Firebase documentation](https://firebase.google.com/docs/reference/js/firebase.auth.AuthProvider)
for more information.
#### signIn
Call `signIn` with an `provider` instance and an optional `options` object.
The `options` object has a single key of `method`. `method` is a string with either
`signInWithRedirect` or `signInWithPopup`. The default is `signInWithRedirect`.
`signIn` returns a promise that will resolve upon a successful sign in (if using a popup)
or reject if a sign in could not be performed.
For example, here is a simple `SignIn` component that allows the user to
sign in using their Google credentials.
```js
import { useFirebaseAuth, AuthProvider } from '@use-firebase/auth';
const SignIn = () => {
const { signIn, createAuthProvider } = useFirebaseAuth();
const googleProvider = createAuthProvider(AuthProvider.GOOGLE);
return (
signIn(googleProvider)}>Sign In with Google
);
};
```
#### signOut
Call `signOut` to sign the user out.
It returns a promise that will resolve upon a successful sign out
or reject if a sign out could not be performed.
### AuthProvider
`AuthProvider` is an enum with the following values.
| Parameter | Description |
| :---------- | :---------------------------- |
| `ANONYMOUS` | No credentials required. |
| `GITHUB` | Authenticate against GitHub |
| `GOOGLE` | Authenticate against Google. |
| `FACEBOOK` | Authenticate against Facebook |
| `TWITTER` | Authenticate against Twitter |
## Live demo
You can run the sign in demo on CodeSandbox where you can
see all of the code above. Fork it, change the `config` data
to point to your Firebase project, and make your own app.
[](https://codesandbox.io/s/jjjqrm6q85?fontsize=14)
## License
**[MIT](LICENSE)** Licensed