atefrihane/livewire-password-meter

A package dedicated to check password strength

1.0.1 2023-02-08 00:44 UTC

This package is auto-updated.

Last update: 2024-04-30 20:29:39 UTC


README

This repo can be used to easily integrate password strength feature to your livewire application

Installation

You can install the package via composer:

composer require  atefrihane/livewire-password-meter

This package also depends on Alpine.js

Install it from here.

<script src="//unpkg.com/alpinejs" defer></script>

Screenshot

Alt Image

Usage

<livewire:password-field
    :wireKey="'password'"
    :class="'your-css-class'"
    :styles="'inline css styles'"
    :placeholder="'placeholder'"
    :eyeIcon="true"
    :showStrength="true"
    
/>

Props

Prop Description
wireKey Key passed from the main livewire component (e.g., password)
placeholder Input's placeholder
eyeIcon Toggle the display of the password text between masked (hidden) and visible.
showStrength Provides feedback to the user on the strength or security of the password they have entered
(default = false)
class Pass CSS classes to the component
styles Pass inline CSS to the component

Config

Optionally you can publish config files which can be used to override feedback messages

php artisan vendor:publish  --provider="Atef\LivewirePasswordMeter\LivewirePasswordMeterServiceProvider" --tag="livewire-password-config"

Testing

composer test

Credits

License

The MIT License (MIT). Please see License File for more information.m