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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@thecb/components",
-  "version": "11.8.0-beta.5",
+  "version": "11.8.0-beta.6",
   "description": "Common lib for CityBase react components",
   "main": "dist/index.cjs.js",
   "typings": "dist/index.d.ts",

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

@@ -5,24 +5,26 @@ import Paragraph from "../../atoms/paragraph";
 import { Box } from "../../atoms/layouts";
 import ButtonWithAction from "../../atoms/button-with-action";
 import { noop, arrowBorder } from "../../../util/general";
-import { ESCAPE } from "../../../constants/keyboard";
 import { fallbackValues } from "./Tooltip.theme";
 import WarningIconXS from "../../atoms/icons/WarningIconXS";
-import { SELECTIVE_YELLOW } from "../../../constants/colors";
 
 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",
@@ -30,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);
@@ -55,13 +52,16 @@ const Tooltip = ({
   };
 
   const handleKeyboardEvent = e => {
-    if (e.key === ESCAPE) {
+    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)}
@@ -80,7 +80,7 @@ const Tooltip = ({
         {hasIconTrigger && (
           <>
             <Box aria-label="Open tooltip">
-              <IconTrigger color={iconColor} />
+              <IconTrigger color={tooltipTriggerColor} />
             </Box>
             <Box padding="0" srOnly>
               <Text>{iconHelpText}</Text>
@@ -90,9 +90,9 @@ const Tooltip = ({
         {!hasIconTrigger && (
           <Text
             extraStyles={`color: ${tooltipTriggerColor}; &:hover {
-          ${hoverColor}; &:active ${activeColor}; ${textExtraStyles}`}
+          ${hoverColor}; &:active ${activeColor}; ${triggerTextExtraStyles}`}
           >
-            {triggerText}
+            {tooltipTriggerText}
           </Text>
         )}
       </ButtonWithAction>
@@ -113,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.stories.js

@@ -9,28 +9,27 @@ export default {
     controls: { expanded: true }
   },
   args: {
-    triggerText: "",
-    content: "",
+    tooltipTriggerText: "",
+    tooltipContent: "",
     hasIconTrigger: false,
     IconTrigger: WarningIconXS,
-    iconHelpText: "",
-    iconColor: undefined,
+    iconHelpText: "Open the tooltip",
     tooltipID: "tooltip-content",
-    extraStyles: undefined,
-    textExtraStyles: undefined,
+    tooltipContainerExtraStyles: undefined,
+    triggerTextExtraStyles: undefined,
     minWidth: "250px",
     maxWidth: "300px",
     height: "auto",
-    position: undefined,
+    contentPosition: undefined,
     arrowPosition: undefined,
     arrowDirection: "down",
     buttonExtraStyles: undefined,
     backgroundColor: "white",
     borderColor: "rgba(255, 255, 255, 0.85)",
-    tooltipContentExtraStyles: undefined
+    contentExtraStyles: undefined
   },
   argTypes: {
-    triggerText: {
+    tooltipTriggerText: {
       description:
         "Text element that tooltip is anchored to. Only used if hasIconTrigger is false.",
       table: {
@@ -38,7 +37,7 @@ export default {
         defaultValue: { summary: "" }
       }
     },
-    content: {
+    tooltipContent: {
       description: "Content of the tooltip",
       table: {
         type: { summary: "string" },
@@ -65,14 +64,7 @@ export default {
       description: "Accessible description of the icon",
       table: {
         type: { summary: "string" },
-        defaultValue: { summary: undefined }
-      }
-    },
-    iconColor: {
-      description: "Color of the icon trigger",
-      table: {
-        type: { summary: "string" },
-        defaultValue: { summary: undefined }
+        defaultValue: { summary: "Open the tooltip" }
       }
     },
     tooltipID: {
@@ -83,7 +75,7 @@ export default {
         defaultValue: { summary: "tooltip-content" }
       }
     },
-    extraStyles: {
+    tooltipContainerExtraStyles: {
       description:
         "Extra CSS styles to apply to the wrapper component around the trigger and tooltip",
       table: {
@@ -91,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" },
@@ -119,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: {
@@ -164,7 +156,7 @@ export default {
         defaultValue: { summary: "rgba(255, 255, 255, 0.85)" }
       }
     },
-    tooltipContentExtraStyles: {
+    contentExtraStyles: {
       description: "Extra styles to apply to the tooltip content box",
       table: {
         type: { summary: "string" },
@@ -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"
   }