Merge pull request microsoft#209965 from microsoft/merogge/view-acc-api-proposal

`accessibilityHelpContent` view API proposal

Author: meganrogge

src/vs/workbench/api/browser/viewsExtensionPoint.ts

@@ -37,6 +37,7 @@ import { HoverPosition } from 'vs/base/browser/ui/hover/hoverWidget';
 import { ILogService } from 'vs/platform/log/common/log';
 import { IExtensionFeatureTableRenderer, IRenderedData, ITableData, IRowData, IExtensionFeaturesRegistry, Extensions as ExtensionFeaturesRegistryExtensions } from 'vs/workbench/services/extensionManagement/common/extensionFeatures';
 import { Disposable } from 'vs/base/common/lifecycle';
+import { MarkdownString } from 'vs/base/common/htmlContent';
 
 export interface IUserFriendlyViewsContainerDescriptor {
 	id: string;
@@ -104,6 +105,8 @@ interface IUserFriendlyViewDescriptor {
 	group?: string;
 	remoteName?: string | string[];
 	virtualWorkspace?: string;
+
+	accessibilityHelpContent: string;
 }
 
 enum InitialVisibility {
@@ -167,6 +170,10 @@ const viewDescriptor: IJSONSchema = {
 		initialSize: {
 			type: 'number',
 			description: localize('vscode.extension.contributs.view.size', "The initial size of the view. The size will behave like the css 'flex' property, and will set the initial size when the view is first shown. In the side bar, this is the height of the view. This value is only respected when the same extension owns both the view and the view container."),
+		},
+		accessibilityHelpContent: {
+			type: 'string',
+			description: localize('vscode.extension.contributes.view.accessibilityHelpContent', "When the accessibility help dialog is invoked in this view, this content will be presented to the user as a markdown string.")
 		}
 	}
 };
@@ -538,6 +545,11 @@ class ViewsExtensionHandler implements IWorkbenchContribution {
 						}
 					}
 
+					let accessibilityHelpContent;
+					if (isProposedApiEnabled(extension.description, 'contribAccessibilityHelpContent') && item.accessibilityHelpContent) {
+						accessibilityHelpContent = new MarkdownString(item.accessibilityHelpContent);
+					}
+
 					const viewDescriptor: ICustomViewDescriptor = {
 						type: type,
 						ctorDescriptor: type === ViewType.Tree ? new SyncDescriptor(TreeViewPane) : new SyncDescriptor(WebviewViewPane),
@@ -558,7 +570,8 @@ class ViewsExtensionHandler implements IWorkbenchContribution {
 						virtualWorkspace: item.virtualWorkspace,
 						hideByDefault: initialVisibility === InitialVisibility.Hidden,
 						workspace: viewContainer?.id === REMOTE ? true : undefined,
-						weight
+						weight,
+						accessibilityHelpContent
 					};
 
 

src/vs/workbench/common/views.ts

@@ -20,7 +20,7 @@ import { SyncDescriptor } from 'vs/platform/instantiation/common/descriptors';
 import { IProgressIndicator } from 'vs/platform/progress/common/progress';
 import Severity from 'vs/base/common/severity';
 import { IAccessibilityInformation } from 'vs/platform/accessibility/common/accessibility';
-import { IMarkdownString } from 'vs/base/common/htmlContent';
+import { IMarkdownString, MarkdownString } from 'vs/base/common/htmlContent';
 import { mixin } from 'vs/base/common/objects';
 import { Codicon } from 'vs/base/common/codicons';
 import { registerIcon } from 'vs/platform/theme/common/iconRegistry';
@@ -300,6 +300,8 @@ export interface IViewDescriptor {
 	readonly virtualWorkspace?: string;
 
 	readonly openCommandActionDescriptor?: OpenCommandActionDescriptor;
+
+	readonly accessibilityHelpContent?: MarkdownString;
 }
 
 export interface ICustomViewDescriptor extends IViewDescriptor {

src/vs/workbench/services/extensions/common/extensionsApiProposals.ts

@@ -25,6 +25,7 @@ export const allApiProposals = Object.freeze({
 	commentThreadApplicability: 'https://raw.githubusercontent.com/microsoft/vscode/main/src/vscode-dts/vscode.proposed.commentThreadApplicability.d.ts',
 	commentingRangeHint: 'https://raw.githubusercontent.com/microsoft/vscode/main/src/vscode-dts/vscode.proposed.commentingRangeHint.d.ts',
 	commentsDraftState: 'https://raw.githubusercontent.com/microsoft/vscode/main/src/vscode-dts/vscode.proposed.commentsDraftState.d.ts',
+	contribAccessibilityHelpContent: 'https://raw.githubusercontent.com/microsoft/vscode/main/src/vscode-dts/vscode.proposed.contribAccessibilityHelpContent.d.ts',
 	contribCommentEditorActionsMenu: 'https://raw.githubusercontent.com/microsoft/vscode/main/src/vscode-dts/vscode.proposed.contribCommentEditorActionsMenu.d.ts',
 	contribCommentPeekContext: 'https://raw.githubusercontent.com/microsoft/vscode/main/src/vscode-dts/vscode.proposed.contribCommentPeekContext.d.ts',
 	contribCommentThreadAdditionalMenu: 'https://raw.githubusercontent.com/microsoft/vscode/main/src/vscode-dts/vscode.proposed.contribCommentThreadAdditionalMenu.d.ts',

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

@@ -0,0 +1,15 @@
+/*---------------------------------------------------------------------------------------------
+ *  Copyright (c) Microsoft Corporation. All rights reserved.
+ *  Licensed under the MIT License. See License.txt in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+
+// empty placeholder declaration for the `accessibilityHelpContent`-property of the `views`-contribution
+
+// https://github.com/microsoft/vscode/issues/209855 @meganrogge
+
+/**
+ * View contributions can include an `accessibilityHelpContent` property that provides help content for screen readers
+ * when the accessibility help dialog is invoked by the user with focus in the view.
+ *
+ * The content is provided as a markdown string and can contain commands that will be resolved along with their keybindings.
+ */