MUI Customisable Password Component

A Customisable Material-UI component that provides real-time password strength evaluation and password rule compliance visualisation.

Developed by Piraveenan Kirupakaran

Features

• Real-time password strength updates
• Password strength bar visualisation
• Interactive checkboxes for rule compliance
• Customisable styling and rule definitions
• TypeScript support for enhanced type safety

Table of Contents

• Installation
• Usage
• Props
• License

Installation

Install the library using your package manager of choice:

npm i mui-customisable-password-component

or

yarn add mui-customisable-password-component

Usage

Once installed, import the MUICustomisablePasswordComponent in your React component:

  import React from 'react';
  import MUICustomisablePasswordComponent from 'react-mui-password-strength';

  function App() {
    return (
      <div>
        <h1>Password Strength Indicator</h1>
        <MUICustomisablePasswordComponent />
      </div>
    );
  }

export default App;

Customise the component's behavior and appearance by passing props as needed. For a full list of available props and their descriptions, refer to the Props section in the README.

Props

License

This project is licensed under the MIT License - see the LICENSE file for details.