Programmatic tree select?

[benbenbenbenbenben]

I have some code that is relying on calling this private method to automate a selection in a lazy loaded tree. Could it be made public? Is that the right way to do this?

shoelace/src/components/tree/tree.component.ts

Line 173 in 761e062

private selectItem(selectedItem: SlTreeItem) {

[claviska]

Related discussion: #1610 (comment)

@KonnorRogers @alenaksu Do you see any harm in making selectIem() public in <sl-tree>?

One thing that may be a problem is the sl-selection-change event being handled inside this method. Usually, programmatic changes don't trigger events so we'd need to move that emitter out.

[alenaksu]

Besides the sl-selection-change thing, no harm from my side, just a minor consideration.

If the component exposes an API for selecting an item, it might be beneficial to also provide an API for deselecting it. This would allow for more control over the selected state.

Thinking out loud, these are some options that come in my mind:

• toggleItem(item: SlTreeItem, selected?: boolean): This API could toggle the selection state of an item. If selected is provided, it would force it to that particular state.
• selectItem(item: SlTreeItem) + deselectItem(item: SlTreeItem): These separate APIs would provide more explicit control over selection and deselection.
• clearSelection(): This API could deselect all items in the tree.

What do you think?

[KonnorRogers]

@claviska seems fine to me! I dont see a reason not to (besides the event, we do want to keep consistent with that.