react-input-formatter

⚠️ Important: Client Component Requirement

react-input-formatter uses browser-only DOM APIs such as selectionStart and setSelectionRange to apply live formatting and caret positioning. These APIs do not exist during server-side rendering.

If you are using Next.js (App Router), you must use this component inside a Client Component.

Add "use client" at the top of the file where you use the component:

"use client";

import FormattedInput from "react-input-formatter";

export default function MyForm() {
  return <FormattedInput {...props} />;
}

Table of Contents

• About
• Installation
• Usage
• Props
• Contributing
• Feedback / Issues
• License

About

react-input-formatter is a lightweight and flexible React component that formats the output of input fields according to a provided format template. It ensures consistent and user-friendly input formatting for various types of data such as phone numbers, credit card numbers, dates, and more.

Installation

npm install react-input-formatter

OR

yarn add react-input-formatter

Usage

import {FormattedInput} from "react-formatted-input";

const ComponentName = ()=>{
  return <>
    <FormattedInput 
      name="postalCode" 
      id="postalCode-id" 
      placeholderText="" 
      formatTemplate="###-###" 
      defaultValue=""
    />
  </>
}

export default ComponentName;

This code will allow the inputs of the following format: A1B2C3 and will make it A1B-2C3.

Props

• formatTemplate: This is the masked version of the input that we want the user to input.
  • # masks an alphanumeric character.
  • 9 masks a numeric character.
  • @ masks a special character.

Examples

• ###-#### → allows an input like A1B-2C3D
• (999)999-999 → allows an input like (123)456-7890

Contributing

Contributions are welcome! Please read the contributing guidelines first.

1. Fork the repository.
2. Create a new branch (git checkout -b feature-branch).
3. Commit your changes (git commit -am 'Add new feature').
4. Push to the branch (git push origin feature-branch).
5. Create a new Pull Request.

Feedback / Issues

If you discover a bug, want to propose an improvement, or have a feature request, feel free to open an issue here:

➡️ Create a GitHub Issue: https://github.com/khushmeetSingh/input-npm-package/issues/new

Or reach out via email:

📧 [email protected]

License

This project is licensed under the MIT License — see the
LICENSE file for details.