Inscription

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

L’écran signup recueille les renseignements de connexion de l’utilisateur pour créer un nouveau compte. Il prend en charge l’inscription standard avec nom d’utilisateur, courriel, numéro de téléphone et mot de passe, ainsi que l’inscription fédérée au moyen de connexions sociales ou d’entreprise.

​

Import

Chaque écran possède son propre ensemble de hooks et de méthodes. Le SDK prend en charge l’import partiel et l’import racine pour chaque écran.

• L’import partiel vous permet d’inclure uniquement le code nécessaire à votre cas d’utilisation.
• L’import 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,
  pickCountryCode,
} from '@auth0/auth0-acul-react/signup';

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

​

Hooks de contexte

Hooks propres à l’écran qui fournissent un accès en lecture seule aux données de contexte Auth0 dans l’écran signup. Importez-les depuis @auth0/auth0-acul-react/signup.

useBranding · () => BrandingMembers

Ce hook fournit les paramètres 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 les configurations liées à l’application, 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 informations sur l’Organisation de l’utilisateur si l’inscription est associée à une Organisation. Retourne null lorsqu’aucun contexte d’Organisation 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 l’invite en cours 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 locataire, 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 expose les données non fiables transmises à l’écran, comme un courriel ou un nom d’utilisateur 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, notamment username, 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 disponibles sur l’écran signup.

​

Méthodes

federatedSignup · Promise<void>

Cette méthode lance l’inscription à l’aide d’un fournisseur d’identité fédéré, comme Google ou GitHub.

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 sociale ou d’entreprise à utiliser (p. ex. google-oauth2, github).

pickCountryCode · Promise<void>

Cette méthode ouvre le sélecteur de code 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>
  );
}

Paramètres de la méthode

Afficher Paramètres

options

CustomOptions.

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

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

signup · Promise<void>

Cette méthode soumet les détails 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 du captcha requise lorsque la détection des bots est activée pour le locataire.

[`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 de thème actuelles avec une configuration mise à plat à partir du contexte d’image de marque.

useChangeLanguage · Hooks

Ce hook retourne une fonction qui permet 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 permet de lire et de gérer les erreurs serveur, d’application et de développement à l’écran.

usePasswordValidation · Hooks

Ce hook valide le mot de passe de l’utilisateur selon les exigences de la stratégie de mot de passe du locataire.

useSignupIdentifiers · Hooks

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

useUsernameValidation · Hooks

Ce hook valide le nom d’utilisateur de l’utilisateur selon les exigences de la stratégie de nom d’utilisateur du locataire.