riot-is-password-known's Introduction

riot-is-password-known

About

riot-is-password-known is a Riot.js plugin to check a given password against the haveibeenpwned.com api, and verify it's secure.

Support

Chome	Edge	Firefox	Opera	Safari
5.0+ ✔	✔	4.0+ ✔	11.50+ ✔	5.0+ ✔

This project only supports riot.js 3, support for previous versions is not available.

Example

Install the plugin like so:

import PasswordKnown from '@neetjn/riot-is-password-known'
import * as riot from 'riot'

PasswordKnown(riot)

Leverage the virtual tag using password-known:

<component>
  <div if={!validPassword} class="danger">
    <h1>Password Known</h1>
  </div>

  <input type="password" data-is="password-known" />

  <script>
    const self = this

    self.validPassword = false
    self.safetyScore = 0
    self.on('passwordKnown', (result) => {
        self.validPassword = !result.found
        self.safetyScore = result.count ....
        self.update()
    })
  </script>
</component>

Other Examples

https://jsfiddle.net/neetjn/gjxLywrm/

Usage

To install via Bower, simply do the following:

bower install riot-is-password-known

To install via NPM:

npm install @neetjn/riot-is-password-known

For quick start using jsdelivr:

<script src="https://cdn.jsdelivr.net/gh/neetjn/riot-is-password-known/dist/riot-is-password-known.browser.js"></script>

Contributors

John Nolette ([email protected])

Contributing guidelines are as follows,

Any new features must include either a unit test, e2e test, or both.
- Branches for bugs and features should be structured like so, issue-x-username.
Before putting in a pull request, be sure to verify you've built all your changes.
Travis will build your changes before testing and publishing, but bower pulls from this repository directly.
Include your name and email in the contributors list.

Notes,

Be sure to run prettier using: