[DataGrid] Remove unnecessary keyboard navigation events #6863
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
m4theushw
added
breaking change
component: data grid
m4theushw
commented
Nov 16, 2022
| @@ -55,15 +54,6 @@ function GridTreeDataGroupingCell(props: GridTreeDataGroupingCellProps) { | |||
| ? rootProps.components.TreeDataCollapseIcon | |||
| : rootProps.components.TreeDataExpandIcon; | |||
|
|
|||
| const handleKeyDown = (event: React.KeyboardEvent<HTMLButtonElement>) => { | |||
| if (event.key === ' ') { | |||
| event.stopPropagation(); | |||
There was a problem hiding this comment.
This event.stopPropagation() can be removed here because the listener already ignores the space key if it comes from the tree data cell.
This also explains its removal from the demos.
| @@ -49,6 +49,8 @@ export function GridGroupingCriteriaCell(props: GridGroupingCriteriaCellProps) { | |||
|
|
|||
| const handleKeyDown = (event: React.KeyboardEvent<HTMLButtonElement>) => { | |||
| if (event.key === ' ') { | |||
| // We call event.stopPropagation to avoid unfolding the row and also scrolling to bottom | |||
| // TODO: Remove and add a check inside useGridKeyboardNavigation | |||
There was a problem hiding this comment.
I'm referring to
There was a problem hiding this comment.
Maybe create a separate issue for it and link to it in the TODO comment?
These are the results for the performance tests:
|
cherniavskii
approved these changes
Nov 22, 2022
| @@ -49,6 +49,8 @@ export function GridGroupingCriteriaCell(props: GridGroupingCriteriaCellProps) { | |||
|
|
|||
| const handleKeyDown = (event: React.KeyboardEvent<HTMLButtonElement>) => { | |||
| if (event.key === ' ') { | |||
| // We call event.stopPropagation to avoid unfolding the row and also scrolling to bottom | |||
| // TODO: Remove and add a check inside useGridKeyboardNavigation | |||
There was a problem hiding this comment.
Maybe create a separate issue for it and link to it in the TODO comment?
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 #5617
Part of #3287
See #3193 for context
I didn't replace with apiRef methods because, despite the presence of
cellNavigationKeyDown, the keyboard navigation was already usingcellKeyDownunderneath. The keyboard navigation events are only a proxy. Also, calling an API method would prevent developers from disabling the default handler for the events.Changelog
Breaking changes
cellNavigationKeyDownevent was removed. UsecellKeyDownand check the key provided in the event argument.columnHeaderNavigationKeyDownevent was removed. UsecolumnHeaderKeyDownand check the key provided in the event argument.