Skip to content
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.

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

feat(routing): change default of cleanUrlOnDispose to false #6499

Merged
merged 3 commits into from
Dec 31, 2024

Conversation

Haroenv
Copy link
Contributor

@Haroenv Haroenv commented Dec 30, 2024

In the vast majority of cases you're either never disposing InstantSearch, or the URL already gets cleared some other way (eg. through SPA navigation). This is why the new default for cleanUrlOnDispose is false.

You'd still want to set this option to true if you're rendering instantsearch in a modal that should have the url cleared when that modal is closed.

BREAKING CHANGE: default of cleanUrlOnDispose is false

FX-3213

In the vast majority of cases you're either never disposing InstantSearch, or the URL already gets cleared some other way (eg. through SPA navigation). This is why the new default for cleanUrlOnDispose is `false`.

You'd still want to set this option to `true` if you're rendering instantsearch in a modal that should have the url cleared when that modal is closed.

BREAKING CHANGE: default of cleanUrlOnDispose is false

[FX-3213]
@Haroenv Haroenv added this to the instantsearch.js v5 milestone Dec 30, 2024
Copy link

codesandbox-ci bot commented Dec 30, 2024

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 877e402:

Sandbox Source
example-instantsearch-getting-started Configuration
example-react-instantsearch-getting-started Configuration
example-react-instantsearch-next-app-dir-example Configuration
example-react-instantsearch-next-routing-example Configuration
example-vue-instantsearch-getting-started Configuration

@Haroenv Haroenv merged commit 8bf0f6a into next Dec 31, 2024
0 of 3 checks passed
@Haroenv Haroenv deleted the feat/change-default-clear-url branch December 31, 2024 09:49
Haroenv added a commit that referenced this pull request Jan 9, 2025
* feat(routing): change default of cleanUrlOnDispose to false

In the vast majority of cases you're either never disposing InstantSearch, or the URL already gets cleared some other way (eg. through SPA navigation). This is why the new default for cleanUrlOnDispose is `false`.

You'd still want to set this option to `true` if you're rendering instantsearch in a modal that should have the url cleared when that modal is closed.

BREAKING CHANGE: default of cleanUrlOnDispose is false

[FX-3213]

* fix tests

* Update packages/instantsearch-core/src/routing/historyRouter.ts

Co-authored-by: Dhaya <[email protected]>

---------

Co-authored-by: Dhaya <[email protected]>
Haroenv added a commit that referenced this pull request Jan 17, 2025
* feat(routing): change default of cleanUrlOnDispose to false

In the vast majority of cases you're either never disposing InstantSearch, or the URL already gets cleared some other way (eg. through SPA navigation). This is why the new default for cleanUrlOnDispose is `false`.

You'd still want to set this option to `true` if you're rendering instantsearch in a modal that should have the url cleared when that modal is closed.

BREAKING CHANGE: default of cleanUrlOnDispose is false

[FX-3213]

* fix tests

* Update packages/instantsearch-core/src/routing/historyRouter.ts

Co-authored-by: Dhaya <[email protected]>

---------

Co-authored-by: Dhaya <[email protected]>
Haroenv added a commit that referenced this pull request Jan 17, 2025
* feat(routing): change default of cleanUrlOnDispose to false

In the vast majority of cases you're either never disposing InstantSearch, or the URL already gets cleared some other way (eg. through SPA navigation). This is why the new default for cleanUrlOnDispose is `false`.

You'd still want to set this option to `true` if you're rendering instantsearch in a modal that should have the url cleared when that modal is closed.

BREAKING CHANGE: default of cleanUrlOnDispose is false

[FX-3213]

* fix tests

* Update packages/instantsearch-core/src/routing/historyRouter.ts

Co-authored-by: Dhaya <[email protected]>

---------

Co-authored-by: Dhaya <[email protected]>
Haroenv added a commit that referenced this pull request Jan 17, 2025
* feat(routing): change default of cleanUrlOnDispose to false

In the vast majority of cases you're either never disposing InstantSearch, or the URL already gets cleared some other way (eg. through SPA navigation). This is why the new default for cleanUrlOnDispose is `false`.

You'd still want to set this option to `true` if you're rendering instantsearch in a modal that should have the url cleared when that modal is closed.

BREAKING CHANGE: default of cleanUrlOnDispose is false

[FX-3213]

* fix tests

* Update packages/instantsearch-core/src/routing/historyRouter.ts

Co-authored-by: Dhaya <[email protected]>

---------

Co-authored-by: Dhaya <[email protected]>
Haroenv added a commit that referenced this pull request Jan 17, 2025
* feat(routing): change default of cleanUrlOnDispose to false

