Mit FirebaseUI ganz einfach Anmeldeinformationen zu Ihrer Webanwendung hinzufügen

FirebaseUI ist eine Bibliothek, die auf dem Firebase Authentication SDK basiert und Drop-in-UI-Abläufe für die Verwendung in Ihrer App bietet. FirebaseUI bietet folgende Vorteile:

  • Mehrere Anbieter: Anmeldeabläufe für E-Mail/Passwort, E-Mail-Link, Telefonauthentifizierung, Google, Facebook, Twitter und GitHub.
  • Kontoverknüpfung: Abläufe zum sicheren Verknüpfen von Nutzerkonten über Identitätsanbieter hinweg.
  • Anpassung: CSS-Stile von FirebaseUI können überschrieben werden, um sie an die Anforderungen Ihrer App anzupassen. Da FirebaseUI Open Source ist, können Sie das Projekt auch forken und genau an Ihre Anforderungen anpassen.
  • Registrierung und automatische Anmeldung mit One Tap: Automatische Integration mit der Registrierung mit One Tap für eine schnelle geräteübergreifende Anmeldung.
  • Lokalisierte Benutzeroberfläche: Internationalisierung für über 40 Sprachen.
  • Upgrade für anonyme Nutzer: Es ist möglich, anonyme Nutzer durch Anmeldung bzw. Registrierung zu einem Upgrade zu bewegen. Weitere Informationen finden Sie im Abschnitt Anonyme Nutzer aktualisieren.

Hinweis

  1. Fügen Sie Ihrer Webanwendung Firebase Authentication hinzu. Verwenden Sie dabei die API mit Version 9 oder höher (nicht die modulare API; siehe Seitenleiste oben).

  2. Fügen Sie FirebaseUI über eine der folgenden Optionen ein:

    1. CDN

      Fügen Sie die folgende Skript- und CSS-Datei auf Ihrer Seite in das Tag <head> unterhalb des Initialisierungs-Snippets aus der Firebase Console ein:

      <script src="https://www.gstatic.com/firebasejs/ui/6.0.1/firebase-ui-auth.js"></script>
<link type="text/css" rel="stylesheet" href="https://www.gstatic.com/firebasejs/ui/6.0.1/firebase-ui-auth.css" />

    2. npm-Modul

      Installieren Sie FirebaseUI und die zugehörigen Abhängigkeiten über npm mit dem folgenden Befehl:

      $ npm install firebaseui --save

      require die folgenden Module in Ihren Quelldateien:

      var firebase = require('firebase');
var firebaseui = require('firebaseui');

    3. Bower-Komponente

      Installieren Sie FirebaseUI und die zugehörigen Abhängigkeiten über Bower mit dem folgenden Befehl:

      $ bower install firebaseui --save

      Fügen Sie die erforderlichen Dateien in Ihre HTML-Datei ein, wenn Ihr HTTP-Server die Dateien innerhalb von bower_components/ bereitstellt:

      <script src="bower_components/firebaseui/dist/firebaseui.js"></script>
<link type="text/css" rel="stylesheet" href="bower_components/firebaseui/dist/firebaseui.css" />

FirebaseUI initialisieren

Nachdem Sie das SDK importiert haben, initialisieren Sie die Auth-Benutzeroberfläche.

// Initialize the FirebaseUI Widget using Firebase.
var ui = new firebaseui.auth.AuthUI(firebase.auth());

Anmeldemethoden einrichten

Bevor Sie Nutzer über Firebase anmelden können, müssen Sie die Anmeldemethoden aktivieren und konfigurieren, die Sie unterstützen möchten.

E-Mail-Adresse und Passwort

  1. Öffnen Sie in der Firebase Console den Bereich Authentifizierung und aktivieren Sie die E-Mail- und Passwort-Authentifizierung.

  2. Fügen Sie die E-Mail-Anbieter-ID der Liste der FirebaseUI-signInOptions hinzu.

    ui.start('#firebaseui-auth-container', {
  signInOptions: [
    firebase.auth.EmailAuthProvider.PROVIDER_ID
  ],
  // Other config options...
});

  3. Optional: Die EmailAuthProvider kann so konfiguriert werden, dass der Nutzer einen Anzeigenamen eingeben muss (Standard ist true).

    ui.start('#firebaseui-auth-container', {
  signInOptions: [
    {
      provider: firebase.auth.EmailAuthProvider.PROVIDER_ID,
      requireDisplayName: false
    }
  ]
});

  1. Öffnen Sie in der Firebase Console den Bereich Authentifizierung. Aktivieren Sie auf dem Tab Anmeldemethode den Anbieter E-Mail/Passwort. Hinweis: Die Anmeldung per E-Mail/Passwort muss aktiviert sein, damit die Anmeldung über einen E-Mail-Link verwendet werden kann.

  2. Aktivieren Sie im selben Abschnitt die Anmeldemethode E-Mail-Link (Anmeldung ohne Passwort) und klicken Sie auf Speichern.

  3. Fügen Sie der Liste der FirebaseUI-signInOptions-E-Mail-Anbieter-IDs den E-Mail-LinksignInMethod hinzu.

    ui.start('#firebaseui-auth-container', {
  signInOptions: [
    {
      provider: firebase.auth.EmailAuthProvider.PROVIDER_ID,
      signInMethod: firebase.auth.EmailAuthProvider.EMAIL_LINK_SIGN_IN_METHOD
    }
  ],
  // Other config options...
});

  4. Wenn die Anmelde-UI bedingt gerendert werden soll (relevant für Single-Page-Apps), kannst du mit ui.isPendingRedirect() erkennen, ob die URL einer Anmeldung mit E-Mail-Link entspricht und die UI gerendert werden muss, um die Anmeldung abzuschließen.

    // Is there an email link sign-in?
