ngx-auth-firebaseui

v7.1.0

Published

2 years ago

Open Source Library for Angular Web Apps to integrate a material user interface for firebase authentication

Downloads

2,174

0High
0Medium
0Low

anthonynahas

ng library angular @angular/fire firebase firebaseui firebase auth authentication firebaseauthentication firestore material material design ssr

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

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:

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 Apple | :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 Microsoft | :heavy_check_mark: | :heavy_check_mark: | | Sign In with Yahoo | :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: | | Password Strength Meter | :heavy_check_mark: | :x: | | Delete account | :heavy_check_mark: | :x: | | Login Authentication Guard | :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: | | Animations | :heavy_check_mark: | :x: | | Angular v2-13 friendly | :heavy_check_mark: | :x: | | Internationalization (i18n) | :heavy_check_mark: | :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, tablet and mobile view) incl. smooth animations for a better UX.
: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
support of i18n

Library's components

<ngx-auth-firebaseui> used for the authentication process see more
<ngx-auth-firebaseui-register> standalone registration component to create new accounts see more
<ngx-auth-firebaseui-login> standalone login component to use already created accounts see more
<ngx-auth-firebaseui-providers> used to display only buttons for providers like google, facebook, twitter, github, microsoft and yahoo see more
<ngx-auth-firebaseui-user> used to display/edit the data of the current authenticated user in form of a material card see more
<ngx-auth-firebaseui-avatar> used to display/edit the data of the current authenticated user in the toolbar see more

Supported Providers:

anonymously
email and password (traditional)
google
apple
facebook
twitter
github
Microsoft
Yahoo
phone number :soon:

Supported Processes and Actions:

sign up
sign in
sign in Anonymously | with google, apple, facebook, twitter, github, microsoft, yahoo
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

Supported Angular Guards

LoggedInGuard used to protect angular routes from unauthenticated users (with fallback routes via NgxAuthFirebaseUIConfig)

the full tutorial guide can be found here

Demo | Features | Examples

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

Screenshots - Browser

in combination with ngx-auth-firebaseui-user

before

after

demo outlook

Screenshots

row layout

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

| User Profile

when logged in

in edit mode

Screenshots - Reset Password

Before

After

Screenshot - i18n - multiple languages

Peer Dependencies - please make sure that peerDependencies are installed if you are not using the schematics

"peerDependencies": {
    "@angular/core": "^13.x",
    "@angular/animations": "^13.x",
    "@angular/cdk": "^13.x",
    "@angular/flex-layout": "^13.0.0-beta.38",
    "@angular/forms": "^13.x",
    "@angular/material": "^13.x",
    "@angular/fire": "7.x",
    "firebase": "9.x",
  }

NOTE:

v1.x should be used with angular v7 projects
v3.x should be used with angular v8 projects
v4.x should be used with angular v9/10 projects
v5.x should be used with angular v11 projects
v6.x should be used with angular v12/13 projects
v7.x should be used with angular v14 projects

help!

Dependencies

Angular (requires Angular 2 or higher, developed with 13.x) - 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

1. Install via ng add. (Recommended)

If Angular Material Design is not setup, just run ng add @angular/material learn more

Now add the library via the angular schematics

ng add ngx-auth-firebaseui

:heavy_check_mark: peer dependencies will be automatically added the package.json and installed
:heavy_check_mark: ngx-auth-firebaseui 's module will be automatically imported to the root module (just replace PUT_YOUR_FIREBASE_API_KEY_HERE with your firebase api key)
:heavy_check_mark: ngx-auth-firebaseui 's assets will be automatically added the angular.json file

2. Install via npm. (Alternative)

Install above dependencies via npm.

Now install ngx-auth-firebaseui via:

npm install --save ngx-auth-firebaseui

Install the dependencies @angular-material-extensions/password-strength via:

npm install --save @angular-material-extensions/password-strength

npm i -s @angular/material @angular/cdk @angular/flex-layout @angular/forms @angular/animations @angular/router

Firebase deps

npm i -s firebase @angular/fire

