@placekit/autocomplete-js - npm Package Compare versions

Comparing version 2.1.1 to 2.1.2

dist/placekit-autocomplete.d.ts

@@ -1,2 +0,2 @@
-/*! @placekit/autocomplete-js v2.1.1 | © placekit.io | MIT license | https://github.com/placekit/autocomplete-js#readme */
+/*! @placekit/autocomplete-js v2.1.2 | © placekit.io | MIT license | https://github.com/placekit/autocomplete-js#readme */
 import type { PKOptions, PKResult } from '@placekit/client-js';
@@ -3,0 +3,0 @@

package.json

 {
   "name": "@placekit/autocomplete-js",
-  "version": "2.1.1",
+  "version": "2.1.2",
   "author": "PlaceKit <[e-mail]>",
@@ -5,0 +5,0 @@ "description": "PlaceKit Autocomplete JavaScript library",

README.md

@@ -49,4 +49,4 @@ <h1 align="center">
 ```html
-<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@placekit/autocomplete-js@2.1.0/dist/placekit-autocomplete.min.css" />
-<script src="https://cdn.jsdelivr.net/npm/@placekit/autocomplete-js@2.1.0"></script>
+<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@placekit/autocomplete-js@2.1.1/dist/placekit-autocomplete.min.css" />
+<script src="https://cdn.jsdelivr.net/npm/@placekit/autocomplete-js@2.1.1"></script>
 ```
@@ -70,3 +70,3 @@
 <script type="module">
-  import placekitAutocomplete from 'https://cdn.jsdelivr.net/npm/@placekit/autocomplete-js@2.1.0/dist/placekit-autocomplete.esm.js';
+  import placekitAutocomplete from 'https://cdn.jsdelivr.net/npm/@placekit/autocomplete-js@2.1.1/dist/placekit-autocomplete.esm.js';
   const pka = placekitAutocomplete(/* ... */);
@@ -165,10 +165,12 @@ // ...
 | `countryAutoFill` | AutoComplete | `boolean?` | `true` | Automatically detect current country by IP and fill input when `types: ['country']`. |
-| `countrySelect` | AutoComplete | `boolean?` | `true` | Show country selector when `countries` is not defined. |
+| `countrySelect` | AutoComplete | `boolean?` | `true` | Show/hide country selector<sup>[(1)](#ft1)[(2)](#ft2)</sup>. |
 | `maxResults` | JS client | `integer` | `5` | Number of results per page. |
-| `language` | JS client | `string?` | `undefined` | Preferred language for the results<sup>[(1)](#ft1)</sup>, [two-letter ISO](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language code. Supported languages are `en` and `fr`. By default the results are displayed in their country's language. |
+| `language` | JS client | `string?` | `undefined` | Preferred language for the results<sup>[(3)](#ft3)</sup>, [two-letter ISO](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language code. Supported languages are `en` and `fr`. By default the results are displayed in their country's language. |
 | `types` | JS client | `string[]?` | `undefined` | Type of results to show. Array of accepted values: `street`, `city`, `country`, `airport`, `bus`, `train`, `townhall`, `tourism`. Prepend `-` to omit a type like `['-bus']`. Unset to return all. |
-| `countries` | JS client | `string[]?` | `undefined` | Restrict search in specific countries. Array of [two-letter ISO](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes<sup>[(1)](#ft1)</sup>. |
+| `countries` | JS client | `string[]?` | `undefined` | Restrict search in specific countries. Array of [two-letter ISO](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes<sup>[(3)](#ft3)</sup>. |
 | `coordinates` | JS client | `string?` | `undefined` | Coordinates to search around. Automatically set when calling [`pka.requestGeolocation()`](#pkarequestgeolocation). |
 
-<a id="ft1"><b>[1]</b></a>: See [Coverage](https://placekit.io/terms/coverage) for more details.
+- <a id="ft1"><b>[1]</b></a>: Ignored if `countries` option is set (Country selector is hidden).
+- <a id="ft2"><b>[2]</b></a>: When `types: ['city']` is set, setting `countrySelect: false` enables a worldwide city search.
+- <a id="ft3"><b>[3]</b></a>: See [Coverage](https://placekit.io/terms/coverage) for more details.
 
@@ -175,0 +177,0 @@ <details>

No alert changes

Improved metrics

Number of lines in readme file

511

increased by0.39%

Worsened metrics

Total package byte prevSize

282004

decreased by-0.06%

Lines of code

6943

decreased by-0.07%

No dependency changes