usePasswordValidation

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

usePasswordValidation · PasswordValidationResult

この React フックは、現在の Auth0 パスワードポリシーに基づいてパスワードをバリデーションし、 パスワードが各ルールを満たしているかどうかを示す構造化された結果を返します。

必要に応じて、バリデーション結果をグローバルエラーマネージャーに送信することで、 フォームのエラーコンポーネントが自動的に更新されるようにできます。

​

主な機能

• ポリシー対応のバリデーション — テナントに設定された Auth0 パスワードポリシーのルールに照らしてパスワードを検証します。
• エラーマネージャー連携 — 必要に応じて、バリデーションの失敗をフォームのエラーコンポーネントに自動的に反映します。

​

パラメータ

password · string

バリデーションするパスワードです。

options · { includeInErrors?: boolean }

フックの任意の設定です。

表示 プロパティ

includeInErrors · boolean

true の場合、バリデーションエラーはグローバルエラーマネージャーの password フィールドに保存されます。既定値は false です。

​

戻り値

PasswordValidationResult

次を含む PasswordValidationResult オブジェクトです。

• isValid — パスワードが設定されたすべてのルールを満たしている場合は true。
• results — code、label、status、isValid を含む、ルールごとの結果の配列。

​

サポート対象の画面

• 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);
}

​

注記

• usePasswordValidation はコンポーネントのトップレベルで呼び出してください。条件付きで呼び出したり、イベントハンドラー内で呼び出したりしないでください。
• インポートパスは画面と一致している必要があります。該当する signup、signup-password、または reset-password を使用してください。