Merge pull request microsoft#187728 from microsoft/merogge/rename-key

improve name for `AccessibleViewProvider` property

Author: meganrogge

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

@@ -33,7 +33,7 @@ class AccessibilityHelpProvider implements IAccessibleContentProvider {
 		this._editor.focus();
 	}
 	options: IAccessibleViewOptions = { type: AccessibleViewType.HelpMenu, ariaLabel: localize('editor-help', "editor accessibility help"), readMoreUrl: 'https://go.microsoft.com/fwlink/?linkid=851010' };
-	id: string = 'editor';
+	verbositySettingKey: string = 'editor';
 	constructor(
 		private readonly _editor: ICodeEditor,
 		@IKeybindingService private readonly _keybindingService: IKeybindingService
@@ -116,7 +116,7 @@ class HoverAccessibleViewContribution extends Disposable {
 				return false;
 			}
 			accessibleViewService.show({
-				id: 'hover',
+				verbositySettingKey: 'hover',
 				provideContent() { return content; },
 				onClose() {
 					controller.focus();

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

@@ -32,7 +32,7 @@ const enum DEFAULT {
 }
 
 export interface IAccessibleContentProvider {
-	id: string;
+	verbositySettingKey: string;
 	provideContent(): string;
 	onClose(): void;
 	onKeyDown?(e: IKeyboardEvent): void;
@@ -103,7 +103,7 @@ class AccessibleView extends Disposable {
 			}
 		}));
 		this._register(this._configurationService.onDidChangeConfiguration(e => {
-			if (this._currentProvider && this._accessiblityHelpIsShown.get() && e.affectsConfiguration(`accessibility.verbosity.${this._currentProvider.id}`)) {
+			if (this._currentProvider && this._accessiblityHelpIsShown.get() && e.affectsConfiguration(`accessibility.verbosity.${this._currentProvider.verbositySettingKey}`)) {
 				this.show(this._currentProvider);
 			}
 		}));
@@ -130,7 +130,7 @@ class AccessibleView extends Disposable {
 
 	private _render(provider: IAccessibleContentProvider, container: HTMLElement): IDisposable {
 		this._currentProvider = provider;
-		const settingKey = `accessibility.verbosity.${provider.id}`;
+		const settingKey = `accessibility.verbosity.${provider.verbositySettingKey}`;
 		const value = this._configurationService.getValue(settingKey);
 		const readMoreLink = provider.options.readMoreUrl ? localize("openDoc", "\nPress H now to open a browser window with more information related to accessibility.\n") : '';
 		const disableHelpHint = provider.options.type === AccessibleViewType.HelpMenu && !!value ? localize('disable-help-hint', '\nTo disable the `accessibility.verbosity` hint for this feature, press D now.\n') : '\n';
@@ -142,7 +142,7 @@ class AccessibleView extends Disposable {
 					? AccessibilityHelpNLS.changeConfigToOnMac
 					: AccessibilityHelpNLS.changeConfigToOnWinLinux
 			);
-			if (accessibilitySupport && provider.id === 'editor') {
+			if (accessibilitySupport && provider.verbositySettingKey === 'editor') {
 				message = AccessibilityHelpNLS.auto_on;
 				message += '\n';
 			} else if (!accessibilitySupport) {
@@ -153,7 +153,7 @@ class AccessibleView extends Disposable {
 
 		const fragment = message + provider.provideContent() + readMoreLink + disableHelpHint + localize('exit-tip', 'Exit this menu via the Escape key.');
 
-		this._getTextModel(URI.from({ path: `accessible-view-${provider.id}`, scheme: 'accessible-view', fragment })).then((model) => {
+		this._getTextModel(URI.from({ path: `accessible-view-${provider.verbositySettingKey}`, scheme: 'accessible-view', fragment })).then((model) => {
 			if (!model) {
 				return;
 			}
@@ -176,7 +176,7 @@ class AccessibleView extends Disposable {
 				// Delay to allow the context view to hide #186514
 				setTimeout(() => provider.onClose(), 100);
 			} else if (e.keyCode === KeyCode.KeyD && this._configurationService.getValue(settingKey)) {
-				alert(localize('disableAccessibilityHelp', '{0} accessibility verbosity is now disabled', provider.id));
+				alert(localize('disableAccessibilityHelp', '{0} accessibility verbosity is now disabled', provider.verbositySettingKey));
 				this._configurationService.updateValue(settingKey, false);
 			}
 			e.stopPropagation();

src/vs/workbench/contrib/chat/browser/actions/chatAccessibilityHelp.ts

@@ -72,7 +72,7 @@ export async function runAccessibilityHelpAction(accessor: ServicesAccessor, edi
 	inputEditor.getSupportedActions();
 	const helpText = getAccessibilityHelpText(accessor, type);
 	accessibleViewService.show({
-		id: type,
+		verbositySettingKey: type,
 		provideContent: () => helpText,
 		onClose: () => {
 			if (type === 'panelChat' && cachedPosition) {

src/vs/workbench/contrib/chat/browser/chat.contribution.ts

@@ -136,7 +136,7 @@ class ChatAccessibleViewContribution extends Disposable {
 				return false;
 			}
 			accessibleViewService.show({
-				id: 'panelChat',
+				verbositySettingKey: 'panelChat',
 				provideContent(): string { return responseContent; },
 				onClose() {
 					widget.focus(focusedItem);

src/vs/workbench/contrib/codeEditor/browser/diffEditorHelper.ts

@@ -65,7 +65,7 @@ class DiffEditorHelperContribution extends Disposable implements IDiffEditorCont
 			const keys = ['audioCues.diffLineDeleted', 'audioCues.diffLineInserted', 'audioCues.diffLineModified'];
 
 			accessibleViewService.show({
-				id: 'diffEditor',
+				verbositySettingKey: 'diffEditor',
 				provideContent: () => [
 					nls.localize('msg1', "You are in a diff editor."),
 					nls.localize('msg2', "Press {0} or {1} to view the next or previous diff in the diff review mode that is optimized for screen readers.", next, previous),

src/vs/workbench/contrib/notebook/browser/notebookAccessibilityHelp.ts

@@ -46,7 +46,7 @@ export async function runAccessibilityHelpAction(accessor: ServicesAccessor, edi
 	const accessibleViewService = accessor.get(IAccessibleViewService);
 	const helpText = getAccessibilityHelpText(accessor);
 	accessibleViewService.show({
-		id: 'notebook',
+		verbositySettingKey: 'notebook',
 		provideContent: () => helpText,
 		onClose: () => {
 			editor.focus();

src/vs/workbench/contrib/terminalContrib/accessibility/browser/terminalAccessibilityHelp.ts

@@ -34,7 +34,7 @@ export class TerminalAccessibleContentProvider extends Disposable implements IAc
 		ariaLabel: localize('terminal-help-label', "terminal accessibility help"),
 		readMoreUrl: 'https://code.visualstudio.com/docs/editor/accessibility#_terminal-accessibility'
 	};
-	id: string = 'terminal';
+	verbositySettingKey: string = 'terminal';
 
 	constructor(
 		private readonly _instance: Pick<ITerminalInstance, 'shellType' | 'capabilities' | 'onDidRequestFocus' | 'resource' | 'focus'>,