if (ui.isPendingRedirect()) {
  ui.start('#firebaseui-auth-container', uiConfig);
}
// This can also be done via:
if (firebase.auth().isSignInWithEmailLink(window.location.href)) {
  ui.start('#firebaseui-auth-container', uiConfig);
}

  5. Optional: Die EmailAuthProvider für die Anmeldung über einen E-Mail-Link kann so konfiguriert werden, dass die geräteübergreifende Anmeldung für den Nutzer zugelassen oder blockiert wird.

    Optional kann ein emailLinkSignIn-Callback definiert werden, um die firebase.auth.ActionCodeSettings-Konfiguration zurückzugeben, die beim Senden des Links verwendet werden soll. So können Sie unter anderem festlegen, wie der Link verarbeitet werden soll, einen benutzerdefinierten dynamischen Link und einen zusätzlichen Status im Deeplink angeben. Wenn Sie diese Informationen nicht angeben, wird die aktuelle URL verwendet und ein Web-Flow ausgelöst.

    Die Anmeldung über den E-Mail-Link in FirebaseUI-Web ist mit FirebaseUI-Android und FirebaseUI-iOS kompatibel. Ein Nutzer, der den Ablauf über FirebaseUI-Android startet, kann den Link öffnen und sich über FirebaseUI-Web anmelden. Das gilt auch für den umgekehrten Fluss.

    ui.start('#firebaseui-auth-container', {
  signInOptions: [
    {
      provider: firebase.auth.EmailAuthProvider.PROVIDER_ID,
      signInMethod: firebase.auth.EmailAuthProvider.EMAIL_LINK_SIGN_IN_METHOD,
      // Allow the user the ability to complete sign-in cross device,
      // including the mobile apps specified in the ActionCodeSettings
      // object below.
      forceSameDevice: false,
      // Used to define the optional firebase.auth.ActionCodeSettings if
      // additional state needs to be passed along request and whether to open
      // the link in a mobile app if it is installed.
      emailLinkSignIn: function() {
        return {
          // Additional state showPromo=1234 can be retrieved from URL on
          // sign-in completion in signInSuccess callback by checking
          // window.location.href.
          url: 'https://www.example.com/completeSignIn?showPromo=1234',
          // Custom FDL domain.
          dynamicLinkDomain: 'example.page.link',
          // Always true for email link sign-in.
          handleCodeInApp: true,
          // Whether to handle link in iOS app if installed.
          iOS: {
            bundleId: 'com.example.ios'
          },
          // Whether to handle link in Android app if opened in an Android
          // device.
          android: {
            packageName: 'com.example.android',
            installApp: true,
            minimumVersion: '12'
          }
        };
      }
    }
  ]
});

