fix: don't call a hook in onChange for KeyboardControls #1279
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.
Why
Passing an
onChange
callback toKeyboardControls
triggers a Rules of Hooks error when a key is pressed.See screenshot:
What
In
src/web/KeyboardControls.tsx
, theonChange
callback tries to get the state of the pressed keys by callingapi[2]
, which is a reference touseControls
. It looks like that should beapi[1]
, which is a reference touseControls.getState
and can safely be called at keypress time.So this PR fixes that, and adds an example of an
onChange
handler to the Storybook story to test that by changing the color of the Player when the user clicks Space.See screenshot
Checklist
Also just wanted to say thanks for this library! This and R3F have made making 3D AR applications so much more pleasant 😄