ng-number-to-text/README.md

Set of pipes for angular2+ projects to convert numbers to words as ordinal numbers

# Number To Text

Number To Text is an angular module that contains a set of pipes to convert numbers into words.

## Features
1. Convert numbers into words for both languages (Arabic and English)
   -more languages will be added later-.
2. For Arabic language, Masculine and Feminine expressions are added.
3. Can convert from 0 to 100 as ordinal numbers.
4. It can be used for ordering, building floors, etc.

## Installation

Use npm to install:

```bash
npm i ng-number-to-text
```

## Usage
1. First, import the module:

```angular2
import {NumberToTextModule} from 'ng-number-to-text';

@NgModule({
  declarations: [
    ...
  ],
  imports: [
    ...
    NumberToTextModule,
    ...
  ],
  providers: [...],
  bootstrap: [...]
})
export class AppModule { }

```
2. Second, use it in your component in one of two ways:
   - in your *.ts file:
```angular2
import {Component, OnInit} from '@angular/core';
import {NumberToTextPipe} from 'ng-number-to-text/lib/pipes/number-to-text.pipe';
import {NumberToTextArPipe} from 'ng-number-to-text/lib/pipes/number-to-text-ar.pipe';
import {NumberToTextArFemPipe} from 'ng-number-to-text/lib/pipes/number-to-text-ar-fem.pipe';

@Component({
  selector: 'app-root',
  templateUrl: './app.component.html',
  styleUrls: ['./app.component.css'],
  providers: [NumberToTextPipe, NumberToTextArPipe, NumberToTextArFemPipe]
})
export class AppComponent implements OnInit {
  textEn: string;
    textAr: string;
    textArFem: string;
  
    constructor(
      private numberToTextPipe: NumberToTextPipe,
      private numberToTextArPipe: NumberToTextArPipe,
      private numberToTextArFemPipe: NumberToTextArFemPipe
    ) {}
  
    ngOnInit(): void {
      this.textEn = this.numberToTextPipe.transform(12);     // The twelfth
      this.textAr = this.numberToTextArPipe.transform(12);   // الثانى عشر
      this.textArFem = this.numberToTextArFemPipe.transform(12);   // الثانية عشر
    }
}
```
   - in your *.html file:
```html
<h1>{{'45' | numberToText}}</h1>       // The forty-fifth
<h1>{{'45' | numberToTextAr}}</h1>     // الخامس والاربعون
<h1>{{'45' | numberToTextArFem}}</h1>  // الخامسة والاربعون
```
## Contributing
Feel free to contribute [GitHub](https://github.com/AhmedBadee/Number-To-Text.git).

## License
[MIT](https://choosealicense.com/licenses/mit/)