🪟 🎨 Update Tooltip component to match design library #14816
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,34 @@ | ||
| @use "../../scss/colors"; | ||
| @use "../../scss/variables"; | ||
| @use "../../scss/z-indices"; | ||
|
|
||
| .container { | ||
| display: inline; | ||
| position: relative; | ||
| } | ||
|
|
||
| .tooltip { | ||
| font-size: 12px; | ||
| line-height: initial; | ||
|
|
||
| padding: variables.$spacing-md; | ||
| border-radius: 5px; | ||
| max-width: 300px; | ||
| z-index: z-indices.$tooltip; | ||
| box-shadow: 0px 2px 4px rgba(colors.$dark-blue, 0.12); | ||
| background: rgba(colors.$dark-blue, 0.9); | ||
| color: colors.$white; | ||
|
|
||
| a { | ||
| color: rgba(colors.$white, 0.5); | ||
| } | ||
|
|
||
| &.light { | ||
| background: rgba(colors.$white, 0.9); | ||
| color: colors.$dark-blue; | ||
|
|
||
| a { | ||
| color: colors.$blue; | ||
| } | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,51 +1,80 @@ | ||
| import { flip, offset, shift, useFloating } from "@floating-ui/react-dom"; | ||
| import classNames from "classnames"; | ||
| import React, { useState, useEffect } from "react"; | ||
|
|
||
| import { tooltipContext } from "./context"; | ||
| import styles from "./ToolTip.module.scss"; | ||
| import { ToolTipProps } from "./types"; | ||
|
|
||
| const MOUSE_OUT_TIMEOUT_MS = 50; | ||
|
|
||
| export const ToolTip: React.FC<ToolTipProps> = (props) => { | ||
| const { children, control, className, disabled, cursor, theme = "dark", placement = "bottom" } = props; | ||
|
|
||
| const [isMouseOver, setIsMouseOver] = useState(false); | ||
| const [isVisible, setIsVisible] = useState(false); | ||
|
|
||
| const { x, y, reference, floating, strategy } = useFloating({ | ||
| placement, | ||
| middleware: [ | ||
| offset(5), // $spacing-sm | ||
| flip(), | ||
| shift(), | ||
| ], | ||
| }); | ||
|
|
||
| useEffect(() => { | ||
| if (isMouseOver) { | ||
| setIsVisible(true); | ||
| return; | ||
| } | ||
|
|
||
| const timeout = window.setTimeout(() => { | ||
| setIsVisible(false); | ||
| }, MOUSE_OUT_TIMEOUT_MS); | ||
|
|
||
| return () => { | ||
| window.clearTimeout(timeout); | ||
| }; | ||
| }, [isMouseOver]); | ||
|
|
||
| const canShowTooltip = isVisible && !disabled; | ||
|
|
||
| const onMouseOver = () => { | ||
| setIsMouseOver(true); | ||
| }; | ||
|
|
||
| const onMouseOut = () => { | ||
| setIsMouseOver(false); | ||
| }; | ||
|
|
||
| return ( | ||
| <> | ||
| <div | ||
| ref={reference} | ||
| className={styles.container} | ||
| style={disabled ? undefined : { cursor }} | ||
| onMouseOver={onMouseOver} | ||
| onMouseOut={onMouseOut} | ||
| > | ||
| {control} | ||
| </div> | ||
| {canShowTooltip && ( | ||
| <div | ||
| role="tooltip" | ||
| ref={floating} | ||
| className={classNames(styles.tooltip, theme === "light" && styles.light, className)} | ||
| style={{ | ||
| position: strategy, | ||
| top: y ?? 0, | ||
| left: x ?? 0, | ||
| }} | ||
| onMouseOver={onMouseOver} | ||
| onMouseOut={onMouseOut} | ||
| > | ||
| <tooltipContext.Provider value={props}>{children}</tooltipContext.Provider> | ||
| </div> | ||
| )} | ||
| </> | ||
| ); | ||
| }; | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| @use "../../scss/variables"; | ||
|
|
||
| .container { | ||
| margin-top: variables.$spacing-md; | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,15 @@ | ||
| import { FormattedMessage } from "react-intl"; | ||
|
|
||
| import styles from "./TooltipLearnMoreLink.module.scss"; | ||
|
|
||
| interface TooltipLearnMoreLinkProps { | ||
| url: string; | ||
| } | ||
|
|
||
| export const TooltipLearnMoreLink: React.VFC<TooltipLearnMoreLinkProps> = ({ url }) => ( | ||
|
There was a problem hiding this comment. Just curious, why did you use There was a problem hiding this comment. VFC (Void FunctionComponent) is a type of component that does not allow children to be passed through it. It's something I discovered recently while working on this. There was a problem hiding this comment. Ah I see, and we don't want this component to have any children because it is just a simple div with a link |
||
| <div className={styles.container}> | ||
| <a href={url} target="_blank" rel="noreferrer"> | ||
|
There was a problem hiding this comment. Probably not worth the effort, nor would this be the place, but I'd love to have a component that would always tack on |
||
| <FormattedMessage id="ui.learnMore" /> | ||
| </a> | ||
| </div> | ||
| ); | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,13 @@ | ||
| @use "../../scss/colors"; | ||
| @use "../../scss/variables"; | ||
|
|
||
| .label { | ||
| color: rgba(colors.$white, 0.7); | ||
| padding-right: variables.$spacing-sm; | ||
| } | ||
|
|
||
| .light { | ||
| .label { | ||
| color: rgba(colors.$dark-blue, 0.7); | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,24 @@ | ||
| import { useTooltipContext } from "./context"; | ||
| import styles from "./TooltipTable.module.scss"; | ||
|
|
||
| interface TooltipTableProps { | ||
| rows: React.ReactNode[][]; | ||
| } | ||
|
|
||
| export const TooltipTable: React.VFC<TooltipTableProps> = ({ rows }) => { | ||
| const { theme } = useTooltipContext(); | ||
|
There was a problem hiding this comment. For my own learning, could you briefly explain why you chose to use a context here? Is this because the There was a problem hiding this comment. I did this in order to understand the context of the tooltip without having to pass the props twice. Otherwise in the component that implements you you'd have to pass the same theme: <Tooltip theme="light">
<TooltipTable theme="light" />
</Tooltip>
// Nothing stopping you from doing:
<Tooltip theme="light">
<TooltipTable /> // If you don't pass the theme and have no context, the theme of the table will be "dark"
</Tooltip>There was a problem hiding this comment. Ah okay, so this is basically forcing the TooltipTable to match the same theme as its parent Tooltip through the use of context, removing that burden from the developer who adds the |
||
|
|
||
| return rows.length > 0 ? ( | ||
krishnaglick marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| <table className={theme === "light" ? styles.light : undefined}> | ||
| <tbody> | ||
| {rows?.map((cols) => ( | ||
| <tr> | ||
| {cols.map((col, index) => ( | ||
| <td className={index === 0 ? styles.label : undefined}>{col}</td> | ||
| ))} | ||
| </tr> | ||
| ))} | ||
| </tbody> | ||
| </table> | ||
| ) : null; | ||
| }; | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,15 @@ | ||
| import { createContext, useContext } from "react"; | ||
|
|
||
| import { TooltipContext } from "./types"; | ||
|
|
||
| export const tooltipContext = createContext<TooltipContext | null>(null); | ||
|
There was a problem hiding this comment. We use both camelCase and PascalCase for context's. We should decide one way or the other just for consistency. |
||
|
|
||
| export const useTooltipContext = () => { | ||
| const ctx = useContext(tooltipContext); | ||
|
|
||
| if (!ctx) { | ||
| throw new Error("useTooltipContext should be used within tooltipContext.Provider"); | ||
| } | ||
|
|
||
| return ctx; | ||
| }; | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,57 @@ | ||
| import { ComponentStory, ComponentMeta } from "@storybook/react"; | ||
|
|
||
| import { ToolTip } from "./ToolTip"; | ||
| import { TooltipLearnMoreLink } from "./TooltipLearnMoreLink"; | ||
| import { TooltipTable } from "./TooltipTable"; | ||
|
|
||
| export default { | ||
| title: "Ui/ToolTip", | ||
| component: ToolTip, | ||
| argTypes: { | ||
| control: { type: { name: "string", required: true } }, | ||
| children: { type: { name: "string", required: true } }, | ||
| }, | ||
| } as ComponentMeta<typeof ToolTip>; | ||
|
|
||
| const Template: ComponentStory<typeof ToolTip> = (args) => ( | ||
| <div style={{ display: "flex", height: "100%", alignItems: "center", justifyContent: "center" }}> | ||
| <ToolTip {...args} /> | ||
| </div> | ||
| ); | ||
|
|
||
| export const Primary = Template.bind({}); | ||
| Primary.args = { | ||
| control: "Hover to see Tooltip", | ||
| children: ( | ||
| <> | ||
| Looking for a job?{" "} | ||
| <a href="https://www.airbyte.com/careers" target="_blank" rel="noreferrer"> | ||
| Apply at Airbyte! | ||
| </a> | ||
| </> | ||
| ), | ||
| }; | ||
|
|
||
| export const WithLearnMoreUrl = Template.bind({}); | ||
| WithLearnMoreUrl.args = { | ||
| control: "Hover to see Tooltip with Body", | ||
| children: ( | ||
| <> | ||
| Airbyte is hiring! <TooltipLearnMoreLink url="https://www.airbyte.com/careers" /> | ||
| </> | ||
| ), | ||
| }; | ||
|
|
||
| export const WithTable = Template.bind({}); | ||
| WithTable.args = { | ||
| control: "Hover to see Tooltip with Table", | ||
| children: ( | ||
| <TooltipTable | ||
| rows={[ | ||
| ["String", "Value"], | ||
| ["Number", 32768], | ||
| ["With a longer label", "And here is a longer value"], | ||
| ]} | ||
| /> | ||
| ), | ||
| }; |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
While reviewing the design with @Upmitt, it was decided that it didn't make sense to show the help cursor here.