Skip to content

wip: allow disabling storing render state #6670

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
Haroenv wants to merge 1 commit into
base: master
Choose a base branch
from
Draft

wip: allow disabling storing render state #6670

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions packages/instantsearch.js/src/lib/InstantSearch.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -191,6 +191,11 @@ export type InstantSearchOptions<
*/
// @MAJOR: Remove legacy behaviour here and in algoliasearch-helper
persistHierarchicalRootCount?: boolean;
/**
* Experimental option to disable `renderState`
* @defualt false
*/
dontStoreRenderState?: boolean;
};
};

Expand All @@ -201,6 +206,7 @@ export const INSTANTSEARCH_FUTURE_DEFAULTS: Required<
> = {
preserveSharedStateOnUnmount: false,
persistHierarchicalRootCount: false,
dontStoreRenderState: false,
};

/**
Expand Down
3 changes: 3 additions & 0 deletions packages/instantsearch.js/src/widgets/index/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -955,6 +955,9 @@ function storeRenderState({
instantSearchInstance: InstantSearch;
parent?: IndexWidget;
}) {
if (instantSearchInstance.future.dontStoreRenderState) {
return;
}
const parentIndexName = parent
? parent.getIndexId()
: instantSearchInstance.mainIndex.getIndexId();
Expand Down