Merge pull request microsoft#182330 from microsoft/merogge/acc-interactive

Add accessibility help menu to chat input

Author: meganrogge

src/vs/workbench/contrib/accessibility/browser/accessibilityContribution.ts

@@ -23,6 +23,12 @@ const configuration: IConfigurationNode = {
 			type: 'boolean',
 			default: true,
 			tags: ['accessibility']
+		},
+		'accessibility.verbosity.chatInput': {
+			description: localize('verbosity.chatInput.description', 'Provide information about how to access the interactive session accessibility help menu when the interactive input is focused'),
+			type: 'boolean',
+			default: true,
+			tags: ['accessibility']
 		}
 	}
 };

src/vs/workbench/contrib/interactiveSession/browser/actions/interactiveSessionAccessibilityHelp.ts

@@ -0,0 +1,25 @@
+/*---------------------------------------------------------------------------------------------
+ *  Copyright (c) Microsoft Corporation. All rights reserved.
+ *  Licensed under the MIT License. See License.txt in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+
+import { localize } from 'vs/nls';
+import { format } from 'vs/base/common/strings';
+import { IKeybindingService } from 'vs/platform/keybinding/common/keybinding';
+
+export function getAccessibilityHelpText(keybindingService: IKeybindingService): string {
+	const content = [];
+	content.push(localize('chat.accessibilityHelp', "Chat Accessibility Help"));
+	content.push(localize('interactiveSession.helpMenuExit', "Exit this menu and return to the interactive editor input via the Escape key."));
+	content.push(descriptionForCommand('interactiveSession.action.focus', localize('interactiveSession.action.focus', 'The Focus Interactive Session ({0}) command focuses the chat request/response list, which can be navigated with UpArrow/DownArrow.',), localize('interactiveSession.action.focusNoKb', 'The Focus Interactive Session command focuses the chat request/response list, which can be navigated with UpArrow/DownArrow and is currently not triggerable by a keybinding.'), keybindingService));
+	content.push(descriptionForCommand('workbench.action.interactiveSession.focusInput', localize('workbench.action.interactiveSession.focusInput', 'The Focus Interactive Session Input ({0}) command focuses the input box for chat requests.'), localize('workbench.action.interactiveSession.focusInputNoKb', 'Focus Interactive Session Input command focuses the input box for chat requests and is currently not triggerable by a keybinding.'), keybindingService));
+	return content.join('\n');
+}
+
+function descriptionForCommand(commandId: string, msg: string, noKbMsg: string, keybindingService: IKeybindingService): string {
+	const kb = keybindingService.lookupKeybinding(commandId);
+	if (kb) {
+		return format(msg, kb.getAriaLabel());
+	}
+	return format(noKbMsg, commandId);
+}

src/vs/workbench/contrib/interactiveSession/browser/actions/interactiveSessionActions.ts

@@ -3,18 +3,22 @@
  *  Licensed under the MIT License. See License.txt in the project root for license information.
  *--------------------------------------------------------------------------------------------*/
 
+import { addStandardDisposableListener } from 'vs/base/browser/dom';
 import { Codicon } from 'vs/base/common/codicons';
 import { KeyCode, KeyMod } from 'vs/base/common/keyCodes';
+import { withNullAsUndefined } from 'vs/base/common/types';
 import { ICodeEditor } from 'vs/editor/browser/editorBrowser';
 import { EditorAction, ServicesAccessor, registerEditorAction } from 'vs/editor/browser/editorExtensions';
 import { EditorContextKeys } from 'vs/editor/common/editorContextKeys';
 import { localize } from 'vs/nls';
 import { Action2, IAction2Options, MenuId, registerAction2 } from 'vs/platform/actions/common/actions';
 import { ContextKeyExpr } from 'vs/platform/contextkey/common/contextkey';
