Changed List to add onActive #6103
Merged
Conversation
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
taysea
reviewed
May 2, 2022
src/js/components/List/List.js
Outdated
| @@ -151,8 +153,15 @@ const List = React.forwardRef( | |||
| // If onOrder is not defined but onClickItem is (e.g. the | |||
| // List items are likely selectable), active will be the | |||
| // index of the item which is currently active. | |||
| const [active, setActive] = useState(); | |||
| const [active, setActiveState] = useState(); | |||
There was a problem hiding this comment.
Should we rename active to activeState ? no change to functionality but we typically have kept these variable names tied together.
There was a problem hiding this comment.
Changed to leave setActive as was and changed new function to be updateActive, to make it clear it wasn't just updating a useState
taysea
approved these changes
May 2, 2022
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.
What does this PR do?
Exposes the internal
activestate of a List viaonActive.Also ensures that any
onKeyDownpassed in is given to the internal Keyboard.Where should the reviewer start?
I'd start by reading the unit test changes. They should give an idea on what is happening.
What testing has been done on this PR?
Enhanced unit tests.
Did some manual testing with the onClickItem story by adding
onActiveandonKeyDownI didn't add a storybook story for this as it seemed somewhat obscure and reasonably covered by the unit tests.
How should this be manually tested?
Add your own
onActiveandonKeyDownto a story.Do Jest tests follow these best practices?
followed existing test structure
What are the relevant issues?
#6087
Do the grommet docs need to be updated?
yes
Should this PR be mentioned in the release notes?
yes
Is this change backwards compatible or is it a breaking change?
backwards compatible