editor: introduce setAria api

isidorn · isidorn · commit 37edc0377b02 · 2019-12-30T14:59:20.000+01:00
diff --git a/src/vs/editor/browser/controller/textAreaHandler.ts b/src/vs/editor/browser/controller/textAreaHandler.ts
@@ -29,6 +29,7 @@ import { RenderingContext, RestrictedRenderingContext, HorizontalPosition } from
 import { ViewContext } from 'vs/editor/common/view/viewContext';
 import * as viewEvents from 'vs/editor/common/view/viewEvents';
 import { AccessibilitySupport } from 'vs/platform/accessibility/common/accessibility';
+import { IEditorAriaOptions } from 'vs/editor/browser/editorBrowser';
 
 export interface ITextAreaHandlerHelper {
 	visibleRangeForPositionRelativeToEditor(lineNumber: number, column: number): HorizontalPosition | null;
@@ -424,6 +425,18 @@ export class TextAreaHandler extends ViewPart {
 		return this._lastRenderPosition;
 	}
 
+	public setAria(options: IEditorAriaOptions): void {
+		if (options.activeDescendent) {
+			this.textArea.setAttribute('aria-haspopup', 'true');
+			this.textArea.setAttribute('aria-autocomplete', 'list');
+			this.textArea.setAttribute('aria-activedescendant', options.activeDescendent);
+		} else {
+			this.textArea.setAttribute('aria-haspopup', 'false');
+			this.textArea.setAttribute('aria-autocomplete', 'both');
+			this.textArea.removeAttribute('aria-activedescendant');
+		}
+	}
+
 	// --- end view API
 
 	private _primaryCursorPosition: Position = new Position(1, 1);
diff --git a/src/vs/editor/browser/editorBrowser.ts b/src/vs/editor/browser/editorBrowser.ts
@@ -319,6 +319,13 @@ export interface IOverviewRuler {
 	setLayout(position: OverviewRulerPosition): void;
 }
 
+/**
+ * Editor aria options.
+ */
+export interface IEditorAriaOptions {
+	activeDescendent: string | undefined;
+}
+
 /**
  * A rich code editor.
  */
@@ -689,6 +696,12 @@ export interface ICodeEditor extends editorCommon.IEditor {
 	 */
 	setHiddenAreas(ranges: IRange[]): void;
 
+	/**
+	 * Sets the editor aria options, primarily the active descendent.
+	 * @internal
+	 */
+	setAria(options: IEditorAriaOptions): void;
+
 	/**
 	 * @internal
 	 */
diff --git a/src/vs/editor/browser/view/viewImpl.ts b/src/vs/editor/browser/view/viewImpl.ts
@@ -11,7 +11,7 @@ import { IDisposable } from 'vs/base/common/lifecycle';
 import { IPointerHandlerHelper } from 'vs/editor/browser/controller/mouseHandler';
 import { PointerHandler } from 'vs/editor/browser/controller/pointerHandler';
 import { ITextAreaHandlerHelper, TextAreaHandler } from 'vs/editor/browser/controller/textAreaHandler';
-import { IContentWidget, IContentWidgetPosition, IOverlayWidget, IOverlayWidgetPosition, IMouseTarget, IViewZoneChangeAccessor } from 'vs/editor/browser/editorBrowser';
+import { IContentWidget, IContentWidgetPosition, IOverlayWidget, IOverlayWidgetPosition, IMouseTarget, IViewZoneChangeAccessor, IEditorAriaOptions } from 'vs/editor/browser/editorBrowser';
 import { ICommandDelegate, ViewController } from 'vs/editor/browser/view/viewController';
 import { ViewOutgoingEvents } from 'vs/editor/browser/view/viewOutgoingEvents';
 import { ContentViewOverlays, MarginViewOverlays } from 'vs/editor/browser/view/viewOverlays';
@@ -510,6 +510,10 @@ export class View extends ViewEventHandler {
 		this._textAreaHandler.refreshFocusState();
 	}
 
+	public setAria(options: IEditorAriaOptions): void {
+		this._textAreaHandler.setAria(options);
+	}
+
 	public addContentWidget(widgetData: IContentWidgetData): void {
 		this.contentWidgets.addWidget(widgetData.widget);
 		this.layoutContentWidget(widgetData);
@@ -559,4 +563,3 @@ function safeInvokeNoArg(func: Function): any {
 		onUnexpectedError(e);
 	}
 }
-
diff --git a/src/vs/editor/browser/widget/codeEditorWidget.ts b/src/vs/editor/browser/widget/codeEditorWidget.ts
@@ -1311,6 +1311,13 @@ export class CodeEditorWidget extends Disposable implements editorBrowser.ICodeE
 		this._modelData.view.render(true, forceRedraw);
 	}
 
+	public setAria(options: editorBrowser.IEditorAriaOptions): void {
+		if (!this._modelData || !this._modelData.hasRealView) {
+			return;
+		}
+		this._modelData.view.setAria(options);
+	}
+
 	public applyFontInfo(target: HTMLElement): void {
 		Configuration.applyFontInfoSlow(target, this._configuration.options.get(EditorOption.fontInfo));
 	}
diff --git a/src/vs/monaco.d.ts b/src/vs/monaco.d.ts
@@ -3726,6 +3726,13 @@ declare namespace monaco.editor {
 		readonly target: IMouseTarget | null;
 	}
 
+	/**
+	 * Editor aria options.
+	 */
+	export interface IEditorAriaOptions {
+		activeDescendent: string | undefined;
+	}
+
 	/**
 	 * A rich code editor.
 	 */

Original file line number	Diff line number	Diff line change
`@@ -1311,6 +1311,13 @@ export class CodeEditorWidget extends Disposable implements editorBrowser.ICodeE`
`1311`	`1311`	`this._modelData.view.render(true, forceRedraw);`
`1312`	`1312`	`}`
`1313`	`1313`
	`1314`	`+ public setAria(options: editorBrowser.IEditorAriaOptions): void {`
	`1315`	`+ if (!this._modelData \|\| !this._modelData.hasRealView) {`
	`1316`	`+ return;`
	`1317`	`+ }`
	`1318`	`+ this._modelData.view.setAria(options);`
	`1319`	`+ }`
	`1320`	`+`
`1314`	`1321`	`public applyFontInfo(target: HTMLElement): void {`
`1315`	`1322`	`Configuration.applyFontInfoSlow(target, this._configuration.options.get(EditorOption.fontInfo));`
`1316`	`1323`	`}`