Fix pagination step and stepOptions behaviors when step is controlled #7205
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?
This PR fixes handling on
step
to ensure that in a controlled scenario, the internal state value is updated. It also ensures thatstep
+stepOptions
works.Previously, #7188 caused the internal management of
stepOptions
to break when caller passed a value to Paginationstep
.For context, we had explored introducing a
useControlled
hook to reduce 1 extra re-render caused by theuseEffect
pattern. That said, this assumes that theprop
being controlled (in this casestep
) has an equivalent change handler (which doesn't currently exist). Therefore, by passingonChange
to theuseControlled
hook, we were incorrectly calling a change event more frequently than previously as well as not allowingstepOptions
to update the internal step in cases wherestep
was also used.Given we follow the
useEffect
pattern elsewhere in Grommet, we will still with that for the time being as opposed to extending Pagination's API surface to include a step handler likeonStep
.Where should the reviewer start?
src/js/components/Pagination/Pagination.js
What testing has been done on this PR?
Locally in storybook.
Added jest tests.
How should this be manually tested?
In storybook locally as mentioned above.
Do Jest tests follow these best practices?
screen
is used for querying.asFragment()
is used for snapshot testing.Any background context you want to provide?
What are the relevant issues?
Closes #7201
Screenshots (if appropriate)
Do the grommet docs need to be updated?
No.
Should this PR be mentioned in the release notes?
Yes.
Is this change backwards compatible or is it a breaking change?
Backwards compatible.