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

Consider to adopt new createStatusBarItem API for id and name properties #4615

Closed
bpasero opened this issue Jun 15, 2021 · 2 comments · Fixed by #4621
Closed

Consider to adopt new createStatusBarItem API for id and name properties #4615

bpasero opened this issue Jun 15, 2021 · 2 comments · Fixed by #4621

Comments

@bpasero
Copy link

bpasero commented Jun 15, 2021

👋 Hi there, Ben here, from the VS Code team.

We just released VSCode 1.57 that landed a new stable API for status bar items to provide id and name properties: https://code.visualstudio.com/updates/v1_57#_status-bar-item-id-and-name-properties

I noticed that your extension is a consumer of the createStatusBarItem API.

Here is an example how using the new API will improve the user experience around managing status bar items:

Without id / name right clicking on the status bar item from your extension will show a generic label that is just the name of the extension:

statusbar

As you can see from the example above, the GH Pull Request extension did not yet adopt this new API and as such, the menu only shows a generic entry (as opposed to the other entries that are more specific).

Another motivation to adopt this new API is that it will enable a user to selectively hide/show status bar entries from your extension in case you register more than one status bar item.

An adoption of the new API involves:

  • configuring "engines": { "vscode": "^1.57.0" } in package.json
  • where createStatusBarItem is called, add a unique id: string property as first parameter
  • in the returned StatusBarItem set name to something that describes the intent of the status bar entry (if you provide multiple status bar entries, make sure the name is different for each entry)

Thanks for the support and the great work! ❤️

@bpasero
Copy link
Author

bpasero commented Jun 22, 2021

Thanks!

@JoeRobich looking at the changes, please also make sure you pass a id: string as first arg to the createStatusBarItem call. Make sure it is different for each status bar item you contribute. It does not have to be universally unique, we automatically add the extension identifier internally.

@JoeRobich
Copy link
Member

Set status bar item ids in #4643

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants