Noosphere Possibilities Maximized

    ngx-mask
    TypeScript icon, indicating that this package has built-in type declarations

    15.0.2 • Public • Published

    NGX MASK

    NGX MASK is the best directive to solve masking input with needed pattern

    CI npm npm downloads

    npm

    GitHub contributors

    GitHub stars

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

    You can try live demo with examples

    Installing

    $ npm install --save ngx-mask

    Quickstart if ngx-mask version >= 15.0.0

    Import ngx-mask directive, pipe and provide NgxMask providers with provideNgxMask function.

    With default config options application level

    bootstrapApplication(AppComponent, {
        providers: [
            (...)
            provideEnvironmentNgxMask(),
            (...)
        ],
    }).catch((err) => console.error(err));

    Passing your own mask config options

    import { IConfig } from 'ngx-mask'
    
    const maskConfig: Partial<IConfig> = {
      validation: false,
    };
    
    bootstrapApplication(AppComponent, {
        providers: [
            (...)
            provideEnvironmentNgxMask(maskConfig),
            (...)
        ],
    }).catch((err) => console.error(err));

    Using a function to configure:

    const maskConfigFunction: () => Partial<IConfig> = () => {
      return {
        validation: false,
      };
    };
    
    bootstrapApplication(AppComponent, {
        providers: [
             (...)
             provideEnvironmentNgxMask(maskConfigFunction),
             (...)
    ],
    }).catch((err) => console.error(err));

    With config options feature level

    @Component({
        selector: 'my-feature',
        templateUrl: './my-feature.component.html',
        styleUrls: ['./my-feature.component.css'],
        standalone: true,
        imports: [NgxMaskDirective, (...)],
        providers: [
              (...)
              provideNgxMask(),
              (...)
        ],
    })
    export class MyFeatureComponent {}

    Then, import directive, pipe to needed standalone component and just define masks in inputs.

    With Angular modules

    @NgModule({
      imports: [
          NgxMaskDirective, NgxMaskPipe
      ],
      providers: [provideNgxMask()]
    })

    Quickstart if ngx-mask version < 15.0.0

    For version ngx-mask < 15.0.0 Import ngx-mask module in Angular app.

    With default mask config options

    import { NgxMaskModule, IConfig } from 'ngx-mask'
    
    export const options: Partial<null|IConfig> | (() => Partial<IConfig>) = null;
    
    @NgModule({
      imports: [
        NgxMaskModule.forRoot(),
      ],
    })

    Passing in your own mask config options

    import { NgxMaskModule, IConfig } from 'ngx-mask'
    
    const maskConfig: Partial<IConfig> = {
      validation: false,
    };
    
    @NgModule({
      imports: [
        NgxMaskModule.forRoot(maskConfig),
      ],
    })

    Or using a function to get the config:

    const maskConfigFunction: () => Partial<IConfig> = () => {
      return {
        validation: false,
      };
    };
    
    @NgModule({
      imports: [
        NgxMaskModule.forRoot(maskConfigFunction),
      ],
    })

    Then, just define masks in inputs.

    Usage

    <input type="text" mask="<here goes your mask>" />

    or

    <input type="text" [mask]="<here goes a reference to your component's mask property>" />

    Also, you can use mask pipe.

    <span>{{phone | mask: '(000) 000-0000'}}</span>

    For separator you can add thousandSeparator

    <span>{{value | mask: 'separator':','}}</span>

    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).

    specialCharacters (string[ ])

    We have next default characters:

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

    Usage

    <input type="text" [specialCharacters]="[ '[' ,']' , '\\' ]" mask="[00]\[000]" />
    Then
    Input value: 789-874.98
    Masked value: [78]\[987]
    
    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
    <input type="text" [patterns]="customPatterns" mask="(000-000)" />

    and in your component

    public customPatterns = { '0': { pattern: new RegExp('\[a-zA-Z\]')} };
    Then
    Input value: 789HelloWorld
    Masked value: (Hel-loW)
    

    Custom pattern for this

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

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

    prefix (string)

    You can add prefix to you masked value

    Usage

    <input type="text" prefix="+7" mask="(000) 000 00 00" />

    suffix (string)

    You can add suffix to you masked value

    Usage

    <input type="text" suffix="$" mask="0000" />

    dropSpecialCharacters (boolean | string[])

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

    Usage

    <input type="text" [dropSpecialCharacters]="false" mask="000-000.00" />
    Then
    Input value: 789-874.98
    Model value: 789-874.98
    

    showMaskTyped (boolean)

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

    Usage

    <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

    <input type="text" [allowNegativeNumbers]="true" mask="separator.2" />
    Then
    Input value: -10,000.45
    Model value: -10000.45
    

    placeHolderCharacter (string)

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

    Usage

    <input mask="(000) 000-0000" prefix="+7" [showMaskTyped]="true" placeHolderCharacter="*" />

    clearIfNotMatch (boolean)

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

    Pipe with mask expression and custom Pattern ([string, pattern])

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

    Usage

    <span>{{phone | mask: customMask}}</span>

    and in your component

    customMask: [string, pattern];
    
    pattern = {
      P: {
        pattern: new RegExp('\\d'),
      },
    };
    
    this.customMask = ['PPP-PPP', this.pattern];

    Repeat mask

    You can pass into mask pattern with brackets.

    Usage

    <input type="text" mask="A{4}" />

    Thousand separator

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

    Usage

    <input type="text" mask="separator" />

    For separate input with dots.

    <input type="text" mask="separator" thousandSeparator="." />

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

    <input type="text" mask="separator.2" />
    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
    
    <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.

    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
    
    <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.

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

    Time validation

    You can validate your input as 24 hour format.

    Usage

    <input type="text" mask="Hh:m0:s0" />

    Date validation

    You can validate your date.

    Usage

    <input type="text" mask="d0/M0/0000" />

    leadZeroDateTime (boolean)

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

    Usage

    <input type="text" mask="d0/M0/0000" [leadZeroDateTime]="true" />
    Input value: 422020
    Masked value: 04/02/2020
    
    <input type="text" mask="Hh:m0:s0" [leadZeroDateTime]="true" />
    Input value: 777
    Masked value: 07:07:07
    

    Percent validation

    You can validate your input for percents.

    Usage

    <input type="text" mask="percent" suffix="%" />

    FormControl validation

    You can validate your formControl, default value is true.

    Usage

    <input type="text" mask="00 00" [validation]="true" />

    Secure input

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

    Usage

    <input placeholder="Secure input" [hiddenInput]="true" mask="XXX/X0/0000" />

    IP valid mask

    Usage

    <input mask="IP" />

    CPF_CNPJ valid mask

    Usage

    <input mask="CPF_CNPJ" />

    Dynamic valid mask

    Usage

    You can pass into mask pattern with ||.

    <input mask="000.000.000-00||00.000.000/0000-00" />
    <input mask="(00) 0000-0000||(00) 0 0000-0000" />

    Function maskFilled

    Usage

    <input mask="0000" (maskFilled)="maskFilled()" />

    Install

    npm i ngx-mask

    DownloadsWeekly Downloads

    218,928

    Version

    15.0.2

    License

    MIT

    Unpacked Size

    740 kB

    Total Files

    24

    Last publish

    Collaborators

    • igornepipenko