Skip to content

OpenProject is the leading open source project management software for product, project and portfolio management. A powerful Jira alternative with agile planning, issue tracking, roadmaps, Gantt charts, time tracking, collaboration features, and more. Available on premises or in the cloud. ⭐ Star us on GitHub

Use PageState, handleEvent

Oliver Günther97692b2b4db2
diff --git a/frontend/src/app/core/setup/globals/openproject.ts b/frontend/src/app/core/setup/globals/openproject.ts
index 579b44c7452..53084e544eb 100644
--- a/frontend/src/app/core/setup/globals/openproject.ts
+++ b/frontend/src/app/core/setup/globals/openproject.ts
@@ -31,6 +31,8 @@ import { input, InputState } from '@openproject/reactivestates';
import { getMetaElement, GlobalHelpers } from 'core-app/core/setup/globals/global-helpers';
import { firstValueFrom } from 'rxjs';
+export type OpenProjectPageState = 'pristine'|'edited'|'submitted';
+
/**
* OpenProject instance methods
*/
@@ -39,6 +41,17 @@ export class OpenProject {
public helpers = new GlobalHelpers();
+ /** Globally setable variable whether the page was edited or submitted */
+ pageState:OpenProjectPageState = 'pristine';
+
+ public get pageWasEdited():boolean {
+ return this.pageState === 'edited';
+ }
+
+ public get pageWasSubmitted():boolean {
+ return this.pageState === 'submitted';
+ }
+
/** Globally setable variable whether any of the EditFormComponent
* contain changes.
* Necessary to show a data loss warning on beforeunload when clicking
diff --git a/frontend/src/app/shared/components/editor/components/ckeditor-augmented-textarea/ckeditor-augmented-textarea.component.ts b/frontend/src/app/shared/components/editor/components/ckeditor-augmented-textarea/ckeditor-augmented-textarea.component.ts
index b5024e73609..62fa40cae82 100644
--- a/frontend/src/app/shared/components/editor/components/ckeditor-augmented-textarea/ckeditor-augmented-textarea.component.ts
+++ b/frontend/src/app/shared/components/editor/components/ckeditor-augmented-textarea/ckeditor-augmented-textarea.component.ts
@@ -59,7 +59,6 @@ import { AttachmentCollectionResource } from 'core-app/features/hal/resources/at
import { populateInputsFromDataset } from 'core-app/shared/components/dataset-inputs';
import { navigator } from '@hotwired/turbo';
import { uniqueId } from 'lodash';
-import { setPageWasEdited, setPageWasSubmitted } from '../../../../../../stimulus/controllers/beforeunload.controller';
@Component({
templateUrl: './ckeditor-augmented-textarea.html',
@@ -192,7 +191,7 @@ export class CkeditorAugmentedTextareaComponent extends UntilDestroyedMixin impl
CkeditorAugmentedTextareaComponent.inFlight.set(this.formElement, true);
this.syncToTextarea();
- setPageWasSubmitted();
+ window.OpenProject.pageState = 'submitted';
setTimeout(() => {
if (evt?.submitter) {
@@ -233,7 +232,7 @@ export class CkeditorAugmentedTextareaComponent extends UntilDestroyedMixin impl
}
public syncToTextarea() {
- setPageWasEdited();
+ window.OpenProject.pageState = 'edited';
try {
this.wrappedTextArea.value = this.ckEditorInstance.getTransformedContent(true);
diff --git a/frontend/src/stimulus/controllers/beforeunload.controller.ts b/frontend/src/stimulus/controllers/beforeunload.controller.ts
index 77fe74c8e1d..6c919e5f22b 100644
--- a/frontend/src/stimulus/controllers/beforeunload.controller.ts
+++ b/frontend/src/stimulus/controllers/beforeunload.controller.ts
@@ -1,61 +1,43 @@
import { ApplicationController } from 'stimulus-use';
import { TurboBeforeVisitEvent } from '@hotwired/turbo';
-export function setPageWasEdited() {
- const application = window.Stimulus;
- const controller = application.getControllerForElementAndIdentifier(document.body, 'beforeunload') as BeforeunloadController;
- if (controller) {
- controller.pageWasEdited = true;
- }
-}
-
-export function setPageWasSubmitted() {
- const application = window.Stimulus;
- const controller = application.getControllerForElementAndIdentifier(document.body, 'beforeunload') as BeforeunloadController;
- if (controller) {
- controller.pageWasEdited = true;
- }
-}
-
export class BeforeunloadController extends ApplicationController {
- /** Globally setable variable whether the page was edited */
- public pageWasEdited = false;
-
- /** Globally setable variable whether the page form is submitted.
- * Necessary to avoid a data loss warning on beforeunload */
- public pageIsSubmitted = false;
-
- private boundBeforeUnloadHandler = this.beforeunloadHandler.bind(this);
-
- private submitHandler = () => {
- this.pageIsSubmitted = true;
- };
-
- private turboHandler = () => {
- this.pageWasEdited = false;
- this.pageIsSubmitted = false;
- };
+ private abortController = new AbortController();
connect() {
super.connect();
- window.addEventListener('beforeunload', this.boundBeforeUnloadHandler);
- document.addEventListener('turbo:before-visit', this.boundBeforeUnloadHandler);
- document.addEventListener('turbo:submit-end', this.turboHandler);
- document.addEventListener('submit', this.submitHandler);
+ const { signal } = this.abortController;
+
+ window.addEventListener('beforeunload', this, { signal });
+ document.addEventListener('turbo:before-visit', this, { signal });
+ document.addEventListener('turbo:submit-end', this, { signal });
+ document.addEventListener('submit', this, { signal });
}
disconnect() {
- window.removeEventListener('beforeunload', this.boundBeforeUnloadHandler);
- document.removeEventListener('turbo:before-visit', this.boundBeforeUnloadHandler);
- document.removeEventListener('turbo:submit-end', this.turboHandler);
- document.removeEventListener('submit', this.submitHandler);
+ this.abortController.abort();
}
- private beforeunloadHandler(evt:BeforeUnloadEvent|TurboBeforeVisitEvent) {
- const { pageWasEdited, pageIsSubmitted } = this;
+ handleEvent(evt:BeforeUnloadEvent|TurboBeforeVisitEvent|CustomEvent) {
+ switch (evt.type) {
+ case 'beforeunload':
+ case 'turbo:before-visit':
+ this.beforeunloadHandler(evt as BeforeUnloadEvent|TurboBeforeVisitEvent);
+ break;
+ case 'turbo:submit-end':
+ window.OpenProject.pageState = 'pristine';
+ break;
+ case 'submit':
+ window.OpenProject.pageState = 'submitted';
+ break;
+ default:
+ break;
+ }
+ }
- if (!pageWasEdited || pageIsSubmitted) {
+ private beforeunloadHandler(evt:BeforeUnloadEvent|TurboBeforeVisitEvent) {
+ if (window.OpenProject.pageState !== 'edited') {
return;
}
diff --git a/frontend/src/stimulus/controllers/dynamic/meetings/check-unsaved.controller.ts b/frontend/src/stimulus/controllers/dynamic/meetings/check-unsaved.controller.ts
index db838fb9e87..19231e5a7f7 100644
--- a/frontend/src/stimulus/controllers/dynamic/meetings/check-unsaved.controller.ts
+++ b/frontend/src/stimulus/controllers/dynamic/meetings/check-unsaved.controller.ts
@@ -81,7 +81,7 @@ export default class extends ApplicationController {
const textInputs = Array.from(document.querySelectorAll('input[type="text"], input[type="number"]'));
const allTextSaved = textInputs.every((input) => (input as HTMLInputElement).value.trim().length === 0);
- return !allTextSaved || this.beforeUnloadController.pageWasEdited;
+ return !allTextSaved || window.OpenProject.pageWasEdited;
}
private beforeUnloadHandler(event:BeforeUnloadEvent):void {