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.

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

Jump to bottom

Implement key press functionality from a user perspective #371

Closed
wants to merge 1 commit into from
Closed

Implement key press functionality from a user perspective #371

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
264 changes: 264 additions & 0 deletions src/__tests__/key-press.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,264 @@
import userEvent from '../'
import {setup} from './helpers/utils'

test('presses arrow keys on active element', () => {
const {element, getEventSnapshot} = setup('<div tabindex="0"/>')
userEvent.click(element)
userEvent.keyPress('ArrowDown')
userEvent.keyPress('ArrowLeft')
userEvent.keyPress('ArrowRight')
userEvent.keyPress('ArrowUp')
expect(getEventSnapshot()).toMatchInlineSnapshot(`
Events fired on: div

div - pointerover
div - pointerenter
div - mouseover: Left (0)
div - mouseenter: Left (0)
div - pointermove
div - mousemove: Left (0)
div - pointerdown
div - mousedown: Left (0)
div - focus
div - focusin
div - pointerup
div - mouseup: Left (0)
div - click: Left (0)
div - keydown: ArrowDown (0)
div - keyup: ArrowDown (0)
div - keydown: ArrowLeft (0)
div - keyup: ArrowLeft (0)
div - keydown: ArrowRight (0)
div - keyup: ArrowRight (0)
div - keydown: ArrowUp (0)
div - keyup: ArrowUp (0)
`)
})

test('presses home and end keys on active element', () => {
const {element, getEventSnapshot} = setup('<div tabindex="0"/>')
userEvent.click(element)
userEvent.keyPress('Home')
userEvent.keyPress('End')
expect(getEventSnapshot()).toMatchInlineSnapshot(`
Events fired on: div

div - pointerover
div - pointerenter
div - mouseover: Left (0)
div - mouseenter: Left (0)
div - pointermove
div - mousemove: Left (0)
div - pointerdown
div - mousedown: Left (0)
div - focus
div - focusin
div - pointerup
div - mouseup: Left (0)
div - click: Left (0)
div - keydown: Home (0)
div - keyup: Home (0)
div - keydown: End (0)
div - keyup: End (0)
`)
})

test('presses page up and page down keys on active element', () => {
const {element, getEventSnapshot} = setup('<div tabindex="0"/>')
userEvent.click(element)
userEvent.keyPress('PageUp')
userEvent.keyPress('PageDown')
expect(getEventSnapshot()).toMatchInlineSnapshot(`
Events fired on: div

div - pointerover
div - pointerenter
div - mouseover: Left (0)
div - mouseenter: Left (0)
div - pointermove
div - mousemove: Left (0)
div - pointerdown
div - mousedown: Left (0)
div - focus
div - focusin
div - pointerup
div - mouseup: Left (0)
div - click: Left (0)
div - keydown: PageUp (0)
div - keyup: PageUp (0)
div - keydown: PageDown (0)
div - keyup: PageDown (0)
`)
})

test('presses printable characters on active element', () => {
const {element, getEventSnapshot} = setup('<div tabindex="0"/>')
userEvent.click(element)
userEvent.keyPress('A')
expect(getEventSnapshot()).toMatchInlineSnapshot(`
Events fired on: div

div - pointerover
div - pointerenter
div - mouseover: Left (0)
div - mouseenter: Left (0)
div - pointermove
div - mousemove: Left (0)
div - pointerdown
div - mousedown: Left (0)
div - focus
div - focusin
div - pointerup
div - mouseup: Left (0)
div - click: Left (0)
div - keydown: A (0)
div - keypress: A (0)
div - keyup: A (0)
`)
})

test('presses key with alt modifier on active element', () => {
const {element, getEventSnapshot} = setup('<div tabindex="0"/>')
userEvent.click(element)
userEvent.keyPress('ArrowDown', {alt: true})
expect(getEventSnapshot()).toMatchInlineSnapshot(`
Events fired on: div

div - pointerover
div - pointerenter
div - mouseover: Left (0)
div - mouseenter: Left (0)
div - pointermove
div - mousemove: Left (0)
div - pointerdown
div - mousedown: Left (0)
div - focus
div - focusin
div - pointerup
div - mouseup: Left (0)
div - click: Left (0)
div - keydown: Alt (0)
div - keydown: ArrowDown (0) {alt}
div - keyup: ArrowDown (0) {alt}
div - keyup: Alt (0)
`)
})

test('presses key with ctrl modifier on active element', () => {
const {element, getEventSnapshot} = setup('<div tabindex="0"/>')
userEvent.click(element)
userEvent.keyPress('ArrowDown', {ctrl: true})
expect(getEventSnapshot()).toMatchInlineSnapshot(`
Events fired on: div

div - pointerover
div - pointerenter
div - mouseover: Left (0)
div - mouseenter: Left (0)
div - pointermove
div - mousemove: Left (0)
div - pointerdown
div - mousedown: Left (0)
div - focus
div - focusin
div - pointerup
div - mouseup: Left (0)
div - click: Left (0)
div - keydown: Ctrl (0)
div - keydown: ArrowDown (0) {ctrl}
div - keyup: ArrowDown (0) {ctrl}
div - keyup: Ctrl (0)
`)
})

test('presses key with meta modifier on active element', () => {
const {element, getEventSnapshot} = setup('<div tabindex="0"/>')
userEvent.click(element)
userEvent.keyPress('ArrowDown', {meta: true})
expect(getEventSnapshot()).toMatchInlineSnapshot(`
Events fired on: div

div - pointerover
div - pointerenter
div - mouseover: Left (0)
div - mouseenter: Left (0)
div - pointermove
div - mousemove: Left (0)
div - pointerdown
div - mousedown: Left (0)
div - focus
div - focusin
div - pointerup
div - mouseup: Left (0)
div - click: Left (0)
div - keydown: Meta (0)
div - keydown: ArrowDown (0) {meta}
div - keyup: ArrowDown (0) {meta}
div - keyup: Meta (0)
`)
})

test('presses key with shift modifier on active element', () => {
const {element, getEventSnapshot} = setup('<div tabindex="0"/>')
userEvent.click(element)
userEvent.keyPress('ArrowDown', {shift: true})
expect(getEventSnapshot()).toMatchInlineSnapshot(`
Events fired on: div

div - pointerover
div - pointerenter
div - mouseover: Left (0)
div - mouseenter: Left (0)
div - pointermove
div - mousemove: Left (0)
div - pointerdown
div - mousedown: Left (0)
div - focus
div - focusin
div - pointerup
div - mouseup: Left (0)
div - click: Left (0)
div - keydown: Shift (0)
div - keydown: ArrowDown (0) {shift}
div - keyup: ArrowDown (0) {shift}
div - keyup: Shift (0)
`)
})

test('presses key with all modifiers on active element', () => {
const {element, getEventSnapshot} = setup('<div tabindex="0"/>')
userEvent.click(element)
userEvent.keyPress('ArrowDown', {
alt: true,
ctrl: true,
meta: true,
shift: true,
})
expect(getEventSnapshot()).toMatchInlineSnapshot(`
Events fired on: div

div - pointerover
div - pointerenter
div - mouseover: Left (0)
div - mouseenter: Left (0)
div - pointermove
div - mousemove: Left (0)
div - pointerdown
div - mousedown: Left (0)
div - focus
div - focusin
div - pointerup
div - mouseup: Left (0)
div - click: Left (0)
div - keydown: Alt (0)
div - keydown: Ctrl (0)
div - keydown: Meta (0)
div - keydown: Shift (0)
div - keydown: ArrowDown (0) {alt}{shift}{meta}{ctrl}
div - keyup: ArrowDown (0) {alt}{shift}{meta}{ctrl}
div - keyup: Shift (0)
div - keyup: Meta (0)
div - keyup: Ctrl (0)
div - keyup: Alt (0)
`)
})
2 changes: 2 additions & 0 deletions src/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ import {hover, unhover} from './hover'
import {upload} from './upload'
import {selectOptions, deselectOptions} from './select-options'
import {paste} from './paste'
import {keyPress} from './key-press'

const userEvent = {
click,
Expand All @@ -19,6 +20,7 @@ const userEvent = {
selectOptions,
deselectOptions,
paste,
keyPress,
}

export default userEvent
36 changes: 36 additions & 0 deletions src/key-press.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
import {fireEvent} from '@testing-library/dom'
import {getActiveElement} from './utils'

function isPrintableCharacter(key) {
return key.length === 1
}

function keyPress(
key,
{alt = false, ctrl = false, meta = false, shift = false} = {},
) {
const activeElement = getActiveElement(document)

const event = {
key,
altKey: alt,
ctrlKey: ctrl,
metaKey: meta,
shiftKey: shift,
}

if (alt) fireEvent.keyDown(activeElement, {key: 'Alt'})
if (ctrl) fireEvent.keyDown(activeElement, {key: 'Ctrl'})
if (meta) fireEvent.keyDown(activeElement, {key: 'Meta'})
if (shift) fireEvent.keyDown(activeElement, {key: 'Shift'})

fireEvent.keyDown(activeElement, event)
if (isPrintableCharacter(key)) fireEvent.keyPress(activeElement, event)
fireEvent.keyUp(activeElement, event)

if (shift) fireEvent.keyUp(activeElement, {key: 'Shift'})
if (meta) fireEvent.keyUp(activeElement, {key: 'Meta'})
if (ctrl) fireEvent.keyUp(activeElement, {key: 'Ctrl'})
if (alt) fireEvent.keyUp(activeElement, {key: 'Alt'})
}
export {keyPress}