Enable future preserveSharedStateOnUnmount on instantsearch#1063
Open
indykoning wants to merge 2 commits intomasterfrom
Open
Enable future preserveSharedStateOnUnmount on instantsearch#1063indykoning wants to merge 2 commits intomasterfrom
indykoning wants to merge 2 commits intomasterfrom
Conversation
Jade-GG
previously approved these changes
Nov 3, 2025
Member
|
Should we extract this somewhere? I see this (and other attributes) multiple times in different files |
Member
|
Conflicts 😇 and we need this for 4.x and 5.x? |
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
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.
See: https://www.algolia.com/doc/guides/building-search-ui/widgets/show-and-hide-widgets/vue#enable-preservesharedstateonunmount
This feature will be default in a future release of Instantsearch.
Enabling this will prevent bugs by not removing search filters when their respective component gets removed. As long as an element still uses it.
What could happen before this addition is you setting a default value in an
ais-configureelement, and removing the element when a different value is passed:If
preservesharedstateonunmountis falsev-if="!query"would causeais-configureto unmount.Forcing
queryto be set tonull, thus re-mounting theais-configurecomponent and settingqueryagain.If
preservesharedstateonunmountis true, instantsearch detectsais-search-boxupdatesqueryas well. And does noet clear thequerys value