Skip to content
This repository was archived by the owner on Apr 5, 2024. It is now read-only.

Commit 1a0723f

Browse files
committed
Update PasswordStrengthBar Docs
1 parent 95da0fd commit 1a0723f

File tree

1 file changed

+7
-4
lines changed

1 file changed

+7
-4
lines changed

src/components/pages/User/PasswordStrengthBar.tsx

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,19 +8,22 @@ const PasswordStrengthBar = React.lazy(
88

99
/**
1010
* PasswordStrengthBarWrapper component's parameter type.
11-
* @typedef {Object} PasswordStrengthBarWrapperArgs
12-
* @property {string} currentPassword The password to check.
13-
* @property {(number, PasswordFeedback) => void} scoreChangeCallback A function which receives the password's strength and reacts to it.
1411
*/
1512
export type PasswordStrengthBarWrapperArgs = {
13+
/** The password to check. */
1614
currentPassword: string
15+
/**
16+
* A function which receives the password's strength and reacts to it.
17+
* @param score The score rating the quality of the password.
18+
* @param feedback Object containing information regarding the feedback's design.
19+
*/
1720
scoreChangeCallback: (score: number, feedback: PasswordFeedback) => void
1821
}
1922

2023
/**
2124
* A component wrapping the password strength checks by lazy loading the component if necessary.
2225
* @param {PasswordStrengthBarWrapperArgs}
23-
* @returns password strength bar or null, depending on if user already inserted a password
26+
* @returns PasswordStrengthBar or null, depending on if user already inserted a password.
2427
*/
2528

2629
const PasswordStrengthBarWrapper = ({

0 commit comments

Comments
 (0)