react-hooks-testing-library

Simple and complete React hooks testing utilities that encourage good testing practices.

Read The Docs

You're writing an awesome custom hook and you want to test it, but as soon as you call it you see the following error:

Invariant Violation: Hooks can only be called inside the body of a function component.

You don't really want to write a component solely for testing this hook and have to work out how you were going to trigger all the various ways the hook can be updated, especially given the complexities of how you've wired the whole thing together.

The react-hooks-testing-library allows you to create a simple test harness for React hooks that handles running them within the body of a function component, as well as providing various useful utility functions for updating the inputs and retrieving the outputs of your amazing custom hook. This library aims to provide a testing experience as close as possible to natively using your hook from within a real component.

Using this library, you do not have to concern yourself with how to construct, render or interact with the react component in order to test your hook. You can just use the hook directly and assert the results.

1. You're writing a library with one or more custom hooks that are not directly tied a component
2. You have a complex hook that is difficult to test through component interactions

1. Your hook is defined along side a component and is only used there
2. Your hook is easy to test by just testing the components using it

import { useState, useCallback } from 'react'

function useCounter() {
  const [count, setCount] = useState(0)

  const increment = useCallback(() => setCount((x) => x + 1), [])

  return { count, increment }
}

export default useCounter

import { renderHook, act } from '@testing-library/react-hooks'
import useCounter from './useCounter'

test('should increment counter', () => {
  const { result } = renderHook(() => useCounter())

  act(() => {
    result.current.increment()
  })

  expect(result.current.count).toBe(1)
})

More advanced usage can be found in the documentation.

npm install --save-dev @testing-library/react-hooks

react-hooks-testing-library does not come bundled with a version of react or react-test-renderer to allow you to install the specific version you want to test against. Generally, the installed versions for react and react-test-renderer should have matching versions:

npm install react@^16.9.0
npm install --save-dev react-test-renderer@^16.9.0

NOTE: The minimum supported version of react and react-test-renderer is ^16.9.0.

See the API reference.

Thanks goes to these wonderful people (emoji key):

Michael Peyper 💻 🎨 📖 🤔 🚇 📦 ⚠️ 🔧	otofu-square 💻	Patrick P. Henley 🤔 👀	Matheus Marques 💻	Dhruv Patel 🐛 👀	Nathaniel Tucker 🐛 👀	Sergei Grishchenko 💻 📖 🤔
Josep M Sobrepere 📖	Marcel Tinner 📖	Daniel K. 🐛 💻	Vince Malone 💻	Sebastian Weber 📝	Christian Gill 📖

This project follows the all-contributors specification. Contributions of any kind welcome!

Looking to contribute? Look for the Good First Issue label.

Please file an issue for bugs, missing documentation, or unexpected behavior.

See Bugs

Please file an issue to suggest new features. Vote on feature requests by adding a 👍. This helps maintainers prioritize what to work on.

See Feature Requests

For questions related to using the library, you can raise issue here, or visit a support community:

• Reactiflux on Discord
• Stack Overflow

MIT