Skip to content

Commit c1bc73d

Browse files
committed
docs(project): updated the readme
1 parent eac59c6 commit c1bc73d

File tree

1 file changed

+26
-13
lines changed

1 file changed

+26
-13
lines changed

README.md

Lines changed: 26 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -219,14 +219,23 @@ export class OtherModule {
219219
| option | bind | type | default | description |
220220
|:-------------------|:--------:|:------:|:------------:|:-------------------------------------------------------------------------------------------------|
221221
| password | Input() | string | - | the password to calculate its strength
222+
| validators | Input() | Criteria[] | see inside the class ;) | custom form validator used to validate the password
222223
| externalError | Input() | boolean | false | used to change the color of the password to warn if an external error occurs
224+
| enableLengthRule | Input() | boolean | true | whether to validate the length of the password
225+
| enableLowerCaseLetterRule | Input() | boolean | true | whether a lowercase letter is optional
226+
| enableUpperCaseLetterRule | Input() | boolean | true | whether a uppercase letter is optional
227+
| enableDigitRule | Input() | boolean | true | whether a digit char is optional
228+
| enableSpecialCharRule | Input() | boolean | true | whether a special char is optional
229+
| min | Input() | number | 8 | the minimum length of the password
230+
| max | Input() | number | 30 | the maximum length of the password
223231
| onStrengthChanged | Output() | number | - | emits the strength of the provided password in % e.g: 20%, 40%, 60%, 80% or 100%
224232

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

227235
| option | bind | type | default | description |
228236
|:-------------------|:--------:|:------:|:------------:|:-------------------------------------------------------------------------------------------------|
229-
| passwordComponent | Input() | PasswordStrengthComponent | - | the password component used in the template in order to display more info related to the provided password
237+
| passwordComponent | Input() | PasswordStrengthComponent | - | the password component used in the template in order to display more info related to the provided password
238+
| enableScoreInfo | Input() | boolean | false | whether to show the password's score in %
230239

231240
---
232241

@@ -272,18 +281,18 @@ or similar.
272281

273282
```html
274283
<div fxLayout="row" fxLayoutGap="10px">
275-
<div *ngIf="passwordComponent.strength === 100; then done else error">
276-
</div>
277-
<ng-template #done>
278-
<mat-icon color="primary">done</mat-icon>
279-
</ng-template>
280-
<ng-template #error>
281-
<mat-icon color="warn">error</mat-icon>
282-
</ng-template>
283-
<div>
284-
<p>Password's strength = {{passwordComponent.strength}} %100</p>
285-
</div>
286-
</div>
284+
<div *ngIf="passwordComponent.strength === 100; then done else error">
285+
</div>
286+
<ng-template #done>
287+
<mat-icon color="primary">done</mat-icon>
288+
</ng-template>
289+
<ng-template #error>
290+
<mat-icon color="warn">error</mat-icon>
291+
</ng-template>
292+
<div>
293+
<p>Password's strength = {{passwordComponent.strength}} %100</p>
294+
</div>
295+
</div>
287296
```
288297

289298
#### Client Side password's validation using a built in angular formController
@@ -344,6 +353,9 @@ this will looks like -->
344353

345354
---
346355

356+
357+
for more examples please visit this URL : [(https://angular-material-extensions.github.io/password-strength/examples]((https://angular-material-extensions.github.io/password-strength/examples)
358+
347359
<a name="documentation"/>
348360

349361
## [Documentation](https://angular-material-extensions.github.io/password-strength/doc/index.html)
@@ -423,6 +435,7 @@ $ npm run lint
423435
## Other Angular Libraries
424436
- [ngx-auth-firebaseui](https://github.com/AnthonyNahas/ngx-auth-firebaseui)
425437
- [ngx-linkifyjs](https://github.com/AnthonyNahas/ngx-linkifyjs)
438+
- [@firebaseui/ng-bootstrap](https://github.com/firebaseui/ng-bootstrap)
426439
- [@angular-material-extensions/link-preview](https://github.com/angular-material-extensions/link-preview)
427440
- [@angular-material-extensions/google-maps-autocomplete](https://github.com/angular-material-extensions/google-maps-autocomplete)
428441
- [@angular-material-extensions/pages](https://github.com/angular-material-extensions/pages)

0 commit comments

Comments
 (0)