@thecb/components 11.8.0-beta.4 → 11.8.0-beta.6

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@thecb/components",
-  "version": "11.8.0-beta.4",
+  "version": "11.8.0-beta.6",
   "description": "Common lib for CityBase react components",
   "main": "dist/index.cjs.js",
   "typings": "dist/index.d.ts",
@@ -81,8 +81,8 @@
     "vite": "^5.2.11"
   },
   "peerDependencies": {
-    "react": "^16.13.1",
-    "react-dom": "^16.13.1",
+    "react": "^16.13.1 || ^17.0.0",
+    "react-dom": "^16.13.1 || ^17.0.0",
     "react-router-dom": "^6.3.0",
     "styled-components": "^5.1.1",
     "styled-theming": "^2.2.0"

package/src/components/molecules/popover/Popover.js

@@ -5,24 +5,10 @@ import Paragraph from "../../atoms/paragraph";
 import { Box } from "../../atoms/layouts";
 import ButtonWithAction from "../../atoms/button-with-action";
 import { useOutsideClick } from "../../../hooks";
-import { noop } from "../../../util/general";
+import { noop, arrowBorder } from "../../../util/general";
 import { ESCAPE } from "../../../constants/keyboard";
 import { fallbackValues } from "./Popover.theme";
 
-const arrowBorder = (borderColor, direction, width = "8px") => {
-  const angle = `${width} solid transparent`;
-  const straight = `${width} solid ${borderColor}`;
-  if (direction == "down") {
-    return `border-left: ${angle}; border-right: ${angle}; border-top: ${straight}`;
-  } else if (direction == "up") {
-    return `border-left: ${angle}; border-right: ${angle}; border-bottom: ${straight}`;
-  } else if (direction == "left") {
-    return `border-top: ${angle}; border-bottom: ${angle}; border-right: ${straight}`;
-  } else if (direction == "right") {
-    return `border-top: ${angle}; border-bottom: ${angle}; border-left: ${straight}`;
-  }
-};
-
 const Popover = ({
   themeValues,
   triggerText = "",

package/src/components/molecules/tooltip/Tooltip.js

@@ -4,39 +4,27 @@ import Text from "../../atoms/text";
 import Paragraph from "../../atoms/paragraph";
 import { Box } from "../../atoms/layouts";
 import ButtonWithAction from "../../atoms/button-with-action";
-import { noop } from "../../../util/general";
-import { ESCAPE } from "../../../constants/keyboard";
+import { noop, arrowBorder } from "../../../util/general";
 import { fallbackValues } from "./Tooltip.theme";
 import WarningIconXS from "../../atoms/icons/WarningIconXS";
-import { SELECTIVE_YELLOW } from "../../../constants/colors";
-
-const arrowBorder = (borderColor, direction, width = "8px") => {
-  const angle = `${width} solid transparent`;
-  const straight = `${width} solid ${borderColor}`;
-  if (direction == "down") {
-    return `border-left: ${angle}; border-right: ${angle}; border-top: ${straight}`;
-  } else if (direction == "up") {
-    return `border-left: ${angle}; border-right: ${angle}; border-bottom: ${straight}`;
-  } else if (direction == "left") {
-    return `border-top: ${angle}; border-bottom: ${angle}; border-right: ${straight}`;
-  } else if (direction == "right") {
-    return `border-top: ${angle}; border-bottom: ${angle}; border-left: ${straight}`;
-  }
-};
 
 const Tooltip = ({
+  tooltipContainerExtraStyles = "",
   themeValues,
-  triggerText = "",
-  content = "",
+  tooltipID = "tooltip-content",
   hasIconTrigger = false,
   IconTrigger = WarningIconXS,
-  iconHelpText = "",
-  tooltipID = "tooltip-content",
-  extraStyles = "",
-  textExtraStyles = "",
-  minWidth = "250px",
-  maxWidth = "300px",
-  height = "auto",
+  iconHelpText = "Open the tooltip",
+  tooltipContent = "",
+  tooltipTriggerText = "",
+  triggerTextExtraStyles = "",
+  contentExtraStyles = "",
+  contentPosition = {
+    top: "-110px",
+    right: "auto",
+    bottom: "auto",
+    left: "-225px"
+  },
   arrowDirection = "down",
   arrowPosition = {
     arrowTop: "auto",
@@ -44,20 +32,15 @@ const Tooltip = ({
     arrowBottom: "-8px",
     arrowLeft: "auto"
   },
-  position = {
-    top: "-110px",
-    right: "auto",
-    bottom: "auto",
-    left: "-225px"
-  },
-  iconColor = SELECTIVE_YELLOW,
+  minWidth = "250px",
+  maxWidth = "300px",
+  height = "auto",
   buttonExtraStyles,
   backgroundColor = "white",
-  borderColor = "rgba(255, 255, 255, 0.85)",
-  tooltipContentExtraStyles
+  borderColor = "rgba(255, 255, 255, 0.85)"
 }) => {
   const { hoverColor, activeColor, tooltipTriggerColor } = themeValues;
-  const { top, right, bottom, left } = position ?? {};
+  const { top, right, bottom, left } = contentPosition ?? {};
   const { arrowTop, arrowRight, arrowBottom, arrowLeft } = arrowPosition ?? {};
 
   const [tooltipOpen, setTooltipOpen] = useState(false);
@@ -69,13 +52,16 @@ const Tooltip = ({
   };
 
   const handleKeyboardEvent = e => {
-    if (e.keyCode === ESCAPE || e.keyCode === 9) {
+    if (e.key === "Escape") {
       handleToggleTooltip(false);
     }
   };
 
   return (
-    <Box padding="0" extraStyles={`position: relative; ${extraStyles}`}>
+    <Box
+      padding="0"
+      extraStyles={`position: relative; ${tooltipContainerExtraStyles}`}
+    >
       <ButtonWithAction
         action={() => noop}
         onFocus={() => handleToggleTooltip(true)}
@@ -93,16 +79,21 @@ const Tooltip = ({
       >
         {hasIconTrigger && (
           <>
-            <Box aria-label="Trigger Popover">
-              <IconTrigger color={iconColor} />
+            <Box aria-label="Open tooltip">
+              <IconTrigger color={tooltipTriggerColor} />
             </Box>
-            <Box padding="0" srOnly aria-hidden="true">
+            <Box padding="0" srOnly>
               <Text>{iconHelpText}</Text>
             </Box>
           </>
         )}
         {!hasIconTrigger && (
-          <Text extraStyles={textExtraStyles}>{triggerText}</Text>
+          <Text
+            extraStyles={`color: ${tooltipTriggerColor}; &:hover {
+          ${hoverColor}; &:active ${activeColor}; ${triggerTextExtraStyles}`}
+          >
+            {tooltipTriggerText}
+          </Text>
         )}
       </ButtonWithAction>
       <Box
@@ -122,10 +113,10 @@ const Tooltip = ({
           bottom: ${bottom}; 
           left: ${left};
           height: ${height};
-          ${tooltipContentExtraStyles};
+          ${contentExtraStyles};
           `}
       >
-        <Paragraph>{content}</Paragraph>
+        <Paragraph>{tooltipContent}</Paragraph>
         <Box
           padding="0"
           extraStyles={`

package/src/components/molecules/tooltip/Tooltip.mdx

@@ -6,7 +6,7 @@ import * as TooltipStories from './Tooltip.stories.js';
 
 <Title />
 
-The Tooltip is a fully accessible tooltip widget that displays additional information when a user hovers over or focuses on a specified trigger element. The trigger can either be text supplied using the `triggerText` prop, or a custom Icon component supplied using the `icon` prop. The trigger is rendered as a `ButtonWithAction` with the `smallGhost` variant.
+The Tooltip is a fully accessible tooltip widget that displays additional information when a user hovers over or focuses on a specified trigger element. The trigger can either be text supplied using the `triggerText` prop, or a custom Icon component supplied using the `IconTrigger` prop. The trigger is rendered as a `ButtonWithAction` with the `smallGhost` variant.
 
 The Tooltip uses the WAI-ARIA tooltip pattern (`role="tooltip"` and `aria-describedby`) for accessibility. It can be positioned anywhere around the trigger element using the position props. Content and style of the tooltip are customizable.
 

package/src/components/molecules/tooltip/Tooltip.stories.js

@@ -9,36 +9,35 @@ export default {
     controls: { expanded: true }
   },
   args: {
-    triggerText: "",
-    content: "",
+    tooltipTriggerText: "",
+    tooltipContent: "",
     hasIconTrigger: false,
     IconTrigger: WarningIconXS,
-    iconHelpText: "",
-    tooltipID: 0,
-    extraStyles: undefined,
-    textExtraStyles: undefined,
+    iconHelpText: "Open the tooltip",
+    tooltipID: "tooltip-content",
+    tooltipContainerExtraStyles: undefined,
+    triggerTextExtraStyles: undefined,
     minWidth: "250px",
     maxWidth: "300px",
     height: "auto",
-    position: undefined,
+    contentPosition: undefined,
     arrowPosition: undefined,
     arrowDirection: "down",
-    transform: "none",
     buttonExtraStyles: undefined,
     backgroundColor: "white",
     borderColor: "rgba(255, 255, 255, 0.85)",
-    tooltipExtraStyles: undefined
+    contentExtraStyles: undefined
   },
   argTypes: {
-    triggerText: {
+    tooltipTriggerText: {
       description:
-        "Text element that tooltip is anchored to. Only used if hasIcon is false.",
+        "Text element that tooltip is anchored to. Only used if hasIconTrigger is false.",
       table: {
         type: { summary: "string" },
         defaultValue: { summary: "" }
       }
     },
-    content: {
+    tooltipContent: {
       description: "Content of the tooltip",
       table: {
         type: { summary: "string" },
@@ -65,18 +64,18 @@ export default {
       description: "Accessible description of the icon",
       table: {
         type: { summary: "string" },
-        defaultValue: { summary: undefined }
+        defaultValue: { summary: "Open the tooltip" }
       }
     },
     tooltipID: {
       description:
         "ID value for tooltip. Use if displaying multiple tooltips on the same page.",
       table: {
-        type: { summary: "number" },
-        defaultValue: { summary: 0 }
+        type: { summary: "string" },
+        defaultValue: { summary: "tooltip-content" }
       }
     },
-    extraStyles: {
+    tooltipContainerExtraStyles: {
       description:
         "Extra CSS styles to apply to the wrapper component around the trigger and tooltip",
       table: {
@@ -84,7 +83,7 @@ export default {
         defaultValue: { summary: undefined }
       }
     },
-    textExtraStyles: {
+    triggerTextExtraStyles: {
       description: "Extra styles to apply to the text trigger of the tooltip",
       table: {
         type: { summary: "CSS string" },
@@ -112,7 +111,7 @@ export default {
         defaultValue: { summary: "auto" }
       }
     },
-    position: {
+    contentPosition: {
       description:
         "Object containing values for top/right/bottom/left position of tooltip relative to trigger",
       table: {
@@ -135,13 +134,6 @@ export default {
         defaultValue: { summary: "down" }
       }
     },
-    transform: {
-      description: "CSS transform to apply to tooltip",
-      table: {
-        type: { summary: "string" },
-        defaultValue: { summary: undefined }
-      }
-    },
     buttonExtraStyles: {
       description:
         "Extra styles to apply to the button that wraps tooltip trigger",
@@ -164,8 +156,8 @@ export default {
         defaultValue: { summary: "rgba(255, 255, 255, 0.85)" }
       }
     },
-    tooltipExtraStyles: {
-      description: "Extra styles to apply to the tooltip",
+    contentExtraStyles: {
+      description: "Extra styles to apply to the tooltip content box",
       table: {
         type: { summary: "string" },
         defaultValue: { summary: undefined }
@@ -176,8 +168,8 @@ export default {
 
 export const BasicTooltip = {
   args: {
-    triggerText: "Help",
-    content:
+    tooltipTriggerText: "Help",
+    tooltipContent:
       "Contact support at 1-800-CTY-VILL for help with your account balance."
   }
 };
@@ -186,17 +178,17 @@ export const IconTooltip = {
   args: {
     hasIconTrigger: true,
     IconTrigger: WarningIconXS,
-    content:
+    tooltipContent:
       "Contact support at 1-800-CTY-VILL for help with your account balance."
   }
 };
 
 export const UnderneathTooltip = {
   args: {
-    triggerText: "What's this?",
-    content:
+    tooltipTriggerText: "What's this?",
+    tooltipContent:
       "Contact support at 1-800-CTY-VILL for help with your account balance.",
-    position: { top: "50px", left: "-100px" },
+    contentPosition: { top: "50px", left: "-100px" },
     arrowPosition: { arrowTop: "-8px", arrowLeft: "50%" },
     arrowDirection: "up"
   }

package/src/components/molecules/tooltip/index.d.ts

@@ -4,9 +4,6 @@ import Expand from "../../../util/expand";
 export interface TooltipProps {
   triggerText?: string | JSX.Element;
   content?: string | JSX.Element;
-  hasIcon?: boolean;
-  iconHelpText?: string;
-  tooltipID?: number;
   extraStyles?: string;
   textExtraStyles?: string;
   minWidth?: string;
@@ -20,11 +17,15 @@ export interface TooltipProps {
     arrowLeft: string;
   };
   arrowDirection?: "left" | "right" | "top" | "bottom";
-  transform?: string;
   buttonExtraStyles?: string;
   borderColor?: string;
   backgroundColor?: string;
-  tooltipExtraStyles?: string;
+  hasIconTrigger?: boolean;
+  IconTrigger?: React.FC<React.SVGProps<SVGSVGElement>>;
+  iconHelpText?: string;
+  iconColor?: string;
+  tooltipID: string;
+  tooltipContentExtraStyles?: string;
 }
 
 export const Tooltip: React.FC<Expand<TooltipProps> &

package/src/components/templates/sidebar-stack-content/SidebarStackContent.js

@@ -36,7 +36,7 @@ const SidebarStackContent = ({
     >
       <Cover centerOverride={!sidebarVerticalCenter} key="page-cover">
         {header ? header : <Box padding="0" key="header-box" />}
-        <Box padding="0" minWidth="100%" key="content-box" role="main">
+        <Box padding="0" minWidth="100%" key="content-box">
           {subHeader && !(isMobile && hideMobileSubHeader) ? (
             subHeader
           ) : (

package/src/util/general.js

@@ -222,3 +222,17 @@ export const adjustHexColor = (hex, percent, action) => {
     .slice(1)
     .padStart(6, "0")}`;
 };
+
+export const arrowBorder = (borderColor, direction, width = "8px") => {
+  const angle = `${width} solid transparent`;
+  const straight = `${width} solid ${borderColor}`;
+  if (direction == "down") {
+    return `border-left: ${angle}; border-right: ${angle}; border-top: ${straight}`;
+  } else if (direction == "up") {
+    return `border-left: ${angle}; border-right: ${angle}; border-bottom: ${straight}`;
+  } else if (direction == "left") {
+    return `border-top: ${angle}; border-bottom: ${angle}; border-right: ${straight}`;
+  } else if (direction == "right") {
+    return `border-top: ${angle}; border-bottom: ${angle}; border-left: ${straight}`;
+  }
+};