intl-tel-input 25.5.2 → 25.8.0

package/CHANGELOG.md

@@ -1,3 +1,31 @@
 See the Github Releases page for changelog: https://github.com/jackocnr/intl-tel-input/releases
 
-Or to lookup a specific version, e.g. v20.0.0, update the URL accordingly: https://github.com/jackocnr/intl-tel-input/releases/tag/v20.0.0
+Or to view a specific version, e.g. v20.0.0, update the URL accordingly, e.g. https://github.com/jackocnr/intl-tel-input/releases/tag/v20.0.0
+
+## Breaking changes
+
+- v25.0.0 https://github.com/jackocnr/intl-tel-input/releases/tag/v25.0.0
+- v24.0.0 https://github.com/jackocnr/intl-tel-input/releases/tag/v24.0.0
+- v23.0.0 https://github.com/jackocnr/intl-tel-input/releases/tag/v23.0.0
+- v22.0.0 https://github.com/jackocnr/intl-tel-input/releases/tag/v22.0.0
+- v21.0.0 https://github.com/jackocnr/intl-tel-input/releases/tag/v21.0.0
+- v20.0.0 https://github.com/jackocnr/intl-tel-input/releases/tag/v20.0.0
+- v19.0.0 https://github.com/jackocnr/intl-tel-input/releases/tag/v19.0.0
+- v18.0.0 https://github.com/jackocnr/intl-tel-input/releases/tag/v18.0.0
+- v17.0.0 https://github.com/jackocnr/intl-tel-input/releases/tag/v17.0.0
+- v16.0.0 https://github.com/jackocnr/intl-tel-input/releases/tag/v16.0.0
+- v15.0.0 https://github.com/jackocnr/intl-tel-input/releases/tag/v15.0.0
+- v14.0.0 https://github.com/jackocnr/intl-tel-input/releases/tag/v14.0.0
+- v13.0.0 https://github.com/jackocnr/intl-tel-input/releases/tag/v13.0.0
+- v12.0.0 https://github.com/jackocnr/intl-tel-input/releases/tag/v12.0.0
+- v11.0.0 https://github.com/jackocnr/intl-tel-input/releases/tag/v11.0.0
+- v10.0.0 https://github.com/jackocnr/intl-tel-input/releases/tag/v10.0.0
+- v9.0.0 https://github.com/jackocnr/intl-tel-input/releases/tag/v9.0.0
+- v8.0.0 https://github.com/jackocnr/intl-tel-input/releases/tag/v8.0.0
+- v7.0.0 https://github.com/jackocnr/intl-tel-input/releases/tag/v7.0.0
+- v6.0.0 https://github.com/jackocnr/intl-tel-input/releases/tag/v6.0.0
+- v5.0.0 https://github.com/jackocnr/intl-tel-input/releases/tag/v5.0.0
+- v4.0.0 https://github.com/jackocnr/intl-tel-input/releases/tag/v4.0.0
+- v3.0.0 https://github.com/jackocnr/intl-tel-input/releases/tag/v3.0.0
+- v2.0.0 https://github.com/jackocnr/intl-tel-input/releases/tag/v2.0.0
+- v1.0.0 https://github.com/jackocnr/intl-tel-input/releases/tag/v1.0.0

package/README.md

@@ -77,16 +77,16 @@ _Note: We have now dropped support for all versions of Internet Explorer because
 ## Getting Started (Using a CDN)
 1. Add the CSS
   ```html
-  <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/intl-tel-input@25.5.2/build/css/intlTelInput.css">
+  <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/intl-tel-input@25.8.0/build/css/intlTelInput.css">
   ```
 
 2. Add the plugin script and initialise it on your input element
   ```html
-  <script src="https://cdn.jsdelivr.net/npm/intl-tel-input@25.5.2/build/js/intlTelInput.min.js"></script>
+  <script src="https://cdn.jsdelivr.net/npm/intl-tel-input@25.8.0/build/js/intlTelInput.min.js"></script>
   <script>
     const input = document.querySelector("#phone");
     window.intlTelInput(input, {
-      loadUtils: () => import("https://cdn.jsdelivr.net/npm/intl-tel-input@25.5.2/build/js/utils.js"),
+      loadUtils: () => import("https://cdn.jsdelivr.net/npm/intl-tel-input@25.8.0/build/js/utils.js"),
     });
   </script>
   ```
