Skip to content
Open
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
5 changes: 5 additions & 0 deletions .changeset/fix-tooltip-callback-ref.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@primer/react': patch
---

Tooltip: Support callback refs on Tooltip trigger
41 changes: 40 additions & 1 deletion packages/react/src/TooltipV2/__tests__/Tooltip.test.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -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'
Expand Down Expand Up @@ -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(
<Tooltip text="Tooltip text" ref={refCallback}>
<Button>Button Text</Button>
</Tooltip>,
)
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(
<Tooltip text="Tooltip text" ref={callbackRefWithSideEffect}>
<Button>Button Text</Button>
</Tooltip>,
)
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()

Expand Down
Loading