feat(core): add getUiState function #4750
Merged
+208
−4
Conversation
This file contains 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
This is useful for if you want to read the ui state externally from InstantSearch, like for example in algolia/autocomplete#550 TODO: tests
|
This pull request is automatically built and testable in CodeSandbox. To see build info of the built libraries, click here or the icon next to each commit SHA. Latest deployment of this branch, based on commit e56bd0c:
|
|
That'll be useful for external integrations to read the InstantSearch internal state! 🙂 |
francoischalifour
approved these changes
May 5, 2021
| @@ -101,6 +103,9 @@ See: https://www.algolia.com/doc/guides/building-search-ui/going-further/backend | |||
| }); | |||
|
|
|||
| it('throws if insightsClient is not a function', () => { | |||
| const warn = jest.spyOn(global.console, 'warn'); | |||
There was a problem hiding this comment.
Why do we need these changes here?
There was a problem hiding this comment.
a continuation of #4746, the warnings now take up a lot of place, so I removed them from this file.
Co-authored-by: François Chalifour <francoischalifour@users.noreply.github.com>
francoischalifour
added a commit
to algolia/autocomplete
that referenced
this pull request
May 6, 2021
In algolia/instantsearch#4750 we introduced the `getUiState` API which allows to retrieve the current category more easily.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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
This is useful for if you want to read the ui state externally from InstantSearch, like for example in algolia/autocomplete#550
Result
a new
getUiStatefunction on the InstantSearch instance that can be used to retrieve the latest ui state, separately from the router.