Microsoft/vscode
1
0
Fork 0
mirror of https://github.com/microsoft/vscode.git synced 2026-02-15 07:28:05 +00:00
Code Issues Packages Projects Releases Wiki Activity

refactor views and pane composite parts (#295015)

Browse Source 
* refactor views and pane composite parts

* simplify
This commit is contained in:
Sandeep Somavarapu
2026-02-12 20:51:27 +01:00
committed by GitHub
parent 1443559d93
commit a701cdcef1
10 changed files with 48 additions and 48 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
src/vs/workbench/browser/parts/paneCompositePart.ts
View File

@@ -12,7 +12,7 @@ import { IPaneComposite } from '../../common/panecomposite.js';
import { IViewDescriptorService, ViewContainerLocation } from '../../common/views.js';
import { DisposableStore, MutableDisposable } from '../../../base/common/lifecycle.js';
import { IView } from '../../../base/browser/ui/grid/grid.js';
import { IWorkbenchLayoutService, Parts } from '../../services/layout/browser/layoutService.js';
import { IWorkbenchLayoutService, Parts, SINGLE_WINDOW_PARTS } from '../../services/layout/browser/layoutService.js';
import { CompositePart, ICompositePartOptions, ICompositeTitleLabel } from './compositePart.js';
import { IPaneCompositeBarOptions, PaneCompositeBar } from './paneCompositeBar.js';
import { Dimension, EventHelper, trackFocus, $, addDisposableListener, EventType, prepend, getWindow } from '../../../base/browser/dom.js';
@@ -48,7 +48,8 @@ export enum CompositeBarPosition {
export interface IPaneCompositePart extends IView {
readonly partId: Parts.PANEL_PART | Parts.AUXILIARYBAR_PART | Parts.SIDEBAR_PART;
readonly partId: SINGLE_WINDOW_PARTS;
readonly registryId: string;
readonly onDidPaneCompositeOpen: Event<IPaneComposite>;
readonly onDidPaneCompositeClose: Event<IPaneComposite>;
@@ -132,7 +133,7 @@ export abstract class AbstractPaneCompositePart extends CompositePart<PaneCompos
protected contentDimension: Dimension | undefined;
constructor(
readonly partId: Parts.PANEL_PART | Parts.AUXILIARYBAR_PART | Parts.SIDEBAR_PART,
readonly partId: SINGLE_WINDOW_PARTS,
partOptions: ICompositePartOptions,
activePaneCompositeSettingsKey: string,
private readonly activePaneContextKey: IContextKey<string>,
@@ -142,7 +143,7 @@ export abstract class AbstractPaneCompositePart extends CompositePart<PaneCompos
titleForegroundColor: string | undefined,
titleBorderColor: string | undefined,
protected readonly location: ViewContainerLocation,
registryId: string,
readonly registryId: string,
private readonly globalActionsMenuId: MenuId,
@INotificationService notificationService: INotificationService,
@IStorageService storageService: IStorageService,

9
src/vs/workbench/browser/parts/paneCompositePartService.ts
View File

@@ -17,6 +17,7 @@ import { ViewContainerLocation } from '../../common/views.js';
import { IPaneCompositePartService } from '../../services/panecomposite/browser/panecomposite.js';
import { Disposable, DisposableStore } from '../../../base/common/lifecycle.js';
import { IPaneCompositePart } from './paneCompositePart.js';
import { SINGLE_WINDOW_PARTS } from '../../services/layout/browser/layoutService.js';
export class PaneCompositePartService extends Disposable implements IPaneCompositePartService {
@@ -47,6 +48,14 @@ export class PaneCompositePartService extends Disposable implements IPaneComposi
this.onDidPaneCompositeClose = Event.any(...viewContainerLocations.map(loc => Event.map(this.paneCompositeParts.get(loc)!.onDidPaneCompositeClose, composite => { return { composite, viewContainerLocation: loc }; }, eventDisposables)));
}
getRegistryId(viewContainerLocation: ViewContainerLocation): string {
return this.getPartByLocation(viewContainerLocation).registryId;
}
getPartId(viewContainerLocation: ViewContainerLocation): SINGLE_WINDOW_PARTS {
return this.getPartByLocation(viewContainerLocation).partId;
}
openPaneComposite(id: string | undefined, viewContainerLocation: ViewContainerLocation, focus?: boolean): Promise<IPaneComposite | undefined> {
return this.getPartByLocation(viewContainerLocation).openPaneComposite(id, focus);
}

10
src/vs/workbench/common/views.ts
View File

@@ -42,8 +42,6 @@ export const enum ViewContainerLocation {
AuxiliaryBar
}
export const ViewContainerLocations = [ViewContainerLocation.Sidebar, ViewContainerLocation.Panel, ViewContainerLocation.AuxiliaryBar];
export function ViewContainerLocationToString(viewContainerLocation: ViewContainerLocation) {
switch (viewContainerLocation) {
case ViewContainerLocation.Sidebar: return 'sidebar';
@@ -175,9 +173,9 @@ export interface IViewContainersRegistry {
getViewContainerLocation(container: ViewContainer): ViewContainerLocation;
/**
* Return the default view container from the given location
* Return the default view containers from the given location
*/
getDefaultViewContainer(location: ViewContainerLocation): ViewContainer | undefined;
getDefaultViewContainers(location: ViewContainerLocation): ViewContainer[];
}
interface ViewOrderDelegate {
@@ -250,8 +248,8 @@ class ViewContainersRegistryImpl extends Disposable implements IViewContainersRe
return [...this.viewContainers.keys()].filter(location => this.getViewContainers(location).filter(viewContainer => viewContainer?.id === container.id).length > 0)[0];
}
getDefaultViewContainer(location: ViewContainerLocation): ViewContainer | undefined {
return this.defaultViewContainers.find(viewContainer => this.getViewContainerLocation(viewContainer) === location);
getDefaultViewContainers(location: ViewContainerLocation): ViewContainer[] {
return this.defaultViewContainers.filter(viewContainer => this.getViewContainerLocation(viewContainer) === location);
}
}

5
src/vs/workbench/contrib/chat/browser/agentSessions/agentSessionsActions.ts
View File

@@ -15,7 +15,6 @@ import { IChatEditorOptions } from '../widgetHosts/editor/chatEditor.js';
import { ChatViewId, IChatWidgetService } from '../chat.js';
import { ACTIVE_GROUP, AUX_WINDOW_GROUP, PreferredGroup, SIDE_GROUP } from '../../../../services/editor/common/editorService.js';
import { IViewDescriptorService, ViewContainerLocation } from '../../../../common/views.js';
import { getPartByLocation } from '../../../../services/views/browser/viewsService.js';
import { IWorkbenchLayoutService, Position } from '../../../../services/layout/browser/layoutService.js';
import { IAgentSessionsService } from './agentSessionsService.js';
import { ContextKeyExpr } from '../../../../../platform/contextkey/common/contextkey.js';
@@ -35,6 +34,7 @@ import { KeybindingWeight } from '../../../../../platform/keybinding/common/keyb
import { KeyCode, KeyMod } from '../../../../../base/common/keyCodes.js';
import { coalesce } from '../../../../../base/common/arrays.js';
import { IStorageService, StorageScope, StorageTarget } from '../../../../../platform/storage/common/storage.js';
import { IPaneCompositePartService } from '../../../../services/panecomposite/browser/panecomposite.js';
const AGENT_SESSIONS_CATEGORY = localize2('chatSessions', "Chat Agent Sessions");
@@ -834,6 +834,7 @@ abstract class UpdateChatViewWidthAction extends Action2 {
const viewDescriptorService = accessor.get(IViewDescriptorService);
const configurationService = accessor.get(IConfigurationService);
const viewsService = accessor.get(IViewsService);
const paneCompositeService = accessor.get(IPaneCompositePartService);
const chatLocation = viewDescriptorService.getViewLocationById(ChatViewId);
if (typeof chatLocation !== 'number') {
@@ -880,7 +881,7 @@ abstract class UpdateChatViewWidthAction extends Action2 {
return; // location does not allow for resize (panel top or bottom)
}
const part = getPartByLocation(chatLocation);
const part = paneCompositeService.getPartId(chatLocation);
let currentSize = layoutService.getSize(part);
const chatViewDefaultWidth = 300;

5
src/vs/workbench/contrib/terminal/browser/terminalGroup.ts
View File

@@ -14,9 +14,9 @@ import { ViewContainerLocation, IViewDescriptorService } from '../../../common/v
import { IShellLaunchConfig, ITerminalTabLayoutInfoById, TerminalLocation } from '../../../../platform/terminal/common/terminal.js';
import { TerminalStatus } from './terminalStatusList.js';
import { getWindow } from '../../../../base/browser/dom.js';
import { getPartByLocation } from '../../../services/views/browser/viewsService.js';
import { asArray } from '../../../../base/common/arrays.js';
import { hasKey, isNumber, type SingleOrMany } from '../../../../base/common/types.js';
import { IPaneCompositePartService } from '../../../services/panecomposite/browser/panecomposite.js';
const enum Constants {
/**
@@ -278,6 +278,7 @@ export class TerminalGroup extends Disposable implements ITerminalGroup {
shellLaunchConfigOrInstance: IShellLaunchConfig | ITerminalInstance | undefined,
@ITerminalConfigurationService private readonly _terminalConfigurationService: ITerminalConfigurationService,
@ITerminalInstanceService private readonly _terminalInstanceService: ITerminalInstanceService,
@IPaneCompositePartService private readonly _paneCompositePartService: IPaneCompositePartService,
@IWorkbenchLayoutService private readonly _layoutService: IWorkbenchLayoutService,
@IViewDescriptorService private readonly _viewDescriptorService: IViewDescriptorService,
@IInstantiationService private readonly _instantiationService: IInstantiationService
@@ -612,7 +613,7 @@ export class TerminalGroup extends Disposable implements ITerminalGroup {
resizeAmount *= -1;
}
this._layoutService.resizePart(getPartByLocation(this._terminalLocation), resizeAmount, resizeAmount);
this._layoutService.resizePart(this._paneCompositePartService.getPartId(this._terminalLocation), resizeAmount, resizeAmount);
} else {
this._splitPaneContainer.resizePane(this._activeInstanceIndex, direction, resizeAmount);
}

5
src/vs/workbench/services/panecomposite/browser/panecomposite.ts
View File

@@ -9,6 +9,7 @@ import { PaneCompositeDescriptor } from '../../../browser/panecomposite.js';
import { IProgressIndicator } from '../../../../platform/progress/common/progress.js';
import { IPaneComposite } from '../../../common/panecomposite.js';
import { ViewContainerLocation } from '../../../common/views.js';
import { SINGLE_WINDOW_PARTS } from '../../layout/browser/layoutService.js';
export const IPaneCompositePartService = createDecorator<IPaneCompositePartService>('paneCompositePartService');
@@ -19,6 +20,10 @@ export interface IPaneCompositePartService {
readonly onDidPaneCompositeOpen: Event<{ composite: IPaneComposite; viewContainerLocation: ViewContainerLocation }>;
readonly onDidPaneCompositeClose: Event<{ composite: IPaneComposite; viewContainerLocation: ViewContainerLocation }>;
getRegistryId(viewContainerLocation: ViewContainerLocation): string;
getPartId(viewContainerLocation: ViewContainerLocation): SINGLE_WINDOW_PARTS;
/**
* Opens a viewlet with the given identifier and pass keyboard focus to it if specified.
*/

2
src/vs/workbench/services/views/browser/viewDescriptorService.ts
View File

@@ -308,7 +308,7 @@ export class ViewDescriptorService extends Disposable implements IViewDescriptor
}
getDefaultViewContainer(location: ViewContainerLocation): ViewContainer | undefined {
return this.viewContainersRegistry.getDefaultViewContainer(location);
return this.viewContainersRegistry.getDefaultViewContainers(location)[0];
}
canMoveViews(): boolean {

36
src/vs/workbench/services/views/browser/viewsService.ts
View File

@@ -23,7 +23,7 @@ import { IThemeService } from '../../../../platform/theme/common/themeService.js
import { IContextMenuService } from '../../../../platform/contextview/browser/contextView.js';
import { IExtensionService } from '../../extensions/common/extensions.js';
import { IWorkspaceContextService } from '../../../../platform/workspace/common/workspace.js';
import { PaneCompositeDescriptor, PaneCompositeRegistry, Extensions as PaneCompositeExtensions, PaneComposite } from '../../../browser/panecomposite.js';
import { PaneCompositeDescriptor, PaneCompositeRegistry, PaneComposite } from '../../../browser/panecomposite.js';
import { IWorkbenchLayoutService, Parts } from '../../layout/browser/layoutService.js';
import { URI } from '../../../../base/common/uri.js';
import { IProgressIndicator } from '../../../../platform/progress/common/progress.js';
@@ -150,7 +150,7 @@ export class ViewsService extends Disposable implements IViewsService {
// Open view container if part is visible and there is only one view container in location
if (
this.layoutService.isVisible(getPartByLocation(to)) &&
this.layoutService.isVisible(this.paneCompositeService.getPartId(to)) &&
this.viewDescriptorService.getViewContainersByLocation(to).filter(vc => this.isViewContainerActive(vc.id)).length === 1
) {
this.openViewContainer(viewContainer.id);
@@ -257,7 +257,7 @@ export class ViewsService extends Disposable implements IViewsService {
const viewContainerLocation = this.viewDescriptorService.getViewContainerLocation(viewContainer);
const isActive = viewContainerLocation !== null && this.paneCompositeService.getActivePaneComposite(viewContainerLocation);
if (viewContainerLocation !== null) {
return isActive ? this.layoutService.setPartHidden(true, getPartByLocation(viewContainerLocation)) : undefined;
return isActive ? this.layoutService.setPartHidden(true, this.paneCompositeService.getPartId(viewContainerLocation)) : undefined;
}
}
}
@@ -528,7 +528,7 @@ export class ViewsService extends Disposable implements IViewsService {
editorGroupService.activeGroup.focus();
} else if (viewLocation !== null) {
// otherwise hide the part where the view lives if focused
layoutService.setPartHidden(true, getPartByLocation(viewLocation));
layoutService.setPartHidden(true, that.paneCompositeService.getPartId(viewLocation));
}
} else {
await viewsService.openView(viewDescriptor.id, !options?.preserveFocus);
@@ -670,7 +670,7 @@ export class ViewsService extends Disposable implements IViewsService {
}
}
Registry.as<PaneCompositeRegistry>(getPaneCompositeExtension(viewContainerLocation)).registerPaneComposite(PaneCompositeDescriptor.create(
Registry.as<PaneCompositeRegistry>(this.paneCompositeService.getRegistryId(viewContainerLocation)).registerPaneComposite(PaneCompositeDescriptor.create(
PaneContainer,
viewContainer.id,
typeof viewContainer.title === 'string' ? viewContainer.title : viewContainer.title.value,
@@ -682,7 +682,7 @@ export class ViewsService extends Disposable implements IViewsService {
}
private deregisterPaneComposite(viewContainer: ViewContainer, viewContainerLocation: ViewContainerLocation): void {
Registry.as<PaneCompositeRegistry>(getPaneCompositeExtension(viewContainerLocation)).deregisterPaneComposite(viewContainer.id);
Registry.as<PaneCompositeRegistry>(this.paneCompositeService.getRegistryId(viewContainerLocation)).deregisterPaneComposite(viewContainer.id);
}
private createViewPaneContainer(element: HTMLElement, viewContainer: ViewContainer, viewContainerLocation: ViewContainerLocation, disposables: DisposableStore, instantiationService: IInstantiationService): ViewPaneContainer {
@@ -712,28 +712,4 @@ export class ViewsService extends Disposable implements IViewsService {
function getEnabledViewContainerContextKey(viewContainerId: string): string { return `viewContainer.${viewContainerId}.enabled`; }
function getPaneCompositeExtension(viewContainerLocation: ViewContainerLocation): string {
switch (viewContainerLocation) {
case ViewContainerLocation.AuxiliaryBar:
return PaneCompositeExtensions.Auxiliary;
case ViewContainerLocation.Panel:
return PaneCompositeExtensions.Panels;
case ViewContainerLocation.Sidebar:
default:
return PaneCompositeExtensions.Viewlets;
}
}
export function getPartByLocation(viewContainerLocation: ViewContainerLocation): Parts.AUXILIARYBAR_PART | Parts.SIDEBAR_PART | Parts.PANEL_PART {
switch (viewContainerLocation) {
case ViewContainerLocation.AuxiliaryBar:
return Parts.AUXILIARYBAR_PART;
case ViewContainerLocation.Panel:
return Parts.PANEL_PART;
case ViewContainerLocation.Sidebar:
default:
return Parts.SIDEBAR_PART;
}
}
registerSingleton(IViewsService, ViewsService, InstantiationType.Eager /* Eager because it registers viewlets and panels in the constructor which are required during workbench layout */);

3
src/vs/workbench/test/browser/parts/activitybar/activitybarPart.test.ts
View File

@@ -18,13 +18,14 @@ import { IConfigurationChangeEvent } from '../../../../../platform/configuration
import { IPaneCompositePart } from '../../../../browser/parts/paneCompositePart.js';
import { Event, Emitter } from '../../../../../base/common/event.js';
import { IPaneComposite } from '../../../../common/panecomposite.js';
import { PaneCompositeDescriptor } from '../../../../browser/panecomposite.js';
import { Extensions, PaneCompositeDescriptor } from '../../../../browser/panecomposite.js';
import { IInstantiationService } from '../../../../../platform/instantiation/common/instantiation.js';
import { ViewContainerLocation } from '../../../../common/views.js';
class StubPaneCompositePart implements IPaneCompositePart {
declare readonly _serviceBrand: undefined;
readonly partId = Parts.SIDEBAR_PART;
readonly registryId = Extensions.Viewlets;
element: HTMLElement = undefined!;
minimumWidth = 0;
maximumWidth = 0;

12
src/vs/workbench/test/browser/workbenchTestServices.ts
View File

@@ -114,7 +114,7 @@ import { IWorkspaceTrustManagementService, IWorkspaceTrustRequestService } from
import { TestWorkspace } from '../../../platform/workspace/test/common/testWorkspace.js';
import { IEnterWorkspaceResult, IRecent, IRecentlyOpened, IWorkspaceFolderCreationData, IWorkspacesService } from '../../../platform/workspaces/common/workspaces.js';
import { EditorPaneDescriptor, IEditorPaneRegistry } from '../../browser/editor.js';
import { PaneComposite, PaneCompositeDescriptor } from '../../browser/panecomposite.js';
import { PaneComposite, PaneCompositeDescriptor, Extensions as PaneCompositeExtensions } from '../../browser/panecomposite.js';
import { Part } from '../../browser/part.js';
import { DEFAULT_EDITOR_PART_OPTIONS, EditorServiceImpl, IEditorGroupsView, IEditorGroupTitleHeight, IEditorGroupView } from '../../browser/parts/editor/editor.js';
import { EditorPane } from '../../browser/parts/editor/editorPane.js';
@@ -164,7 +164,7 @@ import { IHistoryService } from '../../services/history/common/history.js';
import { IHostService, IToastOptions, IToastResult } from '../../services/host/browser/host.js';
import { LabelService } from '../../services/label/common/labelService.js';
import { ILanguageDetectionService } from '../../services/languageDetection/common/languageDetectionWorkerService.js';
import { IPartVisibilityChangeEvent, IWorkbenchLayoutService, PanelAlignment, Position as PartPosition, Parts } from '../../services/layout/browser/layoutService.js';
import { IPartVisibilityChangeEvent, IWorkbenchLayoutService, PanelAlignment, Position as PartPosition, Parts, SINGLE_WINDOW_PARTS } from '../../services/layout/browser/layoutService.js';
import { ILifecycleService, InternalBeforeShutdownEvent, IWillShutdownEventJoiner, ShutdownReason, WillShutdownEvent } from '../../services/lifecycle/common/lifecycle.js';
import { IPaneCompositePartService } from '../../services/panecomposite/browser/panecomposite.js';
import { IPathService } from '../../services/path/common/pathService.js';
@@ -724,6 +724,12 @@ export class TestPaneCompositeService extends Disposable implements IPaneComposi
this.onDidPaneCompositeClose = Event.any(...([ViewContainerLocation.Panel, ViewContainerLocation.Sidebar].map(loc => Event.map(this.parts.get(loc)!.onDidPaneCompositeClose, composite => { return { composite, viewContainerLocation: loc }; }))));
}
getPartId(viewContainerLocation: ViewContainerLocation): SINGLE_WINDOW_PARTS {
return this.getPartByLocation(viewContainerLocation).partId;
}
getRegistryId(viewContainerLocation: ViewContainerLocation): string {
return this.getPartByLocation(viewContainerLocation).registryId;
}
openPaneComposite(id: string | undefined, viewContainerLocation: ViewContainerLocation, focus?: boolean): Promise<IPaneComposite | undefined> {
return this.getPartByLocation(viewContainerLocation).openPaneComposite(id, focus);
}
@@ -772,6 +778,7 @@ export class TestSideBarPart implements IPaneCompositePart {
onDidViewletCloseEmitter = new Emitter<IPaneComposite>();
readonly partId = Parts.SIDEBAR_PART;
readonly registryId = PaneCompositeExtensions.Viewlets;
element: HTMLElement = undefined!;
minimumWidth = 0;
maximumWidth = 0;
@@ -809,6 +816,7 @@ export class TestPanelPart implements IPaneCompositePart {
onDidPaneCompositeOpen = new Emitter<IPaneComposite>().event;
onDidPaneCompositeClose = new Emitter<IPaneComposite>().event;
readonly partId = Parts.AUXILIARYBAR_PART;
readonly registryId = PaneCompositeExtensions.Auxiliary;
async openPaneComposite(id?: string, focus?: boolean): Promise<undefined> { return undefined; }
getPaneComposite(id: string): any { return activeViewlet; }