https://github.com/ionited/mask-vue

Create your masks for Vue easily
https://github.com/ionited/mask-vue

core ionic ionicvue mask vue

Last synced: about 2 months ago
JSON representation

Create your masks for Vue easily

• Host: GitHub
• URL: https://github.com/ionited/mask-vue
• Owner: ionited
• License: mit
• Created: 2021-04-09T23:34:29.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2024-04-09T15:05:22.000Z (10 months ago)
• Last Synced: 2024-11-18T22:02:03.376Z (2 months ago)
• Topics: core, ionic, ionicvue, mask, vue
• Language: TypeScript
• Homepage:
• Size: 476 KB
• Stars: 18
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
# Mask-vue

> Create your masks for Vue easily

Vue wrapper for [@ionited/mask](https://github.com/ionited/mask). Compatible with Vue 3 and Ionic Vue

## Quick start

Choose your favorite option below:

### Install with NPM

```

npm i @ionited/mask-vue

```

### Get from UNPKG

[https://unpkg.com/@ionited/mask-vue@latest/dist/index.js](https://unpkg.com/@ionited/mask-vue@latest/dist/indext.js)

---

## Usage

To basic usage you can simply call:

```html

  

```

Local import:

```ts

import { mask } from '@ionited/mask-vue';

export default {

  ...

  directives: { mask },

  ...

}

```

or global import:

```ts

import { mask } from '@ionited/mask-vue';

const app = createApp(App)

.directive('mask', mask);

```

### Register your own masks

You can create your own mask logic easily, you only need `register` a mask and use:

```ts

register(name: string, mask: any): void;

```

See more [@ionited/mask](https://github.com/ionited/mask) 

## License

Copyright (c) 2021 Ion. Licensed under [MIT License](LICENSE).

[https://ionited.io](https://ionited.io)