Skip to content

feat(Tooltip): Convert Tooltip to CSS modules behind team flag #5228

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Nov 7, 2024
Merged

feat(Tooltip): Convert Tooltip to CSS modules behind team flag #5228

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
d1f6507
Convert Tooltip to CSS modules behind team flag
jonrohan Nov 4, 2024
701546c
Create lazy-mugs-care.md
jonrohan Nov 4, 2024
e03625d
Moving the animation out and fixing the font
jonrohan Nov 7, 2024
03a33aa
Fix types
jonrohan Nov 7, 2024
8526ec2
Lint
jonrohan Nov 7, 2024
72bc2ad
Merge branch 'main' into css_modules_tooltip
jonrohan Nov 7, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/lazy-mugs-care.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"@primer/react": minor
---

feat(Tooltip): Convert Tooltip to CSS modules behind team flag
120 changes: 120 additions & 0 deletions packages/react/src/TooltipV2/Tooltip.module.css
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,120 @@
/* Animation definition */
@keyframes tooltip-appear {
from {
opacity: 0;
}

to {
opacity: 1;
}
}

.Tooltip {
/* Overriding the default popover styles */
display: none;

&[popover] {
position: absolute;
width: max-content;
max-width: 250px;
/* stylelint-disable-next-line primer/spacing */
padding: 0.5em 0.75em;
margin: auto;

/* for scrollbar */
overflow: visible;
clip: auto;
/* stylelint-disable-next-line primer/typography */
font: normal normal 11px/1.5 var(--fontStack-system);
color: var(--tooltip-fgColor);
text-align: center;
word-wrap: break-word;
white-space: normal;
background: var(--tooltip-bgColor);
border: 0;
border-radius: var(--borderRadius-medium);
opacity: 0;
-webkit-font-smoothing: subpixel-antialiased;
inset: auto;
}

/* class name in chrome is :popover-open */
&[popover]:popover-open {
display: block;
}

/* class name in firefox and safari is \:popover-open */
&[popover].\\:popover-open {
display: block;
}

@media (forced-colors: active) {
outline: 1px solid transparent;
}

/* This is needed to keep the tooltip open when the user leaves the trigger element to hover tooltip */
&::after {
position: absolute;
right: 0;
left: 0;
display: block;
height: var(--overlay-offset);
content: '';
}

/* South, East, Southeast, Southwest after */
&[data-direction='n']::after,
&[data-direction='ne']::after,
&[data-direction='nw']::after {
top: 100%;
}

&[data-direction='s']::after,
&[data-direction='se']::after,
&[data-direction='sw']::after {
bottom: 100%;
}

&[data-direction='w']::after {
position: absolute;
bottom: 0;
left: 100%;
display: block;
width: 8px;
height: 100%;
content: '';
}

/* East before and after */
&[data-direction='e']::after {
position: absolute;
right: 100%;
bottom: 0;
display: block;
width: 8px;
height: 100%;
/* stylelint-disable-next-line primer/spacing */
margin-left: -8px;
content: '';
}

/* Animation styles */
&:popover-open,
&:popover-open::before {
animation-name: tooltip-appear;
animation-duration: 0.1s;
animation-fill-mode: forwards;
animation-timing-function: ease-in;
animation-delay: 0s;
}

/* Animation styles */
&.\\:popover-open,
&.\\:popover-open::before {
animation-name: tooltip-appear;
animation-duration: 0.1s;
animation-fill-mode: forwards;
animation-timing-function: ease-in;
animation-delay: 0s;
}
}
209 changes: 110 additions & 99 deletions packages/react/src/TooltipV2/Tooltip.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,15 @@ import {invariant} from '../utils/invariant'
import {warning} from '../utils/warning'
import styled from 'styled-components'
import {get} from '../constants'
import type {ComponentProps} from '../utils/types'
import {getAnchoredPosition} from '@primer/behaviors'
import type {AnchorSide, AnchorAlignment} from '@primer/behaviors'
import {isSupported, apply} from '@oddbird/popover-polyfill/fn'
import {toggleStyledComponent} from '../internal/utils/toggleStyledComponent'
import {clsx} from 'clsx'
import classes from './Tooltip.module.css'
import {useFeatureFlag} from '../FeatureFlags'

const CSS_MODULE_FEATURE_FLAG = 'primer_react_css_modules_team'

