Additions to Tree view API

[sandy081]

• Missing onDidChangeSelection-like event #50662 : Add onDidChangeSelection event
• Ability to know if a custom view is visible or not #48198 : Add visible property and listener
• Need ability to set focus using treeview.reveal #49311 : Add focus property to reveal API
  Ability to contribute and run a command when Double Clicking on a node in custom views #39601 : Add doubleClickCommand property to TreeItem

[jrieken]

We usually don't mention user-gestures like click, doubleClick but we use terms that describe their meaning... Something like alternativeCommand etc. Unsure about a better name... What is this being used for?

[sandy081]

Yeah, I am aware that we do not mention user-gestures. But here I did not find a better name. Usage is pretty simple and from its name, this command gets executed when user double clicks on a node.

Just to note, even though it is not in API, we talk about single click / double click behaviour in one of our settings workbench.settings.openMode. Thought this will align with that.

[jrieken]

Well, settings name are the wild-wild-west ;-) What I was asking is why we are adding this and how is this being used? I would find a it rather weird that double vs single clicking an item is different. Since you brought it up, openMode is now being ignored for contributed trees, right? Is that something we want?

[sandy081]

What I was asking is why we are adding this and how is this being used?

One of the use cases is that in a script view, run script on double click and not on single click. Another use case is to pin a document after opening it by double clicking from tree view.

openMode is now being ignored for contributed trees, right? Is that something we want?

I do not know but looks like it is being respected. But I do not want that behaviour in custom trees.

In general, Single click selects or highlights an element and whereas double click executes the function associated to that element. Currently command property provides a function that should be executed on select. We need a placeholder for a property that provides a function associated to the given element. command looks to me the right word for that but it is already taken.

It seems Single clicking is usually a primary action of the mouse we can call double click command as secondaryCommand ?

[jrieken]

But I do not want that behaviour in custom trees.

That's something for the UX call I'd say.. Personally, I like when they look and feel alike.

In general, Single click selects or highlights an element and whereas double click executes the function associated to that element.

Not sure so about that... Clicking an element in the explorer always opens it, double clicking it also opens it but pins it as well. That reminds me of the alternative menu item which are meant to be a similar but slightly different action. So, maybe call it altCommand or alternativeCommand.

What would really confuse me as a user would be a tree that doesn't do anything on single click but that does do something on double click. So, maybe we should gear the API towards that not being possible. something like { command: Command | { cmd: Command, alt: Command }}

[sandy081]

That's something for the UX call I'd say.. Personally, I like when they look and feel alike.

Custom trees cannot inherit generic behaviour because each node behaves differently. For example, if a node has both command and altCommand and user has openMode configured to doubleClick then what is expected behaviour? I would say in this case commands take the precedence over setting and execute command on select (single click) and altCommand on doubleClick is expected.

So, maybe we should gear the API towards that not being possible. something like { command: Command | { cmd: Command, alt: Command }}

I like it 👍

[jrieken]

This only means visible and not focused, right?

[sandy081]

Yes

[jrieken]

add readonly and ReadonlyArray<T>?

[sandy081]

This was there in last milestone. Hope the change will not break.

[jrieken]

just readonly should be enough and non breaking

[sandy081]

@jrieken Updated the PR with requested changes and removed double click command