passwordping-react-password-strength v1.1.1

PasswordPing React Password Strength Meter

The PasswordPing React Password Strength Meter replaces existing password strength meters for signup and password change forms. It not only provides a typical, algorithmic strength estimation, based on the zxcvbn library, but also verifies that the password is not known to be compromised by checking it against PasswordPing's Passwords API.

The password strength meter is free to use for up to 100,000 requests per month against the PasswordPing API. After that, the meter will fallback to zxcvbn checks only.

Install in your project

npm install --save passwordping-react-password-strength

Note: react/react-dom is a peer dependency. You should be using this in a React project.

Using the tool

<PasswordPing
  className="customClass"
  style={{ display: 'none' }}
  minLength={5}
  minScore={2}
  scoreWords={['hacked', 'weak', 'okay', 'good', 'strong', 'stronger']}
  changeCallback={onchange}
  inputProps={{ autoComplete: "off", className: "form-control" }}
/>

Importing

If using ES6 imports: import PasswordPing from 'passwordping-react-password-strength';

Using CommonJS require: var ReactPasswordStrength = require('passwordping-react-password-strength');

Using in a Universal JS App (server-side rendering):

• Import component from passwordping-react-password-strength/dist/universal
• Include default style from passwordping-react-password-strength/dist/style.css.

Props

ClassName

• ClassName to render with default container classes

Style

• Style object to customize container

minLength (Default: 8)

• Minimum password length acceptable for password to be considered valid

minScore (Default: 4)

• Minimum score acceptable for password to be considered valid
• Scale from 0 - 5. The score values are as follows:
  • 0: Hacked indicates the password is known by PasswordPing to be compromised
  • 1: Very Weak - equivalent to zxcvbn score of 0
  • 2: Weak - equivalent to zxcvbn score of 1
  • 3: Medium - equivalent to zxcvbn score of 2
  • 4: Strong - equivalent to zxcvbn score of 3
  • 5: Very Strong - equivalent to zxcvbn score of 4
• See zxcvbn docs for explanations of scores
• Scores of 0-3 will have a hover popup available indicating reasons for the score and suggestions to improve it.
• Scores 4-5 (Strong, Very Strong) will not have a popup value

scoreWords (Default: 'Hacked', 'Very Weak', 'Weak', 'Medium', 'Strong', 'Very Strong')

• An array denoting the words used to describe respective score values in the UI

tooShortWord (Default: 'Too Short')

• A string to describe when password is too short (based on minLength prop).

changeCallback

• Callback after input has changed (and score was recomputed)
• React Password Strength passes two objects to the callback function:
  • current app state (score, password, isValid)
  • full result produced by zxcvbn including feedback (see docs for more properties)

inputProps

• Props to pass down to the input element of the component. Things like name, id, etc
• Protected props: className, onChange, value
  • Passing in className will append to the existing classes
  • The remaining props will be ignored

defaultValue

• A default value to set for the password field. If a non-empty string is provided the changeCallback will be called in componentDidMount.

userInputs

• An array of strings that zxcvbn will treat as an extra dictionary. You can add your product name, company name into this list to prevent these from being used as part of user passwords.

Classes

All styling is applied with CSS classes to allow custom styling and overriding.

• PasswordPing - namespace class and component wrapper
• is-strength-{0-5} - modifier class indicating password strength
• PasswordPing-input - password input field
• is-password-valid - modifier class indicating valid password
• is-password-invalid - modifier class indicating invalid password (only applies if password length > 0)
• PasswordPing-strength-bar - color bar indicating password strength
• PasswordPing-strength-desc - text indicating password strength

Acknowledgements

This library is based heavily on the react-password-strength library by Mateusz Wijas.