fix(Tip): Fixes hover gap and click issues with ToolTips and PreviewTips

Fix hover gap and click tooltip bugs on `floating` tooltips
Codecademy · Jan 31, 2025 · 84030ff · 84030ff
1 parent 9537b3b
commit 84030ff
Show file tree

Hide file tree

Showing 8 changed files with 112 additions and 32 deletions.
diff --git a/packages/gamut/src/Popover/Popover.tsx b/packages/gamut/src/Popover/Popover.tsx
@@ -5,6 +5,7 @@ import { useWindowScroll, useWindowSize } from 'react-use';
 import { FocusTrap } from '../FocusTrap';
 import {
   Beak,
+  BeakBox,
   PatternContainer,
   PopoverContainer,
   PopoverPortal,
@@ -172,12 +173,16 @@ export const Popover: React.FC<PopoverProps> = ({
         widthRestricted={widthRestricted}
       >
         {beak && (
-          <Beak
-            outline={outline ? 'outline' : 'boxShadow'}
-            beak={`${position}-${beak}${variant === 'secondary' ? '-sml' : ''}`}
-            data-testid="popover-beak"
-            size={variant === 'secondary' ? 'sml' : 'lrg'}
-          />
+          <BeakBox variant={position}>
+            <Beak
+              beak={`${position}-${beak}${
+                variant === 'secondary' ? '-sml' : ''
+              }`}
+              data-testid="popover-beak"
+              size={variant === 'secondary' ? 'sml' : 'lrg'}
+              hasBorder={outline || variant === 'secondary'}
+            />
+          </BeakBox>
         )}
         {children}
       </RaisedDiv>

diff --git a/packages/gamut/src/Popover/elements.tsx b/packages/gamut/src/Popover/elements.tsx
@@ -5,10 +5,12 @@ import { AnimatePresence, motion } from 'framer-motion';
 import * as React from 'react';
 
 import { BodyPortal } from '../BodyPortal';
-import { Box } from '../Box';
+import { Box, FlexBox } from '../Box';
 import { popoverToolTipBodyAlignments } from '../Tip/shared/styles';
 import { WithChildrenProp } from '../utils';
 import {
+  beakBorderStates,
+  beakBoxVariants,
   beakSize,
   beakVariants,
   outlineVariants,
@@ -39,10 +41,13 @@ export const RaisedDiv = styled.div<
 
 export const Beak = styled(Box)<
   StyleProps<typeof popoverStates> &
-    StyleProps<typeof outlineVariants> &
     StyleProps<typeof beakVariants> &
-    StyleProps<typeof beakSize>
->(beakVariants, beakSize);
+    StyleProps<typeof beakSize> &
+    StyleProps<typeof beakBorderStates>
+>(beakBorderStates, beakVariants, beakSize);
+
+export const BeakBox =
+  styled(FlexBox)<StyleProps<typeof beakBoxVariants>>(beakBoxVariants);
 
 export const PatternContainer = styled.div(
   variant({

diff --git a/packages/gamut/src/Popover/styles.tsx b/packages/gamut/src/Popover/styles.tsx
@@ -28,6 +28,7 @@ export const raisedDivVariants = variant({
   },
 });
 
+const borderStyles = { border: 1 } as const;
 export const outlineVariants = variant({
   defaultVariant: 'boxShadow',
   prop: 'outline',
@@ -36,8 +37,7 @@ export const outlineVariants = variant({
       boxShadow: '0 0 16px rgba(0, 0, 0, 0.1), 0 0 24px rgba(0, 0, 0, 0.15)',
     },
     outline: {
-      borderColor: 'secondary',
-      border: 1,
+      ...borderStyles,
       boxShadow: 'none',
     },
   },
@@ -50,6 +50,28 @@ export const widthStates = states({
   },
 });
 
+export const beakBorderStates = states({
+  hasBorder: borderStyles,
+});
+
+export const beakBoxVariants = variant({
+  base: {
+    alignItems: 'flex-end',
+    height: '15px',
+    justifyContent: 'center',
+    left: 0,
+    position: 'absolute',
+    width: '100%',
+  },
+  variants: {
+    above: {
+      bottom: -15,
+    },
+    below: {
+      top: -15,
+    },
+  },
+});
 const beakVariantsArray = [
   'below-left',
   'below-right',
@@ -72,8 +94,10 @@ const beakVariantStyles = createVariantsFromAlignments(
 
 export const beakVariants = variant({
   base: {
-    position: 'absolute',
     transform: 'rotate(45deg)',
+    background: 'transparent',
+    zIndex: 1,
+    position: 'fixed',
   },
   prop: 'beak',
   variants: beakVariantStyles,

diff --git a/packages/gamut/src/Popover/utils.tsx b/packages/gamut/src/Popover/utils.tsx
@@ -3,14 +3,14 @@ import { theme } from '@codecademy/gamut-styles';
 import { tooltipBackgroundColor } from '../Tip/shared/styles';
 
 const popoverAbove = {
-  borderRight: 'inherit',
-  borderBottom: 'inherit',
+  borderLeft: 'none',
+  borderTop: 'none',
   top: 'calc(100% - 10px)',
 } as const;
 
 const popoverBelow = {
-  borderLeft: 'inherit',
-  borderTop: 'inherit',
+  borderRight: 'none',
+  borderBottom: 'none',
   top: '-10px',
 } as const;
 
@@ -27,14 +27,14 @@ const beakCenter = {
 };
 
 const popoverAboveSml = {
-  borderRight: 'inherit',
-  borderBottom: 'inherit',
+  borderLeft: 'none',
+  borderTop: 'none',
   top: 'calc(100% - 8px)',
 } as const;
 
 const popoverBelowSml = {
-  borderLeft: 'inherit',
-  borderTop: 'inherit',
+  borderRight: 'none',
+  borderBottom: 'none',
   top: '-8px',
 } as const;
 

diff --git a/packages/gamut/src/Tip/shared/FloatingTip.tsx b/packages/gamut/src/Tip/shared/FloatingTip.tsx
@@ -3,10 +3,13 @@ import { useLayoutEffect, useRef, useState } from 'react';
 import * as React from 'react';
 import { useMeasure } from 'react-use';
 
-import { Box, FlexBox } from '../../Box';
+import { Box } from '../../Box';
 import { PreviewTipContents } from '../PreviewTip/elements';
-import { FloatingTipBody, TargetContainer } from './elements';
-import { narrowWidth } from './styles';
+import {
+  FloatingTipBody,
+  FloatingTipTextWrapper,
+  TargetContainer,
+} from './elements';
 import { TipWrapperProps } from './types';
 import { getAlignmentWidths, getPopoverAlignment, runWithDelay } from './utils';
 
@@ -113,6 +116,7 @@ export const FloatingTip: React.FC<TipWrapperProps> = ({
         onFocus={toolOnlyEventFunc}
         onBlur={toolOnlyEventFunc}
         onMouseEnter={toolOnlyEventFunc}
+        onMouseDown={(e) => e.preventDefault()}
         onKeyDown={
           escapeKeyPressHandler ? (e) => escapeKeyPressHandler(e) : undefined
         }
@@ -133,14 +137,14 @@ export const FloatingTip: React.FC<TipWrapperProps> = ({
         variant="secondary"
         widthRestricted={false}
       >
-        <FlexBox
-          alignItems={isHoverType ? undefined : 'flex-start'}
-          flexDirection="column"
+        <FloatingTipTextWrapper
           ref={childRef}
-          width={narrow ? narrowWidth : undefined}
+          isHoverType={isHoverType}
+          narrow={narrow}
+          centered={alignment.includes('center')}
         >
           {contents}
-        </FlexBox>
+        </FloatingTipTextWrapper>
       </FloatingTipBody>
     </Box>
   );

diff --git a/packages/gamut/src/Tip/shared/elements.tsx b/packages/gamut/src/Tip/shared/elements.tsx
@@ -1,21 +1,39 @@
-import { css, timing } from '@codecademy/gamut-styles';
+import { css, states, timing } from '@codecademy/gamut-styles';
 import { StyleProps } from '@codecademy/variance';
 import styled from '@emotion/styled';
 
-import { Box } from '../../Box';
+import { Box, FlexBox } from '../../Box';
 import { Selectors } from '../../ButtonBase/ButtonBase';
 import { Popover } from '../../Popover';
 import {
+  centerWidths,
   inlineToolTipBodyAlignments,
+  narrowWidth,
   toolTipBodyCss,
   toolTipWidthRestrictions,
 } from './styles';
 
 const tipWrapperStyles = {
   position: 'relative',
   display: 'inline-flex',
+  overflowWrap: 'break-word',
 } as const;
 
+const floatingTipTextStates = states({
+  isHoverType: { alignItems: 'flexStart' },
+  narrow: { width: narrowWidth },
+  centered: {
+    ...centerWidths,
+  },
+});
+
+export const FloatingTipTextWrapper = styled(FlexBox)<
+  StyleProps<typeof floatingTipTextStates>
+>(
+  css({ flexDirection: 'column', overflowWrap: 'break-word' }),
+  floatingTipTextStates
+);
+
 export const ToolTipWrapper = styled.div(
   css({
     '&:hover > div, &:focus-within > div': {

diff --git a/packages/gamut/src/Tip/shared/styles.tsx b/packages/gamut/src/Tip/shared/styles.tsx
@@ -31,6 +31,14 @@ export const topStyles = {
   pb: containerOffsetVertical,
 } as const;
 
+const beforeStyles = {
+  content: '""',
+  position: 'absolute',
+  width: '100%',
+};
+
+export const topStylesBefore = { ...beforeStyles, height: 16, bottom: '-4px' };
+
 export const topStylesAfter = {
   borderColor: 'currentColor',
   borderWidth: '0 1px 1px 0',
@@ -42,6 +50,12 @@ export const bottomStyles = {
   pt: containerOffsetVertical,
 } as const;
 
+export const bottomStylesBefore = {
+  ...beforeStyles,
+  height: 24,
+  top: '-8px',
+};
+
 export const bottomStylesAfter = {
   borderColor: 'currentColor',
   borderWidth: '1px 0 0 1px',
@@ -104,6 +118,7 @@ export const toolTipAlignmentVariants = variant({
     opacity: 0,
     position: 'absolute',
     visibility: 'hidden',
+
     '&::after': {
       content: '""',
       display: 'block',

diff --git a/packages/gamut/src/Tip/shared/utils.tsx b/packages/gamut/src/Tip/shared/utils.tsx
@@ -5,6 +5,7 @@ import {
   bottomCenterStylesAfter,
   bottomStyles,
   bottomStylesAfter,
+  bottomStylesBefore,
   centerStyles,
   centerStylesAfter,
   leftStyles,
@@ -14,6 +15,7 @@ import {
   topCenterStylesAfter,
   topStyles,
   topStylesAfter,
+  topStylesBefore,
 } from './styles';
 import { TipPlacementComponentProps, TipWrapperProps } from './types';
 
@@ -62,13 +64,16 @@ export const getPopoverAlignment = ({
 export const createToolTipVariantFromAlignment = (alignment: string) => {
   let styleObject = {};
   let styleObjectAfter = {};
+  let styleObjectBefore = {};
 
   if (alignment.includes('top')) {
     styleObject = { ...topStyles };
     styleObjectAfter = { ...topStylesAfter };
+    styleObjectBefore = { ...topStylesBefore };
   } else {
     styleObject = { ...bottomStyles };
     styleObjectAfter = { ...bottomStylesAfter };
+    styleObjectBefore = { ...bottomStylesBefore };
   }
 
   if (alignment.includes('center')) {
@@ -87,7 +92,11 @@ export const createToolTipVariantFromAlignment = (alignment: string) => {
     styleObjectAfter = { ...styleObjectAfter, ...leftStylesAfter };
   }
 
-  return { ...styleObject, '&::after': styleObjectAfter };
+  return {
+    ...styleObject,
+    '&::after': styleObjectAfter,
+    '&::before': styleObjectBefore,
+  };
 };
 
 export const createVariantsFromAlignments = (