Add push history state support to LiveComponent#3550
Open
ajgarlag wants to merge 1 commit into
Open
Conversation
Contributor
📊 Packages dist files size differenceThanks for the PR! Here is the difference in size of the packages dist files between the base branch and the PR.
|
||||||||||||
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.
This PR adds support for pushing browser history entries when a LiveComponent updates URL-bound LiveProp values.
Until now, URL updates were always done with
history.replaceState(), which overwrote the current entry. With this change, components can opt in tohistory.pushState()so users can navigate previous component states via the browser back button (for example, previous pages in pagination or prior filter states in search UIs).Included changes:
pushHistoryStateparameter to#[AsLiveComponent(...)](default: false).push_history_state.LiveComponentMetadata::hasPushHistoryStateEnabled()to read the flag.X-Live-Url-Push-History-State: 1|0BackendResponseto parse the new header.history.pushState(...)when enabledhistory.replaceState(...)otherwise (current behavior preserved)