-
Notifications
You must be signed in to change notification settings - Fork 116
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
2 changed files
with
134 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,130 @@ | ||
# ng2-currency-mask | ||
|
||
A very simple currency mask directive for Angular that allows using a number attribute with the ngModel. In other words, the model is a number, and not a string with a mask. It was tested in Angular version 13. | ||
|
||
## Getting Started | ||
|
||
### Installing and Importing | ||
|
||
Install the package by command: | ||
|
||
```sh | ||
npm install ng2-currency-mask --save | ||
``` | ||
|
||
Import the module | ||
|
||
```ts | ||
import { CurrencyMaskModule } from "ng2-currency-mask"; | ||
|
||
@NgModule({ | ||
imports: [ | ||
... | ||
CurrencyMaskModule | ||
], | ||
declarations: [...], | ||
providers: [...] | ||
}) | ||
export class AppModule {} | ||
``` | ||
|
||
### Using | ||
|
||
```html | ||
<input currencyMask [(ngModel)]="value" /> | ||
``` | ||
|
||
- `ngModel` An attribute of type number. If is displayed `'$ 25.63'`, the attribute will be `'25.63'`. | ||
|
||
### Options | ||
|
||
You can set options as follows: | ||
|
||
```html | ||
<!-- example for pt-BR money --> | ||
<input currencyMask [(ngModel)]="value" [options]="{ prefix: 'R$ ', thousands: '.', decimal: ',' }" /> | ||
``` | ||
|
||
Available options: | ||
|
||
- `align` - Text alignment in input. (default: `right`) | ||
- `allowNegative` - If `true` can input negative values. (default: `true`) | ||
- `decimal` - Separator of decimals (default: `'.'`) | ||
- `precision` - Number of decimal places (default: `2`) | ||
- `prefix` - Money prefix (default: `'$ '`) | ||
- `suffix` - Money suffix (default: `''`) | ||
- `thousands` - Separator of thousands (default: `','`) | ||
|
||
You can also set options globally... | ||
|
||
```ts | ||
import { CurrencyMaskConfig, CurrencyMaskModule, CURRENCY_MASK_CONFIG } from 'ng2-currency-mask'; | ||
|
||
export const CustomCurrencyMaskConfig: CurrencyMaskConfig = { | ||
align: "right", | ||
allowNegative: true, | ||
decimal: ",", | ||
precision: 2, | ||
prefix: "R$ ", | ||
suffix: "", | ||
thousands: "." | ||
}; | ||
|
||
@NgModule({ | ||
imports: [ | ||
... | ||
CurrencyMaskModule | ||
], | ||
declarations: [...], | ||
providers: [ | ||
{ provide: CURRENCY_MASK_CONFIG, useValue: CustomCurrencyMaskConfig } | ||
], | ||
bootstrap: [AppComponent] | ||
}) | ||
export class AppModule {} | ||
``` | ||
|
||
### Validation | ||
|
||
This directive also provides built-in validation for minimum and maximum values. If the attributes 'min' and / or 'max' are set, the Angular CSS class 'ng-invalid' will be added to the input to indicate an invalid value. | ||
|
||
```html | ||
<input currencyMask [(ngModel)]="value" min="-10.50" max="100.75" /> | ||
``` | ||
|
||
## Quick fixes | ||
|
||
### Ionic 2-3 | ||
|
||
Input not working on mobile keyboard | ||
|
||
```html | ||
<!-- Change the type to 'tel' --> | ||
<input currencyMask type="tel" [(ngModel)]="value" /> | ||
``` | ||
|
||
Input focus get hide by the mobile keyboard | ||
|
||
on HTML | ||
|
||
```html | ||
<!-- Change the type to 'tel' --> | ||
<input currencyMask type="tel" [(ngModel)]="value" [id]="'yourInputId' + index" (focus)="scrollTo(index)" /> | ||
``` | ||
|
||
on .ts | ||
|
||
```ts | ||
import { Content } from 'ionic-angular'; | ||
|
||
export class... | ||
|
||
@ViewChild(Content) content: Content; | ||
|
||
scrollTo(index) { | ||
let yOffset = document.getElementById('yourInputId' + index).offsetTop; | ||
this.content.scrollTo(0, yOffset + 20); | ||
} | ||
``` | ||
|
||
## Questions? Open a Issue! |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,11 +1,11 @@ | ||
{ | ||
"name": "ng2-currency-mask", | ||
"version": "0.0.1", | ||
"version": "13.0.0", | ||
"peerDependencies": { | ||
"@angular/common": "^13.1.0", | ||
"@angular/core": "^13.1.0" | ||
"@angular/common": ">= 12.x.x", | ||
"@angular/core": ">= 12.x.x" | ||
}, | ||
"dependencies": { | ||
"tslib": "^2.3.0" | ||
"tslib": ">= 2.3.0" | ||
} | ||
} |