ngx-auth-firebaseui - Open Source Library for Angular Web Apps to integrate a material user interface for firebase authentication.

Angular UI component for firebase authentication. This library is an angular module (including angular components and services) that allows to authenticate your users with your firebase project. NgxAuthFirebseUI is compatible with angular material and angular flexLayout.

If you prefer to develop with bootstrap rather than with material design, please check this project @firebaseui/ng-bootstrap

Migration from V1 to V2

Since the first stable release of angularfire2 has been published within the angular organization, we replaced that module with @angular/fire

Before updating ngx-auth-firebaseui to V2, please make sure that angularifre2 has been replaced with @angular/fire -->

npm un angularfire2 && npm i @angular/fire 

Built by and for developers :heart:

Do you have any question or suggestion ? Please do not hesitate to contact us! Alternatively, provide a PR | open an appropriate issue here

If you like this project, support ngx-auth-firebaseui by starring :star: and sharing it :loudspeaker:

Table of Contents

• ngx-auth-firebaseui vs firebaseui-web
• Why to use ngx-auth-firebaseui ?
• Library's components
• Supported Providers
• Supported Processes and Actions
• Requirements
• Demo
• Features
• Examples
• Documentation
• Screenshots
• Peer Dependencies
• Dependencies
• Installation
• Usage
• API
• Additional Requirements - material (Include a theme)
• Additional Requirements - material icons
• Additional Requirements - assets
• Run Demo App Locally
• Other Angular Libraries
• Support
• License

ngx-auth-firebaseui vs firebaseui-web

| Features | ngx-auth-firebaseui | firebaseui | | -----------------------------------------------|:-------------:| :-------------------: | | Sign Up | :heavy_check_mark: | :heavy_check_mark: | | Sign In | :heavy_check_mark: | :heavy_check_mark: | | Sign In Anonymously | :heavy_check_mark: | :heavy_check_mark: | | Sign In with Google | :heavy_check_mark: | :heavy_check_mark: | | Sign In with Facebook | :heavy_check_mark: | :heavy_check_mark: | | Sign In with Twitter | :heavy_check_mark: | :heavy_check_mark: | | Sign In with Github | :heavy_check_mark: | :heavy_check_mark: | | Sign In with PhoneNumber | :x: | :heavy_check_mark: | | Sign out | :heavy_check_mark: | :x: | | Sign in/up progress indicator | :heavy_check_mark: | :x: | | Password Strength indicator | :heavy_check_mark: | :x: | | Forgot/Reset Password | :heavy_check_mark: | :x: | | Delete account | :heavy_check_mark: | :x: | | User Profile | :heavy_check_mark: | :x: | | Check whether user's email is verified | :heavy_check_mark: | :x: | | Edit user's display name (incl. validation) | :heavy_check_mark: | :x: | | Edit user's email (incl. validation) | :heavy_check_mark: | :x: | | Edit user's phone number (incl. validation) | :heavy_check_mark: | :x: | | Configure your favorite auth provider in runtime| :heavy_check_mark: | :x: | | Sync user'auth with Firestore read more | :heavy_check_mark: | :x: | | Angular v2-6 friendly | :heavy_check_mark: | :x: | | Internationalization (i18n) | :soon: | :heavy_check_mark: | | Ionic/cordova support | :soon: @firebaseui/ionic-auth | :x: | | Real time form validation | :heavy_check_mark: | :x: | | Easy to integrate | :heavy_check_mark: | :x: | | Support Server Side Rendering | :heavy_check_mark: | :x: | | Support SPA without further config | :heavy_check_mark: | :x: | | Support Safari private browsing | :heavy_check_mark: | :interrobang: | | AWESOME | :heavy_check_mark: | :interrobang: |

Why to use ngx-auth-firebaseui ?

• :gift_heart: it uses a responsive and accessible web design UX/UI from google material concepts and components (supporting desktop and mobile view).
• :lipstick: pick up your own theme! change the primary, accent and warn colors whenever you need (e.g to support light and dark themes)
• :ship: super easy to use with an angular based project (project that is created with the angular-cli)
• :soon: optional configuration
• :recycle: configure your authentication providers in runtime
• :recycle: reusable components for every project that needs an authentication with a firebase project/app.
• :customs: built in feedback mechanism in form of a snackbar when an error or any important event occurred.
• :sos: ability to sign out or even to delete totally the account
• :ghost: your client does not want to create an account in your project? Let him to sign in anonymously!
• :busts_in_silhouette: user profile component to display user's data using via ngx-auth-firebaseui-user
• :zap: update user profile as feature
• :fire: Sync user's authentication with FIRESTORE AUTOMATICALLY
• :muscle: Forgot Password feature! Go and let your users to recover their passwords easily
• :tada: Supports SSR - Server Side Rendering

