SignupId

Describe los hooks y métodos disponibles para personalizar la pantalla signup-id de Universal Login.

La pantalla signup-id solicita el identificador del usuario —como el correo electrónico, el username o el número de teléfono— como primer paso de un flujo de registro de varios pasos. También admite el registro federado mediante conexiones sociales o empresariales.

​

Importación

Cada pantalla tiene su propio conjunto de hooks y métodos. El SDK admite importación parcial e importación desde la raíz para cada pantalla.

• La importación parcial le permite incluir solo el código que necesita para su caso de uso concreto.
• La importación desde la raíz le permite cargar todas las pantallas desde un único paquete, lo que resulta útil cuando necesita una compilación unificada para gestionar todas las pantallas posibles.

Import Example

// importación desde la raíz
import { useSignupId } from '@auth0/auth0-acul-react';

// importación parcial
import {
  useSignupId,
  // Hooks de contexto
  useUser,
  useTenant,
  useBranding,
  useClient,
  useOrganization,
  usePrompt,
  useScreen,
  useTransaction,
  useUntrustedData,
  // Hooks comunes
  useCurrentScreen,
  useAuth0Themes,
  useErrors,
  // Hooks de utilidad
  useChangeLanguage,
  useSignupIdentifiers,
  useUsernameValidation,
  // Métodos
  signup,
  federatedSignup,
  pickCountryCode,
} from '@auth0/auth0-acul-react/signup-id';

function SignupIdForm() {
  const { signup } = useSignupId();
  return (
    <button onClick={() => signup({ email: '[e-mail]' })}>
      Continue
    </button>
  );
}

​

Hooks de contexto

Hooks con alcance de pantalla que proporcionan acceso de solo lectura a los datos de contexto de Auth0 en la pantalla signup-id. Impórtelos desde @auth0/auth0-acul-react/signup-id.

useBranding · () => BrandingMembers

Este hook proporciona configuraciones de marca, como el logotipo, los colores y los ajustes del tema que se muestran en la pantalla signup-id.

Example

import { useBranding } from '@auth0/auth0-acul-react/signup-id';
function CustomTheme() {
  const branding = useBranding();
}

useClient · () => ClientMembers

Este hook proporciona datos relacionados con el cliente, como id, name y logoUrl, para la pantalla signup-id.

Example

import { useClient } from '@auth0/auth0-acul-react/signup-id';
function AppInfo() {
  const client = useClient();
}

useOrganization · () => OrganizationMembers

Este hook proporciona información sobre la Organización del usuario si el registro está asociado a una Organización. Devuelve null cuando no hay contexto de Organización.

Example

import { useOrganization } from '@auth0/auth0-acul-react/signup-id';
function OrgSelector() {
  const organization = useOrganization();
  if (!organization) {
    return <p>Sin contexto de organización</p>;
  }
}

usePrompt · () => PromptMembers

Este hook contiene datos sobre la pantalla actual en el flujo de autenticación.

Example

import { usePrompt } from '@auth0/auth0-acul-react/signup-id';
function FlowInfo() {
  const prompt = usePrompt();
}

useScreen · () => ScreenMembersOnSignupId

Este hook contiene detalles específicos de la pantalla signup-id, incluida su configuración y contexto.

Example

import { useScreen } from '@auth0/auth0-acul-react/signup-id';
function ScreenDebug() {
  const screen = useScreen();
}

useTenant · () => TenantMembers

Este hook contiene datos relacionados con el inquilino, como id y los metadatos asociados.

Example

import { useTenant } from '@auth0/auth0-acul-react/signup-id';
function TenantInfo() {
  const tenant = useTenant();
}

useTransaction · () => TransactionMembersOnSignupId

Este hook proporciona datos específicos de la transacción para la pantalla signup-id, como las conexiones activas y el estado actual del flujo.

Example

import { useTransaction } from '@auth0/auth0-acul-react/signup-id';
function TransactionInfo() {
  const transaction = useTransaction();
}

useUntrustedData · () => UntrustedDataMembers

Este hook proporciona acceso a los datos no confiables que se pasan a la pantalla, como un correo electrónico o un username rellenado previamente a partir de parámetros de URL.

Example

import { useUntrustedData } from '@auth0/auth0-acul-react/signup-id';
function PrefilledForm() {
  const untrustedData = useUntrustedData();
}

useUser · () => UserMembers

Este hook ofrece información del usuario actual, incluidos username, email y los métodos de autenticación disponibles.

Example

import { useUser } from '@auth0/auth0-acul-react/signup-id';
function UserProfile() {
  const user = useUser();
}

useSignupId · SignupIdMembers

Este hook devuelve todos los métodos y el contexto disponibles en la pantalla signup-id.

​

Métodos

federatedSignup · Promise<void>

Este método inicia el registro mediante un proveedor de identidad federado, como Google o GitHub.

Example

import { useSignupId } from '@auth0/auth0-acul-react/signup-id';

function SocialButton() {
  const { federatedSignup } = useSignupId();
  return (
    <button onClick={() => federatedSignup({ connection: 'google-oauth2' })}>
      Sign up with Google
    </button>
  );
}

Parámetros del método

Mostrar Parámetros

options

FederatedSignupOptions.

connection · string · requerido

El nombre de la conexión social o empresarial que se va a usar (por ejemplo, google-oauth2, github).

pickCountryCode · Promise<void>

Este método abre el selector de código de país para introducir el número de teléfono durante el registro.

Example

import { useSignupId } from '@auth0/auth0-acul-react/signup-id';

function CountryCodePicker() {
  const { pickCountryCode } = useSignupId();
  return (
    <button onClick={() => pickCountryCode()}>
      Select Country Code
    </button>
  );
}

Parámetros del método

Mostrar Parámetros

options

CustomOptions.

[`key`: `string`] · "string" | "number" | "boolean" | "undefined"

Campos personalizados adicionales con el prefijo ulp- (por ejemplo, 'ulp-custom-field').

signup · Promise<void>

Este método envía el identificador del usuario para pasar al siguiente paso del flujo de registro.

Example

import { useSignupId } from '@auth0/auth0-acul-react/signup-id';

function SignupIdForm() {
  const { signup } = useSignupId();
  return (
    <button onClick={() => signup({ email: '[e-mail]' })}>
      Continue
    </button>
  );
}

Parámetros del método

Mostrar Parámetros

options

SignupOptions.

email · string

La dirección de correo electrónico del usuario.

username · string

El username de la cuenta nueva, si la conexión lo requiere.

phone · string

El número de teléfono del usuario, si la conexión lo requiere.

captcha? · string

Valor de captcha obligatorio cuando la detección de bots está habilitada en el inquilino.

[`key`: `string`] · "string" | "number" | "boolean" | "undefined"

Campos personalizados adicionales con el prefijo ulp- (por ejemplo, 'ulp-custom-field').

​

Hooks comunes/de utilidad

useAuth0Themes · Hooks

Este hook obtiene las opciones del tema actual con la configuración aplanada del contexto de marca.

useChangeLanguage · Hooks

Este hook devuelve una función para cambiar el idioma mostrado en la pantalla actual de ACUL.

useCurrentScreen · Hooks

Este hook obtiene el contexto y el estado de la pantalla actual.

useErrors · Hooks

Este hook lee y administra los errores del servidor, del cliente y del desarrollador en la pantalla.

useSignupIdentifiers · Hooks

Este hook devuelve los tipos de identificadores de registro disponibles (email, username, phone) configurados para la conexión.

useUsernameValidation · Hooks

Este hook valida el username del usuario según los requisitos de la política de username del inquilino.