usePasswordValidation

usePasswordValidation(
  password: string,
  options?: { includeInErrors?: boolean },
): PasswordValidationResult

usePasswordValidation · PasswordValidationResult

Ce hook React valide un mot de passe selon la politique de mot de passe Auth0 actuellement configurée et renvoie un résultat structuré indiquant si le mot de passe respecte chaque règle.

Au besoin, il peut envoyer les résultats de validation au gestionnaire global d’erreurs pour que les composants d’erreur du formulaire se mettent à jour automatiquement.

​

Fonctionnalités clés

• Validation tenant compte de la politique — vérifie le mot de passe en fonction des règles de la politique de mot de passe Auth0 configurées pour le tenant.
• Intégration au gestionnaire d’erreurs — transmet facultativement les échecs de validation aux composants d’erreur du formulaire de façon automatique.

​

Paramètres

password · string

Le mot de passe à valider.

options · { includeInErrors?: boolean }

Configuration facultative du hook.

Afficher propriétés

includeInErrors · boolean

Si true, les erreurs de validation sont stockées dans le gestionnaire global d’erreurs sous le champ password. La valeur par défaut est false.

​

Retourne

PasswordValidationResult

Un objet PasswordValidationResult contenant :

• isValid — true si le mot de passe respecte toutes les règles configurées.
• results — un tableau des résultats pour chaque règle, avec code, label, status et isValid.

​

Écrans pris en charge

• signup
• signup-password
• reset-password

Example

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

const { isValid, results} = usePasswordValidation(password, { includeInErrors: true });

if (!isValid) {
  console.log(results);
}

​

Remarques

• Appelez usePasswordValidation au niveau supérieur de votre composant; ne l’appelez pas de façon conditionnelle ni dans des gestionnaires d’événements.
• Le chemin d’importation doit correspondre à l’écran — utilisez signup, signup-password ou reset-password, selon le cas.