W3cubDocs

/Angular.js 1.6

Improve this Doc View Source ngPattern

  1. directive in module ng

Overview

ngPattern adds the pattern validator to ngModel. It is most often used for text-based input controls, but can also be applied to custom text-based controls.

The validator sets the pattern error key if the ngModel.$viewValue does not match a RegExp which is obtained from the ngPattern attribute value:

  • the value is an AngularJS expression:
    • If the expression evaluates to a RegExp object, then this is used directly.
    • If the expression evaluates to a string, then it will be converted to a RegExp after wrapping it in ^ and $ characters. For instance, "abc" will be converted to new RegExp('^abc$').
  • If the value is a RegExp literal, e.g. ngPattern="/^\d+$/", it is used directly.
Note: Avoid using the g flag on the RegExp, as it will cause each successive search to start at the index of the last search's match, thus not taking the whole input value into account.
Note: This directive is also added when the plain pattern attribute is used, with two differences:
  1. ngPattern does not set the pattern attribute and therefore HTML5 constraint validation is not available.
  2. The ngPattern attribute must be an expression, while the pattern value must be interpolated.

Directive Info

  • This directive executes at priority level 0.

Usage

  • as attribute:
    <ANY
      ng-pattern="">
    ...
    </ANY>

Arguments

Param Type Details
ngPattern expressionRegExp

AngularJS expression that must evaluate to a RegExp or a String parsable into a RegExp, or a RegExp literal. See above for more details.

Example

© 2010–2018 Google, Inc.
Licensed under the Creative Commons Attribution License 4.0.
https://code.angularjs.org/1.6.8/docs/api/ng/directive/ngPattern