Skip to content

FatihKaratepe/mfk-mask-input

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

14 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

mfk-mask-input

A lightweight and flexible vanilla React masked input component built with IMask.

📦 Package

The npm package is located in the lib/ directory. See lib/README.md for full documentation.

Quick Install

npm install mfk-mask-input

Quick Example

import { InputMask } from "mfk-mask-input";

<InputMask
  mask="(000) 000-0000"
  placeholder="Phone number"
  onChange={(e) => console.log(e.maskedValue, e.unmaskedValue)}
/>;

🚀 Demo

A live demo application is available in the demo/ directory. To run it:

cd demo
npm install
npm run dev

📁 Project Structure

mfk-mask-input/
├── lib/          # NPM package source
├── demo/         # Demo application
├── LICENSE
├── CHANGELOG.md
└── README.md

🔧 Development

Building the Library

cd lib
npm install
npm run build

Running the Demo

cd demo
npm install
npm run dev

📖 Documentation

For complete API documentation, usage examples, and TypeScript support, see:

🤝 Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

📄 License

MIT - See LICENSE for details.

🔗 Links

About

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors