Skip to content

Latest commit

 

History

History
86 lines (66 loc) · 2.52 KB

README.md

File metadata and controls

86 lines (66 loc) · 2.52 KB
Raw

react-password-strength-bar

A React component that displays the password strength bar

NPM

Version Build Coverage Status code style: prettier License

Gif

Note

  • This package is based on zxcvbn. zxcvbn is a powerful library, but its size is very large. I recommend you use this package by Code-Splitting.
  • The input tag is not included. If you want to include the input tag, use the mmw/react-password-strength package.

Install

$ npm install react-password-strength-bar

$ yarn add react-password-strength-bar

Usage

import PasswordStrengthBar from 'react-password-strength-bar';

const { password } = this.state;
<PasswordStrengthBar password={password} />

Props

className: string

  • isRequired: false
  • default: undefined

style: object

  • isRequired: false
  • default: undefined

scoreWordClassName: string

  • isRequired: false
  • default: undefined

scoreWordStyle: object

  • isRequired: false
  • default: undefined

password: string

  • isRequired: true
  • default: ''

userInputs: string[]

  • isRequired: false
  • default: []

barColors: string[]

  • isRequired: false
  • default: ['#ddd', '#ef4836', '#f6b44d', '#2b90ef', '#25c281']

scoreWords: string[]

  • isRequired: false
  • default: ['weak', 'weak', 'okay', 'good', 'strong']

minLength: number

  • isRequired: false
  • default: 4

shortScoreWord: string

  • isRequired: false
  • default: 'too short'

onChangeScore: (score) => void

  • isRequired: false
  • default: undefined

Browser support

Tested with modern browsers.

License

the MIT license.