OAuth-Anbieter (Google, Facebook, Twitter und GitHub)

  1. Öffnen Sie in der Firebase Console den Bereich Authentifizierung und aktivieren Sie die Anmeldung über den angegebenen OAuth-Anbieter. Die entsprechende OAuth-Client-ID und das entsprechende Secret müssen ebenfalls angegeben werden.

  2. Achten Sie außerdem darauf, dass die Domain, auf der Ihre Anmeldeseite gerendert wird, im Bereich Authentifizierung der Liste der autorisierten Domains hinzugefügt wird.

  3. Fügen Sie die OAuth-Anbieter-ID der Liste der FirebaseUI-signInOptions hinzu.

    ui.start('#firebaseui-auth-container', {
  signInOptions: [
    // List of OAuth providers supported.
    firebase.auth.GoogleAuthProvider.PROVIDER_ID,
    firebase.auth.FacebookAuthProvider.PROVIDER_ID,
    firebase.auth.TwitterAuthProvider.PROVIDER_ID,
    firebase.auth.GithubAuthProvider.PROVIDER_ID
  ],
  // Other config options...
});

  4. Optional: Wenn Sie benutzerdefinierte Gültigkeitsbereiche oder benutzerdefinierte OAuth-Parameter pro Anbieter angeben möchten, können Sie ein Objekt anstelle des Anbieterwerts übergeben:

    ui.start('#firebaseui-auth-container', {
  signInOptions: [
    {
      provider: firebase.auth.GoogleAuthProvider.PROVIDER_ID,
      scopes: [
        'https://www.googleapis.com/auth/contacts.readonly'
      ],
      customParameters: {
        // Forces account selection even when one account
        // is available.
        prompt: 'select_account'
      }
    },
    {
      provider: firebase.auth.FacebookAuthProvider.PROVIDER_ID,
      scopes: [
        'public_profile',
        'email',
        'user_likes',
        'user_friends'
      ],
      customParameters: {
        // Forces password re-entry.
        auth_type: 'reauthenticate'
      }
    },
    firebase.auth.TwitterAuthProvider.PROVIDER_ID, // Twitter does not support scopes.
    firebase.auth.EmailAuthProvider.PROVIDER_ID // Other providers don't need to be given as object.
  ]
});

Telefonnummer

  1. Öffnen Sie in der Firebase-Konsole den Bereich Authentifizierung und aktivieren Sie die Anmeldung per Telefonnummer.

  2. Achten Sie darauf, dass die Domain, auf der Ihre Anmeldeseite gerendert wird, ebenfalls der Liste der autorisierten Domains hinzugefügt wird.

  3. Fügen Sie die Telefonnummernanbieter-ID der Liste der FirebaseUI-signInOptions hinzu.

    ui.start('#firebaseui-auth-container', {
  signInOptions: [
    firebase.auth.PhoneAuthProvider.PROVIDER_ID
  ],
  // Other config options...
});

  4. Optional: Der PhoneAuthProvider kann mit benutzerdefinierten reCAPTCHA-Parametern konfiguriert werden, unabhängig davon, ob reCAPTCHA sichtbar oder unsichtbar ist (Standardeinstellung: normal). Weitere Informationen finden Sie in der reCAPTCHA API-Dokumentation.

    Sie können auch das Standardland festlegen, das in der Eingabemaske für Telefonnummern ausgewählt werden soll. Eine vollständige Liste der unterstützten Ländercodes findest du unter Liste der unterstützten Ländercodes. Wenn keine Angabe gemacht wird, wird die Telefonnummer standardmäßig für die USA (+1) eingegeben.

    Derzeit werden die folgenden Optionen unterstützt.

    ui.start('#firebaseui-auth-container', {
  signInOptions: [
    {
      provider: firebase.auth.PhoneAuthProvider.PROVIDER_ID,
      recaptchaParameters: {
        type: 'image', // 'audio'
        size: 'normal', // 'invisible' or 'compact'
        badge: 'bottomleft' //' bottomright' or 'inline' applies to invisible.
      },
      defaultCountry: 'GB', // Set default country to the United Kingdom (+44).
      // For prefilling the national number, set defaultNationNumber.
      // This will only be observed if only phone Auth provider is used since
      // for multiple providers, the NASCAR screen will always render first
      // with a 'sign in with phone number' button.
      defaultNationalNumber: '1234567890',
      // You can also pass the full phone number string instead of the
      // 'defaultCountry' and 'defaultNationalNumber'. However, in this case,
      // the first country ID that matches the country code will be used to
      // populate the country selector. So for countries that share the same
      // country code, the selected country may not be the expected one.
      // In that case, pass the 'defaultCountry' instead to ensure the exact
      // country is selected. The 'defaultCountry' and 'defaultNationaNumber'
      // will always have higher priority than 'loginHint' which will be ignored
      // in their favor. In this case, the default country will be 'GB' even
      // though 'loginHint' specified the country code as '+1'.
      loginHint: '+11234567890'
    }
  ]
});

Anmelden

Um den FirebaseUI-Anmeldevorgang zu starten, initialisieren Sie die FirebaseUI-Instanz, indem Sie die zugrunde liegende Auth-Instanz übergeben.

// Initialize the FirebaseUI Widget using Firebase.
var ui = new firebaseui.auth.AuthUI(firebase.auth());

Definieren Sie das HTML-Element, in dem das FirebaseUI-Anmelde-Widget gerendert werden soll.

<!-- The surrounding HTML is left untouched by FirebaseUI.
     Your app may use that space for branding, controls and other customizations.-->
<h1>Welcome to My Awesome App</h1>
<div id="firebaseui-auth-container"></div>
<div id="loader">Loading...</div>

Geben Sie die FirebaseUI-Konfiguration an (unterstützte Anbieter, UI-Anpassungen und Erfolgs-Callbacks usw.).