+import { IKeybindingService } from 'vs/platform/keybinding/common/keybinding';
 import { KeybindingWeight } from 'vs/platform/keybinding/common/keybindingsRegistry';
 import { IQuickInputService, IQuickPickItem } from 'vs/platform/quickinput/common/quickInput';
 import { ViewAction } from 'vs/workbench/browser/parts/views/viewPane';
 import { ActiveEditorContext } from 'vs/workbench/common/contextkeys';
+import { getAccessibilityHelpText } from 'vs/workbench/contrib/interactiveSession/browser/actions/interactiveSessionAccessibilityHelp';
 import { clearChatEditor, clearChatSession } from 'vs/workbench/contrib/interactiveSession/browser/actions/interactiveSessionClear';
 import { IInteractiveSessionWidgetService } from 'vs/workbench/contrib/interactiveSession/browser/interactiveSession';
 import { IInteractiveSessionEditorOptions } from 'vs/workbench/contrib/interactiveSession/browser/interactiveSessionEditor';
@@ -124,6 +128,58 @@ export function registerInteractiveSessionActions() {
 		}
 	});
 
+	registerEditorAction(class AccessibilityHelpInteractiveSessionAction extends EditorAction {
+		constructor() {
+			super({
+				id: 'interactiveSession.action.accessibilityHelp',
+				label: localize('actions.interactiveSession.accessibiltyHelp', "Chat View Accessibility Help"),
+				alias: 'Chat View Accessibility Help',
+				precondition: CONTEXT_IN_INTERACTIVE_INPUT,
+				kbOpts: {
+					primary: KeyMod.Alt | KeyCode.F1,
+					weight: KeybindingWeight.EditorContrib
+				}
+			});
+		}
+
+		async run(accessor: ServicesAccessor, editor: ICodeEditor): Promise<void> {
+			const widgetService = accessor.get(IInteractiveSessionWidgetService);
+			const keybindingService = accessor.get(IKeybindingService);
+			const inputEditor = widgetService.lastFocusedWidget?.inputEditor;
+			const editorUri = editor.getModel()?.uri;
+
+			if (!inputEditor || !editorUri) {
+				return;
+			}
+
+			const widget = widgetService.getWidgetByInputUri(editorUri);
+			const domNode = withNullAsUndefined(inputEditor.getDomNode());
+
+			if (!domNode || !widget) {
+				return;
+			}
+
+			const cachedInput = inputEditor.getValue();
+			const cachedPosition = inputEditor.getPosition();
+
+			const helpText = getAccessibilityHelpText(keybindingService);
+			inputEditor.setValue(helpText);
+			inputEditor.updateOptions({ readOnly: true });
+			inputEditor.focus();
+			const disposable = addStandardDisposableListener(domNode, 'keydown', e => {
+				if (e.keyCode === KeyCode.Escape && inputEditor.getValue() === helpText) {
+					inputEditor.updateOptions({ readOnly: false });
+					inputEditor.setValue(cachedInput);
+					if (cachedPosition) {
+						inputEditor.setPosition(cachedPosition);
+					}
+					widget.focusInput();
+					disposable.dispose();
+				}
+			});
+		}
+	});
+
 	registerAction2(class FocusInteractiveSessionInputAction extends Action2 {
 		constructor() {
 			super({

src/vs/workbench/contrib/interactiveSession/browser/interactiveSessionInputPart.ts

@@ -17,10 +17,12 @@ import { IModelService } from 'vs/editor/common/services/model';
 import { localize } from 'vs/nls';
 import { MenuWorkbenchToolBar } from 'vs/platform/actions/browser/toolbar';
 import { MenuId } from 'vs/platform/actions/common/actions';
+import { IConfigurationService } from 'vs/platform/configuration/common/configuration';
 import { IContextKey, IContextKeyService } from 'vs/platform/contextkey/common/contextkey';
 import { registerAndCreateHistoryNavigationContext } from 'vs/platform/history/browser/contextScopedHistoryWidget';
 import { IInstantiationService } from 'vs/platform/instantiation/common/instantiation';
 import { ServiceCollection } from 'vs/platform/instantiation/common/serviceCollection';
+import { IKeybindingService } from 'vs/platform/keybinding/common/keybinding';
 import { DEFAULT_FONT_FAMILY } from 'vs/workbench/browser/style';
 import { getSimpleCodeEditorWidgetOptions, getSimpleEditorOptions } from 'vs/workbench/contrib/codeEditor/browser/simpleEditorOptions';
 import { IInteractiveSessionExecuteActionContext } from 'vs/workbench/contrib/interactiveSession/browser/actions/interactiveSessionExecuteActions';
@@ -75,12 +77,28 @@ export class InteractiveSessionInputPart extends Disposable implements IHistoryN
 		@IModelService private readonly modelService: IModelService,
 		@IInstantiationService private readonly instantiationService: IInstantiationService,
 		@IContextKeyService private readonly contextKeyService: IContextKeyService,
+		@IConfigurationService private readonly configurationService: IConfigurationService,
+		@IKeybindingService private readonly keybindingService: IKeybindingService
 	) {
 		super();
 
 		this.inputEditorHasText = CONTEXT_INTERACTIVE_INPUT_HAS_TEXT.bindTo(contextKeyService);
 		this.history = new HistoryNavigator([], 5);
 		this._register(this.historyService.onDidClearHistory(() => this.history.clear()));
+		this._register(this.configurationService.onDidChangeConfiguration(e => {
+			if (e.affectsConfiguration('accessibility.verbosity.chatInput')) {
+				this.inputEditor.updateOptions({ ariaLabel: this._getAriaLabel() });
+			}
+		}));
+	}
+
+	private _getAriaLabel(): string {
+		const verbose = this.configurationService.getValue<boolean>('accessibility.verbosity.chatInput');
+		if (verbose) {
+			const kbLabel = this.keybindingService.lookupKeybinding('interactiveSession.action.accessibilityHelp')?.getLabel();
+			return kbLabel ? localize('interactiveSessionInput.accessibilityHelp', "Chat Input,  Type code here and press Enter to run. Use {0} for Interactive Session Accessibility Help.", kbLabel) : localize('interactiveSessionInput.accessibilityHelpNoKb', "Chat Input,  Type code here and press Enter to run. Use the Interactive Session Accessibility Help command for more information.");
+		}
+		return localize('interactiveSessionInput', "Chat Input");
 	}
 
 	setState(providerId: string, inputValue: string): void {
@@ -152,7 +170,7 @@ export class InteractiveSessionInputPart extends Disposable implements IHistoryN
 
 		const options = getSimpleEditorOptions();
 		options.readOnly = false;
-		options.ariaLabel = localize('chatInput', "Chat Input");
+		options.ariaLabel = this._getAriaLabel();
 		options.fontFamily = DEFAULT_FONT_FAMILY;
 		options.fontSize = 13;
 		options.lineHeight = 20;

src/vs/workbench/contrib/interactiveSession/browser/interactiveSessionWidget.ts

@@ -12,6 +12,7 @@ import { isEqual } from 'vs/base/common/resources';
 import { URI } from 'vs/base/common/uri';
 import 'vs/css!./media/interactiveSession';
 import { ICodeEditor } from 'vs/editor/browser/editorBrowser';
+import { EditorOption } from 'vs/editor/common/config/editorOptions';
 import { localize } from 'vs/nls';
 import { MenuId } from 'vs/platform/actions/common/actions';
 import { IContextKey, IContextKeyService } from 'vs/platform/contextkey/common/contextkey';
@@ -423,6 +424,9 @@ export class InteractiveSessionWidget extends Disposable implements IInteractive
 	}
 
 	getViewState(): IViewState {
+		if (this.inputEditor.getOption(EditorOption.readOnly)) {
+			return { inputValue: undefined };
+		}
 		this.inputPart.saveState();
 		return { inputValue: this.inputPart.inputEditor.getValue() };
 	}