• Home
  • Blog
  • Projects
  • Bookshelf
  • About
← Back to all posts

React Testing Library: Checkboxes and events

Published ....
Last modified ....

Share this post on BlueskySee discussion on Bluesky


TL;DR

If you're testing a checkbox input element with React Testing Library, you'll want to fire a click event on the checkbox not a change event!

Read on to find out how I discovered this!

I was recently refactoring about 70 individual Enzyme-based unit tests across our design system codebase at work to swap it for React Testing Library, and encountered an odd quirk that I figured I'd document on my blog.

I was converting some tests for one of our Checkbox Table components, a component that allows users to select individual rows or the entire page of results shown within a table. The previous tests were quite extensive, the entire file was well over 1200 lines of code covering many different and difficult edge cases.

As I went through I converted one of the tests that was asserting on an onChange handler being properly called when one of the checkboxes was selected, the previous test code looked something like:

const handleChange = jest.fn();






const wrapper = mount(<CheckboxTable onChange={handleChange} />);
wrapper
.find(`[data-enzyme-id="header-checkbox"]`)
.simulate("change", { target: { checked: true } });
expect(handleChange).toHaveBeenCalledTimes(1);

So I started converting as I had other tests within the codebase:

const handleChange = jest.fn();
render(<CheckboxTable onChange={handleChange} />);

fireEvent.change(screen.getByTestId("header-checkbox"), {
  target: { checked: true },
});

expect(handleChange).toHaveBeenCalledTimes(1);

However, the test started failing!

I started scratching my head after debugging this for about 30 minutes without making much traction on the failing test, in fact I was about to comment the test out and return to it in a follow up ticket but then I did one last google search and stumbled upon this stackoverflow result, linked from there was this issue comment noting that for checkbox elements, we actually want to fire a click event instead of a change event!

So I went back to my test and updated it one last time to the following:

const handleChange = jest.fn();
render(<CheckboxTable onChange={handleChange} />);

fireEvent.click(screen.getByTestId("header-checkbox"));

expect(handleChange).toHaveBeenCalledTimes(1);

and the test started passing!


Tags:

DevelopmentReact Testing LibraryReact

Loading...

Related Posts

Development

Website Redesign v11

....

I've once again updated my personal website, this time powered by my own RSC framework and a custom CMS solution as well!

Onboarding Your New AI Teammate

....

Are we reinventing the wheel when it comes to onboarding new AI agents to a codebase, when we already have primitives available for onboarding humans?

Tip: GitHub Created Date Filtering

....

Progressive Identifiers

....

Roundup Notes in Obsidian with Dataview

....

A quick tip for creating roundup or summary notes based on other notes in Obsidian using the Dataview plugin!

Quick Tip - Theme Aware Images

....

Have you ever found the need to change the image you render on a web page based on the current preferred color scheme of your theme?

Website Redesign v10

....

I recently launched a rewrite and redesign of this personal website, I figured I'd talk a bit about the changes and new features that I added along the way!

Quick Tip - Specific Local Module Declarations

....

A quick tip outlining how to provide specific TypeScript type definitions for a local module!

You're Building Software Wrong

....

Slicing software: why vertical is better than horizontal.

Single File Web Apps

....

What if you could author an entire web application in a single file?

The AI Development Conundrum

....

Is it a good or a bad thing to offload writing code to AI agents and Large Language Models?

A Quick Look at Import Maps

....

A brief look at Import Maps and package.json#imports to support isomorphic JavaScript applications!

Recommended Tech Talks

....

A collection of tech talks that I regularly re-watch and also recommend to everyone!

Request for a (minimal) RSC Framework

....

Some features and functionality that I'd like within a React Server Component compatible framework.

Bluesky Tips and Tools

....

A (running) collection of Bluesky tips, tools, packages, and other misc things!

Building a Custom Ghostty Theme

....

How to generate a custom Ghostty theme based on any iterm2 theme!

Offload Complexity, Don't Offload Learning

....

A rough mental model for how you should be leveraging AI as a tool for your own growth

More Thoughts on Dogfooding

....

Even more thoughts on dogfooding!

Dogfooding

....

The secret to excellent product teams is using your own product, and often!

Git Notes as a Tool for Thought

....

(Ab)using Git as yet another tool for thought!

My Current Dev Setup

....

A quick look at the applications and tools that I (generally) use day to day for web development!

Tip: Request and Response Headers

....

There's a common gotcha when creating Web Request and Response instances with Headers!

Using Feature Toggles to De-risk Refactors

....

Feature toggles are often underused by most software development teams, and yet offer so much value during not only feature development but also refactors

Hohoro

....

A quick introduction to my new side project, hohoro. An incremental JS/TS library build tool!

Funport: True Dynamic Imports in webpack

....

webpack, and tools built on it like Next.js, don't support true dynamic imports, but I found a way to trick the system!

My Current AI Stack

....

I've been using a variety of AI tools as of late, I figured I'd document the ones I'm primarily using!

Configuring Cloudflare Domains with Vercel

....

I've started to use Cloudflare to manage my domains for several side projects, have had to jump through the same hooks multiple times that I figured I should document them here!

React Error Boundaries: Revisited

....

Revising my previous blog post on React Error Boundaries and my preferred go-to implementation!

Custom Favicon Recipes

....

Two neat tricks for enhancing your site's favicon!

Corporate Sponsored OSS

....

The various risks and pitfalls of open source software run by corporations.

The Library-Docs Monorepo Template

....

A monorepo template for managing a library and documentation together.

Building Better Beacon

....

How we solved an almost show-stopping production bug, and how you can avoid it in your own projects.

Churn Anxiety

....

When did semver major changes become so scary?

Stop Snacking

....

No I don't mean those Milano cookies you keep taking from the office snack wall either (although you should probably stop snacking on those as often as well).

Pair Programming

....

Pair programming can be good sometimes - but not all the time

Taking a Break

....

A few quick thoughts on burn out and taking a break

React

Multi-step Native HTML Forms

....

useInterval

....

Server Side Rendering Compatible CSS Theming

....

A quick tip to implementing CSS theming that's compatible with Server Side Rendered applications!

Resetting Controlled Components in Forms

....

A quick way to handle resetting internal state in components when a parent form is submitted!

Request for a (minimal) RSC Framework

....

Some features and functionality that I'd like within a React Server Component compatible framework.

Don't Break the Implicit Prop Contract

....

React components have a fundamental contract that is often unstated in their implementation, and you should know about it!

A Better useSSR Implementation

....

Replace that old useState and useEffect combo for a new and better option!

React Error Boundaries: Revisited

....

Revising my previous blog post on React Error Boundaries and my preferred go-to implementation!

Suspense Plus GraphQL

....

A few thoughts on using Suspense with GraphQL to optimize application data loading

Managing Complex UI Component State

....

A few thoughts on managing complex UI component state within React

Understanding React 16.3 Updates

....

A quick overview of the new lifecycle methods introduced in React 16.3