# @ionited/mask-vue

> Create your masks for Vue easily

Latest version **0.1.28** (published 2025-02-18) · MIT license · 0 weekly downloads

## Install

```sh
npm install @ionited/mask-vue
pnpm add @ionited/mask-vue
yarn add @ionited/mask-vue
bun add @ionited/mask-vue
```

## Health

**Score 35/100 (D)** — status: maintenance-mode.

Positive: has types; esm support; no vulnerabilities.

Warnings: low downloads; pre 1.0.

Negative: stale; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.28 |
| Published | 2025-02-18 |
| First published | 2021-04-09 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 2 |
| Unpacked size | 116.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 25 |
| Author | Ion |
| Maintainers | ion-project |
| Keywords | Mask, Core, Vue, Ionic, Ionic Vue |

## Links

- npm: https://www.npmjs.com/package/@ionited/mask-vue
- Repository: https://github.com/ionited/mask-vue
- Homepage: https://github.com/ionited/mask-vue#readme
- Issues: https://github.com/ionited/mask-vue/issues
- npm.io page: https://npm.io/package/@ionited/mask-vue

## Dependencies (2)

- [vue](https://npm.io/package/vue.md) ^3.5.13
- [@ionited/mask](https://npm.io/package/@ionited/mask.md) ^0.7.0

## Alternatives

- [lodash.assign](https://npm.io/package/lodash.assign.md) — 2.3M weekly downloads
- [lodash.chunk](https://npm.io/package/lodash.chunk.md) — 1.8M weekly downloads
- [react-native-ios-utilities](https://npm.io/package/react-native-ios-utilities.md) — 138.5K weekly downloads
- [@technically/lodash](https://npm.io/package/@technically/lodash.md) — 50.9K weekly downloads
- [@fluid-topics/ft-icon](https://npm.io/package/@fluid-topics/ft-icon.md) — 20.6K weekly downloads

## Recent versions

- 0.1.28 (latest) — 2025-02-18
- 0.1.27 — 2024-04-09
- 0.1.26 — 2023-10-17
- 0.1.25 — 2023-05-26
- 0.1.24 — 2022-09-28
- 0.1.23 — 2022-09-28
- 0.1.22 — 2022-07-06
- 0.1.21 — 2022-07-06
- 0.1.20 — 2022-07-06
- 0.1.19 — 2022-02-11
- 0.1.18 — 2021-11-19
- 0.1.17 — 2021-11-18
- 0.1.16 — 2021-11-18
- 0.1.15 — 2021-10-06
- 0.1.14 — 2021-10-01
- … 14 more at https://npm.io/package/@ionited/mask-vue/versions

## 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
<template>
  <input v-mask="{ mask: '99 / 9999' }">
</template>
```

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)

---
_Source: https://npm.io/package/@ionited/mask-vue · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._