CODEWITHSUNDEEP
javascriptreactjsjestjsjsdomreact-testing-library
evolutionxbox
evolutionxbox

Reputation: 4122

Tab keypress doesn't change focused element

Note: this isn't about simulating the keypress itself

I'm creating a component which handles focus based on user keyboard events (like pressing enter, arrows, etc).

It'd be preferable to test that the component ignores the tab key on keydown.

However, on firing the keydown tab event, the focus doesn't change like it would in a browser.

Given the react component in Component.js

import React from 'react'

export default () => (
  <>
    <button data-testid="one">
      one
    </button>
    <button data-testid="two">
      two
    </button>
  </>
)

and the following test Component.test.js

import React from 'react'
import 'jest-dom/extend-expect'
import { cleanup, fireEvent, render, wait } from 'react-testing-library'
import Component from './Component'

afterEach(cleanup)

it('changes focus on tab', async () => {
  const { getByTestId } = render(<Component />)
  const one = getByTestId('one')
  const two = getByTestId('two')

  one.focus()

  expect(one).toHaveFocus()

  fireEvent.keyDown(one, {
    key: 'Tab',
    code: 9,
    charCode: 9
  })

  await wait(() => {
    expect(two).toHaveFocus()
  })
})

the test fails, as the element data-testid="one" still has focus.

See CodeSandbox for an editable version of this code

Upvotes: 9

Views: 16528

Answers (2)

Dobby Dimov
Dobby Dimov

Reputation: 1032

A working solution nowadays would be to use userEvent.tab() instead of fireEvent.keyDown().

import '@testing-library/jest-dom'
import userEvent from '@testing-library/user-event'

import { render, screen } from '@testing-library/react'
import Component from './buttons'

it('changes focus on tab', async () => {
  render(<Component />)
  const one = screen.getByTestId('one')
  const two = screen.getByTestId('two')

  one.focus()
  expect(one).toHaveFocus()

  await userEvent.tab()
  expect(two).toHaveFocus()
})

Upvotes: 12

the_haystacker
the_haystacker

Reputation: 1625

You can simply do this with react-testing-library itself. All you have to do is this:

Use the fireEvent.blur(<your-input-element-here>)

import { fireEvent } from '@testing-library/react';

it('changes focus on tab', async () => {
  render(<Component />)
  const one = screen.getByTestId('one')
  const two = screen.getByTestId('two')

  // fires the onBlur event
  fireEvent.blur(one)

  expect(one).not.toHaveFocus()
})

Upvotes: -1

Related Questions