@placekit/autocomplete-js - npm Package Compare versions

Comparing version 1.1.5 to 1.2.0

dist/placekit-autocomplete.d.ts

@@ -1,2 +0,2 @@
-/*! @placekit/autocomplete-js v1.1.5 | © placekit.io | MIT license | https://github.com/placekit/autocomplete-js#readme */
+/*! @placekit/autocomplete-js v1.2.0 | © 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": "1.1.5",
+  "version": "1.2.0",
   "author": "PlaceKit <[e-mail]>",
@@ -43,13 +43,13 @@ "description": "PlaceKit Autocomplete JavaScript library",
   "devDependencies": {
-    "@rollup/plugin-commonjs": "^24.1.0",
-    "@rollup/plugin-node-resolve": "^15.0.2",
+    "@rollup/plugin-commonjs": "^25.0.0",
+    "@rollup/plugin-node-resolve": "^15.1.0",
     "@rollup/plugin-replace": "^5.0.2",
     "autoprefixer": "^10.4.14",
-    "eslint": "^8.40.0",
+    "eslint": "^8.42.0",
     "eslint-config-google": "^0.14.0",
     "npm-watch": "^0.11.0",
-    "postcss": "^8.4.23",
+    "postcss": "^8.4.24",
     "postcss-banner": "^4.0.1",
-    "rimraf": "^5.0.0",
-    "rollup": "^3.21.5",
+    "rimraf": "^5.0.1",
+    "rollup": "^3.23.1",
     "rollup-plugin-cleanup": "^3.2.1",
@@ -61,4 +61,4 @@ "rollup-plugin-copy": "^3.4.0",
     "@placekit/client-js": "^1.0.0",
-    "@popperjs/core": "^2.11.7"
+    "@popperjs/core": "^2.11.8"
   }
 }

README.md

@@ -49,3 +49,3 @@ <h1 align="center">
 <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@placekit/autocomplete-js@1.1.5/dist/placekit-autocomplete.min.css" />
-<script src="https://cdn.jsdelivr.net/npm/@placekit/autocomplete-js"></script>
+<script src="https://cdn.jsdelivr.net/npm/@placekit/autocomplete-js@1.1.5"></script>
 ```
@@ -113,6 +113,5 @@
 - [`pka.configure()`](#pkaconfigure)
+- [`pka.state`](#pkastate)
 - [`pka.on()`](#pkaon)
 - [`pka.handlers`](#pkahandlers)
-- [`pka.isEmpty`](#pkaisEmpty)
-- [`pka.isFreeForm`](#pkaisFreeForm)
 - [`pka.requestGeolocation()`](#pkarequestGeolocation)
@@ -212,2 +211,21 @@ - [`pka.hasGeolocation`](#pkahasGeolocation)
 
+### `pka.state`
+
+Read-only object of input state.
+
+```js
+console.log(pka.state); // {dirty: false, empty: false, freeForm: true}
+
+// `true` after the user modifies the input value.
+console.log(pka.state.dirty); // true or false
+
+// `true` whenever the input value is not empty.
+console.log(pka.state.empty); // true or false
+
+// `true` if the input has a free form value or `false` if value is selected from the suggestions.
+console.log(pka.state.freeForm); // true or false
+```
+
+The `freeForm` value comes handy if you need to implement a strict validation of the address, but we don't interfere with how to implement it as input validation is always very specific to the project's stack.
+
 ### `pka.on()`
@@ -223,4 +241,6 @@
   .on('error', (error) => {})
-  .on('empty', (isEmpty) => {})
-  .on('freeForm', (isFreeForm) => {})
+  .on('dirty', (dirty) => {})
+  .on('empty', (empty) => {})
+  .on('freeForm', (freeForm) => {})
+  .on('state', (state) => {})
   .on('geolocation', (hasGeolocation, position) => {});
@@ -273,2 +293,10 @@ ```
 
+##### `dirty`
+
+Triggered when the input value changes.
+
+| Parameter | Type | Description |
+| --- | --- | --- |
+| `dirty` | `boolean` | `true` after the user modifies the value. |
+
 ##### `empty`
@@ -280,3 +308,3 @@
 | --- | --- | --- |
-| `isEmpty` | `boolean` | `true` if input is empty. |
+| `empty` | `boolean` | `true` if input is empty. |
 
@@ -289,4 +317,12 @@ ##### `freeForm`
 | --- | --- | --- |
-| `isFreeForm` | `boolean` | `true` on user input, `false` on `pick` event. |
+| `freeForm` | `boolean` | `true` on user input, `false` on `pick` event. |
 
+##### `state`
+
+Triggered when one of the input states changes.
+
+| Parameter | Type | Description |
+| --- | --- | --- |
+| `state` | `object` | The current input state. |
+
 ##### `geolocation`
@@ -310,21 +346,2 @@
 
-### `pka.isEmpty`
-
-Read-only boolean, `true` if the input is empty.
-
-```js
-console.log(pka.isEmpty); // true or false
-```
-
-### `pka.isFreeForm`
-
-Read-only boolean, `true` if the input has a free form value or `false` if value is selected from the suggestions.
-The latter can only occur when the user has clicked on a suggestion or pressed ENTER after navigating the suggestions with the keyboard.
-
-```js
-console.log(pka.isFreeForm); // true or false
-```
-
-This value comes handy if you need to implement a strict validation of the address, but we don't interfere with how to implement it as input validation is always very specific to the project's stack.
-
 ### `pka.requestGeolocation()`
@@ -331,0 +348,0 @@

No alert changes

Improved metrics

Total package byte prevSize

269975

0.42%

Lines of code

6706

0.45%

Number of lines in readme file

432

4.1%

Dependency changes

• Updated

  @popperjs/core@^2.11.8