Merge pull request #38 from juanjotorres90/feature/output-number-format

feat: ✨ add 'outputNumberFormat' option
juanjotorres90 · Jan 25, 2025 · ad5a0bb · ad5a0bb
2 parents 6c47e91 + ccd2887
commit ad5a0bb
Show file tree

Hide file tree

Showing 16 changed files with 1,917 additions and 1,988 deletions.
diff --git a/.all-contributorsrc b/.all-contributorsrc
@@ -60,6 +60,20 @@
         "maintenance",
         "review"
       ]
+    },
+    {
+      "login": "Kamma31",
+      "name": "Rant",
+      "avatar_url": "https://avatars.githubusercontent.com/u/50776388?v=4?s=100",
+      "profile": "https://github.com/Kamma31",
+      "contributions": [
+        "code",
+        "doc",
+        "ideas",
+        "question",
+        "maintenance",
+        "review"
+      ]
     }
   ],
   "contributorsPerLine": 7,

diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -6,21 +6,34 @@ on:
   pull_request:
     branches: ['develop', 'main']
 
+permissions:
+  actions: read
+  contents: read
+
 jobs:
-  build:
+  main:
     runs-on: ubuntu-latest
-
-    strategy:
-      matrix:
-        node-version: [22.x]
     steps:
-      - uses: actions/checkout@v3
-      - name: Use Node.js ${{ matrix.node-version }}
-        uses: actions/setup-node@v3
+      - uses: actions/checkout@v4
         with:
-          node-version: ${{ matrix.node-version }}
+          fetch-depth: 0
+
+      # This enables task distribution via Nx Cloud
+      # Run this command as early as possible, before dependencies are installed
+      # Learn more at https://nx.dev/ci/reference/nx-cloud-cli#npx-nxcloud-startcirun
+      # Uncomment this line to enable task distribution
+      # - run: npx nx-cloud start-ci-run --distribute-on="3 linux-medium-js" --stop-agents-after="build"
+
+      # Cache node_modules
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 22
           cache: 'npm'
