ngx-mask 8.1.7 → 8.2.0

package/README.md

@@ -5,7 +5,7 @@
 [![Build Status](https://img.shields.io/travis/JsDaddy/ngx-mask.svg?branch=develop)](https://travis-ci.org/JsDaddy/ngx-mask)
 [![npm](https://img.shields.io/npm/v/ngx-mask.svg)](https://www.npmjs.com/package/ngx-mask)
 <a href="https://npmjs.org/ngx-mask">
-  <img src="https://img.shields.io/npm/dt/ngx-mask.svg" alt="npm downloads">
+<img src="https://img.shields.io/npm/dt/ngx-mask.svg" alt="npm downloads">
 </a>
 
 [![npm](https://img.shields.io/npm/dm/ngx-mask.svg)](https://www.npmjs.com/package/ngx-mask)
@@ -30,7 +30,7 @@ $ npm install --save ngx-mask
 Import **ngx-mask** module in Angular app.
 
 ```typescript
-import { NgxMaskModule } from 'ngx-mask'
+import { NgxMaskModule, IConfig } from 'ngx-mask'
 
 export const options: Partial<IConfig> | (() => Partial<IConfig>);
 
@@ -48,7 +48,13 @@ Then, just define masks in inputs.
 ### Usage
 
 ```html
-<input type="text" mask="{here comes your mask}" />
+<input type="text" mask="<here goes your mask>" />
+```
+
+or
+
+```html
+<input type="text" [mask]="<here goes a reference to your component's mask property>" />
 ```
 
 Also, you can use mask pipe.
@@ -72,35 +78,35 @@ For separator you can add thousandSeparator
 | mask           | example        |
 | -------------- | -------------- |
 | 9999-99-99     | 2017-04-15     |
-| 0*.00          | 2017.22        |
+| 0\*.00         | 2017.22        |
 | 000.000.000-99 | 048.457.987-98 |
 | AAAA           | 0F6g           |
 | SSSS           | asDF           |
 
 ## Mask Options
 
-You can define your custom options for all directives (as  object in the mask module) or for each (as attributes for directive). If you override this parameter, you have to provide all the special characters (default one are not included).
+You can define your custom options for all directives (as object in the mask module) or for each (as attributes for directive). If you override this parameter, you have to provide all the special characters (default one are not included).
 
 ### specialCharacters (string[ ])
 
 We have next default characters:
 
-   | character |
-   |-----------|
-   | - |
-   | / |
-   | ( |
-   | ) |
-   | . |
-   | : |
-   | **space** |
-   | + |
-   | , |
-   | @ |
-   | [ |
-   | ] |
-   | " |
-   | ' |
+| character |
+| --------- |
+| -         |
+| /         |
+| (         |
+| )         |
+| .         |
+| :         |
+| **space** |
+| +         |
+| ,         |
+| @         |
+| [         |
+| ]         |
+| "         |
+| '         |
 
 #### Usage
 
@@ -121,12 +127,12 @@ patterns ({ [character: string]: { pattern: RegExp, optional?: boolean})
 
 We have next default patterns:
 
-  | code  | meaning                                     |
-  | ----- | ------------------------------------------- |
-  | **0** | digits (like 0 to 9 numbers)                |
-  | **9** | digits (like 0 to 9 numbers), but optional  |
-  | **A** | letters (uppercase or lowercase) and digits |
-  | **S** | only letters (uppercase or lowercase)       |
+| code  | meaning                                     |
+| ----- | ------------------------------------------- |
+| **0** | digits (like 0 to 9 numbers)                |
+| **9** | digits (like 0 to 9 numbers), but optional  |
+| **A** | letters (uppercase or lowercase) and digits |
+| **S** | only letters (uppercase or lowercase)       |
 
 ##### Usage
 
@@ -153,11 +159,11 @@ You can define custom pattern and specify symbol to be rendered in input field.
 
 ```typescript
 pattern = {
-  'B': {
+  B: {
     pattern: new RegExp('\\d'),
-    symbol: 'X'
-  }
-}
+    symbol: 'X',
+  },
+};
 ```
 
 ### prefix (string)
@@ -204,7 +210,24 @@ You can choose if mask is shown while typing, or not, default value is `false`.
 #### Usage
 
 ```html
- <input mask="(000) 000-0000" prefix="+7" [showMaskTyped]="true" />
+<input mask="(000) 000-0000" prefix="+7" [showMaskTyped]="true" />
+```
+
+### allowNegativeNumbers (boolean)
+
+You can choose if mask will allow the use of negative numbers. The default value is `false`.
+
+#### Usage
+
+```html
+<input type="text" [allowNegativeNumbers]="true" mask="separator.2" />
+```
+
+##### Then
+
+```text
+Input value: -10,000.45
+Model value: -10000.45
 ```
 
 ### placeHolderCharacter (string)
@@ -214,7 +237,7 @@ If the `showMaskTyped` parameter is enabled, this setting customizes the charact
 #### Usage
 
 ```html
- <input mask="(000) 000-0000" prefix="+7" [showMaskTyped]="true" placeHolderCharacter="*" />
+<input mask="(000) 000-0000" prefix="+7" [showMaskTyped]="true" placeHolderCharacter="*" />
 ```
 
 ### clearIfNotMatch (boolean)
@@ -224,7 +247,7 @@ You can choose clear the input if the input value **not match** the mask, defaul
 ### Pipe with mask expression and custom Pattern ([string, pattern])
 
 You can pass array of expression and custom Pattern to pipe.
-  
+
 #### Usage
 
 ```html
@@ -237,22 +260,22 @@ and in your component
 customMask: [string, pattern];
 
 pattern = {
-  'P': {
+  P: {
     pattern: new RegExp('\\d'),
-  }
+  },
 };
-  
+
 this.customMask = ['PPP-PPP', this.pattern];
 ```
 
 ### Repeat mask
 
 You can pass into mask pattern with brackets.
-  
+
 #### Usage
 
 ```html
- <input type="text" mask="A{4}" />
+<input type="text" mask="A{4}" />
 ```
 
 ### Thousand separator
@@ -262,19 +285,19 @@ You can divide your input by thousands, by default will seperate with a space.
 #### Usage
 
 ```html
- <input type="text" mask="separator" />
+<input type="text" mask="separator" />
 ```
 
 For separate input with dots.
 
 ```html
- <input type="text" mask="separator" thousandSeparator="." />
+<input type="text" mask="separator" thousandSeparator="." />
 ```
 
 For using decimals enter `.` and how many decimals to the end of your input to `separator` mask.
 
 ```html
- <input type="text" mask="separator.2" />
+<input type="text" mask="separator.2" />
 ```
 
 ```text
@@ -289,10 +312,10 @@ Masked value: 1,234.56
 ```
 
 ```html
- <input type="text" mask="separator.2" thousandSeparator="." />
- <input type="text" mask="separator.2" thousandSeparator="," />
- <input type="text" mask="separator.0" thousandSeparator="." />
- <input type="text" mask="separator.0" thousandSeparator="," />
+<input type="text" mask="separator.2" thousandSeparator="." />
+<input type="text" mask="separator.2" thousandSeparator="," />
+<input type="text" mask="separator.0" thousandSeparator="." />
+<input type="text" mask="separator.0" thousandSeparator="," />
 ```
 
 For limiting decimal precision add `.` and the precision you want to limit too on the input. **2** is useful for currency. **0** will prevent decimals completely.
@@ -312,7 +335,7 @@ Masked value: 1,234
 ```
 
 ```html
- <input type="text" mask="separator.2" separatorLimit="1000" />
+<input type="text" mask="separator.2" separatorLimit="1000" />
 ```
 
 For limiting the number of digits before the decimal point you can set `separatorLimit` value to _10_, _100_, _1000_ etc.
@@ -329,7 +352,7 @@ You can validate your input as 24 hour format.
 #### Usage
 
 ```html
- <input type="text" mask="Hh:m0:s0" />
+<input type="text" mask="Hh:m0:s0" />
 ```
 
 ### Percent validation
@@ -339,7 +362,7 @@ You can validate your input for percents.
 #### Usage
 
 ```html
- <input type="text" mask="percent" suffix="%" />
+<input type="text" mask="percent" suffix="%" />
 ```
 
 ### FormControl validation
@@ -349,7 +372,7 @@ You can validate your `formControl`, default value is `true`.
 #### Usage
 
 ```html
- <input type="text" mask="00 00" [validation]="true" />
+<input type="text" mask="00 00" [validation]="true" />
 ```
 
 ### Secure input
@@ -359,7 +382,7 @@ You can hide symbols in input field and get the actual value in `formcontrol`.
 #### Usage
 
 ```html
- <input placeholder="Secure input" [hiddenInput]="true" mask="XXX/X0/0000" />
+<input placeholder="Secure input" [hiddenInput]="true" mask="XXX/X0/0000" />
 ```
 
 ### IP valid mask
@@ -367,5 +390,5 @@ You can hide symbols in input field and get the actual value in `formcontrol`.
 #### Usage
 
 ```html
- <input mask="IP" />
+<input mask="IP" />
 ```

package/bundles/ngx-mask.umd.js

@@ -239,6 +239,8 @@
         /** @type {?} */
         IConfig.prototype.separatorLimit;
         /** @type {?} */
+        IConfig.prototype.allowNegativeNumbers;
+        /** @type {?} */
         IConfig.prototype.patterns;
     }
     /** @type {?} */
@@ -261,6 +263,7 @@
         hiddenInput: undefined,
         shownMaskExpression: '',
         separatorLimit: '',
+        allowNegativeNumbers: false,
         validation: true,
         // tslint:disable-next-line: quotemark
         specialCharacters: ['-', '/', '(', ')', '.', ':', ' ', '+', ',', '@', '[', ']', '"', "'"],
@@ -419,6 +422,7 @@
             this.placeHolderCharacter = this._config.placeHolderCharacter;
             this.validation = this._config.validation;
             this.separatorLimit = this._config.separatorLimit;
+            this.allowNegativeNumbers = this._config.allowNegativeNumbers;
         }
         /**
          * @param {?} inputValue
@@ -872,6 +876,8 @@
         MaskApplierService.prototype.validation;
         /** @type {?} */
         MaskApplierService.prototype.separatorLimit;
+        /** @type {?} */
+        MaskApplierService.prototype.allowNegativeNumbers;
         /**
          * @type {?}
          * @private
@@ -918,7 +924,6 @@
             _this._renderer = _renderer;
             _this.maskExpression = '';
             _this.isNumberValue = false;
-            _this.showMaskTyped = false;
             _this.placeHolderCharacter = '_';
             _this.maskIsShown = '';
             _this.selStart = null;
@@ -1430,8 +1435,6 @@
         /** @type {?} */
         MaskService.prototype.isNumberValue;
         /** @type {?} */
-        MaskService.prototype.showMaskTyped;
-        /** @type {?} */
         MaskService.prototype.placeHolderCharacter;
         /** @type {?} */
         MaskService.prototype.maskIsShown;
@@ -1494,6 +1497,7 @@
             this.clearIfNotMatch = null;
             this.validation = null;
             this.separatorLimit = null;
+            this.allowNegativeNumbers = null;
             this._maskValue = '';
             this._position = null;
             this.onChange = (/**
@@ -1515,7 +1519,7 @@
          * @return {?}
          */
         function (changes) {
-            var maskExpression = changes.maskExpression, specialCharacters = changes.specialCharacters, patterns = changes.patterns, prefix = changes.prefix, suffix = changes.suffix, thousandSeparator = changes.thousandSeparator, decimalMarker = changes.decimalMarker, dropSpecialCharacters = changes.dropSpecialCharacters, hiddenInput = changes.hiddenInput, showMaskTyped = changes.showMaskTyped, placeHolderCharacter = changes.placeHolderCharacter, shownMaskExpression = changes.shownMaskExpression, showTemplate = changes.showTemplate, clearIfNotMatch = changes.clearIfNotMatch, validation = changes.validation, separatorLimit = changes.separatorLimit;
+            var maskExpression = changes.maskExpression, specialCharacters = changes.specialCharacters, patterns = changes.patterns, prefix = changes.prefix, suffix = changes.suffix, thousandSeparator = changes.thousandSeparator, decimalMarker = changes.decimalMarker, dropSpecialCharacters = changes.dropSpecialCharacters, hiddenInput = changes.hiddenInput, showMaskTyped = changes.showMaskTyped, placeHolderCharacter = changes.placeHolderCharacter, shownMaskExpression = changes.shownMaskExpression, showTemplate = changes.showTemplate, clearIfNotMatch = changes.clearIfNotMatch, validation = changes.validation, separatorLimit = changes.separatorLimit, allowNegativeNumbers = changes.allowNegativeNumbers;
             if (maskExpression) {
                 this._maskValue = changes.maskExpression.currentValue || '';
             }
@@ -1570,6 +1574,13 @@
             if (separatorLimit) {
                 this._maskService.separatorLimit = separatorLimit.currentValue;
             }
+            if (allowNegativeNumbers) {
+                this._maskService.maskSpecialCharacters = this._maskService.maskSpecialCharacters.filter((/**
+                 * @param {?} c
+                 * @return {?}
+                 */
+                function (c) { return c !== '-'; }));
+            }
             this._applyMask();
         };
         // tslint:disable-next-line: cyclomatic-complexity
@@ -1590,7 +1601,7 @@
                 return null;
             }
             if (this._maskService.ipError) {
-                return { 'Mask error': true };
+                return this._createValidationError(value);
             }
             if (this._maskValue.startsWith('separator')) {
                 return null;
@@ -1649,7 +1660,7 @@
                 else if ((this._maskValue.indexOf('*') > 1 && value.toString().length < this._maskValue.indexOf('*')) ||
                     (this._maskValue.indexOf('?') > 1 && value.toString().length < this._maskValue.indexOf('?')) ||
                     this._maskValue.indexOf('{') === 1) {
-                    return { 'Mask error': true };
+                    return this._createValidationError(value);
                 }
                 if (this._maskValue.indexOf('*') === -1 || this._maskValue.indexOf('?') === -1) {
                     /** @type {?} */
@@ -1657,7 +1668,7 @@
                         ? this._maskValue.length - this._maskService.checkSpecialCharAmount(this._maskValue) - counterOfOpt
                         : this._maskValue.length - counterOfOpt;
                     if (value.toString().length < length_1) {
-                        return { 'Mask error': true };
+                        return this._createValidationError(value);
                     }
                 }
             }
@@ -1705,6 +1716,9 @@
             var positionToApply = this._position
                 ? this._inputValue.length + position + caretShift
                 : position + (this._code === 'Backspace' && !backspaceShift ? 0 : caretShift);
+            if (positionToApply > this._getActualInputLength()) {
+                positionToApply = this._getActualInputLength();
+            }
             el.setSelectionRange(positionToApply, positionToApply);
             if ((this.maskExpression.includes('H') || this.maskExpression.includes('M')) && caretShift === 0) {
                 el.setSelectionRange(((/** @type {?} */ (el.selectionStart))) + 1, ((/** @type {?} */ (el.selectionStart))) + 1);
@@ -1771,6 +1785,10 @@
                 el.selectionStart = this._maskService.prefix.length;
                 return;
             }
+            /** select only inserted text */
+            if (((/** @type {?} */ (el.selectionEnd))) > this._getActualInputLength()) {
+                el.selectionEnd = this._getActualInputLength();
+            }
         };
         // tslint:disable-next-line: cyclomatic-complexity
         // tslint:disable-next-line: cyclomatic-complexity
@@ -1803,8 +1821,7 @@
                         el.setSelectionRange(this.prefix.length, this.prefix.length);
                     }
                     else {
-                        if (this._inputValue.length !== ((/** @type {?} */ (el.selectionStart))) &&
-                            ((/** @type {?} */ (el.selectionStart))) !== 1) {
+                        if (this._inputValue.length !== ((/** @type {?} */ (el.selectionStart))) && ((/** @type {?} */ (el.selectionStart))) !== 1) {
                             while (this.specialCharacters.includes(this._inputValue[((/** @type {?} */ (el.selectionStart))) - 1].toString()) &&
                                 ((this.prefix.length >= 1 && ((/** @type {?} */ (el.selectionStart))) > this.prefix.length) ||
                                     this.prefix.length === 0)) {
@@ -1837,6 +1854,12 @@
                 this._inputValue.length - this.suffix.length < ((/** @type {?} */ (el.selectionStart)))) {
                 el.setSelectionRange(this._inputValue.length - this.suffix.length, this._inputValue.length);
             }
+            else if ((e.keyCode === 65 && e.ctrlKey === true) || // Ctrl+ A
+                (e.keyCode === 65 && e.metaKey === true) // Cmd + A (Mac)
+            ) {
+                el.setSelectionRange(0, this._getActualInputLength());
+                e.preventDefault();
+            }
             this._maskService.selStart = el.selectionStart;
             this._maskService.selEnd = el.selectionEnd;
         };
@@ -1914,8 +1937,7 @@
                 }
             }
             if (keyCode === 8) {
-                if (this.suffix.length > 1 &&
-                    this._inputValue.length - this.suffix.length < ((/** @type {?} */ (el.selectionStart)))) {
+                if (this.suffix.length > 1 && this._inputValue.length - this.suffix.length < ((/** @type {?} */ (el.selectionStart)))) {
                     el.setSelectionRange(this._inputValue.length - this.suffix.length, this._inputValue.length);
                 }
                 if (this.suffix.length === 1 && this._inputValue.length === ((/** @type {?} */ (el.selectionStart)))) {
@@ -2019,14 +2041,43 @@
              * @return {?}
              */
             function (s) { return s !== ':'; })).length;
-            if (+value[value.length - 1] === 0 && value.length < rowMaskLen) {
-                return { 'Mask error': true };
+            if (value === null || value.length === 0) {
+                return null; // Don't validate empty values to allow for optional form control
             }
-            if (value.length <= rowMaskLen - 2) {
-                return { 'Mask error': true };
+            if ((+value[value.length - 1] === 0 && value.length < rowMaskLen) || value.length <= rowMaskLen - 2) {
+                return this._createValidationError(value);
             }
             return null;
         };
+        /**
+         * @private
+         * @return {?}
+         */
+        MaskDirective.prototype._getActualInputLength = /**
+         * @private
+         * @return {?}
+         */
+        function () {
+            return (this._maskService.actualValue.length || this._maskService.actualValue.length + this._maskService.prefix.length);
+        };
+        /**
+         * @private
+         * @param {?} actualValue
+         * @return {?}
+         */
+        MaskDirective.prototype._createValidationError = /**
+         * @private
+         * @param {?} actualValue
+         * @return {?}
+         */
+        function (actualValue) {
+            return {
+                mask: {
+                    requiredMask: this._maskValue,
+                    actualValue: actualValue,
+                },
+            };
+        };
         MaskDirective.decorators = [
             { type: core.Directive, args: [{
                         selector: '[mask]',
@@ -2074,6 +2125,7 @@
             clearIfNotMatch: [{ type: core.Input }],
             validation: [{ type: core.Input }],
             separatorLimit: [{ type: core.Input }],
+            allowNegativeNumbers: [{ type: core.Input }],
             onInput: [{ type: core.HostListener, args: ['input', ['$event'],] }],
             onBlur: [{ type: core.HostListener, args: ['blur',] }],
             onFocus: [{ type: core.HostListener, args: ['click', ['$event'],] }],
@@ -2115,6 +2167,8 @@
         MaskDirective.prototype.validation;
         /** @type {?} */
         MaskDirective.prototype.separatorLimit;
+        /** @type {?} */
+        MaskDirective.prototype.allowNegativeNumbers;
         /**
          * @type {?}
          * @private