@theia/plugin 1.25.0-next.2 → 1.25.0-next.20

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@theia/plugin",
-  "version": "1.25.0-next.2+ce495c5fb38",
+  "version": "1.25.0-next.20+c78d302e4cd",
   "description": "Theia - Plugin API",
   "types": "./src/theia.d.ts",
   "publishConfig": {
@@ -32,5 +32,5 @@
   "nyc": {
     "extends": "../../configs/nyc.json"
   },
-  "gitHead": "ce495c5fb3845dd48ccb525e43fdf24a34d04a16"
+  "gitHead": "c78d302e4cddfec1acbe60933fc3ac3ec6f0932d"
 }

package/src/theia-proposed.d.ts

@@ -642,6 +642,11 @@ export module '@theia/plugin' {
          */
         contextValue?: string;
 
+        /**
+         * Accessibility information used when screen reader interacts with this timeline item.
+         */
+        accessibilityInformation?: AccessibilityInformation;
+
         /**
          * @param label A human-readable string describing the timeline item
          * @param timestamp A timestamp (in milliseconds since 1 January 1970 00:00:00) for when the timeline item occurred

package/src/theia.d.ts

@@ -496,6 +496,17 @@ export module '@theia/plugin' {
          */
         appendPlaceholder(value: string | ((snippet: SnippetString) => any), number?: number): SnippetString;
 
+        /**
+         * Builder-function that appends a choice (`${1|a,b,c|}`) to
+         * the {@linkcode SnippetString.value value} of this snippet string.
+         *
+         * @param values The values for choices - the array of strings
+         * @param number The number of this tabstop, defaults to an auto-increment
+         * value starting at 1.
+         * @return This snippet string.
+         */
+        appendChoice(values: string[], number?: number): SnippetString;
+
         /**
          * Builder-function that appends a variable (`${VAR}`) to
          * the [`value`](#SnippetString.value) of this snippet string.
@@ -2180,6 +2191,11 @@ export module '@theia/plugin' {
          */
         matchOnDetail: boolean;
 
+        /*
+         * An optional flag to maintain the scroll position of the quick pick when the quick pick items are updated. Defaults to false.
+         */
+        keepScrollPosition?: boolean;
+
         /**
          * Active items. This can be read and updated by the extension.
          */
@@ -2388,6 +2404,24 @@ export module '@theia/plugin' {
         export function getCommands(filterInternal?: boolean): PromiseLike<string[]>;
     }
 
+    /**
+     * Accessibility information which controls screen reader behavior.
+     */
+    export interface AccessibilityInformation {
+        /**
+         * Label to be read out by a screen reader once the item has focus.
+         */
+        readonly label: string;
+
+        /**
+         * Role of the widget which defines how a screen reader interacts with it.
+         * The role should be set in special cases when for example a tree-like element behaves like a checkbox.
+         * If role is not specified the editor will pick the appropriate role automatically.
+         * More about aria roles can be found here https://w3c.github.io/aria/#widget_roles
+         */
+        readonly role?: string;
+    }
+
     /**
      * Represents an action that is shown with a message.
      */
@@ -2447,6 +2481,14 @@ export module '@theia/plugin' {
      */
     export interface StatusBarItem {
 
+        /**
+         * The identifier of this item.
+         *
+         * *Note*: if no identifier was provided by the {@linkcode window.createStatusBarItem}
+         * method, the identifier will match the {@link Extension.id extension identifier}.
+         */
+        readonly id: string;
+
         /**
          * The alignment of this item.
          */
@@ -2458,6 +2500,13 @@ export module '@theia/plugin' {
          */
         readonly priority: number;
 
+        /**
+         * The name of the entry, like 'Python Language Indicator', 'Git Status' etc.
+         * Try to keep the length of the name short, yet descriptive enough that
+         * users can understand what the status bar item is about.
+         */
+        name: string | undefined;
+
         /**
          * The text to show for the entry. To set a text with icon use the following pattern in text string:
          * $(fontawesomeClassName)
@@ -2474,11 +2523,30 @@ export module '@theia/plugin' {
          */
         color: string | ThemeColor | undefined;
 
+        /**
+         * The background color for this entry.
+         *
+         * *Note*: only the following colors are supported:
+         * * `new ThemeColor('statusBarItem.errorBackground')`
+         * * `new ThemeColor('statusBarItem.warningBackground')`
+         *
+         * More background colors may be supported in the future.
+         *
+         * *Note*: when a background color is set, the statusbar may override
+         * the `color` choice to ensure the entry is readable in all themes.
+         */
+        backgroundColor: ThemeColor | undefined;
+
         /**
          * The identifier of a command to run on click.
          */
         command: string | Command | undefined;
 
+        /**
+         * Accessibility information used when a screen reader interacts with this StatusBar item.
+         */
+        accessibilityInformation: AccessibilityInformation | undefined;
+
         /**
          * Shows the entry in the status bar.
          */
@@ -5239,6 +5307,13 @@ export module '@theia/plugin' {
          */
         contextValue?: string;
 
+        /**
+         * Accessibility information used when screen reader interacts with this tree item.
+         * Generally, a TreeItem has no need to set the `role` of the accessibilityInformation;
+         * however, there are cases where a TreeItem is not displayed in a tree-like way where setting the `role` may make sense.
+         */
+        accessibilityInformation?: AccessibilityInformation;
+
         /**
          * @param label A human-readable string describing this item
          * @param collapsibleState [TreeItemCollapsibleState](#TreeItemCollapsibleState) of the tree item. Default is [TreeItemCollapsibleState.None](#TreeItemCollapsibleState.None)
@@ -6833,8 +6908,7 @@ export module '@theia/plugin' {
      * thenable.
      *
      */
-    export type ProviderResult<T> = T | undefined | PromiseLike<T | undefined>;
-
+    export type ProviderResult<T> = T | undefined | null | Thenable<T | undefined | null>;
     /**
      * A symbol kind.
      */
@@ -7909,7 +7983,7 @@ export module '@theia/plugin' {
      *
      * A code action can be any command that is [known](#commands.getCommands) to the system.
      */
-    export interface CodeActionProvider {
+    export interface CodeActionProvider<T extends CodeAction = CodeAction> {
         /**
          * Provide commands for the given document and range.
          *
@@ -7921,12 +7995,7 @@ export module '@theia/plugin' {
          * @return An array of commands, quick fixes, or refactorings or a thenable of such. The lack of a result can be
          * signaled by returning `undefined`, `null`, or an empty array.
          */
-        provideCodeActions(
-            document: TextDocument,
-            range: Range | Selection,
-            context: CodeActionContext,
-            token: CancellationToken | undefined
-        ): ProviderResult<(Command | CodeAction)[]>;
+        provideCodeActions(document: TextDocument, range: Range | Selection, context: CodeActionContext, token: CancellationToken | undefined): ProviderResult<(Command | T)[]>;
 
         /**
          * Given a code action fill in its `edit`-property. Changes to
@@ -7942,7 +8011,7 @@ export module '@theia/plugin' {
          * @return The resolved code action or a thenable that resolves to such. It is OK to return the given
          * `item`. When no result is returned, the given `item` will be used.
          */
-        resolveCodeAction?(codeAction: CodeAction, token: CancellationToken | undefined): ProviderResult<CodeAction>;
+        resolveCodeAction?(codeAction: T, token: CancellationToken | undefined): ProviderResult<T>;
     }
 
     /**