maska/README.md

# Maska

Simple zero-dependency input mask for Vue 2/3 or Vanilla JS.

[![npm bundle size](https://img.shields.io/bundlephobia/minzip/maska)](https://bundlephobia.com/package/maska)
[![build](https://github.com/beholdr/maska/actions/workflows/build.yml/badge.svg)](https://github.com/beholdr/maska/actions/workflows/build.yml)
![code coverage](https://img.shields.io/endpoint?url=https://gist.githubusercontent.com/beholdr/7f2a04de5e494f9a3820832520ee2562/raw/badge.json)

**[Documentation & demo →](https://beholdr.github.io/maska/)**

## Features ✨

- No dependencies and small size: ~2.5 Kb gziped
- Works with any native input
- Ability to define custom tokens
- Dynamic, reversed and eager masks
- Token modifiers, transform functions and hooks

## What’s new in v2 🎉

- Fully rewritten in TypeScript
- Autobind to vue variable
- Eager and reversed masking modes
- Optonal and repeated tokens
- Simplified syntax for custom tokens
- Dynamic masks with custom function logic
- Hooks for pre/post- processing
- Ability to replace or merge custom tokens

## Source of Inspiration 💡

- [vue-the-mask](https://vuejs-tips.github.io/vue-the-mask/)
- [jQuery Mask Plugin](http://igorescobar.github.io/jQuery-Mask-Plugin/)

## License 📄

[MIT](LICENSE.txt)