Skip to content

Add fallback for tooltip internal state handling when onTransitionEnd never fires #1145

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.

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 2 commits into from
Dec 27, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
8 changes: 0 additions & 8 deletions docs/docs/examples/styling.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -446,14 +446,6 @@ In summary, if you do it correctly you can use CSS specificity instead of `!impo
By default, the tooltip has a fade-in/fade-out transition when opening/closing, with a delay of 150ms for both.
If you wish to change the delay for any of them, override the following CSS variables:

:::caution

Do not set `--rt-transition-closing-delay` to `0`. Doing so will result in the tooltip component being stuck (but not visible) on the DOM. This isn't itself a problem, but may lead to performance issues.

Set to `1ms` or a similar value if you want to disable the fade-out transition when closing.

:::

```css
:root {
--rt-transition-show-delay: 0.15s;
Expand Down
24 changes: 20 additions & 4 deletions src/components/Tooltip/Tooltip.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ import { useTooltip } from 'components/TooltipProvider'
import useIsomorphicLayoutEffect from 'utils/use-isomorphic-layout-effect'
import { getScrollParent } from 'utils/get-scroll-parent'
import { computeTooltipPosition } from 'utils/compute-positions'
import { cssTimeToMs } from 'utils/css-time-to-ms'
import coreStyles from './core-styles.module.css'
import styles from './styles.module.css'
import type {
Expand Down Expand Up @@ -67,6 +68,7 @@ const Tooltip = ({
const tooltipArrowRef = useRef<HTMLElement>(null)
const tooltipShowDelayTimerRef = useRef<NodeJS.Timeout | null>(null)
const tooltipHideDelayTimerRef = useRef<NodeJS.Timeout | null>(null)
const missedTransitionTimerRef = useRef<NodeJS.Timeout | null>(null)
const [actualPlacement, setActualPlacement] = useState(place)
const [inlineStyles, setInlineStyles] = useState({})
const [inlineArrowStyles, setInlineArrowStyles] = useState({})
Expand Down Expand Up @@ -211,13 +213,28 @@ const Tooltip = ({
if (show === wasShowing.current) {
return
}
if (missedTransitionTimerRef.current) {
clearTimeout(missedTransitionTimerRef.current)
}
wasShowing.current = show
if (show) {
afterShow?.()
} else {
/**
* see `onTransitionEnd` on tooltip wrapper
*/
const style = getComputedStyle(document.body)
const transitionShowDelay = cssTimeToMs(style.getPropertyValue('--rt-transition-show-delay'))
missedTransitionTimerRef.current = setTimeout(() => {
/**
* if the tooltip switches from `show === true` to `show === false` too fast
* the transition never runs, so `onTransitionEnd` callback never gets fired
*/
setRendered(false)
setImperativeOptions(null)
afterHide?.()
// +25ms just to make sure `onTransitionEnd` (if it gets fired) has time to run
}, transitionShowDelay + 25)
}
}, [show])

Expand Down Expand Up @@ -803,10 +820,9 @@ const Tooltip = ({
clickable && coreStyles['clickable'],
)}
onTransitionEnd={(event: TransitionEvent) => {
/**
* @warning if `--rt-transition-closing-delay` is set to 0,
* the tooltip will be stuck (but not visible) on the DOM
*/
if (missedTransitionTimerRef.current) {
clearTimeout(missedTransitionTimerRef.current)
}
if (show || event.propertyName !== 'opacity') {
return
}
Expand Down
11 changes: 11 additions & 0 deletions src/utils/css-time-to-ms.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
export const cssTimeToMs = (time: string): number => {
const match = time.match(/^([\d.]+)(m?s?)$/)
if (!match) {
return 0
}
const [, amount, unit] = match
if (unit !== 's' && unit !== 'ms') {
return 0
}
return Number(amount) * (unit === 'ms' ? 1 : 1000)
}