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.

Sign up for GitHub

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

Add optional id property to the tree item #41413

Merged
merged 4 commits into from
Jan 16, 2018
Merged

Add optional id property to the tree item #41413

Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
46e07c2
Add optional id property to the tree item
sandy081 Jan 10, 2018
7d8065a
Adding more doc to `id` attribute
sandy081 Jan 15, 2018
aa0bcc8
Doc feedback for id attribute
sandy081 Jan 16, 2018
ee287dd
Merge branch 'master' into sandy081/40018
sandy081 Jan 16, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions src/vs/vscode.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4967,6 +4967,15 @@ declare module 'vscode' {
*/
label: string;

/**
* Optional id for the tree item that has to be unique across tree. If not provided, an unique id is generated using the tree item's label.
*
* This is used by the view to preserve the selection and expansion state of the tree item.
*
* *Note:* With generated id, tree item's view state will be reset when label is changed.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sure what that mean? With a re-generated id state will reset?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, if the label has changed, new id (different from old) is generated and as a result previous state is lost.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ok, how about merging that with sentence about how an id will be generated.

Optional id for the tree item that has to be unique across tree. The id is used to preserve the selection and expansion state of the tree item.

If not provided, an id is generated using the tree item's label. **Note** that when labels change, ids will change and that selection and expansion state cannot be kept stable anymore.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks better. Updated.

*/
id?: string;

/**
* The icon path for the tree item
*/
Expand Down