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.

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

fix: Better detection of initial state #21

Merged
merged 1 commit into from
May 28, 2024
Merged

fix: Better detection of initial state #21

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
56 changes: 9 additions & 47 deletions package-lock.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@
"eslint-config-prettier": "^8.8.0",
"eslint-config-typescript": "^3.0.0",
"eslint-plugin-prettier": "^4.2.1",
"naja": "^2.5.0",
"naja": "^2.6.0",
"prettier": "^2.8.8",
"rollup": "^3.21.6",
"typescript": "^5.0.4"
Expand Down
20 changes: 13 additions & 7 deletions src/extensions/AjaxModalExtension.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -156,7 +156,7 @@ export class AjaxModalExtension implements Extension {

private onSnippetFetch(event: FetchEvent): void {
// When snippet cache is off, this method is called to construct Naja request options. We retrieve modal
// `options` from original state in history if neccessary. Also, when closing the modal from `PopstateEvent`, we
// `options` from original state in history if necessary. Also, when closing the modal from `PopstateEvent`, we
// don't need to make a new request, so we call `event.preventDefault()` in that case.
const { state } = event.detail

Expand Down Expand Up @@ -201,16 +201,22 @@ export class AjaxModalExtension implements Extension {
}

private buildState(event: BuildStateEvent): void {
const { options, state } = event.detail
const { operation, options, state } = event.detail

// If this is called from Naja's `replaceInitialState`, we don't change the state.
//
// This is a possible weakness, because this condition could be true even with actual user interaction, if
// Naja's first interaction is with an element with `data-naja-history="replace"`. In this case the condition
// will also be true, but it is probably the desired behaviour to save this state as non-modal anyway, since
// the initial state should (or could) never be opened in a modal.
if (operation === 'replaceState' && state.cursor === 0) {
return
}

// Every time naja builds the state, and we have the modal opened, we extend the state with `pdModal` object
// containing information about modal being opened and what history mode is in use. When `options.forceRedirect`
// is set, modal might be open but the new state will be redirected outside of it.
//
// We must check this.modal.isShown instead of this.isPdModalRequest, because of initial replace state from
// Naja - in that case, options already contains information about request to be made, but we have to build the
// "previous" state yet.
const isShown: boolean = this.modal.isShown() && !options.forceRedirect
const isShown: boolean = this.isPdModalRequest(options) && !options.forceRedirect

if (isShown) {
state.pdModal = {
Expand Down