-> continue by following the instructions here

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) Configuration

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'
                },
                 () => 'your_app_name_factory',
                {
                  enableFirestoreSync: true, // enable/disable autosync users with firestore
                  toastMessageOnAuthSuccess: false, // whether to open/show a snackbar message on auth success - default : true
                  toastMessageOnAuthError: false, // whether to open/show a snackbar message on auth error - default : true
                  authGuardFallbackURL: '/loggedout', // url for unauthenticated users - to use in combination with canActivate feature on a route
                  authGuardLoggedInURL: '/loggedin', // url for authenticated users - to use in combination with canActivate feature on a route
                  passwordMaxLength: 60, // `min/max` input parameters in components should be within this range.
                  passwordMinLength: 8, // Password length min/max in forms independently of each componenet min/max.
                  // Same as password but for the name
                  nameMaxLength: 50,
                  nameMinLength: 2,
                  // If set, sign-in/up form is not available until email has been verified.
                  // Plus protected routes are still protected even though user is connected.
                  guardProtectedRoutesUntilEmailIsVerified: true,
                  enableEmailVerification: true, // default: true
                  useRawUserCredential: true, // If set to true outputs the UserCredential object instead of firebase.User after login and signup - Default: false
                }),
  ],
  providers: [],
  bootstrap: [AppComponent]
})
export class AppModule { }

(3) Usage

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

`<ngx-auth-firebaseui></ngx-auth-firebaseui>` see the usage

`<ngx-auth-firebaseui-login></ngx-auth-firebaseui-login>` see the usage

`<ngx-auth-firebaseui-register></ngx-auth-firebaseui-register>` see the usage

`<ngx-auth-firebaseui-providers></ngx-auth-firebaseui-providers>` see the usage

`<ngx-auth-firebaseui-user></ngx-auth-firebaseui-user>` see the usage

`<ngx-auth-firebaseui-avatar></ngx-auth-firebaseui-avatar>` see the usage

API

`<ngx-auth-firebaseui></ngx-auth-firebaseui>` see the api

`<ngx-auth-firebaseui-login></ngx-auth-firebaseui-login>` see the api

`<ngx-auth-firebaseui-register></ngx-auth-firebaseui-register>` see the api

`<ngx-auth-firebaseui-providers></ngx-auth-firebaseui-providers>` see the api

`<ngx-auth-firebaseui-user></ngx-auth-firebaseui-user>` see the api

`<ngx-auth-firebaseui-avatar></ngx-auth-firebaseui-avatar>` see the api

EXTRA TIP: Login Authentication Guard

If you want to prevent a route to be accessed from non authorized users, you can use a built in LoggedInGuard angular router guard.

enter the fallback url in the NgxAuthFirebaseUIConfig under authGuardFallbackURL
enter the logged in url in the NgxAuthFirebaseUIConfig under authGuardLoggedInURL

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


NgxAuthFirebaseUIModule.forRoot(firebaseKey, firebaseAppNameFactory,
    {
      authGuardFallbackURL: 'examples/logged-out',
      authGuardLoggedInURL: 'examples/logged-in',
    }),

if the user is logged in, he will be redirected to examples/logged-in route (per example), otherwise he will be redirected to the examples/logged-out route

import the LoggedInGuard in your router module

import {NgModule} from '@angular/core';
import {Routes, RouterModule} from '@angular/router';

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

const routes: Routes = [
  {
    path: '',
    redirectTo: 'home',
    pathMatch: 'full'
  },
  {
    path: 'secured',
    loadChildren: 'app/secured/secured.module#SecuredModule',
    canActivate: [LoggedInGuard]
  }
];

@NgModule({
  imports: [RouterModule.forRoot(routes)],
  exports: [RouterModule]
})
export class AppRoutingModule {
}

Other Angular Libraries

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:

Youtube Videos

https://www.youtube.com/watch?v=qP5zw7fjQgo&feature=emb_logo&ab_channel=Fireship https://www.youtube.com/watch?v=KpfJCEvpS9g&t=2s&ab_channel=JsWiz

Who is using ngx-mailto? Awesome apps?

Nahaus.de

Are you missing your project or you app? PR me to publish it on the README