In the vast majority of cases you're either never disposing InstantSearch, or the URL already gets cleared some other way (eg. through SPA navigation). This is why the new default for cleanUrlOnDispose is `false`.

You'd still want to set this option to `true` if you're rendering instantsearch in a modal that should have the url cleared when that modal is closed.

BREAKING CHANGE: default of cleanUrlOnDispose is false

[FX-3213]

* fix tests

* Update packages/instantsearch-core/src/routing/historyRouter.ts

Co-authored-by: Dhaya <[email protected]>

---------

Co-authored-by: Dhaya <[email protected]>
Haroenv added a commit that referenced this pull request Jan 21, 2025
* feat(routing): change default of cleanUrlOnDispose to false

In the vast majority of cases you're either never disposing InstantSearch, or the URL already gets cleared some other way (eg. through SPA navigation). This is why the new default for cleanUrlOnDispose is `false`.

You'd still want to set this option to `true` if you're rendering instantsearch in a modal that should have the url cleared when that modal is closed.

BREAKING CHANGE: default of cleanUrlOnDispose is false

[FX-3213]

* fix tests

* Update packages/instantsearch-core/src/routing/historyRouter.ts

Co-authored-by: Dhaya <[email protected]>

---------

Co-authored-by: Dhaya <[email protected]>
Haroenv added a commit that referenced this pull request Jan 21, 2025
* feat(routing): change default of cleanUrlOnDispose to false

In the vast majority of cases you're either never disposing InstantSearch, or the URL already gets cleared some other way (eg. through SPA navigation). This is why the new default for cleanUrlOnDispose is `false`.

You'd still want to set this option to `true` if you're rendering instantsearch in a modal that should have the url cleared when that modal is closed.

BREAKING CHANGE: default of cleanUrlOnDispose is false

[FX-3213]

* fix tests

* Update packages/instantsearch-core/src/routing/historyRouter.ts

Co-authored-by: Dhaya <[email protected]>

---------

Co-authored-by: Dhaya <[email protected]>
Haroenv added a commit that referenced this pull request Jan 22, 2025
* feat(routing): change default of cleanUrlOnDispose to false

In the vast majority of cases you're either never disposing InstantSearch, or the URL already gets cleared some other way (eg. through SPA navigation). This is why the new default for cleanUrlOnDispose is `false`.

You'd still want to set this option to `true` if you're rendering instantsearch in a modal that should have the url cleared when that modal is closed.

BREAKING CHANGE: default of cleanUrlOnDispose is false

[FX-3213]

* fix tests

* Update packages/instantsearch-core/src/routing/historyRouter.ts

Co-authored-by: Dhaya <[email protected]>

---------

Co-authored-by: Dhaya <[email protected]>
Haroenv added a commit that referenced this pull request Jan 22, 2025
* feat(routing): change default of cleanUrlOnDispose to false

In the vast majority of cases you're either never disposing InstantSearch, or the URL already gets cleared some other way (eg. through SPA navigation). This is why the new default for cleanUrlOnDispose is `false`.

You'd still want to set this option to `true` if you're rendering instantsearch in a modal that should have the url cleared when that modal is closed.

BREAKING CHANGE: default of cleanUrlOnDispose is false

[FX-3213]

* fix tests

* Update packages/instantsearch-core/src/routing/historyRouter.ts

Co-authored-by: Dhaya <[email protected]>

---------

Co-authored-by: Dhaya <[email protected]>
Haroenv added a commit that referenced this pull request Jan 27, 2025
* feat(routing): change default of cleanUrlOnDispose to false

In the vast majority of cases you're either never disposing InstantSearch, or the URL already gets cleared some other way (eg. through SPA navigation). This is why the new default for cleanUrlOnDispose is `false`.

You'd still want to set this option to `true` if you're rendering instantsearch in a modal that should have the url cleared when that modal is closed.

BREAKING CHANGE: default of cleanUrlOnDispose is false

[FX-3213]

* fix tests

* Update packages/instantsearch-core/src/routing/historyRouter.ts

Co-authored-by: Dhaya <[email protected]>

---------

Co-authored-by: Dhaya <[email protected]>
Haroenv added a commit that referenced this pull request Jan 28, 2025
* feat(routing): change default of cleanUrlOnDispose to false

In the vast majority of cases you're either never disposing InstantSearch, or the URL already gets cleared some other way (eg. through SPA navigation). This is why the new default for cleanUrlOnDispose is `false`.

You'd still want to set this option to `true` if you're rendering instantsearch in a modal that should have the url cleared when that modal is closed.

BREAKING CHANGE: default of cleanUrlOnDispose is false

[FX-3213]

* fix tests

* Update packages/instantsearch-core/src/routing/historyRouter.ts

Co-authored-by: Dhaya <[email protected]>

---------

Co-authored-by: Dhaya <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants