Skip to content

fix: improve accessibility of rich in-app messages #157

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

Merged
merged 3 commits into from
Jun 8, 2022
Merged

fix: improve accessibility of rich in-app messages #157

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
08788bc
fix: focus iframe content window on load
gyoshev Jun 8, 2022
0fbcf39
fix: add title to iframe element
gyoshev Jun 8, 2022
a3b2d63
style: lint
gyoshev Jun 8, 2022
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
2 changes: 2 additions & 0 deletions src/Messages.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -294,6 +294,7 @@ export default class Messages {
} else {
iframe.style.top = '0'
}
iframe.contentWindow.focus()

context.track()
break
Expand Down Expand Up @@ -339,6 +340,7 @@ export default class Messages {
const vars = JSON.stringify(options.message)
const iframe = document.createElement('iframe') as MessageFrame
iframe.setAttribute('id', `lp-message-${messageId}`)
iframe.setAttribute('title', 'Popup')
iframe.style.cssText = [
'border-width: 0',
'position: fixed',
Expand Down
9 changes: 7 additions & 2 deletions test/specs/Messages.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1189,11 +1189,12 @@ describe(Messages, () => {
})

it("shows the message on loadFinished events", () => {
const renderedMessage = createMockMessageRender()
const renderedMessage = createMockMessageRender() as any

messages.processMessageEvent("123", "http://leanplum/loadFinished")

expect(renderedMessage.style.visibility).toEqual("visible")
expect(renderedMessage.contentWindow.focus).toHaveBeenCalledTimes(1)
})

it("removes the message on close events", () => {
Expand Down Expand Up @@ -1250,7 +1251,10 @@ describe(Messages, () => {
expect(renderedMessage.style.top).toEqual("")
})

type RenderedMessage = HTMLElement & { metadata: any }
type RenderedMessage = HTMLElement & {
metadata: any,
contentWindow: Window
}

function createMockMessageRender(message: any = {}): RenderedMessage {
const renderedMessage = document.createElement('a') as unknown as RenderedMessage
Expand All @@ -1266,6 +1270,7 @@ describe(Messages, () => {
runTrackedActionNamed: jest.fn()
}
}
jest.spyOn(renderedMessage.contentWindow, 'focus').mockImplementation(() => { /* noop */ })
jest.spyOn(document, 'getElementById').mockReturnValue(renderedMessage)

return renderedMessage
Expand Down