Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ronaldjerez/vue-input-facade
A lightweight and dependency free input masking library created specific for Vue
https://github.com/ronaldjerez/vue-input-facade
facade input input-mask masking plugin vue vue-components
Last synced: 2 days ago
JSON representation
A lightweight and dependency free input masking library created specific for Vue
- Host: GitHub
- URL: https://github.com/ronaldjerez/vue-input-facade
- Owner: RonaldJerez
- Created: 2019-12-12T18:05:42.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2024-01-12T18:57:28.000Z (10 months ago)
- Last Synced: 2024-11-05T19:07:40.279Z (9 days ago)
- Topics: facade, input, input-mask, masking, plugin, vue, vue-components
- Language: JavaScript
- Homepage: https://ronaldjerez.github.io/vue-input-facade/latest/
- Size: 3.55 MB
- Stars: 183
- Watchers: 6
- Forks: 27
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Vue Input Facade
A lightweight and dependency free input masking library created specific for Vue
[](https://travis-ci.org/RonaldJerez/vue-input-facade)
[](https://coveralls.io/github/RonaldJerez/vue-input-facade?branch=master&service=github)
[](LICENSE)
[](https://github.com/prettier/prettier)
### [Docs and Demo](https://ronaldjerez.github.io/vue-input-facade/latest/)
---
## Installing
```bash
npm i vue-input-facade
```
```bash
yarn add vue-input-facade
```
## Importing
### Globally
Installs the component, directive and filter for your entire application.
```javascript
import InputFacade from 'vue-input-facade'
Vue.use(InputFacade)
```
### Locally
Install per component as needed
```javascript
import { InputFacade, facade, filter } from 'vue-input-facade'
export default {
components: { InputFacade },
directives: { facade },
filters: { facade: filter },
// ... rest of component config
}
```
### Default Mask Tokens
+ `S` = alpha characters
+ `#` = numerical characters
+ `X` = alpha numerical characters
+ `A` = alpha characters, transformed to uppercase
+ `a` = alpha characters, transformed to lowercase
+ `\` = escape any of the above characters
+ `?` = mark the preceding character as optional [0 or 1]
+ `*` = mark the preceding character as optional & repeating [0 or more]
+ `|` = used for alternative static characters: A|B|C will accept A or B or C
See the [token source file](https://github.com/RonaldJerez/vue-input-facade/blob/master/src/tokens.js) for definition signature
## Note about special input types
The masking library does not currently work on special input types such as number, email etc. This is due to browsers treating these special inputs differently than text input and not supporting the same API. As such, only use vue-input-facade with ``.
## Usage
### As Component
```html
Phone Number
```
### As Directive
```html
Date
```
### Migrating existing projects
If you are migrating an existing project to vue-input-facade from another plugin and dont want to touch the whole codebase. You may pass options during plugin installation to override the default tokens or directive name.
```javascript
import InputFacade from 'vue-input-facade'
// migrating from v-mask
const options = {
// rename the directive from: v-facade to: v-mask
name: 'mask',
// use these tokens instead of the default
tokens: {
'#': { pattern: /\d/ },
'A': { pattern: /[a-z]/i },
'N': { pattern: /[0-9a-z]/i },
'X': { pattern: /./ }
}
}
Vue.use(InputFacade, options)
```
See [demo page](https://ronaldjerez.github.io/vue-input-facade) for more usage examples
## 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. The project uses [semantic-release](https://github.com/semantic-release/semantic-release) to release new versions, therefore all commit messages should follow [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/#summary), we are using [commitizen](https://github.com/commitizen/cz-cli) to facilitate writting the commit messages.
## License
This project is licensed under [MIT License](http://en.wikipedia.org/wiki/MIT_License)