Expose the StatusBarEntryLocation parameter in the `createStatusBar…
#290253
+186
−96
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…Item` function Added arguments to the `createStatusBarItem` function for creating grouped status bars in user-developed extensions. * Since `IStatusbarEntryLocation` must be accessible from the extHost API layer, moved it from browser to common. * Due to numerous uses of `StatusbarAlignment` within browser/statusbar.ts, retained its definition as a const value.
📬 CODENOTIFYThe following users are being notified based on files changed in this PR: @bpaseroMatched files:
|
Author
|
@microsoft-github-policy-service agree |
Contributor
There was a problem hiding this comment.
Pull request overview
This PR exposes the StatusBarEntryLocation parameter in the public createStatusBarItem API, allowing extensions to position status bar items relative to other items with fine-grained control over alignment and compact grouping.
Changes:
- Added
StatusBarEntryLocationinterface to the public API (vscode.d.ts) with support for positioning items relative to other items - Refactored internal status bar types into a new shared module (
types.ts) for better code organization - Updated all status bar-related type signatures throughout the codebase to use the new type definitions
- Added comprehensive test coverage for the new functionality
Reviewed changes
Copilot reviewed 12 out of 13 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| src/vscode-dts/vscode.d.ts | Added StatusBarEntryLocation interface and updated createStatusBarItem signatures to accept the new location type |
| src/vs/workbench/services/statusbar/common/types.ts | New file containing shared status bar type definitions including StatusBarAlignment enum, IStatusBarEntryLocation interface, and utility functions |
| src/vs/workbench/services/statusbar/browser/statusbar.ts | Refactored to import types from types.ts and created backward-compatible constants object for internal use |
| src/vs/workbench/browser/parts/statusbar/statusbarPart.ts | Updated imports and type signatures to use the refactored types |
| src/vs/workbench/browser/parts/statusbar/statusbarModel.ts | Updated imports and type signatures to use the refactored types |
| src/vs/workbench/browser/parts/editor/editorStatus.ts | Updated imports and type signatures to use the refactored types |
| src/vs/workbench/api/common/extHostTypes.ts | Removed StatusBarAlignment enum and asStatusBarItemIdentifier function (moved to types.ts) |
| src/vs/workbench/api/common/extHostStatusBar.ts | Updated to handle StatusBarEntryLocation in priority parameter with proper validation and conversion |
| src/vs/workbench/api/common/extHost.protocol.ts | Updated protocol signature to support IStatusBarEntryLocation in priority parameter |
| src/vs/workbench/api/common/extHost.api.impl.ts | Updated API implementation to handle the new StatusBarEntryLocation type in createStatusBarItem |
| src/vs/workbench/api/browser/statusBarExtensionPoint.ts | Updated to handle and process IStatusBarEntryLocation when creating status bar entries |
| src/vs/workbench/api/browser/mainThreadStatusBar.ts | Updated main thread implementation to support the new location type in the protocol |
| extensions/vscode-api-tests/src/singlefolder-tests/window.test.ts | Added test verifying correct behavior when using StatusBarEntryLocation with compact positioning |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
…Item` function
I am submitting a pull request to extend the function arguments in the createStatusBarItem section of the document below.
Document: https://code.visualstudio.com/api/references/vscode-api#window
There is no associated issue, but I can create one if needed.