Library's components

• <ngx-auth-firebaseui> used for the authentication process
• <ngx-auth-firebaseui-providers> used to display only buttons for providers like googe, facebook, twitter and github
• <ngx-auth-firebaseui-user> used to display/edit the data of the current authenticated user

Supported Providers:

• anonymously
• email and password (traditional)
• google
• facebook
• twitter
• github
• phone number :soon:

Supported Processes and Actions:

• sign up
• sign in
• sign in Anonymously | with google, facebook, twitter, github
• sign out
• validation of password's strength while creating a new account using @angular-material-extensions/password-strength
• forgot/reset password
• sending email verifications
• delete user's account
• edit user's profile like email, name, (profile picture :soon:) and phone number
• firestore auto sync :fire:
• do not allow users to create new accounts before checking the terms of services and private policy - for mor info check this here

Requirements:

• angular material theme
• angular material icons
• angular cdk - v6.x
• angular material - v6.x
• angular forms - v6.x
• angular animations - v6.x
• angular flex-layout v6.0.0-beta.18
• @angular/fire - v5.0.2
• firebase - v5.x

the full tutorial guide can be found here

Demo |

Features

take a look at live example with firestore's synchronization here

Examples

Documentation

Screenshots - Browser

• sign in

• Sign up - registration

before

after

demo outlook

Screenshots - Client Side Validation

Screenshots

row layout

Please note: when the view port is getting too small, the layout will be automatically change to column

column layout

Screenshots

• user profile

when logged out

when logged in

in edit mode

Screenshots - Mobile Browser

• Sign in - mobile

Screenshots - Reset Password

• Before

• After

Peer Dependencies - please make sure that peerDependencies are installed

"peerDependencies": {
    "@angular/core": "^6.x",
    "@angular/animations": "^6.x",
    "@angular/cdk": "^6.x",
    "@angular/flex-layout": "^6.0.0-beta.16",
    "@angular/forms": "^5.x",
    "@angular/material": "^5.x",
    "@angular/fire": "5.0.0-rc.10.0",
    "firebase": "5.x",
  }

e.g:

Angular deps

npm i -s @angular/[email protected] @angular/[email protected] @angular/[email protected] @angular/[email protected] @angular/[email protected]

Firebase deps

npm i -s [email protected] @angular/[email protected]

NOTE:

If you are still running angular v5, please consider to user ngx-auth-firebaseui v0.x

v1.x should be used with angular v6 projects

help!

Dependencies

• Angular (requires Angular 2 or higher, developed with 6.0.3) - obviously
• @angular-material-extensions/password-strength

the @angular-material-extensions/password-strength is used to indicate how secure is the provided password when registering a new firebase user e.g:

(1) Installation

Install above dependencies via npm.

Now install ngx-auth-firebaseui via:

npm install --save ngx-auth-firebaseui

Once installed you need to import the main module:

import { NgxAuthFirebaseUIModule } from 'ngx-auth-firebaseui';

The only remaining part is to list the imported module in your application module. The exact method will be slightly different for the root (top-level) module for which you should end up with the code similar to (notice NgxAuthFirebaseUIModule .forRoot()):

and then from your Angular AppModule:

import { BrowserModule } from '@angular/platform-browser';
import { NgModule } from '@angular/core';

import { AppComponent } from './app.component';

// Import your library
import { NgxAuthFirebaseUIModule } from 'ngx-auth-firebaseui';
import {BrowserAnimationsModule} from '@angular/platform-browser/animations';