var uiConfig = {
  callbacks: {
    signInSuccessWithAuthResult: function(authResult, redirectUrl) {
      // User successfully signed in.
      // Return type determines whether we continue the redirect automatically
      // or whether we leave that to developer to handle.
      return true;
    },
    uiShown: function() {
      // The widget is rendered.
      // Hide the loader.
      document.getElementById('loader').style.display = 'none';
    }
  },
  // Will use popup for IDP Providers sign-in flow instead of the default, redirect.
  signInFlow: 'popup',
  signInSuccessUrl: '<url-to-redirect-to-on-success>',
  signInOptions: [
    // Leave the lines as is for the providers you want to offer your users.
    firebase.auth.GoogleAuthProvider.PROVIDER_ID,
    firebase.auth.FacebookAuthProvider.PROVIDER_ID,
    firebase.auth.TwitterAuthProvider.PROVIDER_ID,
    firebase.auth.GithubAuthProvider.PROVIDER_ID,
    firebase.auth.EmailAuthProvider.PROVIDER_ID,
    firebase.auth.PhoneAuthProvider.PROVIDER_ID
  ],
  // Terms of service url.
  tosUrl: '<your-tos-url>',
  // Privacy policy url.
  privacyPolicyUrl: '<your-privacy-policy-url>'
};

Rendern Sie abschließend die FirebaseUI Auth-Benutzeroberfläche:

// The start method will wait until the DOM is loaded.
ui.start('#firebaseui-auth-container', uiConfig);

Anonyme Nutzer upgraden

Upgrade für anonyme Nutzer aktivieren

Wenn sich ein anonymer Nutzer mit einem dauerhaften Konto anmeldet oder registriert, sollte er dort weitermachen können, wo er vor der Registrierung aufgehört hat. Legen Sie dazu einfach autoUpgradeAnonymousUsers auf true fest, wenn Sie die Anmeldeoberfläche konfigurieren. Diese Option ist standardmäßig deaktiviert.

Umgang mit Konflikten beim Zusammenführen von Upgrades für anonyme Nutzer

Es kann vorkommen, dass ein Nutzer, der sich ursprünglich anonym angemeldet hat, ein Upgrade auf ein bestehendes Firebase-Konto durchführen möchte. Da ein vorhandener Nutzer nicht mit einem anderen vorhandenen Nutzer verknüpft werden kann, löst FirebaseUI in diesem Fall den signInFailure-Callback mit dem Fehlercode firebaseui/anonymous-upgrade-merge-conflict aus. Das Fehlerobjekt enthält auch die dauerhaften Anmeldedaten. Die Anmeldung mit den dauerhaften Anmeldedaten sollte im Callback ausgelöst werden, um die Anmeldung abzuschließen. Bevor die Anmeldung über auth.signInWithCredential(error.credential) abgeschlossen werden kann, müssen Sie die Daten des anonymen Nutzers speichern und den anonymen Nutzer löschen. Kopieren Sie die Daten nach Abschluss der Anmeldung wieder auf den nicht anonymen Nutzer. Im folgenden Beispiel wird veranschaulicht, wie dieser Ablauf funktioniert.

// Temp variable to hold the anonymous user data if needed.
var data = null;
// Hold a reference to the anonymous current user.
var anonymousUser = firebase.auth().currentUser;
ui.start('#firebaseui-auth-container', {
  // Whether to upgrade anonymous users should be explicitly provided.
  // The user must already be signed in anonymously before FirebaseUI is
  // rendered.
  autoUpgradeAnonymousUsers: true,
  signInSuccessUrl: '<url-to-redirect-to-on-success>',
  signInOptions: [
    firebase.auth.GoogleAuthProvider.PROVIDER_ID,
    firebase.auth.FacebookAuthProvider.PROVIDER_ID,
    firebase.auth.EmailAuthProvider.PROVIDER_ID,
    firebase.auth.PhoneAuthProvider.PROVIDER_ID
  ],
  callbacks: {
    // signInFailure callback must be provided to handle merge conflicts which
    // occur when an existing credential is linked to an anonymous user.
    signInFailure: function(error) {
      // For merge conflicts, the error.code will be
      // 'firebaseui/anonymous-upgrade-merge-conflict'.
      if (error.code != 'firebaseui/anonymous-upgrade-merge-conflict') {
        return Promise.resolve();
      }
      // The credential the user tried to sign in with.
      var cred = error.credential;
      // Copy data from anonymous user to permanent user and delete anonymous
      // user.
      // ...
      // Finish sign-in after data is copied.
      return firebase.auth().signInWithCredential(cred);
    }
  }
});

Nächste Schritte

  • Weitere Informationen zur Verwendung und Anpassung von FirebaseUI finden Sie in der README-Datei.
  • Wenn Sie ein Problem mit FirebaseUI finden und melden möchten, verwenden Sie den GitHub-Issue-Tracker.