@krozamdev/masked-password

A lightweight and modern utility to mask input fields with password-like characters. This package is designed to prevent automatic storage in password managers while allowing easy retrieval of the original value. Perfect for cases where sensitive data needs to be handled in a custom way.

Compatible Packages

Features

🔒 Masks input fields in real-time using customizable characters (e.g., * or •).
📜 Allows retrieval of the original value without exposing it in the UI.
✅ Works seamlessly with JavaScript and TypeScript.
🚀 Lightweight and easy to integrate with any frontend framework.
💡 Prevents password managers from saving sensitive input values.

Installation

npm
```
npm install @krozamdev/masked-password
```
yarn
```
yarn add @krozamdev/masked-password
```
pnpm
```
pnpm add @krozamdev/masked-password
```
bun
```
bun add @krozamdev/masked-password
```

Usage

Basic Example ESModule

By default, the masking character is •, and the original value can be retrieved using the provided method.

import { applyMaskedInput } from '@krozamdev/masked-password';

const inputElement = document.getElementById("passwordInput") as HTMLInputElement;
const maskedInput = applyMaskedInput(inputElement);

console.log(maskedInput.getOriginalValue()); // Original value of input

Custom Mask Character

You can also provide a custom mask character, such as •, by passing it as a configuration option.

import { applyMaskedInput } from '@krozamdev/masked-password';

const inputElement = document.getElementById("passwordInput") as HTMLInputElement;
const maskedInput = applyMaskedInput(inputElement);

console.log(maskedInput.getOriginalValue()); // Original value of input

HTML Example

<input type="text" id="passwordInput" />
<script type="module">
  import { applyMaskedInput } from '@krozamdev/masked-password';

  const inputElement = document.getElementById('passwordInput');
  const maskedInput = applyMaskedInput(inputElement, { character: '*' });

  // To get the original value
  console.log(maskedInput.getOriginalValue());
</script>

CommonJS Example

In CommonJS, you can use require to import the module.

Default Mask (`•`):

const { applyMaskedInput } = require('@krozamdev/masked-password');

const inputElement = document.getElementById('passwordInput');
const maskedInput = applyMaskedInput(inputElement);

console.log(maskedInput.getOriginalValue()); // Original value of input

Custom Mask (`*`):

const { applyMaskedInput } = require('@krozamdev/masked-password');

const inputElement = document.getElementById('passwordInput');
const maskedInput = applyMaskedInput(inputElement, { character: '*' });

console.log(maskedInput.getOriginalValue()); // Original value of input

HTML Example

<input type="text" id="passwordInput" />
<script type="module">
  const { applyMaskedInput } = require('@krozamdev/masked-password');

  const inputElement = document.getElementById('passwordInput');
  const maskedInput = applyMaskedInput(inputElement, { character: '*' });

  // To get the original value
  console.log(maskedInput.getOriginalValue());
</script>

Destroy & add Event

<input type="text" id="passwordInput" />
<button id="eye_btn">Eye Button</button>
<button id="btn">Show Log</button>
<script type="module">
  const { applyMaskedInput } = require('@krozamdev/masked-password');

  const inputElement = document.getElementById('passwordInput');
  const maskedInput = applyMaskedInput(inputElement, { character: '*' });

  let show = false;
  const eyeBtn = document.getElementById("eye_btn");
  eyeBtn.addEventListener("click", function () {
    if (show) {
      eyeBtn.style.textDecoration = "line-through";
      maskedInput.addEvent();
    }else{
      eyeBtn.style.textDecoration = "none";
      maskedInput.destroy();
    }
    show = !show
  });

  document.getElementById("btn").addEventListener("click", function () {
    console.log(maskedInput.getOriginalValue());
  });
</script>

Browser Support

omit the version completely to get the latest one you should NOT use this in production

<script src="https://cdn.jsdelivr.net/npm/@krozamdev/masked-password/dist/index.umd.min.js"></script>
<input type="text" id="passwordInput" />
<button id="btn">Show Log</button>
<script>
  const inputElement = document.getElementById("passwordInput");
  const maskedInput = MaskedPassword.applyMaskedInput(inputElement, {
    character: "•",
  });

  document.getElementById("btn").addEventListener("click", function () {
    console.log(maskedInput.getOriginalValue());
  });
</script>

Options

character (optional): The character to use for masking the input field. Default is *.

Methods

getOriginalValue():
- This function returns the original unmasked value of the input field. For example, if the input has a masking format (like a phone number with parentheses and dashes), this function will return the raw, unformatted value without any masking.
destroy():
- This function removes the registered event listeners from the input element, restores the original value, and disables the masking feature.
- The destroy() method checks certain conditions (like whether the onChange configuration exists), allowing the logic of the event handling to be adjusted or replaced before fully destroying the masking.
addEvent():
- This function re-registers the event listeners on the input element, making it easier to re-enable the masking after it has been destroyed. This method is useful if you temporarily disable masking and later want to re-enable it without losing the initial setup or logic.
purgeDestroy():
- This function is similar to destroy(), but it removes all registered event listeners from the input element without checking any conditions. It restores the original value and disables masking completely.
- The key difference is that purgeDestroy() aggressively removes event listeners and masking without considering additional configurations or conditions.

Key Differences:

destroy() takes into account specific conditions (such as the existence of the onChange configuration), allowing more control over the event handling before removing the masking.
purgeDestroy() is more direct and forceful in that it removes all event listeners and deactivates masking without checking any conditions.

When to Use:

Use destroy() if you need finer control or need to consider additional configurations (e.g., onChange) before disabling the masking.
Use purgeDestroy() if you want to completely reset the input element without considering any conditions or logic.

Example Use Cases:

destroy(): Used when you want to stop masking but still retain logic related to value changes (onChange).
purgeDestroy(): Used when you want to fully reset the input element and remove masking without regard to existing logic or configurations.

Sample Code

sample code