# @devindex/vue-mask 中文文档

规范地址：https://npmcn.com/package/%40devindex/vue-mask/

版本：2\.0\.3
npm 元数据更新时间：2022-04-05T04:07:26.892Z
中文译文更新时间：2026-11-12T03:20:11.709Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40devindex/vue-mask
原文对照：https://npmcn.com/package/%40devindex/vue-mask/?lang=original
项目主页：https://github.com/devindex/vue-mask#readme
源码仓库：https://github.com/devindex/vue-mask

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：51.4 kB，6 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：未声明
- 运行依赖：0 个
- 首次发布：2021-08-10T19:13:38.232Z
- 最新版本发布：2021-08-14T20:04:25.687Z
- 近 30 天下载量：9948（2026-10-12 至 2026-11-10，npm 官方下载统计）
- 已发布版本数：4（近 12 个月 0 个）

## 中文简介

Vue 3 的遮罩插件

## 安装

```sh
npm install @devindex/vue-mask
```

也可以使用：`pnpm add @devindex/vue-mask`、`yarn add @devindex/vue-mask`、`bun add @devindex/vue-mask`

## README

# 阴道口罩

Vue.js 基于 [字符串任务](https://github.com/the-darc/string-mask)

## 安装

这个版本只在Vue 3.

```bash
# npm
$ npm i -S @devindex/vue-mask

# yarn
$ yarn add @devindex/vue-mask
```

## 使用量

```javascript
import { createApp } from 'vue';
import VueMask from '@devindex/vue-mask'; // <-- ADD THIS LINE
import App from './App.vue';

const app = createApp(App);

app.use(VueMask);  // <-- ADD THIS LINE

app.mount('#app');
```

HTML 输入元素的基本用途

```html
<input type="text" name="mask" v-model="mask" v-mask="'0000-0000'">
```

## 可用口罩

### v 任务

```html
<input type="text" name="mask" v-model="mask" v-mask="'0000-0000'">
```

### v- mask- 日期( us- br)

```html
<input type="text" name="date" v-model="maskDate" v-mask-date.br>
```

### v- mask- 手机( us- br)

```html
<input type="text" name="phone" v-model="maskPhone" v-mask-phone.br>
```

### v- mask- 十进制( us- br)

```html
<input type="text" name="decimal" v-model="maskDecimal" v-mask-decimal.br="2">
```

### v 任务编号

```html
<input type="text" name="number" v-model="maskNumber" v-mask-number>
```

### v- mask- cpf 任务

```html
<input type="text" name="cpf" v-model="maskCpf" v-mask-cpf>
```

### 任务- cnpj

```html
<input type="text" name="cnpj" v-model="maskCnpj" v-mask-cnpj>
```

### v- mask- cep (韩语)

```html
<input type="text" name="cep" v-model="maskCep" v-mask-cep>
```

### 任务

```html
<input type="text" name="cc" v-model="maskCc" v-mask-cc>
```

## 特殊口罩字符

| 字符 | 说明 |
| --- | --- |
| `0` | 任意数字 |
| `9` | 任意数字(可选) |
| `#` | 任意数字( 递归) |
| `A` | 任意数字字符 |
| `S` | 任何信件 |
| `U` | 任意字母( 所有小写字符将被映射为大写) |
| `L` | 任意字母( 所有大写字符将被映射为小写) |
| `$` | 逃避字符,用于逃避任何特殊格式化字符. |

## 常见问题

### @devindex/vue-mask 是什么？

Vue 3 的遮罩插件

### 如何安装 @devindex/vue-mask？

在项目目录运行 npm install @devindex/vue-mask，或使用 pnpm add / yarn add / bun add。

### @devindex/vue-mask 支持 TypeScript 吗？

该包的 package\.json 没有声明类型入口。需要类型提示时，可以在 npm 上查找社区维护的 @types/devindex\_\_vue-mask 是否存在。

### @devindex/vue-mask 支持 ESM 还是 CommonJS？

同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。

### @devindex/vue-mask 可以商用吗？

@devindex/vue-mask 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @devindex/vue-mask 的下载量有多少？

根据 npm 官方下载统计，@devindex/vue-mask 在 2026/10/12 – 2026/11/10 这 30 天内被下载 9,948 次，日均约 332 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @devindex/vue-mask 还在维护吗？

最新版本 2\.0\.3 发布于 2021/08/15（5 年前）；至今共发布 4 个版本，其中过去 12 个月发布了 0 个；首次发布于 2021/08/11。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。