grep-components 2.5.1 → 2.5.2

package/dist/build/components/NavGuard/index.d.ts

@@ -1,4 +1,8 @@
 import * as React from 'react';
+export interface NavguardExclusion {
+    current: string;
+    next: string;
+}
 export interface NavGuardProperties {
     when: boolean;
     title: string;
@@ -6,9 +10,11 @@ export interface NavGuardProperties {
     txtSave: string;
     txtCancel: string;
     txtDiscard: string;
+    /** Pass in an array of NavguardExclusions that the Navguard will not trigger when navigating from current to next. */
+    exclude?: NavguardExclusion[];
     onDiscard?: () => void;
     onCancel?: () => void;
     onSave?: () => void;
 }
-declare const NavGuard: ({ when, title, txt, txtSave, txtCancel, txtDiscard, onSave, onCancel, onDiscard, }: NavGuardProperties) => React.JSX.Element;
+declare const NavGuard: ({ when, exclude, title, txt, txtSave, txtCancel, txtDiscard, onSave, onCancel, onDiscard, }: NavGuardProperties) => React.JSX.Element;
 export default NavGuard;

package/dist/build/components/NavGuard/stories/NavGuard.stories.d.ts

@@ -27,3 +27,7 @@ export declare const WithAppBar: {
     (): React.JSX.Element;
     storyName: string;
 };
+export declare const WithExclude: {
+    (): React.JSX.Element;
+    storyName: string;
+};

package/dist/index.js

@@ -15653,7 +15653,7 @@ const AppBar = ({ username, currentPath, environmentTitle, appTitle, userMenuIte
             React.createElement(MobileAppBar, { menuItems: menuItems, userMenuItems: userMenuItems, colors: colors }))));
 };
 
-const NavGuard = ({ when, title, txt, txtSave, txtCancel, txtDiscard, onSave, onCancel, onDiscard, }) => {
+const NavGuard = ({ when, exclude, title, txt, txtSave, txtCancel, txtDiscard, onSave, onCancel, onDiscard, }) => {
     const [open, setOpen] = React.useState(false);
     const handleCancel = () => {
         setOpen(false);
@@ -15669,7 +15669,16 @@ const NavGuard = ({ when, title, txt, txtSave, txtCancel, txtDiscard, onSave, on
         setOpen(false);
         blocker.proceed ? blocker.proceed() : null;
     };
-    const blocker = useBlocker(({ currentLocation, nextLocation }) => when && currentLocation.pathname !== nextLocation.pathname);
+    const blocker = useBlocker(({ currentLocation, nextLocation }) => {
+        let excluded = false;
+        exclude?.forEach((navGuardExclusion) => {
+            if (navGuardExclusion.current.includes(currentLocation.pathname) &&
+                navGuardExclusion.next.includes(nextLocation.pathname)) {
+                excluded = true;
+            }
+        });
+        return (when && !excluded && currentLocation.pathname !== nextLocation.pathname);
+    });
     React.useEffect(() => {
         if (blocker.state === 'blocked') {
             setOpen(true);