@angular-material-extensions/password-strength - Material password strength meter to indicate how secure is the provided password - Angular v6 supported

This project has been transferred from ngx-material-password-strength to @angular-material-extensions/password-strength

Built by and for developers ❤️

Do you have any question or suggestion ? Please do not hesitate to contact us! Alternatively, provide a PR | open an appropriate issue here

If did you like this project, support angular-material-extensions by starring ⭐ and sharing it 📢

Table of Contents

• Demo
• Components
• Dependencies
• Peer Dependencies
• Additional Requirements - material (Include a theme)
• Additional Requirements - material icons
• Installation
• API
• Usage
• Documentation
• Run Demo App Locally
• Development
• Other Angular Libraries
• Support
• License

Demo

View all the directives and components in action at https://angular-material-extensions.github.io/password-strength

Library's components

• <mat-password-strength> used to calculate and display the strength of a provided password

1. strength score <= 20%

2. strength score <= 80%

1. strength score > 80%

• <mat-password-strength-info> used to display more information about the strength of a provided password

Dependencies

• Angular developed and tested with 6.1.78

Requirements (peer dependencies):

• angular animations v6.1.8

• angular forms v6.1.8

• angular cdk v6.4.7

• angular material v6.4.7

• angular material theme

• angular material icons

npm i @angular/cdk @angular/material @angular/animations @angular/forms 

or use angular schematics like e.g:

ng add @angular/material 

Additional requirements Theme (Material Design)

• angular material theme

Additional Requirements - Import the material design icons learn more

• The easiest way to import material design icons is to provide a link in your index.html file like below:

<link href="https://fonts.googleapis.com/icon?family=Material+Icons" rel="stylesheet">

• alternative solution:

1. Install of the official npm module of the material design icons

npm i -s material-design-icons

2. Import them in your angular.json file

"styles": [
        "styles.css",
        "../node_modules/material-design-icons/iconfont/material-icons.css"
      ],

Installation

Install above dependencies via npm.

Now install @angular-material-extensions/password-strength via:

npm install --save @angular-material-extensions/password-strength

SystemJS

Note:If you are using SystemJS, you should adjust your configuration to point to the UMD bundle. In your systemjs config file, map needs to tell the System loader where to look for @angular-material-extensions/password-strength:

map: {
  '@angular-material-extensions/password-strength': 'node_modules/@angular-material-extensions/password-strength/bundles/@angular-material-extensions/password-strength.umd.js',
}

Once installed you need to import the main module:

import { MatPasswordStrengthModule } from '@angular-material-extensions/password-strength';

The only remaining part is to list the imported module in your application module. The exact method will be slightly different for the root (top-level) module for which you should end up with the code similar to (notice MatPasswordStrengthModule .forRoot()):

import { MatPasswordStrengthModule } from '@angular-material-extensions/password-strength';

@NgModule({
  declarations: [AppComponent, ...],
  imports: [MatPasswordStrengthModule.forRoot(), ...],  
  bootstrap: [AppComponent]
})
export class AppModule {
}

Other modules in your application can simply import MatPasswordStrengthModule:

import { MatPasswordStrengthModule } from '@angular-material-extensions/password-strength';

@NgModule({
  declarations: [OtherComponent, ...],
  imports: [MatPasswordStrengthModule, ...], 
})
export class OtherModule {
}

API

<mat-password-strength> used to calculate and display the strength of a provided password

<mat-password-strength-info> used to display more information about the strength of a provided password

Usage

add the @angular-material-extensions/password-strength element to your template:

<mat-password-strength  [password]="password.value">
</mat-password-strength>

This will display only the material password strength meter in form of a progress without any input fields or similar.

In the following example, we integration a material input container with @angular-material-extensions/password-strength 's component.

<div>
  <mat-form-field appearance="outline" style="width: 100%" [color]="passwordComponent.color">
              <mat-label>Password</mat-label>
              <input matInput #password
                     [type]="inputType"
                     required
                     placeholder="Password">
              <mat-hint align="end" aria-live="polite">
                {{password.value.length}} / 25
              </mat-hint>
            </mat-form-field>
  
            <mat-password-strength #passwordComponent
                                   (onStrengthChanged)="onStrengthChanged($event)"
                                   [password]="password.value">
            </mat-password-strength>
     </div>

