feat: add public traverse() method to TreeView#506
Merged
Conversation
Made-with: Cursor
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adds a public traverse() method to the TreeView component, providing a clean API for depth-first traversal of tree items. Previously, consumers needed to use the protected _traverseDepthFirst() method or implement their own traversal logic. The new method makes the common use case of visiting all tree items simpler and more discoverable.
Changes:
- Added public
traverse()method to TreeView with comprehensive JSDoc documentation - Refactored
expandAll()andcollapseAll()to use the new public method - Added unit tests verifying depth-first traversal order and empty tree handling
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
src/components/TreeView/index.ts |
Added public traverse() method wrapping the existing protected _traverseDepthFirst() method; updated expandAll() and collapseAll() to use the new public API |
test/components/treeview.mjs |
Added test suite for traverse() covering depth-first order verification and empty tree edge case |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
traverse()method toTreeViewthat visits everyTreeViewItemdepth-firstexpandAll()andcollapseAll()to use the new public method instead of the protected_traverseDepthFirstdirectlytraverse()covering both populated and empty treesDetails
The existing
_traverseDepthFirstmethod isprotected, forcing consumers (like the Editor) to build their own traversal. The newtraverse()method delegates to it, providing a clean public API:Test plan
npm run build)npm test)npm run lint)