diff --git a/README.md b/README.md index 6244e4b3..3dda67be 100644 --- a/README.md +++ b/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) - npm downloads + npm downloads [![npm](https://img.shields.io/npm/dm/ngx-mask.svg)](https://www.npmjs.com/package/ngx-mask) @@ -15,24 +15,21 @@ [![GitHub stars](https://img.shields.io/github/stars/JSDaddy/ngx-mask.svg?label=GitHub%20Stars&style=flat-square)](https://github.com/JSDaddy/ngx-mask) -You can also try our NGX LOADER INDICATOR [Download](https://www.npmjs.com/package/ngx-loader-indicator) it. -You can also try our NGX COPYPASTE [Download](https://www.npmjs.com/package/ngx-copypaste) it. - +You can also try our [NGX LOADER INDICATOR](https://www.npmjs.com/package/ngx-loader-indicator). +You can also try our [NGX COPYPASTE](https://www.npmjs.com/package/ngx-copypaste). ### You can see the full [documentation](https://jsdaddy.github.io/ngx-mask-page/) with examples. ## Installing - ```bash $ npm install --save ngx-mask ``` ## Quickstart - Import **ngx-mask** module in Angular app. ```typescript -import {NgxMaskModule} from 'ngx-mask' +import { NgxMaskModule } from 'ngx-mask' export const options: Partial | (() => Partial); @@ -48,21 +45,18 @@ export const options: Partial | (() => Partial); Then, just define masks in inputs. #### Usage - ```html - + ``` -Also you can use mask pipe +Also, you can use mask pipe. #### Usage - ```html {{phone | mask: '(000) 000-0000'}} ``` #### Examples - | mask | example | | -------------- | -------------- | | 9999-99-99 | 2017-04-15 | @@ -72,31 +66,30 @@ Also you can use mask pipe | 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** | - | + | - | , | - | @ | +We have next default characters: + + | character | + |-----------| + | / | + | ( | + | ) | + | . | + | : | + | - | + | **space** | + | + | + | , | + | @ | ##### Usage - ```html - + ``` -##### Then: - +##### Then ``` Input value: 789-874.98 Masked value: [78]\[987] @@ -104,7 +97,7 @@ Masked value: [78]\[987] ```typescript patterns ({ [character: string]: { pattern: RegExp, optional?: boolean}) ``` - We have next default patterns: + We have next default patterns: | code | meaning | | ----- | ------------------------------------------- | @@ -113,157 +106,140 @@ patterns ({ [character: string]: { pattern: RegExp, optional?: boolean}) | **A** | letters (uppercase or lowercase) and digits | | **S** | only letters (uppercase or lowercase) | -##### Usage: - +##### Usage ```html - + ``` + and in your component ```typescript -public customPatterns = {'0': { pattern: new RegExp('\[a-zA-Z\]')}}; +public customPatterns = { '0': { pattern: new RegExp('\[a-zA-Z\]')} }; ``` -##### Then: - +##### 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. +You can define custom pattern and specify symbol to be rendered in input field. ```typescript -pattern = { - 'B': { - pattern: new RegExp('\\d'), - symbol: 'X' - } +pattern = { + 'B': { + pattern: new RegExp('\\d'), + symbol: 'X' } +} ``` ### prefix (string) - You can add prefix to you masked value -##### Usage +You can add prefix to you masked value +##### Usage ```html - + ``` ### suffix (string) - You can add suffix to you masked value -##### Usage +You can add suffix to you masked value +##### Usage ```html - + ``` ### dropSpecialCharacters (boolean) - You can choose if mask will drop special character in the model, or not, default value true -##### Usage +You can choose if mask will drop special character in the model, or not, default value is `true`. +##### Usage ```html - + ``` -##### Then: - +##### 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 false -##### Usage +You can choose if mask is shown while typing, or not, default value is `false`. +##### Usage ```html - + ``` ### placeHolderCharacter (string) - - If the `showMaskTyped` parameter is enabled, this setting customizes the character used as placeholder. Default value is '_'. +If the `showMaskTyped` parameter is enabled, this setting customizes the character used as placeholder. Default value is `_`. ##### Usage - ```html - + ``` ### clearIfNotMatch (boolean) - You can choose clear the input if the input value **not match** the mask, default value false +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 +You can pass array of expression and custom Pattern to pipe. ##### Usage - ```html - {{phone | mask: customMaska}} +{{phone | mask: customMask}} ``` + and in your component -``` -customMaska: [string, pattern]; +```typescript +customMask: [string, pattern]; -pattern = { - 'P': { - pattern: new RegExp('\\d'), - }}; +pattern = { + 'P': { + pattern: new RegExp('\\d'), + } +}; -this.customMaska = ['PPP-PPP', this.pattern]; +this.customMask = ['PPP-PPP', this.pattern]; ``` ### Repeat mask - You can pass into mask pattern with brackets +You can pass into mask pattern with brackets. ##### Usage - ```html - + ``` ### Thousand separator - You can devide your input by thousands +You can divide your input by thousands. ##### Usage - ```html - + ``` -For separate input with dots +For separate input with dots ```html - + ``` -For using decimals enter '.' to the end of your input to 'separator' mask and ',' to 'dot_separator' +For separate input with commas ```html - -``` -For using decimals enter '.' to the end of your input to 'separator' or 'comma_separator' mask and ',' to 'dot_separator' - - -``` -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 + ``` +For using decimals enter `.` to the end of your input to 'separator' or 'dot_separator' mask and `,` to 'comma_separator'. ```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. +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 @@ -277,55 +253,51 @@ Masked value: 1.234 Input value: 1234.56 Masked value: 1,234 ``` + +For limiting the number of digits before the decimal point you can set `separatorLimit` value to _10_, _100_, _1000_, etc. ```html - + ``` -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 +You can validate your input as 24-hour format. ##### Usage - ```html - + ``` ### Percent validation - You can validate your input for percents +You can validate your input for percents. ##### Usage - ```html - + ``` ### FormControl validation - You can validate your formControl, default value is true +You can validate your `formControl`, default value is `true`. ##### Usage - ```html - + ``` + ### Secure input - You can hide symbols in input field and get the actual value in formcontrol +You can hide symbols in input field and get the actual value in `formControl`. ##### Usage - ```html - + ``` ### IP valid mask ##### Usage - ```html - + ```