vue-password-toggle
v1.3.3
Published
A simple lightweight component to show and hide the password input.
Downloads
327
Maintainers
Readme
vue-password-toggle
A simple lightweight component to show and hide the password input.
Demo
Setup
Business as usual by running
npm i vue-password-toggle
and integrating it directly into your .vue file:
<script>
import { PasswordToggle } from 'vue-password-toggle'
import 'vue-password-toggle/dist/style.css'
</script>
Current recommendation is overwriting the default keyboard enter behaviour by using the integrated emit option and use a vue.js two way data binding.
<template>
<PasswordToggle
v-model:password="password"
@keydownEnter="doLogin($event)"/>
</template>
Validation
There's no default to able to login in without validation showing up. The result of the validation is transported with a passwordValid
emit to the parent. The rest of the options are:
| Parameter | Type | Required | | :---------------- | :------: | ----: | | minPasswordLength | Number | No | | minOneLowerLetter | Boolean | No | | minOneUpperLetter | Boolean | No | | minOneNumber | Boolean | No | | minOneSpecialCharacter | Boolean | No |
and can be added like this.
<template>
<PasswordToggle
v-model:password="password"
@keydownEnter="doLogin($event)"
@passwordValid="this.passwordValid = $event"
:minOneUpperLetter="true"
:minPasswordLength="10"/>
</template>
Example Code
Full working code example based on the vue.js generated template app included in the repository.
npm i
npm run dev
Contributions
Any kind of requests, bugs, and so on and so forth, write a ticket.
Status
- [x] Configure build process so dependency can be used
- [x] Write proper docu
- [x] Add validation of password
- [ ] Clean out code
- [ ] Remove unused dependencies
- [ ] Add color options
- [ ] Set preventDefault behaviour as mandatory
- [ ] Have fun at riversurfing
- [ ] Fry super tasty rice with shrimps
- [ ] Save the world
Credits
- If you made it this far in reading this doc, you deserve a laugh or two ;)
- Thank you for being, Vue.js!
- You make this look good, Pico.css ^^
- My icons would look like crazy doodles from a 4 year old without FontAwesome...
- The boring school system and games such as CS1.6, Warcraft III, Starcraft to inspire me to become a software engineer
- My Mom and Dad for bringing me into this world, and my imaginary girlfried for her love and support
- The Universe for creating such a wonderful planet
License
Thank you for not reading MIT!