ngx-currency

Demo

https://nbfontana.github.io/ngx-currency/

Table of contents

• Getting Started
• Documentation
• Development
• License

Getting Started

Installing and Importing

Install the package by command:

1npm install ngx-currency --save

Import the directive

1import { NgxCurrencyDirective } from "ngx-currency";
2
3@Component({
4  selector: "app-root",
5  templateUrl: "./app.component.html",
6  imports: [NgxCurrencyDirective],
7})
8export class AppComponent {}

Using

1<input type="text" inputmode="decimal" currencyMask formControlName="value" />

• ngModel An attribute of type number. If is displayed '$ 25.63', the attribute will be '25.63'.

Options

You can set options...

1<!-- example for pt-BR money -->
2<input [currencyMask]="{ prefix: 'R$ ', thousands: '.', decimal: ',' }" formControlName="value" />

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: ',')
• nullable - when true, the value of the clean field will be null, when false the value will be 0
• min - The minimum value (default: undefined)
• max - The maximum value (default: undefined)
• inputMode - Determines how to handle numbers as the user types them (default: Financial)

Input Modes:

• Financial - Numbers start at the highest precision decimal. Typing a number shifts numbers left. The decimal character is ignored. Most cash registers work this way. For example:
  • Typing '12' results in '0.12'
  • Typing '1234' results in '12.34'
  • Typing '1.234' results in '12.34'
• Natural - Numbers start to the left of the decimal. Typing a number to the left of the decimal shifts numbers left; typing to the right of the decimal replaces the next number. Most text inputs and spreadsheets work this way. For example:
  • Typing '1234' results in '1234'
  • Typing '1.234' results in '1.23'
  • Typing '12.34' results in '12.34'
  • Typing '123.4' results in '123.40'

You can also set options globally...

1import { provideEnvironmentNgxCurrency, NgxCurrencyInputMode } from 'ngx-currency';
2
3bootstrapApplication(AppComponent, {
4  providers: [
5    ...
6    provideEnvironmentNgxCurrency({
7      align: "right",
8      allowNegative: true,
9      allowZero: true,
10      decimal: ",",
11      precision: 2,
12      prefix: "R$ ",
13      suffix: "",
14      thousands: ".",
15      nullable: true,
16      min: null,
17      max: null,
18      inputMode: NgxCurrencyInputMode.Financial,
19    }),
20    ...
21  ],
22}).catch((err) => console.error(err));

Development

Prepare your environment

• Install Node.js and NPM
• Install local dev dependencies: npm install while current directory is this repo

Development server

To start a local development server, run:

1npm start

Building

To build the library run:

1npm run build:lib

Testing

To execute unit tests with the Karma test runner, use the following command:

1npm test

When running in the Chrome browser, you can set code breakpoints to debug tests using these instructions:

• From the main Karma browser page, click the Debug button to open the debug window
• Press ctrl + shift + i to open Chrome developer tools
• Press ctrl + p to search for a file to debug
• Enter a file name like input.handler.ts and click the file
• Within the file, click on a row number to set a breakpoint
• Refresh the browser window to re-run tests and stop on the breakpoint

License

MIT @ Neri Bez Fontana