@@ -229,9 +229,9 @@ _Note that the `failure` callback must be called in the event of an error, hence
 
 **hiddenInput**  
 Type: `Function` Default: `null`  
-Allows the creation of hidden input fields within a form to store the full international telephone number and the selected country code. It accepts a function that receives the name of the main telephone input as an argument. This function should return an object with `phone` and (optionally) `country` properties to specify the names of the hidden inputs for the phone number and country code, respectively. This is useful for non-Ajax form submissions to ensure the full international number and country code are captured, especially when `nationalMode` is enabled.
+Allows the creation of hidden input fields within a form, which, on submit, get populated with the (1) full international telephone number and (2) the selected country code. It accepts a function that receives the name of the main telephone input as an argument. This function should return an object with `phone` and (optionally) `country` properties to specify the names of the hidden inputs for the phone number and country code, respectively. This is useful for non-Ajax form submissions to ensure the full international number and country code are captured, especially when `nationalMode` is enabled.
 
-***Note**: This feature requires the input to be inside a `<form>` element, as it listens for the `submit` event on the closest form element. Also note that since this uses `getNumber` internally, firstly it requires the [utils script to be loaded](#loading-the-utilities-script), and secondly it expects a valid number and so will only work correctly if you have used `isValidNumber` to validate the number before allowing the form submit to go through.
+***Note**: This feature requires the input to be inside a `<form>` element, as it listens for the `submit` event on the closest form element. Also note that since this uses `getNumber` internally, firstly it requires the [utils script to be loaded](#loading-the-utilities-script), and secondly, it expects a valid number and so will only work correctly if you have used `isValidNumber` to validate the number before allowing the form submit to go through.
 
 ```js
 intlTelInput(input, {
@@ -251,7 +251,7 @@ This will generate the following (hidden) elements, which will be automatically
 
 **i18n**  
 Type: `Object` Default: `{}`  
-Allow localisation/customisation of the 200+ country names, as well as other user interface text (e.g. the placeholder text for the country search input). The easiest way to do this is to simply import one of the [provided translation modules](https://github.com/jackocnr/intl-tel-input/tree/master/build/js/i18n) and set `i18n` to that value (see option 1 below). You can also override one or more individual keys this way (see option 1 below). Alternatively, you can provide your own custom translations (see option 2 below). If providing your own, you will need to specify all the country names (which can be copied from the country-list project e.g. here are the [country names in French](https://github.com/umpirsky/country-list/blob/master/data/fr/country.json)), as well as a few UI strings (listed below). [See example](https://intl-tel-input.com/examples/localise-countries.html).
+Allows you to specify translation strings for the 200+ country names, as well as other user interface text (e.g. the placeholder text for the country search input). The easiest way to do this is to import one of the [provided translation modules](https://github.com/jackocnr/intl-tel-input/tree/master/build/js/i18n) and set `i18n` to that value (see option 1 below). You can also override one or more individual keys this way (see option 1 below). Alternatively, you can provide your own custom translations (see option 2 below). If providing your own, you will need to specify all the country names (which can be copied from the country-list project, e.g. here are the [country names in French](https://github.com/umpirsky/country-list/blob/master/data/fr/country.json)), as well as a few UI strings (listed below). [See example](https://intl-tel-input.com/examples/localise-countries.html).
 
 If we don't currently support a language you need, it's easy to [contribute this](https://github.com/jackocnr/intl-tel-input/blob/master/.github/CONTRIBUTING.md#adding-a-new-translation) yourself - you only need to provide a handful of UI translation strings, as we automatically pull in the country names from the country-list project.
 
@@ -297,7 +297,7 @@ intlTelInput(input, {
     oneSearchResult: "1 result found",
     // Screen reader text for when the search produces multiple results
     multipleSearchResults: "${count} results found",
-    // For more complex pluralisation cases e.g. Polish or Arabic, you can implement your own logic
+    // For more complex pluralisation cases, e.g. Polish or Arabic, you can implement your own logic
     // Note that if this function is defined, the plugin will ignore the "zero", "one" and "multiple" keys listed above
     searchResultsText(count) {
       if (count === 0) return "No results found";
@@ -322,7 +322,7 @@ The `loadUtils` option takes a function which returns a Promise which resolves t
 ```js
 // (A) import utils module from a CDN
 intlTelInput(htmlInputElement, {
-  loadUtils: () => import("https://cdn.jsdelivr.net/npm/intl-tel-input@25.5.2/build/js/utils.js"),
+  loadUtils: () => import("https://cdn.jsdelivr.net/npm/intl-tel-input@25.8.0/build/js/utils.js"),
 });
 
 // (B) import utils module from your own hosted version of utils.js
@@ -464,6 +464,12 @@ Change the selected country. It should be rare, if ever, that you need to do thi
 iti.setCountry("gb");
 ```
 
+**setDisabled**  
+Updates the disabled attribute of both the telephone input and the selected country button. Accepts a boolean value. _Note: we recommend using this instead of updating the disabled attribute of the input directly._
+```js
+iti.setDisabled(true);
+```
+
 **setNumber**  
 Insert a number, and update the selected country accordingly. _Note that if `formatOnDisplay` is enabled, this will attempt to format the number to either national or international format according to the `nationalMode` option._  
 ```js
@@ -476,12 +482,6 @@ Change the placeholderNumberType option.
 iti.setPlaceholderNumberType("FIXED_LINE");
 ```
 
-**setDisabled**  
-Updates the disabled attribute of both the telephone input and the selected country button. Accepts a boolean value. _Note: we recommend using this instead of updating the disabled attribute of the input directly._
-```js
-iti.setDisabled(true);
-```
-
 ## Static Methods
 
 **getCountryData**  
@@ -606,7 +606,7 @@ The `loadUtils` option takes a function which returns a Promise which resolves t
 ```js
 // (A) import utils module from a CDN
 intlTelInput(htmlInputElement, {
-  loadUtils: () => import("https://cdn.jsdelivr.net/npm/intl-tel-input@25.5.2/build/js/utils.js"),
+  loadUtils: () => import("https://cdn.jsdelivr.net/npm/intl-tel-input@25.8.0/build/js/utils.js"),
 });
 
 // (B) import utils module from your own hosted version of utils.js

package/angular/README.md

@@ -29,7 +29,7 @@ import "intl-tel-input/styles";
 
 See the [Validation demo](https://github.com/jackocnr/intl-tel-input/blob/master/angular/demo/validation/validation.component.ts) for a more fleshed-out example of how to handle validation.
 
-A note on the utils script (~260KB): if you're lazy loading the IntlTelInput chunk (and so less worried about filesize) then you can just import IntlTelInput from `"intl-tel-input/angularWithUtils"`, to include the utils script. Alternatively, if you use the main `"intl-tel-input/angular"` import, then you should couple this with the `loadUtils` initialisation option - you will need to host the [utils.js](https://github.com/jackocnr/intl-tel-input/blob/master/build/js/utils.js) file, and then set the `loadUtils` option to that URL, or alternatively just point it to a CDN hosted version e.g. `"https://cdn.jsdelivr.net/npm/intl-tel-input@25.2.1/build/js/utils.js"`.
+A note on the utils script (~260KB): if you're lazy loading the IntlTelInput chunk (and so less worried about filesize) then you can just import IntlTelInput from `"intl-tel-input/angularWithUtils"`, to include the utils script. Alternatively, if you use the main `"intl-tel-input/angular"` import, then you should couple this with the `loadUtils` initialisation option - you will need to host the [utils.js](https://github.com/jackocnr/intl-tel-input/blob/master/build/js/utils.js) file, and then set the `loadUtils` option to that URL, or alternatively just point it to a CDN hosted version e.g. `"https://cdn.jsdelivr.net/npm/intl-tel-input@25.8.0/build/js/utils.js"`.
 
 ## Props
 Here's a list of all of the current props you can pass to the IntlTelInput Angular component.