百科.dev
全部条目在线工具AI 编程趋势榜开源项目技术资讯提交条目
登录
< 返回工具列表
U

ui-mask

> 编程语言
开源

在输入字段上添加掩码,以便用户只能输入预先确定的模式

387 stars0 点赞1 次浏览
访问官网GitHub

工具介绍

在输入字段上添加掩码,以便用户只能输入预先确定的模式

ui-mask

Apply a mask on an input field so the user can only type pre-determined pattern.

PROJECT NEEDS NEW MAINTAINER!

Please reach out to Dean Sofer / ProLoser if you're interested in taking over!!!

Requirements

  • AngularJS

Usage

Bower

You can get it from Bower

bash
bower install angular-ui-mask

Load the script files in your application:

xml

Add the specific module to your dependencies:

javascript
angular.module('myApp', ['ui.mask', ...])

NPM (CommonJS, ES6 module)

Also you can use it as CommonJS or ES6 module with any build system that supports those type of modules (Webpack, SystemJS, JSPM etc):

bash
npm install angular-ui-mask

And then include it with

javascript
// CommonJS
var uiMask = require('angular-ui-mask');
angular.module('myApp', [uiMask, ...]);
javascript
// ES6 module
import uiMask from 'angular-ui-mask';
angular.module('myApp', [uiMask, ...]);

Customizing

You can customize several behaviors of ui-mask by taking advantage of the ui-options object. Declare ui-options as an additional attribute on the same element where you declare ui-mask.

Inside of ui-options, you can customize these five properties:

  • maskDefinitions - default: { '9': /\d/, 'A': /[a-zA-Z]/, '*': /[a-zA-Z0-9]/ },
  • clearOnBlur - default: true,
  • clearOnBlurPlaceholder - default: false,
  • eventsToHandle - default: ['input', 'keyup', 'click', 'focus']
  • addDefaultPlaceholder - default: true
  • escChar - default: '\\'
  • allowInvalidValue - default: false

When customizing eventsToHandle, clearOnBlur, or addDefaultPlaceholder, the value you supply will replace the default. To customize eventsToHandle, be sure to replace the entire array.

Whereas, maskDefinitions is an object, so any custom object you supply will be merged together with the defaults using angular.extend(). This allows you to override the defaults selectively, if you wish.

When setting clearOnBlurPlaceholder to true, it will show the placeholder text instead of the empty mask. It requires the ui-mask-placeholder attribute to be set on the input to display properly.

If the escChar (\ by default) is encountered in a mask, the next character will be treated as a literal and not a mask definition key. To disable the escChar feature completely, set escChar to null.

When allowInvalidValue is set to true, apply value to $modelValue even if it isn't valid. By default, if you write an invalid value, the model will stay undefined.

Global customization

In addition to customizing behaviors for a specific element, you can also customize the behaviors globally. To do this, simply use the uiMaskConfig provider in your app configuration. Example:

javascript
app.config(['uiMask.ConfigProvider', function(uiMaskConfigProvider) {
  uiMaskConfigProvider.maskDefinitions({'A': /[a-z]/, '*': /[a-zA-Z0-9]/});
  uiMaskConfigProvider.clearOnBlur(false);
  uiMaskConfigProvider.eventsToHandle(['input', 'keyup', 'click']);
}

maskDefinitions

The keys in maskDefinitions represent the special tokens/characters used in your mask declaration to delimit acceptable ranges of inputs. For example, we use '9' here to accept any numeric values for a phone number: ui-mask="(999) 999-9999". The values associated with each token are regexen. Each regex defines the ranges of values that will be acceptable as inputs in the position of that token.

modelViewValue

If this is set to true, then the model value bound with ng-model will be the same as the $viewValue meaning it will contain any static mask characters present in the mask definition. This will not set the model value to a $viewValue that is considered invalid.

uiMaskPlaceholder

Allows customizing the mask placeholder when a user has focused the input element and while typing in their value

uiMaskPlaceholderChar

Allows customizing the mask placeholder character. The default mask placeholder is _.

Set this attribute to the word space if you want the placeholder character to be whitespace.

addDefaultPlaceholder

The default placeholder is constructed from the ui-mask definition so a mask of 999-9999 would have a default placeholder of ___-____; unless you have overridden the default placeholder character.

Testing

Most of the testing is done using Karma to run the tests and SauceLabs to provide the different browser environments to test against.

Mobile testing and debugging uses BrowserStack for its abilities to remotely debug mobile devices from a browser.

Development

We use Karma and jshint to ensure the quality of the code. The easiest way to run these checks is to use gulp:

bash
npm install -g gulp-cli
npm install && bower install
gulp

The karma task will try to open Firefox and Chrome as browser in which to run the tests. Make sure this is available or change the configuration in karma.conf.js

Gulp watch

gulp watch will automatically test your code and build a release whenever source files change.

How to release

Use gulp to bump version, build and create a tag. Then push to GitHub:

bash
gulp release [--patch|--minor|--major]
git push --tags origin master # push everything to GitHub

Travis will take care of testing and publishing to npm's registry (bower will pick up the change automatically). Finally create a release on GitHub from the tag created by Travis.

Issues· 0 开放

查看全部 Issues在 GitHub 打开

暂无开放 Issues,或尚未同步最近议题。

> 标签

JavaScript

暂无评论,来聊聊你的看法吧

> 工具信息

发布日期2026年8月1日
最后更新2026年9月17日
分类编程语言
定价开源

> 相关工具

T
TypeScript
JavaScript 的超集,为前端与全栈提供静态类型
P
Python
通用编程语言,广泛用于 Web、数据与 AI
G
Go
Google 推出的简洁高效系统语言