rnf

react-native-firebaseui-auth

Easily add sign-in to your React Native app with FirebaseUI

Showing:

Popularity

Downloads/wk

37

GitHub Stars

19

Maintenance

Last Commit

3d ago

Contributors

5

Package

Dependencies

0

License

MIT

Type Definitions

Tree-Shakeable

No?

Categories

Readme

oijusti

Build Status

npm version PR's welcome

install size

react-native-firebaseui-auth

Easily add sign-in to your React Native app with FirebaseUI

Getting started

Add Firebase to your project

Android:

  1. Follow the Android setup guide
  2. Follow the sign-in methods guide

iOS:

  1. Follow the iOS setup guide

  2. Add FirebaseUI to your Podfile:

    pod 'FirebaseUI'
    

    Run $ pod update

  3. Follow the sign-in methods guide

Installation

$ npm install react-native-firebaseui-auth --save

or

$ yarn add react-native-firebaseui-auth

Linking (RN >= 0.60 skip this step)

RN <= 0.59 only

Automatic

$ react-native link react-native-firebaseui-auth

Manual

iOS

  1. In XCode, in the project navigator, right click LibrariesAdd Files to [your project's name]
  2. Go to node_modulesreact-native-firebaseui-auth and add RNFirebaseuiAuth.xcodeproj
  3. In XCode, in the project navigator, select your project. Add libRNFirebaseuiAuth.a to your project's Build PhasesLink Binary With Libraries
  4. Run your project (Cmd+R)

Android

  1. Open up android/app/src/main/java/[...]/MainApplication.java
  • Add import com.oijusti.firebaseuiauth.RNFirebaseuiAuthPackage; to the imports at the top of the file
  • Add new RNFirebaseuiAuthPackage() to the list returned by the getPackages() method
  1. Append the following lines to android/settings.gradle:
    include ':react-native-firebaseui-auth'
    project(':react-native-firebaseui-auth').projectDir = new File(rootProject.projectDir,  '../node_modules/react-native-firebaseui-auth/android')
    
  2. Insert the following lines inside the dependencies block in android/app/build.gradle:
      implementation project(':react-native-firebaseui-auth')
    

Usage

import Auth from 'react-native-firebaseui-auth';

...

  const config = {
    providers: [
      'anonymous',
      'facebook', 
      'google', 
      'email', 
      'phone', 
      'apple', 
      'yahoo', 
      'github', 
      'twitter', 
      'microsoft'
    ],
    tosUrl: 'https://example.com/tos.htm',
    privacyPolicyUrl: 'https://example.com/privacypolicy.htm',
  };

  Auth.signIn(config)
    .then(user => console.log(user))
    .catch(err => console.log(err));

...

  Auth.getCurrentUser().then(user => console.log(user));

...

  Auth.signOut().then(res => console.log(res));

...

  Auth.delete().then(res => console.log(res));

...

Returns: user

FieldTypeDescription
uidstringThe provider's user ID for the user.
displayNamestringThe name of the user.
photoURLstringThe URL of the user's profile photo.
emailstringIndicates the email address associated with this user has been verified.
phoneNumberstringA phone number associated with the user.
providerIdstringThe provider identifier.
isNewUserbooleanIndicates whether or not the current user was signed in for the first time.
creationTimestampnumberStores the timestamp at which this account was created as dictated by the server clock in milliseconds since epoch.
lastSignInTimestampnumberStores the last signin timestamp as dictated by the server clock in milliseconds since epoch.

UI Customization

Optionally, you can use the option customizations to change the look of the authentication screens. This does not apply to the actual sign-in buttons and their position. What you can change depends on the platform.

Android

The values available for android customization are as follows,

  const config = {
    ...
    customizations: [
      'theme',
      'logo'
    ],
  };

First add FirebaseUI in your build.gradle (:app),

dependencies {
    implementation 'com.firebaseui:firebase-ui-auth:6.4.0'
    ...

For theme, add the next style in your styles.xml, then copy into the drawable folder an image to use for background and name it auth_background.png.

    <style name="AuthTheme" parent="FirebaseUI">
        <item name="colorPrimary">@color/colorPrimary</item>
        <item name="colorPrimaryDark">@color/colorPrimaryDark</item>
        <item name="colorAccent">@color/colorAccent</item>

        <item name="colorControlNormal">@android:color/white</item>
        <item name="colorControlActivated">@android:color/white</item>
        <item name="colorControlHighlight">@android:color/white</item>
        <item name="android:windowBackground">@drawable/auth_background</item>
    </style>

For logo, copy an image in the drawable folder and name it auth_logo.png.

iOS

The values available for iOS customization correspond to specific screens and are as follows,

  const config = {
    ...
    customizations: [
      'auth_picker',
      'email_entry',
      'password_sign_in',
      'password_sign_up',
      'password_recovery',
      'password_verification'
    ],
  };

Open your project in XCode and add the .xib file of the screen you want to customize. The .xib files are located in ./ios/custom-screens/ of this library. Let's say, you want to customize the auth-picker screen, add the file FUICustomAuthPickerViewController.xib and use the XCode tools to add it labels, images, change colors, and so on.

Email Password Settings

You can control whether new users can sign in or not by using the option allowNewEmailAccounts. Also, if you do not want to require the user name during sign up you can set the option requireDisplayName to false.

  const config = {
    ...
    allowNewEmailAccounts: false,
    requireDisplayName: false,
  };

Example Project

Create a project in the Firebase Console and add apps for Android and iOS. Then enable Email/Password provider in Authentication.

Android

Make sure you type com.example.app in the Android package name field.

Download the file google-services.json in the android/app folder.

iOS

Make sure you type com.example.app in the iOS bundle ID field.

Download the file GoogleService-Info.plist in the ios/example folder and add it into the project using xcode.

Update pods $ pod install

Contributing

Feel free to report bugs, ask questions and submit a PR.

If this is your first open source contribution, please take a look at this guide .

Find this library useful?

Please give me a star ✭ if you like it!

License

(MIT)

Rate & Review

Great Documentation0
Easy to Use0
Performant0
Highly Customizable0
Bleeding Edge0
Responsive Maintainers0
Poor Documentation0
Hard to Use0
Slow0
Buggy0
Abandoned0
Unwelcoming Community0
100