@codemirror/autocomplete - npm Package Compare versions

Comparing version 6.8.1 to 6.9.0

CHANGELOG.md

@@ -0,1 +1,7 @@
+## 6.9.0 (2023-07-18)
+
+### New features
+
+Completions may now provide a `displayLabel` property that overrides the way they are displayed in the completion list.
+
 ## 6.8.1 (2023-06-23)
@@ -2,0 +8,0 @@

dist/index.d.ts

@@ -17,2 +17,9 @@ import * as _codemirror_state from '@codemirror/state';
     /**
+    An optional override for the completion's visible label. When
+    using this, matched characters will only be highlighted if you
+    provide a [`getMatch`](https://codemirror.net/6/docs/ref/#autocomplete.CompletionResult.getMatch)
+    function.
+    */
+    displayLabel?: string;
+    /**
     An optional short piece of information to show (with a different
@@ -234,8 +241,11 @@ style) after the label.
     When [`filter`](https://codemirror.net/6/docs/ref/#autocomplete.CompletionResult.filter) is set to
-    `false`, this may be provided to compute the ranges on the label
-    that match the input. Should return an array of numbers where
-    each pair of adjacent numbers provide the start and end of a
-    range.
+    `false` or a completion has a
+    [`displayLabel`](https://codemirror.net/6/docs/ref/#autocomplete.Completion.displayLabel), this
+    may be provided to compute the ranges on the label that match
+    the input. Should return an array of numbers where each pair of
+    adjacent numbers provide the start and end of a range. The
+    second argument, the match found by the library, is only passed
+    when `filter` isn't `false`.
     */
-    getMatch?: (completion: Completion) => readonly number[];
+    getMatch?: (completion: Completion, matched?: readonly number[]) => readonly number[];
     /**
@@ -242,0 +252,0 @@ Synchronously update the completion result after typing or

package.json

 {
   "name": "@codemirror/autocomplete",
-  "version": "6.8.1",
+  "version": "6.9.0",
   "description": "Autocompletion for the CodeMirror code editor",
@@ -5,0 +5,0 @@ "scripts": {

No alert changes

Improved metrics

Total package byte prevSize

226835

increased by0.79%

Lines of code

4473

increased by0.45%

No dependency changes