Skip to content

Commit

Permalink
README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
titou10titou10 committed Aug 24, 2019
1 parent 75ba17b commit 628d212
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 12 deletions.
22 changes: 11 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,23 +2,13 @@
**A vue.js package that provides a directive to apply a mask to input tags**

### TD;LR;
A`"mask"` directive for Vue.js that sets the **masked** and **unmasked**** value of an`"input"`component (ie the `"v-text-field"` component from vuetify)
A`"mask"` directive for Vue.js that sets the **masked** and **unmasked** value of an`"input"`component (eg the `"v-text-field"` component from vuetify)

#### The differences with`"vue-the-mask"`:
- "v-model" will always contain the masked value, the directive may also set the unmasked value to a specified variable (see below)
- the package provides predefined masks (see below)
- the package does not include a Vue.js component, just a directive

#### Why this package?
This package has been created after the`"mask"` property of the`"v-text-field"`component has been removed and I was not able to find another package that allow to **retrieve the masked and unmasked value** of an input text from a directive

Technically, it is a "merge" of the`vue-the-mask`package, which is not maintained since years, and the old`mask`code from vuetify v1.5.x

Most of the credit goes to:
- [vuetify v1.5.x code](https://github.com/vuetifyjs/vuetify/blob/v1.5.18/packages/vuetify/src/util/mask.ts)
- [vue-the-mask](https://github.com/vuejs-tips/vue-the-mask)
- [RonaldJerez/vue-the-mask](https://github.com/RonaldJerez/vue-the-mask)

### Install

```sh
Expand Down Expand Up @@ -66,3 +56,13 @@ export default {
- `time: '##:##'`
- `time-with-seconds: '##:##:##'`
- `postalcode-ca: 'A#A #A#'`

#### Why this package?
This package has been created after the`"mask"` property of the`"v-text-field"`component has been removed and I was not able to find another package that allow to **retrieve the masked and unmasked value** of an input text from a directive

Technically, it is a "merge" of the`vue-the-mask`package, which is not maintained since years, and the old`mask`code from vuetify v1.5.x

Most of the credit goes to:
- [vuetify v1.5.x code](https://github.com/vuetifyjs/vuetify/blob/v1.5.18/packages/vuetify/src/util/mask.ts)
- [vue-the-mask](https://github.com/vuejs-tips/vue-the-mask)
- [RonaldJerez/vue-the-mask](https://github.com/RonaldJerez/vue-the-mask)
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "@titou10/v-mask",
"description": "mask directive for vue.js that exposes the unmasked value",
"version": "0.9.4",
"version": "0.9.5",
"author": "Denis Forveille <[email protected]>",
"license": "MIT",
"keywords": [
Expand Down

0 comments on commit 628d212

Please sign in to comment.