fix(routing): warn if initialUiState is used #6238
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.
Summary
If you use initialUiState, as well as routing, you can get some confusing situations where the state is overridden, only if routing actually has some state. This can be very sporadic depending on your setup, and thus confusing.
Result
CR-6027 is somewhat handled, documentation still needed.
If you have any state set in
intialUiState
(not an empty object), you will receive a warning upon initialisation of InstantSearch with routing.