feat(scm): add visibility variable in plugin API

eclipse-theia · Jul 12, 2022 · f1b9175 · f1b9175
1 parent d29ac06
commit f1b9175
Show file tree

Hide file tree

Showing 5 changed files with 41 additions and 0 deletions.
diff --git a/packages/plugin-ext/src/common/plugin-api-rpc.ts b/packages/plugin-ext/src/common/plugin-api-rpc.ts
@@ -871,6 +871,7 @@ export interface ScmMain {
 
     $setInputBoxValue(sourceControlHandle: number, value: string): void;
     $setInputBoxPlaceholder(sourceControlHandle: number, placeholder: string): void;
+    $setInputBoxVisible(sourceControlHandle: number, visible: boolean): void;
 }
 
 export interface SourceControlProviderFeatures {

diff --git a/packages/plugin-ext/src/main/browser/scm-main.ts b/packages/plugin-ext/src/main/browser/scm-main.ts
@@ -430,4 +430,14 @@ export class ScmMainImpl implements ScmMain {
 
         repository.input.placeholder = placeholder;
     }
+
+    $setInputBoxVisible(sourceControlHandle: number, visible: boolean): void {
+        const repository = this.repositories.get(sourceControlHandle);
+
+        if (!repository) {
+            return;
+        }
+
+        repository.input.visible = visible;
+    }
 }
diff --git a/packages/plugin-ext/src/plugin/scm.ts b/packages/plugin-ext/src/plugin/scm.ts
@@ -311,6 +311,17 @@ export class ScmInputBoxImpl implements theia.SourceControlInputBox {
         this._placeholder = placeholder;
     }
 
+    private _visible: boolean = true;
+
+    get visible(): boolean {
+        return this._visible;
+    }
+
+    set visible(visible: boolean) {
+        this.proxy.$setInputBoxVisible(this.sourceControlHandle, visible);
+        this._visible = visible;
+    }
+
     private _validateInput: ValidateInput | undefined;
 
     get validateInput(): ValidateInput | undefined {

diff --git a/packages/plugin/src/theia.d.ts b/packages/plugin/src/theia.d.ts
@@ -9609,6 +9609,11 @@ export module '@theia/plugin' {
          * A string to show as place holder in the input box to guide the user.
          */
         placeholder: string;
+
+        /**
+         * Controls whether the input box is visible (default is true).
+         */
+        visible: boolean;
     }
 
     interface QuickDiffProvider {

diff --git a/packages/scm/src/browser/scm-input.ts b/packages/scm/src/browser/scm-input.ts
@@ -38,6 +38,7 @@ export interface ScmInputValidator {
 export interface ScmInputOptions {
     placeholder?: string
     validator?: ScmInputValidator
+    visible?: boolean
 }
 
 export interface ScmInputData {
@@ -94,6 +95,19 @@ export class ScmInput implements Disposable {
         this.validate();
     }
 
+    protected _visible = this.options.visible;
+    get visible(): boolean {
+        return this._visible ?? true;
+    }
+    set visible(visible: boolean) {
+        if (this.visible === visible) {
+            return;
+        }
+        this._visible = visible;
+        this.fireDidChange();
+        this.validate();
+    }
+
     protected _issue: ScmInputIssue | undefined;
     get issue(): ScmInputIssue | undefined {
         return this._issue;