Improve hook to register events on canvas #1481
Merged
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.
I'm rethinking
useCanvasEvents
a bit. The hook is now calleduseCanvasEvent
(singular) and allows registering only one event listener at a time. This brings the API closer to that ofuseEventListener
from react-hookz and avoids registering event listeners that are not actually used.Additional benefits of the new implementation:
pointerdown
,pointerup
,pointermove
andwheel
— so basically any event that hasoffsetX
andoffsetY
(i.e. any event that extendsMouseEvent
, includingWheelEvent
,PointerEvent
,DragEvent
).useSyncedRef
so consumers don't have to wrap their listeners inuseCallback
— this simplifies a bunch of code.addEventListener
, notablypassive
, which might be useful at some point notably forwheel
events (currently, the only place where we do need to configurepassive
is inuseWheelCapture
but it doesn't rely onuseCanvasEvent
).