FirebaseUI es una biblioteca creada sobre el SDK de autenticación de Firebase que proporciona flujos de interfaz de usuario directos para usar en su aplicación. FirebaseUI proporciona los siguientes beneficios:
- Múltiples proveedores : flujos de inicio de sesión para correo electrónico/contraseña, enlace de correo electrónico, autenticación telefónica, inicio de sesión en Google, Facebook, Twitter y GitHub.
- Vinculación de cuentas : fluye para vincular de forma segura cuentas de usuarios entre proveedores de identidad.
- Personalización : anule los estilos CSS de FirebaseUI para que coincidan con los requisitos de su aplicación. Además, como FirebaseUI es de código abierto, puedes bifurcar el proyecto y personalizarlo exactamente según tus necesidades.
- Registro con un toque e inicio de sesión automático : integración automática con el registro con un toque para un inicio de sesión rápido entre dispositivos.
- UI localizada : internacionalización para más de 40 idiomas .
- Actualización de usuarios anónimos : capacidad de actualizar usuarios anónimos mediante el inicio de sesión/registro. Para obtener más información, visita la sección Actualización de usuarios anónimos .
Antes de que empieces
Agregue Firebase Authentication a su aplicación web y asegúrese de utilizar el SDK compatible con v9 (recomendado) o anterior (consulte la barra lateral arriba).
Incluya FirebaseUI a través de una de las siguientes opciones:
CDN
Incluye el siguiente script y archivo CSS en la etiqueta <head> de tu página, debajo del fragmento de inicialización de Firebase Console:
<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" />
módulo npm
Instale FirebaseUI y sus dependencias a través de npm usando el siguiente comando:
$ npm install firebaseui --save
require
los siguientes módulos dentro de sus archivos fuente:var firebase = require('firebase'); var firebaseui = require('firebaseui');
Componente de glorieta
Instale FirebaseUI y sus dependencias a través de Bower usando el siguiente comando:
$ bower install firebaseui --save
Incluya los archivos requeridos en su HTML, si su servidor HTTP sirve los archivos dentro de
bower_components/
:<script src="bower_components/firebaseui/dist/firebaseui.js"></script> <link type="text/css" rel="stylesheet" href="bower_components/firebaseui/dist/firebaseui.css" />
Inicializar FirebaseUI
Después de importar el SDK, inicialice la interfaz de usuario de autenticación.
// Initialize the FirebaseUI Widget using Firebase.
var ui = new firebaseui.auth.AuthUI(firebase.auth());
Configurar métodos de inicio de sesión
Antes de poder usar Firebase para iniciar sesión en los usuarios, debes habilitar y configurar los métodos de inicio de sesión que deseas admitir.
Dirección de correo electrónico y contraseña
En Firebase console , abra la sección Autenticación y habilite la autenticación de correo electrónico y contraseña.
Agregue el ID del proveedor de correo electrónico a la lista de
signInOptions
de FirebaseUI.ui.start('#firebaseui-auth-container', { signInOptions: [ firebase.auth.EmailAuthProvider.PROVIDER_ID ], // Other config options... });
Opcional :
EmailAuthProvider
se puede configurar para requerir que el usuario ingrese un nombre para mostrar (el valor predeterminado estrue
).ui.start('#firebaseui-auth-container', { signInOptions: [ { provider: firebase.auth.EmailAuthProvider.PROVIDER_ID, requireDisplayName: false } ] });
Autenticación de enlace de correo electrónico
En Firebase console , abre la sección Autenticación . En la pestaña Método de inicio de sesión , habilite el proveedor de correo electrónico/contraseña . Tenga en cuenta que el inicio de sesión por correo electrónico/contraseña debe estar habilitado para utilizar el inicio de sesión mediante enlace de correo electrónico.
En la misma sección, habilite el método de inicio de sesión mediante enlace de correo electrónico (inicio de sesión sin contraseña) y haga clic en Guardar .
Agregue el ID del proveedor de correo electrónico a la lista de
signInOptions
de FirebaseUI junto con el enlace de correo electrónicosignInMethod
.ui.start('#firebaseui-auth-container', { signInOptions: [ { provider: firebase.auth.EmailAuthProvider.PROVIDER_ID, signInMethod: firebase.auth.EmailAuthProvider.EMAIL_LINK_SIGN_IN_METHOD } ], // Other config options... });
Al representar la interfaz de usuario de inicio de sesión de forma condicional (relevante para aplicaciones de una sola página), use
ui.isPendingRedirect()
para detectar si la URL corresponde a un inicio de sesión con un enlace de correo electrónico y la interfaz de usuario debe representarse para completar el inicio de sesión.// 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); }
Opcional :
EmailAuthProvider
para el inicio de sesión mediante enlace de correo electrónico se puede configurar para permitir o impedir que el usuario complete el inicio de sesión entre dispositivos.Se puede definir una devolución de llamada
emailLinkSignIn
opcional para devolver la configuraciónfirebase.auth.ActionCodeSettings
que se usará al enviar el enlace. Esto proporciona la capacidad de especificar cómo se puede manejar el enlace, enlace dinámico personalizado, estado adicional en el enlace profundo, etc. Cuando no se proporciona, se utiliza la URL actual y se activa un flujo solo web.El inicio de sesión con enlace de correo electrónico en FirebaseUI-web es compatible con FirebaseUI-Android y FirebaseUI-iOS , donde un usuario que inicia el flujo desde FirebaseUI-Android puede abrir el enlace y completar el inicio de sesión con FirebaseUI-web. Lo mismo ocurre con el flujo opuesto.
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' } }; } } ] });
Proveedores de OAuth (Google, Facebook, Twitter y GitHub)
En Firebase console , abra la sección Autenticación y habilite el inicio de sesión del proveedor de OAuth especificado. Asegúrese de que también se especifiquen el ID y el secreto del cliente OAuth correspondiente.
También en la sección Autenticación , asegúrese de que el dominio donde se mostrará su página de inicio de sesión también esté agregado a la lista de dominios autorizados.
Agregue el ID del proveedor de OAuth a la lista de
signInOptions
de FirebaseUI.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... });
Opcional : para especificar ámbitos personalizados o parámetros OAuth personalizados por proveedor, puede pasar un objeto en lugar de solo el valor del proveedor:
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. ] });
Número de teléfono
En Firebase console , abra la sección Autenticación y habilite el inicio de sesión con número de teléfono.
Asegúrese de que el dominio donde se mostrará su página de inicio de sesión también esté agregado a la lista de dominios autorizados.
Agregue el ID del proveedor del número de teléfono a la lista de
signInOptions
de FirebaseUI.ui.start('#firebaseui-auth-container', { signInOptions: [ firebase.auth.PhoneAuthProvider.PROVIDER_ID ], // Other config options... });
Opcional : PhoneAuthProvider se puede configurar con parámetros reCAPTCHA personalizados, ya sea que reCAPTCHA sea visible o invisible (el valor predeterminado es normal). Consulte los documentos de la API reCAPTCHA para obtener más detalles.
También se puede configurar el país predeterminado para seleccionar en la entrada del número de teléfono. Consulte la lista de códigos de países admitidos para obtener la lista completa de códigos. Si no se especifica, la entrada del número de teléfono será predeterminada para los Estados Unidos (+1).
Actualmente se admiten las siguientes opciones.
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' } ] });
Iniciar sesión
Para iniciar el flujo de inicio de sesión de FirebaseUI, inicialice la instancia de FirebaseUI pasando la instancia Auth
subyacente.
// Initialize the FirebaseUI Widget using Firebase.
var ui = new firebaseui.auth.AuthUI(firebase.auth());
Defina el elemento HTML donde se representará el widget de inicio de sesión de FirebaseUI.
<!-- 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>
Especifique la configuración de FirebaseUI (proveedores admitidos y personalizaciones de la interfaz de usuario, así como devoluciones de llamada exitosas, etc.).
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>'
};
Finalmente, renderice la interfaz de autenticación de FirebaseUI:
// The start method will wait until the DOM is loaded.
ui.start('#firebaseui-auth-container', uiConfig);
Actualización de usuarios anónimos
Habilitar la actualización de usuarios anónimos
Cuando un usuario anónimo inicia sesión o se registra con una cuenta permanente, desea asegurarse de que el usuario pueda continuar con lo que estaba haciendo antes de registrarse. Para hacerlo, simplemente establezca autoUpgradeAnonymousUsers
en true
cuando configure la interfaz de usuario de inicio de sesión (esta opción está deshabilitada de forma predeterminada).
Manejo de conflictos de fusión de actualizaciones de usuarios anónimos
Hay casos en los que un usuario, que inicialmente inició sesión de forma anónima, intenta actualizar a un usuario de Firebase existente. Dado que un usuario existente no puede vincularse a otro usuario existente, FirebaseUI activará la devolución de llamada signInFailure
con un código de error firebaseui/anonymous-upgrade-merge-conflict
cuando ocurra lo anterior. El objeto de error también contendrá la credencial permanente. El inicio de sesión con la credencial permanente debe activarse en la devolución de llamada para completar el inicio de sesión. Antes de poder completar el inicio de sesión a través de auth.signInWithCredential(error.credential)
, debe guardar los datos del usuario anónimo y eliminarlo. Luego, una vez completado el inicio de sesión, copie los datos nuevamente al usuario no anónimo. Un ejemplo a continuación ilustra cómo funcionaría este flujo.
// 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);
}
}
});
Próximos pasos
- Para obtener más información sobre el uso y la personalización de FirebaseUI, visite el archivo README .
- Si encuentra un problema en FirebaseUI y desea informarlo, utilice el rastreador de problemas de GitHub .