Merge pull request #286388 from microsoft/dev/dmitriv/finalize-quickInputButtonLocation-api

Finalize quickInputbuttonLocation API

extensions/git/package.json

@@ -25,7 +25,6 @@
     "contribViewsWelcome",
     "editSessionIdentityProvider",
     "quickDiffProvider",
-    "quickInputButtonLocation",
     "quickPickSortByLabel",
     "scmActionButton",
     "scmArtifactProvider",

extensions/git/tsconfig.json

@@ -13,7 +13,6 @@
 		"../../src/vscode-dts/vscode.proposed.canonicalUriProvider.d.ts",
 		"../../src/vscode-dts/vscode.proposed.editSessionIdentityProvider.d.ts",
 		"../../src/vscode-dts/vscode.proposed.quickDiffProvider.d.ts",
-		"../../src/vscode-dts/vscode.proposed.quickInputButtonLocation.d.ts",
 		"../../src/vscode-dts/vscode.proposed.quickPickSortByLabel.d.ts",
 		"../../src/vscode-dts/vscode.proposed.scmActionButton.d.ts",
 		"../../src/vscode-dts/vscode.proposed.scmArtifactProvider.d.ts",

extensions/vscode-api-tests/package.json

@@ -32,7 +32,6 @@
     "notebookMessaging",
     "notebookMime",
     "portsAttributes",
-    "quickInputButtonLocation",
     "quickPickSortByLabel",
     "resolvers",
     "scmActionButton",

src/vs/platform/extensions/common/extensionsApiProposals.ts

@@ -331,9 +331,6 @@ const _allApiProposals = {
 	quickDiffProvider: {
 		proposal: 'https://raw.githubusercontent.com/microsoft/vscode/main/src/vscode-dts/vscode.proposed.quickDiffProvider.d.ts',
 	},
-	quickInputButtonLocation: {
-		proposal: 'https://raw.githubusercontent.com/microsoft/vscode/main/src/vscode-dts/vscode.proposed.quickInputButtonLocation.d.ts',
-	},
 	quickPickItemTooltip: {
 		proposal: 'https://raw.githubusercontent.com/microsoft/vscode/main/src/vscode-dts/vscode.proposed.quickPickItemTooltip.d.ts',
 	},

src/vs/workbench/api/common/extHostQuickOpen.ts

@@ -391,12 +391,6 @@ export function createExtHostQuickOpen(mainContext: IMainContext, workspace: IEx
 		}
 
 		set buttons(buttons: QuickInputButton[]) {
-			if (buttons.some(button =>
-				typeof button.location === 'number' ||
-				typeof button.toggle === 'object' && typeof button.toggle.checked === 'boolean')) {
-				checkProposedApiEnabled(this._extension, 'quickInputButtonLocation');
-			}
-
 			this._buttons = buttons.slice();
 			this._handlesToButtons.clear();
 			buttons.forEach((button, i) => {

src/vscode-dts/vscode.d.ts

@@ -13298,6 +13298,26 @@ declare module 'vscode' {
 		validationMessage: string | InputBoxValidationMessage | undefined;
 	}
 
+	/**
+	 * Specifies the location where a {@link QuickInputButton} should be rendered.
+	 */
+	export enum QuickInputButtonLocation {
+		/**
+		 * The button is rendered in the title bar.
+		 */
+		Title = 1,
+
+		/**
+		 * The button is rendered inline to the right of the input box.
+		 */
+		Inline = 2,
+
+		/**
+		 * The button is rendered at the far end inside the input box.
+		 */
+		Input = 3
+	}
+
 	/**
 	 * A button for an action in a {@link QuickPick} or {@link InputBox}.
 	 */
@@ -13311,6 +13331,26 @@ declare module 'vscode' {
 		 * An optional tooltip displayed when hovering over the button.
 		 */
 		readonly tooltip?: string | undefined;
+
+		/**
+		 * The location where the button should be rendered.
+		 *
+		 * Defaults to {@link QuickInputButtonLocation.Title}.
+		 *
+		 * **Note:** This property is ignored if the button was added to a {@link QuickPickItem}.
+		 */
+		location?: QuickInputButtonLocation;
+
+		/**
+		 * When present, indicates that the button is a toggle button that can be checked or unchecked.
+		 */
+		readonly toggle?: {
+			/**
+			 * Indicates whether the toggle button is currently checked.
+			 * This property will be updated when the button is toggled.
+			 */
+			checked: boolean;
+		};
 	}
 
 	/**

src/vscode-dts/vscode.proposed.quickInputButtonLocation.d.ts

@@ -1,49 +0,0 @@
-/*---------------------------------------------------------------------------------------------
- *  Copyright (c) Microsoft Corporation. All rights reserved.
- *  Licensed under the MIT License. See License.txt in the project root for license information.
- *--------------------------------------------------------------------------------------------*/
-
-declare module 'vscode' {
-
-	// https://github.com/microsoft/vscode/issues/175662
-
-	/**
-	 * Specifies the location where a {@link QuickInputButton} should be rendered.
-	 */
-	export enum QuickInputButtonLocation {
-		/**
-		 * The button is rendered in the title bar.
-		 */
-		Title = 1,
-
-		/**
-		 * The button is rendered inline to the right of the input box.
-		 */
-		Inline = 2,
-
-		/**
-		 * The button is rendered at the far end inside the input box.
-		 */
-		Input = 3
-	}
-
-	export interface QuickInputButton {
-		/**
-		 * The location where the button should be rendered.
-		 *
-		 * Defaults to {@link QuickInputButtonLocation.Title}.
-		 *
-		 * **Note:** This property is ignored if the button was added to a {@link QuickPickItem}.
-		 */
-		location?: QuickInputButtonLocation;
-
-		/**
-		 * When present, indicates that the button is a toggle button that can be checked or unchecked.
-		 *
-		 * **Note:** This property is currently only applicable to buttons with {@link QuickInputButtonLocation.Input} location.
-		 * It must be set for such buttons, and the state will be updated when the button is toggled.
-		 * It cannot be set for buttons with other location values.
-		 */
-		readonly toggle?: { checked: boolean };
-	}
-}