Add badges extension API by matthewjamesadam · Pull Request #139225 · microsoft/vscode

matthewjamesadam · 2021-12-15T18:04:36Z

This is a WIP for getting feedback for #62783

Alternative API can be seen here: #139229

ghost · 2021-12-15T18:04:48Z

All CLA requirements met.

src/vscode-dts/vscode.proposed.badges.d.ts

alexr00 · 2022-01-18T13:38:24Z

@matthewjamesadam thanks for the proposal PR! Of your two proposals, this one is closer to what we want. A few notes from our discussion on it:

Instead of having the way to set the badge be on the TreeDataProvider, it should be on the TreeView, as this is view related. I think the equivalent place for webviews would be on WebviewView, but @mjbvz would need to confirm that.
Instead of an event for setting the badge, we could have just have a property badge on TreeView and WebviewView.
The type for badge would be number. At this time, we're not ready to support a way for views to have arbitrary characters in the badge.

matthewjamesadam · 2022-01-18T18:49:12Z

Hi @alexr00 and @isidorn ,

Thanks for taking the time to discuss this! I have updated this PR to reflect your feedback:

Badges are now provided on TreeView and WebviewView.
Only numeric badges are allowed.

There are a couple of issues I'd appreciate further feedback on:

I've specified the label as a simple string property here. The implementation in IBadge uses a callback function to provide this (IBadge.descriptorFn), I believe to delay resolving the description until a tooltip is displayed. Using a callback seemed like it might be unnecessarily complicated in the extension API, but please let me know if you think that's the right approach.
I made the badge property an abstract base type (Badge), of which there is only one concrete implementation (NumberBadge). I thought this would allow VSCode to provide other badge types in the future (progress, text, etc). I am happy to replace this with a simple number if you would prefer, though this would prevent displaying a badge tooltip. Another alternative would be to allow providing one of a set of badge interfaces, similar to how for instance TerminalOptions.location allows one of a set of interfaces. The downside to this approach seemed to be on the implementation end, in that VSCode would have to determine which interface was passed in at runtime by checking property existence.

Thanks again!

alexr00

We had an opportunity to discuss the new proposal. A few more changes, then we can discuss implementing it.

src/vscode-dts/vscode.proposed.badges.d.ts

# Conflicts: # src/vs/workbench/services/extensions/common/extensionsApiProposals.ts

matthewjamesadam · 2022-01-19T17:37:49Z

Thanks for your feedback @alexr00 , I have updated the PR to reflect it.

lgrammel · 2022-01-27T16:53:20Z

@matthewjamesadam thanks for working on this! I'm an extension developer and have a question regarding the API. From what I understand, this PR seems to add badges to TreeView and WebviewView. However, on the activity viewContainers are being displayed, and they can contain multiple views. Since the badges are showing up on the activity bar, I'm wondering how the badges from the individual views are mapped to that? Is it an aggregation of the badge numbers of all the views in a view container?

matthewjamesadam · 2022-01-27T19:53:29Z

Hi @lgrammel -- yes I believe the badge would be an aggregate of the values for all the container's views. There was an alternative proposal for a badge API here: #139229 that allowed providing a single badge for the entire viewContainer, but it is a more complicated API (it requires a separate Provider interface, since viewContainers don't have any interface representation in the API). @alexr00 might have more thoughts on this though!

alexr00 · 2022-01-28T08:57:21Z

I think we'd do one of two things:

One of the view's would "win" showing the badge. How a view wins would be TBD, but likely done by extension install order since I think we do that else where.
There would be a "there're multiple badges" badge. Maybe a badge with ellipses would work for that.

I don't think we'll ever show multiple badges on one container though as this will get very cluttered very quickly.

lgrammel · 2022-01-28T09:26:35Z

Thanks - both of those options would work well for my use case. Really excited about this feature, looking forward to having it part of VS Code!

matthewjamesadam · 2022-01-28T20:39:22Z

@alexr00 that makes sense! Do you have any other feedback for this proposal? Is there anything else I can do to help push this forward? I'd be happy to prepare a draft PR implementing this as well, with the understanding that this proposal might change in the future.

mjbvz

Just adding a few minor comments on the api proposal

mjbvz · 2022-01-28T21:20:55Z

src/vscode-dts/vscode.proposed.badges.d.ts

+		/**
+		 * A label to present in tooltips for the badge
+		 */
+		label: string;


These properties should be readonly as I don't think we support updating the badge if you do treeView.badge.value = 1

mjbvz · 2022-01-28T21:22:43Z

src/vscode-dts/vscode.proposed.badges.d.ts

+		/**
+		 * A label to present in tooltips for the badge
+		 */
+		label: string;


I believe we use tooltip (instead of label) in other places in vscode.d.ts

alexr00 · 2022-01-31T10:34:12Z

@matthewjamesadam We'll try to discuss during our weekly API meeting this week (there was no meeting last week because of our endgame). After that, we can look into a PR.

matthewjamesadam · 2022-01-31T17:21:38Z

@mjbvz thanks for your PR feedback, I addressed both items.

@alexr00 thanks for the update!

matthewjamesadam · 2022-02-15T21:25:08Z

