Fix special click behavior in new side nav (#214650)

Not sure whether we have an issue for is, but a problem I constantly run
into is that cmd+click to open in new tab doesn't work with the new side
nav. You need to do right click + open in new tab which is taking at
least 3 times as long.

This is a problem because it's not the expected behavior - the entries
in the nav are regular links and they should behave like that (the old
nav didn't have this problem).

This PR fixes the issue to not call `e.preventDefault()` in case it's a
"special click" and only triggers the in-page navigation in cases where
the user does a normal left click.

Co-authored-by: Bhavya RM <[email protected]>

Author: flash1293

src/platform/packages/shared/shared-ux/chrome/navigation/src/ui/components/navigation_section_ui.tsx

@@ -283,6 +283,16 @@ const getEuiProps = (
         })
         .flat();
 
+  /**
+   * Check if the click event is a special click (e.g. right click, click with modifier key)
+   * We do not want to prevent the default behavior in these cases.
+   */
+  const isSpecialClick = (e: React.MouseEvent<HTMLElement | HTMLButtonElement>) => {
+    const isModifiedEvent = !!(e.metaKey || e.altKey || e.ctrlKey || e.shiftKey);
+    const isLeftClickEvent = e.button === 0;
+    return isModifiedEvent || !isLeftClickEvent;
+  };
+
   const linkProps: EuiCollapsibleNavItemProps['linkProps'] | undefined = hasLink
     ? {
         href,
@@ -301,6 +311,10 @@ const getEuiProps = (
             return;
           }
 
+          if (isSpecialClick(e)) {
+            return;
+          }
+
           if (href) {
             e.preventDefault();
             navigateToUrl(href);
@@ -327,6 +341,10 @@ const getEuiProps = (
     // will be used in the breadcrumb navigation.
     if (isAccordion && isCollapsible) return;
 
+    if (isSpecialClick(e)) {
+      return;
+    }
+
     if (href !== undefined) {
       e.preventDefault();
       navigateToUrl(href);