ResetPasswordEmail

Décrit tous les hooks et toutes les méthodes disponibles pour personnaliser l’écran reset-password-email dans Universal Login.

L’écran reset-password-email s’affiche après qu’un utilisateur a demandé une réinitialisation du mot de passe. Il informe l’utilisateur qu’un courriel de réinitialisation a été envoyé et lui permet de renvoyer le courriel au besoin.

​

Importation

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

• L’importation partielle vous permet d’inclure uniquement le code nécessaire à votre cas d’utilisation.
• L’importation à la racine vous permet de charger tous les écrans à partir d’un seul bundle, ce qui est utile si vous voulez un build unifié capable de gérer tous les écrans possibles.

Import Example

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

// importation partielle
import {
  useResetPasswordEmail,
  // Hooks de contexte
  useUser,
  useTenant,
  useBranding,
  useClient,
  useOrganization,
  usePrompt,
  useScreen,
  useTransaction,
  useUntrustedData,
  // Hooks communs
  useCurrentScreen,
  useAuth0Themes,
  useErrors,
  // Hooks utilitaires
  useChangeLanguage,
  // Méthodes
  resendEmail,
} from '@auth0/auth0-acul-react/reset-password-email';

function ResetPasswordEmailScreen() {
  const { resendEmail } = useResetPasswordEmail();
  return (
    <button onClick={() => resendEmail()}>
      Resend Email
    </button>
  );
}

​

Hooks de contexte

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

useBranding · () => BrandingMembers

Ce hook fournit la configuration d’image de marque, comme le logo, les couleurs et les paramètres de thème affichés sur l’écran reset-password-email.

Example

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

useClient · () => ClientMembers

Ce hook fournit des configurations liées à l’application, comme id, name et logoUrl, pour l’écran reset-password-email.

Example

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

useOrganization · () => OrganizationMembers

Ce hook fournit des renseignements sur l’organisation de l’utilisateur si la réinitialisation du mot de passe est associée à une organisation. Renvoie null lorsqu’aucun contexte d’organisation n’est présent.

Example

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

usePrompt · () => PromptMembers

Ce hook contient des données sur l’invite active dans le flux d’authentification.

Example

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

useScreen · () => ScreenMembersOnResetPasswordEmail

Ce hook contient des détails propres à l’écran reset-password-email, y compris sa configuration et son contexte.

Example

import { useScreen } from '@auth0/auth0-acul-react/reset-password-email';
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/reset-password-email';
function TenantInfo() {
  const tenant = useTenant();
}

useTransaction · () => TransactionMembers

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

Example

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

useUntrustedData · () => UntrustedDataMembers

Ce hook gère 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/reset-password-email';
function PrefilledForm() {
  const untrustedData = useUntrustedData();
}

useUser · () => UserMembers

Ce hook fournit des renseignements sur l’utilisateur actif, notamment username, email et les méthodes d’authentification disponibles.

Example

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

useResetPasswordEmail · ResetPasswordEmailMembers

Ce hook renvoie toutes les méthodes et tout le contexte disponibles sur l’écran reset-password-email.

​

Méthodes

resendEmail · Promise<void>

Cette méthode renvoie le courriel de réinitialisation du mot de passe à l’utilisateur.

Example

import { useResetPasswordEmail } from '@auth0/auth0-acul-react/reset-password-email';

function ResendButton() {
  const { resendEmail } = useResetPasswordEmail();
  return (
    <button onClick={() => resendEmail()}>
      Resend Email
    </button>
  );
}

​

Hooks communs et utilitaires

useAuth0Themes · Hooks

Ce hook récupère les options de thème actuelles avec une configuration à plat issue 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 permet de lire et de gérer les erreurs serveur, client et développeur à l’écran.