ngx-mask





You can also try our NGX LOADER INDICATOR.
You can also try our NGX COPYPASTE.

$3

Installing

``bash
$ npm install --save ngx-mask
`

Quickstart

Import ngx-mask module in Angular app.

$3

`typescript
import { NgxMaskModule, IConfig } from 'ngx-mask'

export const options: Partial | (() => Partial) = null;

@NgModule({
imports: [
NgxMaskModule.forRoot(),
],
})
`

$3

`typescript
import { NgxMaskModule, IConfig } from 'ngx-mask'

const maskConfig: Partial = {
validation: false,
};

@NgModule({
imports: [
NgxMaskModule.forRoot(maskConfig),
],
})
`

Or using a function to get the config:

`typescript
const maskConfigFunction: () => Partial = () => {
return {
validation: false,
};
};

@NgModule({
imports: [
NgxMaskModule.forRoot(maskConfigFunction),
],
})
`

Then, just define masks in inputs.

$3

`html

`

or

`html

`

Also, you can use mask pipe.

$3

`html
{{phone | mask: '(000) 000-0000'}}
`

For separator you can add thousandSeparator

$3

`html
{{value | mask: 'separator':','}}
`

#### Examples

| mask | example |
| -------------- | -------------- |
| 9999-99-99 | 2017-04-15 |
| 0\*.00 | 2017.22 |
| 000.000.000-99 | 048.457.987-98 |
| AAAA | 0F6g |
| SSSS | asDF |
| UUUU | ASDF |
| LLLL | 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).

$3

We have next default characters:

| character |
| --------- |
| - |
| / |
| ( |
| ) |
| . |
| : |
| space |
| + |
| , |
| @ |
| [ |
| ] |
| " |
| ' |

#### Usage

`html

`

##### Then

`text
Input value: 789-874.98
Masked value: [78]\[987]
`

`typescript
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) |
| U | only letters uppercase |
| L | only letters lowercase |

##### Usage

`html

`

and in your component

`typescript
public customPatterns = { '0': { pattern: new RegExp('\[a-zA-Z\]')} };
`

##### Then

`text
Input value: 789HelloWorld
Masked value: (Hel-loW)
`

$3

You can define custom pattern and specify symbol to be rendered in input field.

`typescript
pattern = {
B: {
pattern: new RegExp('\\d'),
symbol: 'X',
},
};
`

$3

You can add prefix to you masked value

#### Usage

`html

`

$3

You can add suffix to you masked value

#### Usage

`html

`

$3

You can choose if mask will drop special character in the model, or not, default value is true.

#### Usage

`html

`

##### Then

`text
Input value: 789-874.98
Model value: 789-874.98
`

$3

You can choose if mask is shown while typing, or not, default value is false.

#### Usage

`html

`

$3

You can choose if mask will allow the use of negative numbers. The default value is false.

#### Usage

`html

`

##### Then

`text
Input value: -10,000.45
Model value: -10000.45
`

$3

If the showMaskTyped parameter is enabled, this setting customizes the character used as placeholder. Default value is _.

#### Usage

`html

`

$3

You can choose clear the input if the input value not match the mask, default value is false.

$3

You can pass array of expression and custom Pattern to pipe.

#### Usage

`html
{{phone | mask: customMask}}
`

and in your component

`typescript
customMask: [string, pattern];

pattern = {
P: {
pattern: new RegExp('\\d'),
},
};

this.customMask = ['PPP-PPP', this.pattern];
`

$3

You can pass into mask pattern with brackets.

#### Usage

`html

`

$3

You can divide your input by thousands, by default will seperate with a space.

#### Usage

`html

`

For separate input with dots.

`html

`

For using decimals enter . and how many decimals to the end of your input to separator mask.

`html

`

`text
Input value: 1234.56
Masked value: 1 234.56

Input value: 1234,56
Masked value: 1.234,56

Input value: 1234.56
Masked value: 1,234.56
`

`html




`

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.

`text
Input value: 1234,56
Masked value: 1.234,56

Input value: 1234.56
Masked value: 1,234.56

Input value: 1234,56
Masked value: 1.234

Input value: 1234.56
Masked value: 1,234
`

`html

`

For limiting the number of digits before the decimal point you can set separatorLimit value to _10_, _100_, _1000_ etc.

`text
Input value: 12345678,56
Masked value: 1.234,56
`

$3

You can validate your input as 24 hour format.

#### Usage

`html

`

$3

You can validate your date.

#### Usage

`html

`

$3

If the leadZeroDateTime parameter is true, skipped symbols of date or time will be replaced by 0. Default value is false.

#### Usage

`html

`

`text
Input value: 422020
Masked value: 04/02/2020
`

`html

`

`text
Input value: 777
Masked value: 07:07:07
`

$3

You can validate your input for percents.

#### Usage

`html

`

$3

You can validate your formControl, default value is true.

#### Usage

`html

`

$3

You can hide symbols in input field and get the actual value in formcontrol.

#### Usage

`html

`

$3

#### Usage

`html

`

$3

#### Usage

`html

`

$3

#### Usage

You can pass into mask pattern with ||.

`html

`

`html

`

$3

#### Usage

`html

``