Skip to content

feat: Upgrade to 3.8.1 with tooltip updates #2962

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

Closed
werdnanoslen wants to merge 3 commits into from
Closed

feat: Upgrade to 3.8.1 with tooltip updates #2962

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c9e4973
Make tooltip content hoverable
werdnanoslen Jun 24, 2024
b4fc992
upgrade uswds
werdnanoslen Jun 24, 2024
35d84e2
Make tooltip dismissible with escape key
werdnanoslen Jun 24, 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
4 changes: 2 additions & 2 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@
},
"homepage": "https://github.com/trussworks/react-uswds#readme",
"peerDependencies": {
"@uswds/uswds": "^3.7.1",
"@uswds/uswds": "^3.8.1",
"focus-trap-react": "^10.2.3",
"react": "^16.x || ^17.x || ^18.x",
"react-dom": "^16.x || ^17.x || ^18.x"
Expand Down Expand Up @@ -98,7 +98,7 @@
"@types/react-test-renderer": "^18.0.7",
"@typescript-eslint/eslint-plugin": "^7.0.0",
"@typescript-eslint/parser": "^7.1.1",
"@uswds/uswds": "3.7.1",
"@uswds/uswds": "3.8.1",
"@vitejs/plugin-react": "^4.2.1",
"@vitest/coverage-istanbul": "^1.2.1",
"all-contributors-cli": "^6.24.0",
Expand Down
9 changes: 7 additions & 2 deletions src/components/Tooltip/Tooltip.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ describe('Tooltip component', () => {
expect(bodyEl).toHaveClass('is-visible')
expect(bodyEl).toHaveAttribute('aria-hidden', 'false')

fireEvent.mouseLeave(screen.getByTestId('triggerElement'))
fireEvent.mouseLeave(screen.getByTestId('tooltipWrapper'))
expect(bodyEl).not.toHaveClass('is-visible')
expect(bodyEl).toHaveAttribute('aria-hidden', 'true')
})
Expand Down Expand Up @@ -110,14 +110,19 @@ describe('Tooltip component', () => {
expect(bodyEl).toHaveAttribute('aria-hidden', 'true')
})

it('hides tooltip on keydown after focus', () => {
it('hides tooltip on Escape keydown after focus', () => {
render(<Tooltip label="Click me">My Tooltip</Tooltip>)
const bodyEl = screen.queryByRole('tooltip', { hidden: true })

fireEvent.focus(screen.getByTestId('triggerElement'))
expect(bodyEl).toHaveClass('is-visible')
expect(bodyEl).toHaveAttribute('aria-hidden', 'false')

fireEvent.keyDown(screen.getByTestId('triggerElement'), { key: 'a' })

expect(bodyEl).toHaveClass('is-visible')
expect(bodyEl).not.toHaveAttribute('aria-hidden', 'true')

fireEvent.keyDown(screen.getByTestId('triggerElement'), { key: 'Escape' })

expect(bodyEl).not.toHaveClass('is-visible')
Expand Down
19 changes: 13 additions & 6 deletions src/components/Tooltip/Tooltip.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -189,6 +189,9 @@ export function Tooltip<
const hideTooltip = (): void => {
setVisible(false)
}
const escapeTooltip = (e: React.KeyboardEvent<HTMLButtonElement>): void => {
if (e.key === 'Escape') hideTooltip()
}

const wrapperClasses = classnames('usa-tooltip', wrapperclasses)

Expand Down Expand Up @@ -220,16 +223,18 @@ export function Tooltip<
onMouseEnter: showTooltip,
onMouseOver: showTooltip,
onFocus: showTooltip,
onMouseLeave: hideTooltip,
onBlur: hideTooltip,
onKeyDown: hideTooltip,
onKeyDown: escapeTooltip,
className: triggerClasses,
},
children
)

return (
<span data-testid="tooltipWrapper" className={wrapperClasses}>
<span
data-testid="tooltipWrapper"
className={wrapperClasses}
onMouseLeave={hideTooltip}>
{triggerElement}
<span
data-testid="tooltipBody"
Expand All @@ -254,7 +259,10 @@ export function Tooltip<
)

return (
<span data-testid="tooltipWrapper" className={wrapperClasses}>
<span
data-testid="tooltipWrapper"
className={wrapperClasses}
onMouseLeave={hideTooltip}>
<button
{...remainingProps}
data-testid="triggerElement"
Expand All @@ -267,9 +275,8 @@ export function Tooltip<
onMouseEnter={showTooltip}
onMouseOver={showTooltip}
onFocus={showTooltip}
onMouseLeave={hideTooltip}
onBlur={hideTooltip}
onKeyDown={hideTooltip}>
onKeyDown={escapeTooltip}>
{children}
</button>
<span
Expand Down
8 changes: 4 additions & 4 deletions yarn.lock
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3301,10 +3301,10 @@
resolved "https://registry.yarnpkg.com/@ungap/structured-clone/-/structured-clone-1.2.0.tgz#756641adb587851b5ccb3e095daf27ae581c8406"
integrity sha512-zuVdFrMJiuCDQUMCzQaD6KL28MjnqqN8XnAqiEq9PNm/hCPTSGfrXCOfwj1ow4LFb/tNymJPwsNbVePc1xFqrQ==

"@uswds/uswds@3.7.1":
version "3.7.1"
resolved "https://registry.yarnpkg.com/@uswds/uswds/-/uswds-3.7.1.tgz#455dee2d7a9c7b316192bb2e21ecd0df6fad3085"
integrity sha512-32u2S50bf5dwIujebqL+f1Jgx2rmRrpxcaccSZzdo3Qv9HaDUdcmeavlrxHqN30edHc7p8kRPjvjevOmOJKB7w==
"@uswds/uswds@3.8.1":
version "3.8.1"
resolved "https://registry.yarnpkg.com/@uswds/uswds/-/uswds-3.8.1.tgz#3d834559498ae1bb7d3a618f3f85a5f4e9818497"
integrity sha512-bKG/B9mJF1v0yoqth48wQDzST5Xyu3OxxpePIPDyhKWS84oDrCehnu3Z88JhSjdIAJMl8dtjtH8YvdO9kZUpAg==
dependencies:
classlist-polyfill "1.2.0"
object-assign "4.1.1"
Expand Down