carousel: subscribe before calling setApi - #214
Merged
Merged
Conversation
The lint fix in #211 left the listeners in an effect declared after the one that calls setApi. Effects run in order, so a consumer that scrolls as soon as it gets the api (e.g. `setApi={(api) => api?.scrollTo(2, true)}`) moved the carousel before anyone was listening. The triggers and indicators then stayed on slide 1. Subscribing first fixes it, with no setState in an effect.
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Problem
This is a regression from #211, found by the new browser behaviour tests (a-peak-works/untitledui-react#346). The effect that calls
setApiwas declared before the one that subscribes to Embla'sselectandreInitevents, and effects run in declaration order. So a consumer that moves the carousel as soon as it gets the api did it before anyone was listening:Prev/Next and the indicators then stayed on slide 1. Before #211, the subscribing effect also re-read the position, which hid the problem, but that re-read is the
setStatein an effect that the lint rules forbid.Fix
Declare the subscribing effect first.
setApithen runs with the listeners already attached. There's no extra render and nosetStatein an effect.Verified
ScrollFromSetApifails without this change and passes with it; each run rebuilt Storybook.bun run test(type-check, lint and Prettier) passes.🤖 Generated with Claude Code