Allow returning a Promise<boolean> with onEdit

deltablot · Nov 19, 2023 · e683a31 · e683a31
1 parent 152c1bf
commit e683a31
Show file tree

Hide file tree

Showing 5 changed files with 9 additions and 5 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,9 @@
 # Changelog for malle
 
+## 2.5.2
+
+* Allow returning a `Promise<boolean>` with `onEdit`
+
 ## 2.5.1
 
 * Fix the type of `input` from `fun` or `onEdit` to `HTMLInputElement|HTMLSelectElement`

diff --git a/DOCUMENTATION.md b/DOCUMENTATION.md
@@ -118,7 +118,7 @@ default value: 'submit'
 What to do when the user clicks outside the input? By default the form will be submitted (if valid), but you can decide to do nothing or cancel the edition.
 
 #### onEdit
-`Function(original: HTMLElement, event: Event, input: HTMLInputElement): any`
+`Function(original: HTMLElement, event: Event, input: HTMLInputElement): boolean | Promise<boolean>`
 default: `undefined`
 
 This function will be called once the input is there and user is ready to type. The return value is not checked.

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@deltablot/malle",
-  "version": "2.5.1",
+  "version": "2.5.2",
   "description": "Make text elements malleable, without dependencies.",
   "main": "dist/main.js",
   "typings":  "dist/main.d.ts",

diff --git a/src/main.ts b/src/main.ts
@@ -51,7 +51,7 @@ export interface Options {
   listenNow?: boolean;
   listenOn?: string;
   onBlur?: Action;
-  onEdit?(original: HTMLElement, event:Event, input: HTMLInputElement|HTMLSelectElement): boolean;
+  onEdit?(original: HTMLElement, event:Event, input: HTMLInputElement|HTMLSelectElement): boolean | Promise<boolean>;
   onEnter?: Action;
   onEscape?: Action;
   placeholder?: string;