1. Plugins
  3. Strong Password

Plugins

Tailwind CSS Strong Password

Use strong passwords based on required characters.

Image Description

Installation

To get started, install Strong Password plugin via npm, else you can skip this step if you are already using Preline UI as a package.

                      
                        npm i @preline/strong-password

Example

Here is an example of a strong password with level of weakness, hints and progress.

Basic usage

Prefer to create your own style? Here is a completely unstylized example.

                      
                        <div class="flex-1">
                          <input type="password" id="hs-strong-password-input" class="py-3 px-4 block w-full border-gray-200 rounded-lg text-sm focus:border-blue-500 focus:ring-blue-500 dark:bg-slate-900 dark:border-gray-700 dark:text-gray-400"
                          />
                          <div data-hs-strong-password='{
                                "target": "#hs-strong-password-input",
                                "stripClasses": "hs-strong-password:opacity-100 hs-strong-password-accepted:bg-green-500 h-2 flex-auto rounded-full bg-blue-500 opacity-50 mx-1"
                              }' id="strong-password" class="flex mt-2 -mx-1"
                          ></div>
                        </div>
                        
                        <div class="mb-3">
                          <span id="strong-password-weakness"></span>
                        </div>

Options

Name Description Options Default value
data-hs-strong-password Activate a Strong Password by specifying on an element. The value should contain at least one lowercase number, one uppercase letter, one number, one special character (!%&@#$^*?_~), and minimum 6 characters. — —
:target (required) Determines which element should be observed. This must be a valid selector. string —
:hints Determines which element should be observed as hints container. This must be a valid selector.
There are some selectors that available for using inside the hints:
  • [data-hs-strong-password-hints-weakness-text] determines which element should be observed as weakness text container. It should contain an array of strings, e.g. - ["Empty", "Weak", "Medium", "Strong", "Very Strong", "Super Strong"]. Each text is for the concrete strength value, e.g. "Medium" have index 2, and it will be set up if strength is also 2. "Empty" have index 0, and it will be shown if field is empty and have no any strength
  • [data-hs-strong-password-hints-rule-text] determines which element should be observed as rule text container. It could have one of the follow value: "min-length" | "lowercase" | "uppercase" | "numbers" | "special-characters"
  • [data-check] determines which element should be observed inside the [data-hs-strong-password-hints-rule-text] as rule check icon container
  • [data-uncheck] determines which element should be observed inside the [data-hs-strong-password-hints-rule-text] as rule uncheck icon container
 string —
:stripClasses Defines CSS classes for each strip. — —
:minLength Determines minimum password length. number 6
:mode Determines which mode should be used. If popover is selected, the hints will be displayed as a popover. "default" | "popover" default
:popoverSpace Available if mode is set to popover. Determines the space between the popover and the target element. number 10
:checksExclude Determines which checks should be excluded. It could contain an array of strings, e.g. - ["min-length", "lowercase", "uppercase", "numbers", "special-characters"]. array []
:specialCharactersSet Determines which special characters should be used for checking. It could contain a string of available characters, e.g. - "!%&". string !"#$%&\'()*+,-./:;<=>?@[\\\\\\]^_`{|}~

Classes

Name Description
hs-strong-password: A modifier that allows you to set Tailwind classes for the passed stripes.
hs-strong-password-accepted: A modifier that allows you to set Tailwind classes when password strength is accepted.

Methods

The HSStrongPassword object is contained within the global window object

Method Description
Public methods
recalculateDirection() Force recalculation for dropdown hint.
Static methods
HSStrongPassword.getInstance(target) Returns the element associated to the target.
  • target should be a Node or string (valid selector)

Force dropdown hint position to be recalculated when scrolling (public method).

                      
                        const strongPassword = new HSStrongPassword(document.querySelector('#strong-password'));
                        
                        document.addEventListener('scroll', () => {
                          if (strongPassword) strongPassword.recalculateDirection();
                        });

Force dropdown hint position to be recalculated when scrolling (mixed).

                      
                        const strongPassword = HSStrongPassword.getInstance('#strong-password');
                        
                        document.addEventListener('scroll', () => {
                          if (strongPassword) strongPassword.recalculateDirection();
                        });

Events

Method Description Returned value
on:change Called when target element was changed.
  • strength number. Current level of strength (0 - 4). Default - 0
  • rules array. Current set of passed checks ("lowercase", "uppercase", "numbers", "special-characters")

An example where a function is run every time a value changes.

                      
                        const el = HSStrongPassword.getInstance('#strong-password');

                        el.on('change', ({strength, rules}) => {...});

Demo examples

Looking for prebuilt UI components based on the Tailwind CSS? Preline UI packs hundreds of component examples for all your website needs.

Image Description
Check out Preline UI Strong Password