@theia/plugin 1.24.0-next.58 → 1.24.0-next.60

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@theia/plugin",
-  "version": "1.24.0-next.58+f044a0a081d",
+  "version": "1.24.0-next.60+06aa90cdf45",
   "description": "Theia - Plugin API",
   "types": "./src/theia.d.ts",
   "publishConfig": {
@@ -32,5 +32,5 @@
   "nyc": {
     "extends": "../../configs/nyc.json"
   },
-  "gitHead": "f044a0a081dd3aad4feec7d6b2c1086723e3a900"
+  "gitHead": "06aa90cdf455319ac6e24b8bcb7f8a731898b6b4"
 }

package/src/theia.d.ts

@@ -2078,8 +2078,12 @@ export module '@theia/plugin' {
     /**
      * Represents an item that can be selected from a list of items.
      */
-    export interface QuickPickItemValue {
-        type?: 'item';
+    export interface QuickPickItem {
+        /**
+         * Defaults to {@link QuickPickItemKind.Default}. If set to {@link QUickPickItemKind.Separator}, the item will not be displayed as a row but only as a separator,
+         * and all fields other than {@link QuickPickItem.label label} will be ignored.
+         */
+        kind?: QuickPickItemKind;
         /**
          * The item label
          */
@@ -2106,13 +2110,14 @@ export module '@theia/plugin' {
         alwaysShow?: boolean;
     }
 
-    export interface QuickPickSeparator {
-        type: 'separator';
-        label?: string;
+    /**
+     * The type of a {@link QuickPickItem quitk pick item}. If `Separator` is set, all fields other than {@link QuickPickItem.label label} will be ignored.
+     */
+    export enum QuickPickItemKind {
+        Separator = -1,
+        Default = 0,
     }
 
-    export type QuickPickItem = QuickPickSeparator | QuickPickItemValue;
-
     /**
      * A concrete [QuickInput](#QuickInput) to let the user pick an item from a
      * list of items of type T. The items can be filtered through a filter text field and
@@ -7333,6 +7338,31 @@ export module '@theia/plugin' {
         Deprecated = 1
     }
 
+    /**
+     * A structured label for a {@link CompletionItem completion item}.
+     */
+    export interface CompletionItemLabel {
+
+        /**
+         * The label of this completion item.
+         *
+         * By default this is also the text that is inserted when this completion is selected.
+         */
+        label: string;
+
+        /**
+         * An optional string which is rendered less prominently directly after {@link CompletionItemLabel.label label},
+         * without any spacing. Should be used for function signatures or type annotations.
+         */
+        detail?: string;
+
+        /**
+         * An optional string which is rendered less prominently after {@link CompletionItemLabel.detail}. Should be used
+         * for fully qualified names or file path.
+         */
+        description?: string;
+    }
+
     /**
      * A completion item represents a text snippet that is proposed to complete text that is being typed.
      *
@@ -7355,7 +7385,7 @@ export module '@theia/plugin' {
          * this is also the text that is inserted when selecting
          * this completion.
          */
-        label: string;
+        label: string | CompletionItemLabel;
 
         /**
          * The kind of this completion item. Based on the kind
@@ -7474,7 +7504,7 @@ export module '@theia/plugin' {
          * @param label The label of the completion.
          * @param kind The [kind](#CompletionItemKind) of the completion.
          */
-        constructor(label: string, kind?: CompletionItemKind);
+        constructor(label: string | CompletionItemLabel, kind?: CompletionItemKind);
     }
 
     /**