@NgModule({
  declarations: [
    AppComponent
  ],
  imports: [
    BrowserModule,
    BrowserAnimationsModule,

    // Specify the ngx-auth-firebaseui library as an import
    NgxAuthFirebaseUIModule.forRoot({
                    apiKey: 'your-firebase-apiKey',
                    authDomain: 'your-firebase-authDomain',
                    databaseURL: 'your-firebase-databaseURL',
                    projectId: 'your-firebase-projectId',
                    storageBucket: 'your-firebase-storageBucket',
                    messagingSenderId: 'your-firebase-messagingSenderId'
                }),
  ],
  providers: [],
  bootstrap: [AppComponent]
})
export class AppModule { }

Other modules in your application can simply import NgxAuthFirebaseUIModule:

import { NgxAuthFirebaseUIModule } from 'ngx-auth-firebaseui';

@NgModule({
  declarations: [OtherComponent, ...],
  imports: [NgxAuthFirebaseUIModule, ...],
})
export class OtherModule {
}

SystemJS

Note:If you are using SystemJS, you should adjust your configuration to point to the UMD bundle. In your systemjs config file, map needs to tell the System loader where to look for ngx-auth-firebaseui:

map: {
  'ngx-auth-firebaseui': 'node_modules/ngx-auth-firebaseui/bundles/ngx-auth-firebaseui.umd.js',
}

(2) Usage

Once the library is imported, you can use its components, directives and pipes in your Angular application:

<ngx-auth-firebaseui></ngx-auth-firebaseui>

<!-- You can now use the library component in app.component.html  -->

<ngx-auth-firebaseui (onSuccess)="printUser($event)"
                     (onError)="printError()">
</ngx-auth-firebaseui>

or

<!-- or simply in the app.component.ts -->
@Component({
    selector: 'app',
    template: `
        <ngx-auth-firebaseui (onSuccess)="printUser($event)" (onError)="printError()"></ngx-auth-firebaseui>`
})
class AppComponent {

    printUser(event) {
        console.log(event);
    }

    printError(event) {
        console.error(event);
    }
}

Result:

<ngx-auth-firebaseui-providers></ngx-auth-firebaseui-providers>

<!-- You can now use the library component in app.component.html  -->
<ngx-auth-firebaseui-providers layout="column"></ngx-auth-firebaseui-providers>

<ngx-auth-firebaseui-user></ngx-auth-firebaseui-user>

<ngx-auth-firebaseui-user></ngx-auth-firebaseui-user>

Result:

API

<ngx-auth-firebaseui></ngx-auth-firebaseui>

| option | bind | type | default | description | |:---------------------|:------:|:------:|:------------:|:-------------------------------------------------------------------------------------------------| | providers | Input() | string[] | ['all'] or [AuthProvider.All] | choose your favorite authentication provider: google | facebook | twitter | github | appearance | Input() | MatFormFieldAppearance | standard | the appearance of the mat-form-field #'legacy' | 'standard' | 'fill' | 'outline' | tabIndex | Input() | number | null; | 0 | the selected tab - either sign in or register | guestEnabled | Input() | boolean | true | whether the user can sign in and continue as guest | tosUrl | Input() | string | - | the url of term of services | privacyPolicyUrl | Input() | string | - | the url of the private privacy | onSuccess | Output() | any | - | this will be fired when an authentication process was success. The authenticated user is emitted! | onError | Output() | any | - | this event will be fired when an error occurred during the authentication process! An error message is emitted!

