@codemirror/autocomplete 6.1.1 → 6.2.0

package/CHANGELOG.md

@@ -1,3 +1,9 @@
+## 6.2.0 (2022-09-13)
+
+### New features
+
+Autocompletion now takes an `interactionDelay` option that can be used to control the delay between the time where completion opens and the time where commands like `acceptCompletion` affect it.
+
 ## 6.1.1 (2022-09-08)
 
 ### Bug fixes

package/dist/index.cjs

@@ -331,7 +331,8 @@ const completionConfig = state.Facet.define({
             aboveCursor: false,
             icons: true,
             addToOptions: [],
-            compareCompletions: (a, b) => a.label.localeCompare(b.label)
+            compareCompletions: (a, b) => a.label.localeCompare(b.label),
+            interactionDelay: 75
         }, {
             defaultKeymap: (a, b) => a && b,
             closeOnBlur: (a, b) => a && b,
@@ -826,7 +827,6 @@ const completionState = state.StateField.define({
     ]
 });
 
-const CompletionInteractMargin = 75;
 /**
 Returns a command that moves the completion selection forward or
 backward by the given amount.
@@ -834,7 +834,8 @@ backward by the given amount.
 function moveCompletionSelection(forward, by = "option") {
     return (view$1) => {
         let cState = view$1.state.field(completionState, false);
-        if (!cState || !cState.open || Date.now() - cState.open.timestamp < CompletionInteractMargin)
+        if (!cState || !cState.open ||
+            Date.now() - cState.open.timestamp < view$1.state.facet(completionConfig).interactionDelay)
             return false;
         let step = 1, tooltip;
         if (by == "page" && (tooltip = view.getTooltip(view$1, cState.open.tooltip)))
@@ -855,8 +856,8 @@ Accept the current completion.
 */
 const acceptCompletion = (view) => {
     let cState = view.state.field(completionState, false);
-    if (view.state.readOnly || !cState || !cState.open || Date.now() - cState.open.timestamp < CompletionInteractMargin ||
-        cState.open.selected < 0)
+    if (view.state.readOnly || !cState || !cState.open || cState.open.selected < 0 ||
+        Date.now() - cState.open.timestamp < view.state.facet(completionConfig).interactionDelay)
         return false;
     applyCompletion(view, cState.open.options[cState.open.selected]);
     return true;

package/dist/index.d.ts

@@ -78,6 +78,13 @@ interface CompletionConfig {
     [`localeCompare`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/localeCompare).
     */
     compareCompletions?: (a: Completion, b: Completion) => number;
+    /**
+    By default, commands relating to an open completion only take
+    effect 75 milliseconds after the completion opened, so that key
+    presses made before the user is aware of the tooltip don't go to
+    the tooltip. This option can be used to configure that delay.
+    */
+    interactionDelay?: number;
 }
 
 /**

package/dist/index.js

@@ -327,7 +327,8 @@ const completionConfig = /*@__PURE__*/Facet.define({
             aboveCursor: false,
             icons: true,
             addToOptions: [],
-            compareCompletions: (a, b) => a.label.localeCompare(b.label)
+            compareCompletions: (a, b) => a.label.localeCompare(b.label),
+            interactionDelay: 75
         }, {
             defaultKeymap: (a, b) => a && b,
             closeOnBlur: (a, b) => a && b,
@@ -822,7 +823,6 @@ const completionState = /*@__PURE__*/StateField.define({
     ]
 });
 
-const CompletionInteractMargin = 75;
 /**
 Returns a command that moves the completion selection forward or
 backward by the given amount.
@@ -830,7 +830,8 @@ backward by the given amount.
 function moveCompletionSelection(forward, by = "option") {
     return (view) => {
         let cState = view.state.field(completionState, false);
-        if (!cState || !cState.open || Date.now() - cState.open.timestamp < CompletionInteractMargin)
+        if (!cState || !cState.open ||
+            Date.now() - cState.open.timestamp < view.state.facet(completionConfig).interactionDelay)
             return false;
         let step = 1, tooltip;
         if (by == "page" && (tooltip = getTooltip(view, cState.open.tooltip)))
@@ -851,8 +852,8 @@ Accept the current completion.
 */
 const acceptCompletion = (view) => {
     let cState = view.state.field(completionState, false);
-    if (view.state.readOnly || !cState || !cState.open || Date.now() - cState.open.timestamp < CompletionInteractMargin ||
-        cState.open.selected < 0)
+    if (view.state.readOnly || !cState || !cState.open || cState.open.selected < 0 ||
+        Date.now() - cState.open.timestamp < view.state.facet(completionConfig).interactionDelay)
         return false;
     applyCompletion(view, cState.open.options[cState.open.selected]);
     return true;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@codemirror/autocomplete",
-  "version": "6.1.1",
+  "version": "6.2.0",
   "description": "Autocompletion for the CodeMirror code editor",
   "scripts": {
     "test": "cm-runtests",