Test tree checkbox API

[alexr00]

Refs: #116141

• anyOS @TylerLeonhardt
• anyOS @aeschli

Complexity: 5
Roles: Developer, Engineering Manager

Create Issue

---

Tree items support an optional checkbox with this API proposal:

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

Lines 8 to 15 in 0524ecc

	export class TreeItem2 extends TreeItem {
	/**
	* {@link TreeItemCheckboxState TreeItemCheckboxState} of the tree item.
	* {@link TreeDataProvider.onDidChangeTreeData onDidChangeTreeData} should be fired when {@link TreeItem2.checkboxState checkboxState} changes.
	*/
	checkboxState?: TreeItemCheckboxState | { readonly state: TreeItemCheckboxState; readonly tooltip?: string; readonly accessibilityInformation?: AccessibilityInformation };
	}

To verify, you'll need to use this checkbox property in a tree view. If you don't have an extension that could benefit from having checkboxes, you can use the tree view sample and add the checkbox property here:

https://github.com/microsoft/vscode-extension-samples/blob/f7b27a91779e770b8f8f0e6791bcefc5d9c64035/tree-view-sample/src/testView.ts#L77-L81

And listen for the checkbox change event on this tree view:

https://github.com/microsoft/vscode-extension-samples/blob/f7b27a91779e770b8f8f0e6791bcefc5d9c64035/tree-view-sample/src/testView.ts#L6-L7

Things to verify:

• Verify that by default, if you check the checkbox of a node with children, the children get checked. Verify that when you check all children, the parent gets checked. Also verify that you see this reflected in the onDidChangeCheckboxState.
• Verify that if you set the manuallyManageCheckboxSelection option (

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

  Lines 51 to 56 in 0524ecc

  	/**
  	* By default, when the children of a tree item have already been fetched, child checkboxes are automatically managed based on the checked state of the parent tree item.
  	* If the tree item is collapsed by default (meaning that the children haven't yet been fetched) then child checkboxes will not be updated.
  	* To override this behavior and manage child and parent checkbox state in the extension, set this to `true`.
  	*/
  	manuallyManageCheckboxSelection?: boolean;

  ) that you do not see the children and parents get automatically checked as described in the previous point.
• Verify that the JS Doc comments make sense.
• Verify that the checkbox tool tip and accessibility information are applied in the way you'd expect.

[TylerLeonhardt]

Feels really nice! Excited for finalization so I can adopt it completely 😄

[aeschli]

There's no API to set the checked state programmatically, correct?

[TylerLeonhardt]

@aeschli I was using a tree data provider by setting the checked state on the TreeItem, then firing the did change event. This allowed me to programmatically set an item as checked/unchecked.

[meganrogge]

I think this should be closed, reopen if I'm wrong

[alexr00]

Using a tree data provider and setting the checked state on the TreeItem, then firing the on did change event is the way to set the checked state programmatically.