diff --git a/.changeset/fix-tooltip-callback-ref.md b/.changeset/fix-tooltip-callback-ref.md new file mode 100644 index 00000000000..896dcc6795c --- /dev/null +++ b/.changeset/fix-tooltip-callback-ref.md @@ -0,0 +1,5 @@ +--- +'@primer/react': patch +--- + +Tooltip: Support callback refs on Tooltip trigger diff --git a/packages/react/src/TooltipV2/__tests__/Tooltip.test.tsx b/packages/react/src/TooltipV2/__tests__/Tooltip.test.tsx index b543c0c3d3d..59000a9286b 100644 --- a/packages/react/src/TooltipV2/__tests__/Tooltip.test.tsx +++ b/packages/react/src/TooltipV2/__tests__/Tooltip.test.tsx @@ -3,7 +3,7 @@ import {describe, expect, it, vi} from 'vitest' import {page, userEvent} from 'vitest/browser' import type {TooltipProps} from '../Tooltip' import {Tooltip} from '../Tooltip' -import {act, fireEvent, render as HTMLRender} from '@testing-library/react' +import {act, fireEvent, render as HTMLRender, waitFor} from '@testing-library/react' import BaseStyles from '../../BaseStyles' import {Button, IconButton} from '../../Button' import {ActionMenu} from '../../ActionMenu' @@ -422,6 +422,45 @@ describe('Tooltip forwarded ref', () => { expect(refCallback).toHaveBeenCalledWith(button.element()) }) + it('calls a callback ref with the trigger element and opens the tooltip as expected', async () => { + const refCallback = vi.fn() + const {getByRole, getByText} = HTMLRender( + + + , + ) + const button = getByRole('button') + const tooltip = getByText('Tooltip text') + + expect(refCallback).toHaveBeenCalledWith(button) + expect(tooltip.matches(':popover-open')).toBe(false) + + fireEvent.mouseOver(button) + await waitFor(() => expect(tooltip.matches(':popover-open')).toBe(true)) + }) + + it('supports callback ref with side effects without interfering with tooltip trigger', async () => { + let sideEffectExecuted = false + const callbackRefWithSideEffect = (node: HTMLButtonElement | null) => { + if (node) { + sideEffectExecuted = true + } + } + + const {getByRole, getByText} = HTMLRender( + + + , + ) + const button = getByRole('button') + const tooltip = getByText('Tooltip text') + + expect(sideEffectExecuted).toBe(true) + expect(tooltip.matches(':popover-open')).toBe(false) + fireEvent.mouseOver(button) + await waitFor(() => expect(tooltip.matches(':popover-open')).toBe(true)) + }) + it("preserves trigger element's own ref", () => { const buttonRefCallback = vi.fn()