[TreeView] Add selectItem and getItemDOMElement methods to the public API
#13485
Conversation
This file contains 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
flaviendelangle
commented
Jun 14, 2024
| @@ -56,9 +56,10 @@ Use the `setItemExpansion` API method to change the expansion of an item. | |||
| apiRef.current.setItemExpansion( | |||
| // The DOM event that triggered the change | |||
| event, | |||
| // The ID of the item to expand or collapse | |||
| // The id of the item to expand or collapse | |||
There was a problem hiding this comment.
I tried to unify a bit the wording for those boolean parameters throughout the Tree View codebase
And to always have the same descriptions for the params in the JSDoc and in the doc section
|
Deploy preview: https://deploy-preview-13485--material-ui-x.netlify.app/ Updated pages: |
|
@flaviendelangle This DX looks perfectly agreeable to me 👍🏻 |
flaviendelangle
commented
Jun 20, 2024
| newSelected = [itemId].concat(cleanSelectedItems); | ||
| } else { | ||
| newSelected = cleanSelectedItems; | ||
| } | ||
| } else { | ||
| // eslint-disable-next-line no-lonely-if | ||
| if (newValue === false) { | ||
| if (isSelected === false || (isSelected == null && instance.isItemSelected(itemId))) { |
There was a problem hiding this comment.
Small fix: in single selection, if isSelected is not defined and the item is selected we should de-select.
I fixed the usage of this method in useTreeItemState and useTreeItem2Utils to keep the same behavior on the UI.
noraleonte
approved these changes
Jul 1, 2024
packages/x-tree-view/src/internals/plugins/useTreeViewSelection/useTreeViewSelection.types.ts
Outdated
Show resolved
Hide resolved
DungTiger
pushed a commit
to DungTiger/mui-x
that referenced
this pull request
Jul 23, 2024
This was referenced Jul 27, 2024
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.
Closes #10113
selectItem doc preview
getItemDOMElement doc preview
@bharatkashyap I propose to expose a method that allow you to easily retrieve the DOM element rather than a method that allow you to scroll.
I first tried to implement something like
apiRef.current.scrollToItem(itemId), but I was basically copy-pasting the entire API of thescrollIntoViewmethod.Your use case can be achieved as follow:
And if you are using multi selection you might prefer:
I'll add some tests once we agree on the DX