0.12.5 • Published 6 years ago

@rj-pkgs/vue-the-mask v0.12.5

Weekly downloads
95
License
MIT
Repository
github
Last release
6 years ago

The Mask

The original seems to be abandoned, I am trying to fix a few outstanding issues and update this repo a bit. WORK IN PROGRESS.

A lightweight and dependency free mask input created specific for Vue.js

Docs and Demo

Install

yarn add @rj-pkgs/vue-the-mask
or
npm i @rj-pkgs/vue-the-mask

Usage (two flavors)

Global

import VueTheMask from '@rj-pkgs/vue-the-mask'
Vue.use(VueTheMask)

Local (inside the component)

import { TheMask } from '@rj-pkgs/vue-the-mask'
export default {
  components: { TheMask }
}

Local (as directive)

import { mask } from '@rj-pkgs/vue-the-mask'
export default {
  directives: { mask }
}

Tokens

'#': {pattern: /\d/},
'X': {pattern: /[0-9a-zA-Z]/},
'S': {pattern: /[a-zA-Z]/},
'A': {pattern: /[a-zA-Z]/, transform: v => v.toLocaleUpperCase()},
'a': {pattern: /[a-zA-Z]/, transform: v => v.toLocaleLowerCase()},
'!': {escape: true}

Properties

PropertyRequiredTypeDefaultDescription
valuefalseStringInput value or v-model
masktrueString, ArrayMask pattern
maskedfalseBooleanfalseemit value with mask chars, default is raw
placeholderfalseStringSame as html input
typefalseString'text'Input type (email, tel, number, ...)
tokensfalseObjecttokensCustom tokens for mask

Contribution

You're free to contribute to this project by submitting Issues and/or pull requests. This project is test-driven, so keep in mind that every change and new feature should be covered by tests. Your name will be added to the hall of fame ;)

License

This project is licensed under MIT License

0.12.5

6 years ago

0.12.4

6 years ago

0.12.3

6 years ago

0.12.2

6 years ago

0.12.1

6 years ago

0.12.0

6 years ago