Skip to content
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

bug: ensure Announce components work without pre-existing text node #5568

Merged
merged 6 commits into from
Jan 22, 2025
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
5 changes: 5 additions & 0 deletions .changeset/afraid-pianos-invent.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"@primer/react": patch
---

bug: ensure Announce components work without pre-existing text node
1 change: 1 addition & 0 deletions packages/react/src/live-region/Announce.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -108,6 +108,7 @@ export function Announce({
observer.observe(container, {
subtree: true,
characterData: true,
childList: true,
})

return () => {
Expand Down
29 changes: 29 additions & 0 deletions packages/react/src/live-region/__tests__/AriaAlert.test.tsx
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
import {render, screen} from '@testing-library/react'
import React from 'react'
import {AriaAlert} from '../AriaAlert'
import {userEvent} from '@testing-library/user-event'
import {getLiveRegion} from '../../utils/testing'

describe('AriaAlert', () => {
Expand Down Expand Up @@ -46,4 +47,32 @@ describe('AriaAlert', () => {
)
expect(screen.getByTestId('container').tagName).toBe('SPAN')
})

it('should update live-region element when AriaAlert goes from empty to populated', async () => {
function TestComponent() {
const [show, setShow] = React.useState(false)
return (
<>
<AriaAlert>{show ? 'Failed to export data!' : null}</AriaAlert>
<button
type="button"
onClick={() => {
setShow(true)
}}
>
Export data
</button>
</>
)
}
const user = userEvent.setup()

render(<TestComponent />)

const liveRegion = getLiveRegion()
expect(liveRegion.getMessage('assertive')).toBe('')

await user.click(screen.getByText('Export data'))
expect(liveRegion.getMessage('assertive')).toBe('Failed to export data!')
})
})
28 changes: 28 additions & 0 deletions packages/react/src/live-region/__tests__/AriaStatus.test.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -83,4 +83,32 @@ describe('AriaStatus', () => {
)
expect(screen.getByTestId('container').tagName).toBe('SPAN')
})

it('should update live-region element when AriaStatus goes from empty to populated', async () => {
function TestComponent() {
const [show, setShow] = React.useState(false)
return (
<>
<AriaStatus>{show ? 'Export completed' : null}</AriaStatus>
<button
type="button"
onClick={() => {
setShow(true)
}}
>
Export data
</button>
</>
)
}
const user = userEvent.setup()

render(<TestComponent />)

const liveRegion = getLiveRegion()
expect(liveRegion.getMessage('polite')).toBe('')

await user.click(screen.getByText('Export data'))
expect(liveRegion.getMessage('polite')).toBe('Export completed')
})
})
Loading