Hi @alexr00, do you have any updates on this? Did you manage to discuss this proposal at the API meeting? Thanks!

alexr00 · 2022-02-16T15:12:40Z

I haven't had a chance to bring this to our API discussion. I will post an update as soon as I have one!

jrieken · 2022-03-08T07:24:31Z

src/vscode-dts/vscode.proposed.badges.d.ts

+	/**
+	 * A badge presenting a value for a view
+	 */
+	export interface Badge {


Maybe call them ViewBadge?

alexr00

@matthewjamesadam we had a chance to discuss last week. This proposal is heading in the right direction! If you want to make a PR that implements this feature/API I will be happy to review it.

matthewjamesadam · 2022-03-09T19:46:45Z

Thanks @alexr00 ! I have added a PR to implement this API here: #144775

First attempt at a badges API

d316682

matthewjamesadam commented Dec 15, 2021

View reviewed changes

src/vscode-dts/vscode.proposed.badges.d.ts Outdated Show resolved Hide resolved

matthewjamesadam mentioned this pull request Dec 15, 2021

Second attempt at a badges API #139229

Closed

vscode-triage-bot added the triage-needed label Dec 15, 2021

vscode-triage-bot assigned bpasero Dec 15, 2021

matthewjamesadam mentioned this pull request Dec 15, 2021

badges on custom activities added to activity bar by extensions #62783

Closed

bpasero assigned sandy081 and alexr00 and unassigned bpasero Dec 15, 2021

bpasero removed the triage-needed label Dec 15, 2021

sandy081 removed their assignment Dec 16, 2021

isidorn self-assigned this Jan 18, 2022

Updated badge API to reflect feedback

7c42fb9

alexr00 requested changes Jan 19, 2022

View reviewed changes

src/vscode-dts/vscode.proposed.badges.d.ts Outdated Show resolved Hide resolved

src/vscode-dts/vscode.proposed.badges.d.ts Outdated Show resolved Hide resolved

src/vscode-dts/vscode.proposed.badges.d.ts Outdated Show resolved Hide resolved

matthewjamesadam added 2 commits January 19, 2022 09:30

Update to reflect PR feedback

edbdc2d

Merge branch 'main' into matthewjamesadam/badges-api-1

28cde72

# Conflicts: # src/vs/workbench/services/extensions/common/extensionsApiProposals.ts

mjbvz reviewed Jan 28, 2022

View reviewed changes

Address further feedback

65c388d

matthewjamesadam changed the title ~~WIP: Add badges extension API~~ Add badges extension API Jan 31, 2022

matthewjamesadam marked this pull request as ready for review January 31, 2022 17:54

alexr00 added this to the March 2022 milestone Feb 16, 2022

alexr00 added api api-proposal feature-request Request for new features or functionality labels Mar 1, 2022

jrieken reviewed Mar 8, 2022

View reviewed changes

alexr00 added 2 commits March 8, 2022 13:58

Badge -> ViewBadge

b51cf5e

Merge branch 'main' into matthewjamesadam/badges-api-1

087c49f

alexr00 approved these changes Mar 8, 2022

View reviewed changes

alexr00 merged commit 9be0d5e into microsoft:main Mar 8, 2022

matthewjamesadam deleted the matthewjamesadam/badges-api-1 branch March 8, 2022 17:02

matthewjamesadam mentioned this pull request Mar 9, 2022

Implement badge API for webviews and treeviews #144775

Merged

github-actions bot locked and limited conversation to collaborators Apr 22, 2022

Conversation

matthewjamesadam commented Dec 15, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ghost commented Dec 15, 2021 • edited by ghost Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

alexr00 commented Jan 18, 2022

Uh oh!

matthewjamesadam commented Jan 18, 2022

Uh oh!

alexr00 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

matthewjamesadam commented Jan 19, 2022

Uh oh!

lgrammel commented Jan 27, 2022

Uh oh!

matthewjamesadam commented Jan 27, 2022

Uh oh!

alexr00 commented Jan 28, 2022

Uh oh!

lgrammel commented Jan 28, 2022

Uh oh!

matthewjamesadam commented Jan 28, 2022

Uh oh!

mjbvz left a comment

Choose a reason for hiding this comment

Uh oh!

mjbvz Jan 28, 2022

Choose a reason for hiding this comment

Uh oh!

matthewjamesadam Jan 31, 2022

Choose a reason for hiding this comment

Uh oh!

mjbvz Jan 28, 2022

Choose a reason for hiding this comment

Uh oh!

matthewjamesadam Jan 31, 2022

Choose a reason for hiding this comment

Uh oh!

alexr00 commented Jan 31, 2022

Uh oh!

matthewjamesadam commented Jan 31, 2022

Uh oh!

matthewjamesadam commented Feb 15, 2022

Uh oh!

alexr00 commented Feb 16, 2022

Uh oh!

jrieken Mar 8, 2022

Choose a reason for hiding this comment

Uh oh!

alexr00 left a comment

Choose a reason for hiding this comment

Uh oh!

matthewjamesadam commented Mar 9, 2022

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

9 participants

matthewjamesadam commented Dec 15, 2021 •

edited

Loading

ghost commented Dec 15, 2021 •

edited by ghost

Loading