Signup

Décrit tous les hooks et les méthodes offerts pour personnaliser l’écran signup de Universal Login.

L’écran signup recueille les identifiants de l’utilisateur pour créer un nouveau compte. Il prend en charge le Signup standard avec nom d’utilisateur, courriel, numéro de téléphone et mot de passe, ainsi que le Signup fédéré par l’entremise de connexions sociales ou d’entreprise et Google One Tap.

​

Importation

Chaque écran a son propre ensemble de hooks et de méthodes. Le SDK prend en charge l’importation partielle et l’importation racine pour chaque écran.

• L’importation partielle vous permet d’inclure uniquement le code nécessaire à votre cas d’utilisation.
• L’importation racine vous permet de charger tous les écrans à partir d’un seul bundle, ce qui est utile si vous souhaitez qu’une version unifiée prenne en charge tous les écrans possibles.

Import Example

// importation racine
import { useSignup } from '@auth0/auth0-acul-react';

// importation partielle
import {
  useSignup,
  // Hooks de contexte
  useUser,
  useTenant,
  useBranding,
  useClient,
  useOrganization,
  usePrompt,
  useScreen,
  useTransaction,
  useUntrustedData,
  // Hooks communs
  useCurrentScreen,
  useAuth0Themes,
  useErrors,
  // Hooks utilitaires
  useChangeLanguage,
  usePasswordValidation,
  useSignupIdentifiers,
  useUsernameValidation,
  // Méthodes
  signup,
  federatedSignup,
  googleOneTap,
  pickCountryCode,
} from '@auth0/auth0-acul-react/signup';

function SignupForm() {
  const { signup } = useSignup();
  return (
    <button onClick={() => signup({ email: '[e-mail]', password: 'secret' })}>
      Create Account
    </button>
  );
}

​

Context Hooks

Des hooks à portée d’écran qui fournissent un accès en lecture seule aux données de contexte d’Auth0 sur l’écran signup. Importez-les depuis @auth0/auth0-acul-react/signup.

useBranding · () => BrandingMembers

Ce hook fournit des configurations d’image de marque, comme le logo, les couleurs et les paramètres de thème affichés sur l’écran signup.

Example

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

useClient · () => ClientMembers

Ce hook fournit des configurations liées au client, comme id, name et logoUrl, pour l’écran signup.

Example

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

useOrganization · () => OrganizationMembers

Ce hook fournit des renseignements sur l’Organization de l’utilisateur si l’inscription est associée à une Organization. Retourne null lorsqu’aucun contexte d’Organization n’est présent.

Example

import { useOrganization } from '@auth0/auth0-acul-react/signup';
function OrgSelector() {
  const organization = useOrganization();
  if (!organization) {
    return <p>No organization context</p>;
  }
}

usePrompt · () => PromptMembers

Ce hook contient des données sur le prompt actuel dans le flux d’authentification.

Example

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

useScreen · () => ScreenMembersOnSignup

Ce hook contient des détails propres à l’écran signup, notamment sa configuration et son contexte.

Example

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

useTenant · () => TenantMembers

Ce hook contient des données liées au tenant, comme id et les métadonnées associées.

Example

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

useTransaction · () => TransactionMembersOnSignup

Ce hook fournit des données propres à la transaction pour l’écran signup, comme les connexions actives et l’état actuel du flux.

Example

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

useUntrustedData · () => UntrustedDataMembers

Ce hook gère les données non fiables transmises à l’écran, comme une adresse courriel ou un username prérempli à partir des paramètres d’URL.

Example

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

useUser · () => UserMembers

Ce hook fournit des détails sur l’utilisateur actif, y compris le username, l’email et les méthodes d’authentification disponibles.

Example

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

useSignup · SignupMembers

Ce hook renvoie toutes les méthodes et le contexte accessibles sur l’écran signup.

​

Méthodes

googleOneTap · Promise<void>

Cette méthode enregistre un nouvel utilisateur à l’aide d’une information d’identification Google One Tap, ce qui permet de s’inscrire en un clic sans être redirigé vers une page distincte.

Example

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

function GoogleOneTapHandler({ credential }) {
  const { googleOneTap } = useSignup();
  return googleOneTap({ one_tap_credential: credential });
}

Paramètres de la méthode

Afficher Paramètres

one_tap_credential · string · requis

Le jeton d’identification Google One Tap renvoyé par l’invite Google Identity Services.

federatedSignup · Promise<void>

Cette méthode redirige l’utilisateur vers le Social ou le fournisseur d’identité Enterprise (IdP) pour l’inscription.

Example

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

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

Paramètres de la méthode

Afficher Paramètres

options

FederatedSignupPayloadOptions.

connection · string · requis

Le nom de la connexion du fournisseur d’identité Social ou Enterprise.

pickCountryCode · Promise<void>

Cette méthode ouvre le sélecteur d’indicatif de pays pour la saisie du numéro de téléphone pendant l’inscription.

Example

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

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

signup · Promise<void>

Cette méthode envoie les renseignements d’inscription de l’utilisateur pour créer un nouveau compte.

Example

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

function SignupForm() {
  const { signup } = useSignup();
  return (
    <button onClick={() => signup({ email: '[e-mail]', password: 'secret' })}>
      Create Account
    </button>
  );
}

Paramètres de la méthode

Afficher Paramètres

options

SignupPayloadOptions.

email · string

L’adresse courriel de l’utilisateur.

password · string

Le mot de passe du nouveau compte.

username · string

Le nom d’utilisateur du nouveau compte, si la connexion l’exige.

phoneNumber · string

Le numéro de téléphone de l’utilisateur, si la connexion l’exige.

captcha? · string

Valeur captcha requise lorsque Bot Detection est activé sur le tenant.

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

Champs personnalisés supplémentaires préfixés par ulp- (par exemple, 'ulp-custom-field').

​

Hooks communs/utilitaires

useAuth0Themes · Hooks

Ce hook récupère les options du thème actuel avec une configuration mise à plat à partir du contexte d’image de marque.

useChangeLanguage · Hooks

Ce hook renvoie une fonction permettant de changer la langue d’affichage sur l’écran ACUL actuel.

useCurrentScreen · Hooks

Ce hook récupère le contexte et l’état de l’écran actuel.

useErrors · Hooks

Ce hook lit et gère les erreurs serveur, client et de développement à l’écran.

usePasswordValidation · Hooks

Ce hook valide le mot de passe de l’utilisateur en fonction des exigences de la politique de mot de passe du tenant.

useSignupIdentifiers · Hooks

Ce hook renvoie les types d’identifiant d’inscription disponibles (courriel, nom d’utilisateur, téléphone) configurés pour la connexion.

useUsernameValidation · Hooks

Ce hook valide le nom d’utilisateur selon les exigences de la politique de nom d’utilisateur du tenant.