Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

SCM - add aria labels to the SCMSyncViewPane #193552

Merged
merged 1 commit into from
Sep 20, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
53 changes: 49 additions & 4 deletions src/vs/workbench/contrib/scm/browser/scmSyncViewPane.ts
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,10 @@ import { ISCMHistoryItem, ISCMHistoryItemChange, ISCMHistoryItemGroup } from 'vs
import { localize } from 'vs/nls';
import { Iterable } from 'vs/base/common/iterator';
import { IListAccessibilityProvider } from 'vs/base/browser/ui/list/listWidget';
import { IWorkspaceContextService } from 'vs/platform/workspace/common/workspace';
import { basename, dirname } from 'vs/base/common/resources';
import { ILabelService } from 'vs/platform/label/common/label';
import { stripIcons } from 'vs/base/common/iconLabels';

type TreeElement = ISCMRepository[] | ISCMRepository | ISCMActionButton | SCMHistoryItemGroupTreeElement | SCMHistoryItemTreeElement | SCMHistoryItemChangeTreeElement;

Expand Down Expand Up @@ -261,8 +265,49 @@ class HistoryItemChangeRenderer implements ITreeRenderer<SCMHistoryItemChangeTre

class SCMSyncViewPaneAccessibilityProvider implements IListAccessibilityProvider<TreeElement> {

constructor(
@ILabelService private readonly labelService: ILabelService,
@IWorkspaceContextService private readonly workspaceContextService: IWorkspaceContextService
) { }

getAriaLabel(element: TreeElement): string {
// TODO - add aria labels
if (isSCMRepository(element)) {
let folderName = '';
if (element.provider.rootUri) {
const folder = this.workspaceContextService.getWorkspaceFolder(element.provider.rootUri);

if (folder?.uri.toString() === element.provider.rootUri.toString()) {
folderName = folder.name;
} else {
folderName = basename(element.provider.rootUri);
}
}
return `${folderName} ${element.provider.label}`;
} else if (isSCMHistoryItemGroupTreeElement(element)) {
return `${stripIcons(element.label).trim()}${element.description ? `, ${element.description}` : ''}`;
} else if (isSCMActionButton(element)) {
return element.button?.command.title ?? '';
} else if (isSCMHistoryItemTreeElement(element)) {
return `${stripIcons(element.label).trim()}${element.description ? `, ${element.description}` : ''}`;
} else if (isSCMHistoryItemChangeTreeElement(element)) {
const result: string[] = [];

result.push(basename(element.uri));

// TODO - add decoration
// if (element.decorations.tooltip) {
// result.push(element.decorations.tooltip);
// }

const path = this.labelService.getUriLabel(dirname(element.uri), { relative: true, noPrefix: true });

if (path) {
result.push(path);
}

return result.join(', ');
}

return '';
}
getWidgetAriaLabel(): string {
Expand Down Expand Up @@ -373,9 +418,9 @@ export class SCMSyncViewPane extends ViewPane {
this.instantiationService.createInstance(SCMSyncDataSource),
{
horizontalScrolling: false,
accessibilityProvider: new SCMSyncViewPaneAccessibilityProvider(),
identityProvider: new SCMSyncViewPaneTreeIdentityProvider(),
sorter: new SCMSyncViewPaneTreeSorter(),
accessibilityProvider: this.instantiationService.createInstance(SCMSyncViewPaneAccessibilityProvider),
identityProvider: this.instantiationService.createInstance(SCMSyncViewPaneTreeIdentityProvider),
sorter: this.instantiationService.createInstance(SCMSyncViewPaneTreeSorter),
}) as WorkbenchAsyncDataTree<TreeElement, TreeElement>;

this._register(this._tree);
Expand Down