const animationStyles = `
animation-name: tooltip-appear;
Expand All @@ -19,119 +24,123 @@ const animationStyles = `
animation-delay: 0s;
`

const StyledTooltip = styled.span`
/* Overriding the default popover styles */
display: none;
&[popover] {
position: absolute;
padding: 0.5em 0.75em;
width: max-content;
margin: auto;
clip: auto;
white-space: normal;
font: normal normal 11px/1.5 ${get('fonts.normal')};
-webkit-font-smoothing: subpixel-antialiased;
color: var(--tooltip-fgColor, ${get('colors.fg.onEmphasis')});
text-align: center;
word-wrap: break-word;
background: var(--tooltip-bgColor, ${get('colors.neutral.emphasisPlus')});
border-radius: ${get('radii.2')};
border: 0;
opacity: 0;
max-width: 250px;
inset: auto;
/* for scrollbar */
overflow: visible;
}
/* class name in chrome is :popover-open */
&[popover]:popover-open {
display: block;
}
/* class name in firefox and safari is \:popover-open */
&[popover].\\:popover-open {
display: block;
}
const StyledTooltip = toggleStyledComponent(
CSS_MODULE_FEATURE_FLAG,
'span',
styled.span`
/* Overriding the default popover styles */
display: none;
&[popover] {
position: absolute;
padding: 0.5em 0.75em;
width: max-content;
margin: auto;
clip: auto;
white-space: normal;
font: normal normal 11px/1.5 ${get('fonts.normal')};
-webkit-font-smoothing: subpixel-antialiased;
color: var(--tooltip-fgColor, ${get('colors.fg.onEmphasis')});
text-align: center;
word-wrap: break-word;
background: var(--tooltip-bgColor, ${get('colors.neutral.emphasisPlus')});
border-radius: ${get('radii.2')};
border: 0;
opacity: 0;
max-width: 250px;
inset: auto;
/* for scrollbar */
overflow: visible;
}
/* class name in chrome is :popover-open */
&[popover]:popover-open {
display: block;
}
/* class name in firefox and safari is \:popover-open */
&[popover].\\:popover-open {
display: block;
}

@media (forced-colors: active) {
outline: 1px solid transparent;
}
@media (forced-colors: active) {
outline: 1px solid transparent;
}

// This is needed to keep the tooltip open when the user leaves the trigger element to hover tooltip
&::after {
position: absolute;
display: block;
right: 0;
left: 0;
height: var(--overlay-offset, 0.25rem);
content: '';
}
// This is needed to keep the tooltip open when the user leaves the trigger element to hover tooltip
&::after {
position: absolute;
display: block;
right: 0;
left: 0;
height: var(--overlay-offset, 0.25rem);
content: '';
}

/* South, East, Southeast, Southwest after */
&[data-direction='n']::after,
&[data-direction='ne']::after,
&[data-direction='nw']::after {
top: 100%;
}
&[data-direction='s']::after,
&[data-direction='se']::after,
&[data-direction='sw']::after {
bottom: 100%;
}
/* South, East, Southeast, Southwest after */
&[data-direction='n']::after,
&[data-direction='ne']::after,
&[data-direction='nw']::after {
top: 100%;
}
&[data-direction='s']::after,
&[data-direction='se']::after,
&[data-direction='sw']::after {
bottom: 100%;
}

&[data-direction='w']::after {
position: absolute;
display: block;
height: 100%;
width: 8px;
content: '';
bottom: 0;
left: 100%;
}
/* East before and after */
&[data-direction='e']::after {
position: absolute;
display: block;
height: 100%;
width: 8px;
content: '';
bottom: 0;
right: 100%;
margin-left: -8px;
}
&[data-direction='w']::after {
position: absolute;
display: block;
height: 100%;
width: 8px;
content: '';
bottom: 0;
left: 100%;
}
/* East before and after */
&[data-direction='e']::after {
position: absolute;
display: block;
height: 100%;
width: 8px;
content: '';
bottom: 0;
right: 100%;
margin-left: -8px;
}

/* Animation definition */
@keyframes tooltip-appear {
from {
opacity: 0;
/* Animation definition */
@keyframes tooltip-appear {
from {
opacity: 0;
}
to {
opacity: 1;
}
}
to {
opacity: 1;
/* Animation styles */
&:popover-open,
&:popover-open::before {
${animationStyles}
}
}
/* Animation styles */
&:popover-open,
&:popover-open::before {
${animationStyles}
}

/* Animation styles */
&.\\:popover-open,
&.\\:popover-open::before {
${animationStyles}
}
/* Animation styles */
&.\\:popover-open,
&.\\:popover-open::before {
${animationStyles}
}

${sx};
`
${sx};
`,
)

export type TooltipDirection = 'nw' | 'n' | 'ne' | 'e' | 'se' | 's' | 'sw' | 'w'
export type TooltipProps = React.PropsWithChildren<
{
direction?: TooltipDirection
text: string
type?: 'label' | 'description'
} & SxProp &
ComponentProps<typeof StyledTooltip>
>
} & SxProp
> &
React.HTMLAttributes<HTMLElement>

type TriggerPropsType = {
'aria-describedby'?: string
Expand Down Expand Up @@ -187,11 +196,12 @@ const isInteractive = (element: HTMLElement) => {
export const TooltipContext = React.createContext<{tooltipId?: string}>({})

export const Tooltip = React.forwardRef(
({direction = 's', text, type = 'description', children, id, ...rest}: TooltipProps, forwardedRef) => {
({direction = 's', text, type = 'description', children, id, className, ...rest}: TooltipProps, forwardedRef) => {
const tooltipId = useId(id)
const child = Children.only(children)
const triggerRef = useProvidedRefOrCreate(forwardedRef as React.RefObject<HTMLElement>)
const tooltipElRef = useRef<HTMLDivElement>(null)
const enabled = useFeatureFlag(CSS_MODULE_FEATURE_FLAG)

const [calculatedDirection, setCalculatedDirection] = useState<TooltipDirection>(direction)

Expand Down Expand Up @@ -355,6 +365,7 @@ export const Tooltip = React.forwardRef(
},
})}
<StyledTooltip
className={clsx(className, {[classes.Tooltip]: enabled})}
ref={tooltipElRef}
data-direction={calculatedDirection}
{...rest}
Expand Down
Loading