PS: if either tosUrl or privacyPolicyUrl` are provided, the user will be asked to check and accepts tos and pp before registering a new account or sign in in anonymously

How to disable users to sign in and continue as guest, use the guestEnabled input

<ngx-auth-firebaseui [guestEnabled]="false"
                     (onSuccess)="printUser($event)"
                     (onError)="printError($event)">
</ngx-auth-firebaseui>

Result:

How to configure your input providers ? see the examples

e.g: in your component, import the AuthProvider enum to pick up your favorite provider:

import {OnInit} from '@angular/core';
import {AuthProvider} from 'ngx-auth-firebaseui';

export class ExampleComponent implements OnInit {

  providers = AuthProvider;

  ngOnInit() {
  }
}

in your template -->

  <ngx-auth-firebaseui
  [providers]="[providers.Google, providers.Facebook, providers.Twitter]"
  (onSuccess)="printUser($event)"
   (onError)="printError()"></ngx-auth-firebaseui>

or

  <ngx-auth-firebaseui
  [providers]="['google', 'facebook', 'twitter']"
  (onSuccess)="printUser($event)"
  (onError)="printError()">
</ngx-auth-firebaseui>

take a look at the full documentation here

<ngx-auth-firebaseui-providers></ngx-auth-firebaseui-providers>

| option | bind | type | default | description | |:---------------------|:------:|:------:|:------------:|:-------------------------------------------------------------------------------------------------| | layout | Input() | string | row | set the layout of the providers buttons options: 'column' or 'row' | theme | Input() | string | default | set the theme of the providers buttons options: '', 'classic', 'stroked', 'fab', 'mini-fab', 'raised',

e.g: in template:

<ngx-auth-firebaseui-providers [theme]="themes.CLASSIC"></ngx-auth-firebaseui-providers>
<ngx-auth-firebaseui-providers [theme]="themes.STROKED"></ngx-auth-firebaseui-providers>
<ngx-auth-firebaseui-providers [theme]="themes.RAISED"></ngx-auth-firebaseui-providers>
<ngx-auth-firebaseui-providers [theme]="themes.FAB"></ngx-auth-firebaseui-providers>
<ngx-auth-firebaseui-providers [theme]="themes.MINI_FAB"></ngx-auth-firebaseui-providers>

in your component:

import {Component} from '@angular/core';
import {AuthProvider, Theme} from 'ngx-auth-firebaseui';

@Component({
selector: 'app-root',
templateUrl: './app.component.html',
styleUrls: ['./app.component.css']
})
export class AppComponent {

  themes = Theme;
}

<ngx-auth-firebaseui-user></ngx-auth-firebaseui-user>

| option | bind | type | default | description | |:---------------------|:------:|:------:|:------------:|:-------------------------------------------------------------------------------------------------| | onAccountDeleted | Output() | void | - | this will be fired when the user deletes his account

(3) Additional Requirements - material (Include a theme)

With Angular CLI

Please take a look of the official documentation of angular material themes here

Without Angular CLI

see how it works

(4) Additional Requirements - Import the material design icons learn more

• The easiest way to import material design icons is to provide a link in your index.html file like below:

<link href="https://fonts.googleapis.com/icon?family=Material+Icons" rel="stylesheet">

• alternative solution:

1. Install of the official npm module of the material design icons

npm i -s material-design-icons

2. Import them in your angular.json file

"styles": [
        "styles.css",
        "node_modules/material-design-icons/iconfont/material-icons.css"
      ],

(5) Additional Requirements - assets

With Angular CLI

• open the file .angular.json
• add the following into the assets section

{
          "glob": "**/*",
          "input": "../node_modules/ngx-auth-firebaseui/dist/assets/",
          "output": "./assets/"
}

• after that the required images will be copied to the assets dir and will be available for the app.
• finally the assets section should be in a way similar to that -->

"assets": [
        "assets",
        "favicon.ico",
        {
          "glob": "**/*",
          "input": "../node_modules/ngx-auth-firebaseui/dist/assets/",
          "output": "./assets/"
        }
      ]

Without Angular CLI

copy the assets directory into the root of your project, so that your app can get the required images for the UI. This is an example of requesting an image from the library Request URL:http://localhost:4200/assets/google.svg. Please make sur that the images will be hosted in the right place

Run Demo App Locally

• clone this repo by running

$ git clone https://github.com/AnthonyNahas/ngx-auth-firebaseui.git

• link the ngx-auth-firebaseui package

$ gulp link

• navigate to the demo app directory

$ cd demo

• install the dependencies

$ npm i

• run/start/serve the app

$ npm run start

or

$ ng serve --open

• the app is now hosted by http://localhost:4200/

Other Angular Libraries

• @firebaseui/ng-bootstrap
• ngx-linkifyjs
• @angular-material-extensions/password-strength
• @angular-material-extensions/link-preview
• @angular-material-extensions/pages
• @angular-material-extensions/contacts
• @angular-material-extensions/faq
• @angular-material-extensions/jumbotron
• @angular-material-extensions/google-maps-autocomplete
• @angular-material-extensions/combination-generator

Support

• Drop an email to: Anthony Nahas
• or open an appropriate issue
• let us chat on Gitter

Built by and for developers :heart: we will help you :punch:

This project is supported by jetbrains with 1 ALL PRODUCTS PACK OS LICENSE incl. webstorm

License

Copyright (c) 2018 Anthony Nahas. Licensed under the MIT License (MIT)