====================================================
jQuery Password Strength Meter for Twitter Bootstrap
====================================================
The jQuery Password Strength Meter is a plugin for Twitter Bootstrap that
provides rulesets for visualy displaying the quality of a users typed in
password.
Requirements
============
* jQuery (tested with 1.8.3)
* Bootstrap CSS for progress bars (tested with 2.2.2)
Options
=======
* __minChar__:
Default: `8` (Integer)
Sets the minimum required of characters for a password to not be considered
too weak
* __verdicts__:
Default: `["Weak", "Normal", "Medium", "Strong", "Very Strong"]` (Array)
The display names for the verdicts related to the progressClass
* __scores__:
Default: `[17, 26, 40, 50]` (Array)
The scores used to determine what progressClass and verdicts to display
* __showVerdicts__:
Default: `true` (Boolean)
Determines if the verdicts are display on the progress bar or not
* __viewports__:
Default: (Object)
```
{
progress: undefined,
verdict: undefined,
errors: undefined
}
```
An object containing the viewports to use to show the elements of the
strength meter. Each one can be a CSS selector (`"#progressbar"`) or a DOM
node reference.
* __usernameField__:
Default: `"#username"` (String)
The username field to match a password to, to ensure the user does not use
the same value for their password
* __raisePower__:
Default: `1.4` (Double)
The value used to modify the final score, allows you to tailor your results
* __onLoad__:
Default: `undefined` (Function)
A callback function, fired on load of the widget
* __onKeyUp__:
Default: `undefined` (Function)
A callback function, fired on key up when the user is typing
* __errorMessages__:
Default: (Object)
```
{
password_to_short : "The Password is too short",
same_as_username : "Your password cannot be the same as your username"
}
```
An object containing error messages. These can be overwritten for language
purposes, and can also be added to for your custom rules.
Adding Custom Rules
===================
The plugin comes with the functionality to easily define your own custom rules.
The format is as follows:
```javascript
$("#passwdfield").pwstrength("addRule", "ruleName", function (options, word, score) {}, rule_score, rule_enabled);
```
Example:
```javascript
$("#passwdfield").pwstrength("addRule", "testRule", function (options, word, score) {
return word.match(/[a-z].[0-9]/) && score;
}, 10, true);
```
Callback Functions
==================
The plugin provides two callback functions, onLoad and onKeyUp. You can use
them like this:
```javascript
$(document).ready(function () {
var options = {
onLoad: function () {
$('#messages').text('Start typing password');
},
onKeyUp: function (evt) {
$(evt.target).pwstrength("outputErrorList");
}
};
$(':password').pwstrength(options);
});
```
|