Feature/import navigation lock (#1536)

Use navigation lock on repository import to prevent that the current user accidentally leaves the page and aborts the running import.

scm-ui/ui-components/src/navigation/index.ts

@@ -35,3 +35,4 @@ export { MenuContext, StateMenuContextProvider } from "./MenuContext";
 export { default as SecondaryNavigationItem } from "./SecondaryNavigationItem";
 export { default as ExternalLink } from "./ExternalLink";
 export { default as ExternalNavLink } from "./ExternalNavLink";
+export { default as useNavigationLock } from "./useNavigationLock";

scm-ui/ui-components/src/navigation/useNavigationLock.ts

@@ -0,0 +1,43 @@
+/*
+ * MIT License
+ *
+ * Copyright (c) 2020-present Cloudogu GmbH and Contributors
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+
+import { useEffect } from "react";
+
+// This hook can be used to warn the user on reloading or closing the current page if the navigation lock is enabled.
+const useNavigationLock = (enabled: boolean) => {
+  useEffect(() => {
+    if (enabled) {
+      window.onbeforeunload = () => true;
+    } else {
+      // @ts-ignore We need to reset this listener if the lock was disabled
+      window.onbeforeunload = undefined;
+    }
+    return () => {
+      // @ts-ignore Remove this listener when the hook will be unmounted
+      window.onbeforeunload = undefined;
+    };
+  }, [enabled]);
+};
+
+export default useNavigationLock;