FirebaseUI React Components provides React Wrappers on top of the Firebase UI Web library and notably Firebase UI Auth.
FirebaseUI Auth provides a drop-in auth solution that handles the UI flows for signing in users with email addresses and passwords, and Identity Provider Sign In using Google, Facebook and others. It is built on top of Firebase Auth.
For an example on how to use the FirebaseAuth react component have a look at the example folder.
Install the npm package in your React app:
npm install --save react-firebaseuiYou also need the firebase package installed which is a peer dependency:
npm install --save firebaseIn your app:
- Import the
FirebaseAuthcomponent fromreact-firebaseuiand importfirebase. - Configure Firebase as described in the Firebase Docs.
- Write a Firebase UI configuration as described in firebase/firebaseui-web.
- Use the
FirebaseAuthcomponent in your template passing it the Firebase UI configuration and a Firebase Auth instance.
Below is an example on how to use FirebaseAuth with a redirect upon sign-in:
// Import FirebaseAuth and firebase.
import React from 'react';
import { FirebaseAuth } from 'react-firebaseui';
import firebase from 'firebase';
// Configure Firebase.
const config = {
apiKey: 'AIzaSyAeue-AsYu76MMQlTOM-KlbYBlusW9c1FM',
authDomain: 'myproject-1234.firebaseapp.com',
// ...
};
firebase.initializeApp(config);
// Configure FirebaseUI.
const uiConfig = {
// Popup signin flow rather than redirect flow.
signInFlow: 'popup',
// Redirect to /signedIn after sign in is successful. Alternatively you can provide a callbacks.signInSuccess function.
signInSuccessUrl: '/signedIn',
// We will display Google and Facebook as auth providers.
signInOptions: [
firebase.auth.GoogleAuthProvider.PROVIDER_ID,
firebase.auth.FacebookAuthProvider.PROVIDER_ID
]
};
class SignInScreen extends React.Component {
render() {
return (
<div>
<h1>My App</h1>
<p>Please sign-in:</p>
<FirebaseAuth uiConfig={uiConfig} firebaseAuth={firebase.auth()}/>
</div>
);
}
}Below is an example on how to use FirebaseAuth with a state change upon sign-in:
// Import FirebaseAuth and firebase.
import React from 'react';
import { FirebaseAuth } from 'react-firebaseui';
import firebase from 'firebase';
// Configure Firebase.
const config = {
apiKey: 'AIzaSyAeue-AsYu76MMQlTOM-KlbYBlusW9c1FM',
authDomain: 'myproject-1234.firebaseapp.com',
// ...
};
firebase.initializeApp(config);
class SignInScreen extends React.Component {
// Configure FirebaseUI.
uiConfig = {
// Popup signin flow rather than redirect flow.
signInFlow: 'popup',
// We will display Google and Facebook as auth providers.
signInOptions: [
firebase.auth.GoogleAuthProvider.PROVIDER_ID,
firebase.auth.FacebookAuthProvider.PROVIDER_ID
],
// Sets the `signedIn` state property to `true` once signed in.
callbacks: {
signInSuccess: () => {
this.setState({signedIn: true});
return false;
}
}
};
state = {
signedIn: false
};
render() {
if (!this.state.signedIn) {
return (
<div>
<h1>My App</h1>
<p>Please sign-in:</p>
<FirebaseAuth uiConfig={this.uiConfig} firebaseAuth={firebase.auth()}/>
</div>
);
}
return (
<div>
<h1>My App</h1>
<p>Welcome! You are now signed-in!</p>
</div>
);
}
}The FirebaseAuth component needs a global CSS to get proper styling. The CSS is already imported within FirebaseAuth.
If you are using webpack you'll need to add CSS loaders:
{
module: {
rules: [
{
test: /\.css/,
use: [ 'style-loader', 'css-loader' ]
}
]
}
}If you are using ExtractTextPlugin to extract a CSS file from the required CSS files you would typically use:
{
plugins: [new ExtractTextPlugin('./bundle.css')],
module: {
rules: [
{
test: /\.css/,
loader: ExtractTextPlugin.extract(
{
fallback: 'style-loader',
use: ['css-loader']
})
}
]
}
}If you are using CSS modules in your app you need to handle the CSS files in /node_modules/ in a separate loader so that they are imported as global CSS files and not modules. Your setup could look like:
{
plugins: [new ExtractTextPlugin('./bundle.css')],
module: {
rules: [
// CSS loaders for CSS modules in your project. We exclude CSS files in ./node_modules
{
test: /\.css$/,
exclude: [/\.global\./, /node_modules/],
loader: ExtractTextPlugin.extract(
{
fallback: 'style-loader',
use:[
{
loader: 'css-loader',
options: {
importLoaders: 1,
modules: true,
autoprefixer: true,
minimize: true,
localIdentName: '[name]__[local]___[hash:base64:5]'
}
}
]
})
},
// CSS loaders for global CSS files which includes files in ./node_modules
{
test: /\.css/,
include: [/\.global\./, /node_modules/],
loader: ExtractTextPlugin.extract(
{
fallback: 'style-loader',
use: ['css-loader']
})
}
]
}
}To change the styling of the FirebaseAuth widget you can override its CSS. You can import a CSS that will be included globally in your packed application. For instance create a firebaseui-overrides.globlal.css file and import it in your app:
import './firebaseui-styling.global.css'; // Import globally.Note: If you are using the "With ExtractTextPlugin and CSS modules" Webpack build rule above, the
.global.csssuffixe will make sure the CSS file is imported globally and not ran through modules support.
If you would like to see an example of styling, have a look at the example app.
In the case where you would need to load multiple instances of FirebaseAuth at the same time you need to set them up with a different ID using the elementId attribute. For instance:
<FirebaseAuth elementId="auth_1" uiConfig={this.uiConfig} firebaseAuth={firebase.auth()}/>
<FirebaseAuth elementId="auth_2" uiConfig={this.otherUiConfig} firebaseAuth={firebase.auth()}/>We'd love that you contribute to the project. Before doing so please read our Contributor guide.
© Google, 2011. Licensed under an Apache-2 license.
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent