ngx-digits-only 1.0.0 → 1.0.1

package/README.md

@@ -1,64 +1,89 @@
-# DigitsOnly
+# ngx-digits-only
 
-This project was generated using [Angular CLI](https://github.com/angular/angular-cli) version 22.0.0.
+Dependency-free Angular directive for numeric-only inputs — a lightweight alternative to `ngx-mask` when all you need is digit filtering and formatting.
 
-## Code scaffolding
+## Features
 
-Angular CLI includes powerful code scaffolding tools. To generate a new component, run:
+- Restricts input to digits only, with optional decimal and negative number support
+- Thousands separator formatting (configurable)
+- Prefix / suffix support (e.g. currency symbols, units)
+- Configurable decimal places
+- Min / max value validation
+- Persian / Arabic (Eastern) numeral conversion and display
+- Full RTL / LTR layout support
+- Implements `ControlValueAccessor` and `Validator` — works natively with Reactive Forms and Template-driven forms
+- Standalone directive — no NgModule required
+- Zero runtime dependencies
 
-```bash
-ng generate component component-name
-```
-
-For a complete list of available schematics (such as `components`, `directives`, or `pipes`), run:
+## Installation
 
 ```bash
-ng generate --help
+npm install ngx-digits-only
 ```
 
-## Building
-
-To build the library, run:
-
-```bash
-ng build digits-only
+## Usage
+
+Import the directive directly into your standalone component:
+
+```typescript
+import { Component } from '@angular/core';
+import { ReactiveFormsModule } from '@angular/forms';
+import { NgxDigitsOnlyDirective } from 'ngx-digits-only';
+
+@Component({
+  selector: 'app-example',
+  standalone: true,
+  imports: [ReactiveFormsModule, NgxDigitsOnlyDirective],
+  template: `
+    <input
+      ngxDigitsOnly
+      [allowDecimal]="true"
+      [decimalPlaces]="2"
+      [allowNegative]="false"
+      [thousandsSeparator]="true"
+      [min]="0"
+      [max]="1000000"
+      [formControl]="amountControl"
+    />
+  `
+})
+export class ExampleComponent {
+  amountControl = new FormControl('');
+}
 ```
 
-This command will compile your project, and the build artifacts will be placed in the `dist/` directory.
-
-### Publishing the Library
-
-Once the project is built, you can publish your library by following these steps:
+### In an NgModule-based app
 
-1. Navigate to the `dist` directory:
+Standalone directives can still be used inside NgModule-based components — just add it to that component's own `imports` array if the component itself is standalone, or import it directly where the input lives:
 
-   ```bash
-   cd dist/digits-only
-   ```
-
-2. Run the `npm publish` command to publish your library to the npm registry:
-   ```bash
-   npm publish
-   ```
-
-## Running unit tests
-
-To execute unit tests with the [Karma](https://karma-runner.github.io) test runner, use the following command:
-
-```bash
-ng test
+```typescript
+@Component({
+  standalone: true,
+  imports: [NgxDigitsOnlyDirective],
+  ...
+})
 ```
 
-## Running end-to-end tests
+If your component is *not* standalone (declared in an `NgModule`), you can import the directive into that NgModule's `imports` array directly — standalone directives are valid entries there too.
 
-For end-to-end (e2e) testing, run:
+## API
 
-```bash
-ng e2e
-```
+| Input | Type | Default | Description |
+|---|---|---|---|
+| `allowDecimal` | `boolean` | `false` | Allow decimal point input |
+| `decimalPlaces` | `number` | `2` | Max digits after decimal point |
+| `allowNegative` | `boolean` | `false` | Allow leading minus sign |
+| `thousandsSeparator` | `boolean` | `false` | Format with thousands separators as user types |
+| `prefix` | `string` | `''` | Text prepended to the display value |
+| `suffix` | `string` | `''` | Text appended to the display value |
+| `min` | `number` | `undefined` | Minimum allowed value (adds validator) |
+| `max` | `number` | `undefined` | Maximum allowed value (adds validator) |
+| `easternNumerals` | `boolean` | `false` | Display Persian/Arabic-Indic digits instead of Western |
+
+## Compatibility
 
-Angular CLI does not come with an end-to-end testing framework by default. You can choose one that suits your needs.
+Requires Angular `>=16.0.0` (standalone APIs). Works in both standalone and NgModule-based applications.
 
-## Additional Resources
+## License
 
-For more information on using the Angular CLI, including detailed command references, visit the [Angular CLI Overview and Command Reference](https://angular.dev/tools/cli) page.
+ISC

package/package.json

@@ -1,14 +1,22 @@
 {
   "name": "ngx-digits-only",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "peerDependencies": {
-    "@angular/common": "^22.0.0",
-    "@angular/core": "^22.0.0"
+    "@angular/common": ">=16.0.0",
+    "@angular/core": ">=16.0.0"
   },
   "dependencies": {
     "tslib": "^2.3.0"
   },
   "sideEffects": false,
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/YOUR_USERNAME/ngx-digits-only.git"
+  },
+  "homepage": "https://github.com/YOUR_USERNAME/ngx-digits-only#readme",
+  "bugs": {
+    "url": "https://github.com/YOUR_USERNAME/ngx-digits-only/issues"
+  },
   "module": "fesm2022/ngx-digits-only.mjs",
   "typings": "types/ngx-digits-only.d.ts",
   "exports": {