-      - run: npm install
-      - run: npm run lint:all --if-present
-      - run: npm run unit-tests:all --if-present
-      - run: npm run build:all --if-present
+
+      - run: npm ci --legacy-peer-deps
+      - uses: nrwl/nx-set-shas@v4
+
+      # Prepend any command with "nx-cloud record --" to record its logs to Nx Cloud
+      # - run: npx nx-cloud record -- echo Hello World
+      # Nx Affected runs only tasks affected by the changes in this PR/commit. Learn more: https://nx.dev/ci/features/affected
+      - run: npx nx affected -t lint test build
diff --git a/.husky/pre-push b/.husky/pre-push
@@ -1 +1 @@
-npm run lint:all && npm run unit-tests:all && npm run build:all
+npx nx affected -t lint test build
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -5,6 +5,18 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
+## [19.2.0] - 2025-01-25
+
+### Added
+
+- Add 'outputNumberFormat' option to set the output number to INTERNATIONAL, E164, or RFC3966 format.
+- Add css variables to customize the input field appearance ([#34](https://github.com/juanjotorres90/ngx-material-intl-tel-input/pull/34)).
+
+### Fixed
+
+- Clear the number input field when a form reset is triggered ([#37](https://github.com/juanjotorres90/ngx-material-intl-tel-input/issues/37)).
+- Fix cursor position when editing the number from the middle or start position ([#37](https://github.com/juanjotorres90/ngx-material-intl-tel-input/issues/37)).
+
 ## [19.1.0] - 2024-12-21
 
 ### Added

diff --git a/README.md b/README.md
@@ -1,4 +1,4 @@
-[![All Contributors](https://img.shields.io/badge/all_contributors-4-orange.svg?style=flat-square)](#contributors)
+[![All Contributors](https://img.shields.io/badge/all_contributors-5-orange.svg?style=flat-square)](#contributors)
 
 [![npm version](https://img.shields.io/npm/v/ngx-material-intl-tel-input.svg?style=flat-square)](https://www.npmjs.com/package/ngx-material-intl-tel-input)
 [![npm downloads total](https://img.shields.io/npm/dt/ngx-material-intl-tel-input.svg?style=flat-square)](https://www.npmjs.com/package/ngx-material-intl-tel-input)
@@ -20,7 +20,7 @@ Validation with [google-libphonenumber](https://github.com/google/libphonenumber
 
 | ngx-material-intl-tel-input | Angular   |
 | --------------------------- | --------- |
-| 19.0.0 - 19.1.0             | >= 19.0.0 |
+| 19.0.0 - 19.2.0             | >= 19.0.0 |
 | 18.0.0 - 18.2.1             | >= 18.0.0 |
 | 0.0.1 - 17.3.0              | >= 17.2.0 |
 
@@ -76,6 +76,7 @@ imports: [NgxMaterialIntlTelInputComponent];
 | useMask                  | `boolean`                  | `false`                                                                                                                                                                                                                                                                                                      | Use mask for phone number input.                                         |
 | forceSelectedCountryCode | `boolean`                  | `false`                                                                                                                                                                                                                                                                                                      | If useMask is active it forces the selected country code to be displayed |
 | showMaskPlaceholder      | `boolean`                  | `false`                                                                                                                                                                                                                                                                                                      | If useMask is active it shows the placeholder for the mask               |
+| outputNumberFormat       | `PhoneNumberFormat`        | `PhoneNumberFormat.INTERNATIONAL`                                                                                                                                                                                                                                                                            | Sets the output number format to INTERNATIONAL, E164, or RFC3966 format  |
 | textLabels               | `TextLabels`               | {mainLabel: 'Phone number', codePlaceholder: 'Code', searchPlaceholderLabel: 'Search', noEntriesFoundLabel: 'No countries found', nationalNumberLabel: 'Number', hintLabel: 'Select country and type your phone number', invalidNumberError: 'Number is not valid', requiredError: 'This field is required'} | Overrides all component text labels                                      |
 
 ## Events
@@ -86,6 +87,69 @@ imports: [NgxMaterialIntlTelInputComponent];
 | currentCountryCode | `string` | `''`    | Country code value emitted when the value of the input changes.      |
 | currentCountryISO  | `string` | `''`    | Country ISO value emitted when the value of the input changes.       |
 
+# CSS Custom Properties Reference
+
+## 🎨 Component Styling Variables
+
+### Container Styles
+
+- `--mdc-filled-tel-form-outline-width`: Outline width (`default: 1px`)
+- `--mdc-filled-tel-form-outline-color`: Border color (`default: #d8d8d8`)
+- `--mdc-filled-tel-form-background`: Background color (`default: #fbfbfb`)
+- `--mdc-filled-tel-form-container-shape`: Border radius (`default: 8px`)
+
+### Focus States
+
+- `--mdc-filled-tel-form-focus-outline-color`: Focus border color (`default: rgb(32, 159, 252)`)
+- `--mdc-filled-tel-form-focus-background`: Focus background (`default: #fff`)
+
+### Hover States
+
+- `--mdc-filled-tel-form-hover-background`: Hover background (`default: #f5f5f5`)
+- `--mdc-outline-tel-form-hover-background`: Outline variant hover background (`default: #f5f5f5`)
+
+## 📱 Input Field Customization
+
+### Appearance
+
+- `--mdc-outline-tel-form-background`: Outline variant background (`default: #fbfbfb`)
+- `--mdc-tel-form-placeholder-color`: Input placeholder color (`default: #ccc`)
+- `--mdc-tel-form-icon-color`: Action icon color (`default: #909090`)
+
+### Shape Customization
+
+- `--mdc-outlined-tel-form-container-shape`: Outline field border radius (`default: Material system variable`)
+- `--mdc-outlined-text-field-container-shape`: Text field border radius (`default: Material system variable`)
+
+## 🔍 Validation & Feedback
+
+- `--mdc-tel-form-hint-color`: Hint text color (`default: #b2b2b2`)
+- `--mdc-tel-form-error-color`: Error message color (`default: Material system error`)
+- `--mat-sys-error`: Material system error fallback (`default: #f44336`)
+
+## 🖌️ Theme Integration
+
+- `--mdc-theme-primary`: Primary theme color (`default: rgb(32, 159, 252)`)
+- `--mdc-theme-error`: Error state color (`default: #f44336`)
+- `--mat-sys-corner-extra-small`: Material system small corner radius
+
+## Example Configuration
+
+```css
+:root {
+  /* Container Customization */
+  --mdc-filled-tel-form-background: #f8f9fa;
+  --mdc-filled-tel-form-container-shape: 6px;
+
+  /* Theme Colors */
+  --mdc-theme-primary: #2a7de1;
+  --mdc-tel-form-error-color: #dc3545;
+
+  /* Input Styling */
+  --mdc-tel-form-placeholder-color: #a0aec0;
+}
+```
+
 ## Contribute and develop locally
 
 <a alt="Nx logo" href="https://nx.dev" target="_blank" rel="noreferrer"><img src="https://raw.githubusercontent.com/nrwl/nx/master/images/nx-logo.png" width="45"></a>
@@ -148,6 +212,7 @@ Thanks goes to these wonderful people:
     <td align="center"><a href="https://github.com/whegar"><img src="https://avatars3.githubusercontent.com/u/5524772?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Rafa Hernández</b></sub></a><br /> <a href="https://github.com/juanjotorres90/ngx-material-intl-tel-input/commits?author=whegar" title="Code">💻</a> <a href="#ideas-whegar" title="Ideas, Planning, & Feedback">🤔</a> <a href="#question-whegar" title="Answering Questions">💬</a> <a href="#infra-whegar" title="Infrastructure (Hosting, Build-Tools, etc)">🚇</a> <a href="#maintenance-whegar" title="Maintenance">🚧</a> <a href="https://github.com/juanjotorres90/ngx-material-intl-tel-input/pulls?q=is%3Apr+reviewed-by%whegar" title="Reviewed Pull Requests">👀</a></td>
     <td align="center"><a href="https://github.com/ghollingworthh"><img src="https://avatars.githubusercontent.com/u/26550815?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Glen Hollingworth</b></sub></a><br /> <a href="https://github.com/juanjotorres90/ngx-material-intl-tel-input/commits?author=ghollingworthh" title="Code">💻</a> <a href="#ideas-ghollingworthh" title="Ideas, Planning, & Feedback">🤔</a> <a href="#question-ghollingworthh" title="Answering Questions">💬</a> <a href="#example-ghollingworthh" title="Examples">💡</a> <a href="#maintenance-ghollingworthh" title="Maintenance">🚧</a> <a href="https://github.com/juanjotorres90/ngx-material-intl-tel-input/pulls?q=is%3Apr+reviewed-by%ghollingworthh" title="Reviewed Pull Requests">👀</a></td>
     <td align="center"><a href="https://github.com/EphraimHaber"><img src="https://avatars.githubusercontent.com/u/61934858?v=4?s=100" width="100px;" alt=""/><br /><sub><b>EphraimHaber</b></sub></a><br /> <a href="https://github.com/juanjotorres90/ngx-material-intl-tel-input/commits?author=EphraimHaber" title="Code">💻</a> <a href="#ideas-EphraimHaber" title="Ideas, Planning, & Feedback">🤔</a> <a href="#question-EphraimHaber" title="Answering Questions">💬</a> <a href="#example-EphraimHaber" title="Examples">💡</a> <a href="#maintenance-EphraimHaber" title="Maintenance">🚧</a> <a href="https://github.com/juanjotorres90/ngx-material-intl-tel-input/pulls?q=is%3Apr+reviewed-by%EphraimHaber" title="Reviewed Pull Requests">👀</a></td>
+    <td align="center"><a href="https://github.com/Kamma31"><img src="https://avatars.githubusercontent.com/u/50776388?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Rant</b></sub></a><br /> <a href="https://github.com/juanjotorres90/ngx-material-intl-tel-input/commits?author=Kamma31" title="Code">💻</a> <a href="#ideas-Kamma31" title="Ideas, Planning, & Feedback">🤔</a> <a href="#question-Kamma31" title="Answering Questions">💬</a> <a href="#example-Kamma31" title="Examples">💡</a> <a href="#maintenance-Kamma31" title="Maintenance">🚧</a> <a href="https://github.com/juanjotorres90/ngx-material-intl-tel-input/pulls?q=is%3Apr+reviewed-by%Kamma31" title="Reviewed Pull Requests">👀</a></td>
 </table>
 
 <!-- markdownlint-restore -->

diff --git a/apps/ngx-material-intl-tel-input/src/app/app.component.html b/apps/ngx-material-intl-tel-input/src/app/app.component.html
@@ -10,10 +10,13 @@
       [useMask]="false"
       [forceSelectedCountryCode]="false"
       [showMaskPlaceholder]="true"
+      [outputNumberFormat]="PhoneNumberFormat.INTERNATIONAL"
+      [appearance]="'fill'"
     ></ngx-material-intl-tel-input>
     <button mat-flat-button type="submit" [disabled]="!formTestGroup.valid">
       Submit
     </button>
+    <button mat-flat-button (click)="resetForm()" type="button">Reset</button>
 
     <mat-checkbox (change)="toggleShowSetPhoneInput()"
       >Show input to change number</mat-checkbox

diff --git a/apps/ngx-material-intl-tel-input/src/app/app.component.ts b/apps/ngx-material-intl-tel-input/src/app/app.component.ts
@@ -11,6 +11,7 @@ import { MatChipsModule } from '@angular/material/chips';
 import { MatFormFieldModule } from '@angular/material/form-field';
 import { MatInputModule } from '@angular/material/input';
 import { RouterModule } from '@angular/router';
+import { PhoneNumberFormat } from 'google-libphonenumber';
 import { NgxMaterialIntlTelInputComponent } from 'ngx-material-intl-tel-input';
 
 @Component({
@@ -37,6 +38,7 @@ export class AppComponent {
   submittedPhoneValue = signal<string>('');
   formTestGroup: FormGroup;
   showSetPhoneInput = signal<boolean>(false);
+  PhoneNumberFormat = PhoneNumberFormat;
 
   constructor(private fb: FormBuilder) {
     this.formTestGroup = this.fb.group({
@@ -94,4 +96,11 @@ export class AppComponent {
   getCountryISO(value: string): void {
     this.currentCountryISO.set(value);
   }
+
+  /**
+   * Resets the form group to its initial state, clearing all form controls.
+   */
+  resetForm(): void {
+    this.formTestGroup.reset();
+  }
 }
Original file line number	Diff line number	Diff line change
		@@ -1 +1 @@
		npm run lint:all && npm run unit-tests:all && npm run build:all
		npx nx affected -t lint test build