https://github.com/lannex/react-password-strength-bar

A React component that displays the password strength bar
https://github.com/lannex/react-password-strength-bar

Last synced: about 2 months ago
JSON representation

A React component that displays the password strength bar

• Host: GitHub
• URL: https://github.com/lannex/react-password-strength-bar
• Owner: lannex
• License: mit
• Created: 2019-05-16T09:00:42.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2024-04-20T13:13:05.000Z (5 months ago)
• Last Synced: 2024-07-05T13:39:22.319Z (3 months ago)
• Language: TypeScript
• Size: 2.41 MB
• Stars: 77
• Watchers: 2
• Forks: 23
• Open Issues: 12
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# react-password-strength-bar

A React component that displays the password strength bar

[![NPM](https://nodei.co/npm/react-password-strength-bar.png?compact=true)](https://nodei.co/npm/react-password-strength-bar/)

[![Version](https://img.shields.io/npm/v/react-password-strength-bar.svg)](https://www.npmjs.com/package/react-password-strength-bar)

[![Build](https://travis-ci.org/lannex/react-password-strength-bar.svg?branch=master)](https://www.npmjs.com/package/react-password-strength-bar)

[![Coverage Status](https://coveralls.io/repos/github/lannex/react-password-strength-bar/badge.svg?branch=master)](https://coveralls.io/github/lannex/react-password-strength-bar?branch=master)

[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg)](https://github.com/prettier/prettier)

[![License](https://img.shields.io/npm/l/react-password-strength-bar.svg)](https://www.npmjs.com/package/react-password-strength-bar)

![Gif](./examples/static/example.gif)

## Note

- This package is based on [zxcvbn](https://github.com/dropbox/zxcvbn).

`zxcvbn` is a powerful library, but its size is very large.

I recommend you use this package by [Code-Splitting](https://reactjs.org/docs/code-splitting.html).

- The input tag is not included.

If you want to include the input tag, use the [mmw/react-password-strength](https://github.com/mmw/react-password-strength) package.

## Install

```

$ npm install react-password-strength-bar

```

```

$ yarn add react-password-strength-bar

```

## Usage

```js

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

const { password } = this.state;

```

## 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`: ReactNode[]

- isRequired: false

- default: ['weak', 'weak', 'okay', 'good', 'strong']

#### `minLength`: number

- isRequired: false

- default: 4

#### `shortScoreWord`: ReactNode

- isRequired: false

- default: 'too short'

#### `onChangeScore`: (score, feedback) => void

- isRequired: false

- default: undefined

## Browser support

Tested with modern browsers.

## License

the MIT license.