learn more about mat-form-field

Example of how to use the emitted strength of the password in your template

<div fxLayout="row" fxLayoutGap="10px">
   <div *ngIf="passwordComponent.strength === 100; then done else error">
   </div>
   <ng-template #done>
     <mat-icon color="primary">done</mat-icon>
   </ng-template>
   <ng-template #error>
     <mat-icon color="warn">error</mat-icon>
   </ng-template>
   <div>
     <p>Password's strength = {{passwordComponent.strength}} %100</p>
   </div>
</div>

Client Side password's validation using a built in angular formController

1. add an input element to your template with an appropriate @angular-material-extensions/password-strength's component
2. hold a reference of the @angular-material-extensions/password-strength's component by adding passwordComponentWithValidation (or whatever you want) inside the element

e.g:

 <mat-password-strength #passwordComponentWithValidation
                       [password]="passwordWithValidation.value">
                       </mat-password-strength>

3. bind the form controller of the mat-password-strength to the input element

• you can access the form controller of @angular-material-extensions/password-strength using the chile view --> passwordComponentWithValidation.passwordFormControl
• bind the form controller to an input element --> [formControl]="passwordComponentWithValidation.passwordFormControl"

4. Full example - see below

<div>
  <mat-form-field appearance="outline" style="width: 100%">
    <mat-label>Password</mat-label>
    <input matInput #passwordWithValidation
           [type]="inputType"
           required
           [formControl]="passwordComponentWithValidation.passwordFormControl"
           placeholder="Password">
    <mat-hint align="end" aria-live="polite">
      {{passwordWithValidation.value.length}} / 25
    </mat-hint>
    <mat-error *ngIf="passwordComponentWithValidation.passwordFormControl.hasError('required')">
      Password is required
    </mat-error>
    <mat-error *ngIf="passwordComponentWithValidation.passwordFormControl.hasError('pattern')">
      Password is not valid
    </mat-error>
  </mat-form-field>
  <mat-password-strength #passwordComponentWithValidation
                                  (onStrengthChanged)="onStrengthChanged($event)"
                                  [password]="passwordWithValidation.value">
  </mat-password-strength>
  <!--Password's strength info-->
  <mat-password-strength-info
    [passwordComponent]="passwordComponentWithValidation">
  </mat-password-strength-info>
</div>

this will looks like -->

for more examples please visit this URL : (https://angular-material-extensions.github.io/password-strength/examples

Documentation

Please checkout the full documentation here or follow the official tutorial

Run Demo App Locally

• clone this repo by running

$ git clone https://github.com/angular-material-extensions/password-strength.git

• link the @angular-material-extensions/password-strength package

$ gulp link

• navigate to the demo app directory

$ cd demo

• install the dependencies

$ npm i

• run/start/serve the app

$ npm run start

or

$ ng serve --open

• the app is now hosted by http://localhost:4200/

Development

1. clone this repo
2. Install the dependencies by running npm i
3. build the library npm run build or gulp build
4. Link the library gulp link
5. Navigate to the demo app's directory

• cd demo _ npm i _ npm start

Other Angular Libraries

• ngx-auth-firebaseui
• ngx-linkifyjs
• @firebaseui/ng-bootstrap
• @angular-material-extensions/link-preview
• @angular-material-extensions/google-maps-autocomplete
• @angular-material-extensions/pages
• @angular-material-extensions/contacts
• @angular-material-extensions/faq
• @angular-material-extensions/combination-generator

Support

• Drop an email to: Anthony Nahas
• or open an appropriate issue
• let us chat on Gitter

Built by and for developers ❤️ we will help you 👊

This project is supported by jetbrains with 1 ALL PRODUCTS PACK OS LICENSE incl. webstorm

License

Copyright (c) 2018 Anthony Nahas. Licensed under the MIT License (MIT)