React Testing Library integration in NextJS - Mini Project: Build & Apply

React Testing Library integration

📖 Scenario: You are building a simple Next.js app with a button that toggles a message. You want to write a test to check if the message appears when the button is clicked.

🎯 Goal: Create a React component with a button and a message that shows or hides on click. Then write a test using React Testing Library to verify the toggle behavior.

📋 What You'll Learn

Create a functional React component called ToggleMessage with a button and a message.

Add a state variable showMessage to control message visibility.

Write a test file using React Testing Library to check if clicking the button toggles the message.

Use render, screen, and fireEvent from React Testing Library.

💡 Why This Matters

🌍 Real World

This pattern is common in interactive web apps where UI changes based on user actions, such as toggling menus, modals, or messages.

💼 Career

React Testing Library is widely used in professional React and Next.js projects to write reliable UI tests that simulate real user behavior.

1

DATA SETUP: Create the ToggleMessage component with initial state

Create a functional React component called ToggleMessage. Inside it, create a state variable called showMessage initialized to false using useState. Return a div with a button that says "Toggle Message".

NextJS

import React, { useState } from 'react';

// Your code here

Hint

Use useState(false) to create showMessage. Return a button inside a div.

2

CONFIGURATION: Add the click handler to toggle the message

Add an onClick handler to the button that toggles the showMessage state between true and false using setShowMessage.

NextJS

import React, { useState } from 'react';

export default function ToggleMessage() {
  const [showMessage, setShowMessage] = useState(false);
  return (
    
      Toggle Message
    
  );
}

Hint

Use an arrow function in onClick to call setShowMessage(!showMessage).

3

CORE LOGIC: Show the message conditionally based on state

Inside the div, below the button, add a p element that contains the text "Hello, you toggled me!". Render this p only if showMessage is true using conditional rendering.

NextJS

import React, { useState } from 'react';

export default function ToggleMessage() {
  const [showMessage, setShowMessage] = useState(false);
  return (
    
       setShowMessage(!showMessage)}>Toggle Message
      {/* Add conditional  here */}
    
  );
}

Hint

Use {showMessage && <p>Hello, you toggled me!</p>} to show the message only when showMessage is true.

4

COMPLETION: Write a test to verify the toggle behavior

Create a test file that imports render, screen, and fireEvent from '@testing-library/react' and imports ToggleMessage. Write a test named "toggles message on button click" that renders <ToggleMessage />, clicks the button with text "Toggle Message", and asserts that the message "Hello, you toggled me!" appears using screen.getByText.

NextJS

import { render, screen, fireEvent } from '@testing-library/react';
import ToggleMessage from './ToggleMessage';

// Write test here
// Your code here

Hint

Use render to render the component, fireEvent.click to click the button, and expect(screen.getByText(...)).toBeInTheDocument() to check the message.

Practice

1. What is the main purpose of React Testing Library in a Next.js project?

easy

A. To manage global state in React applications

B. To style React components with CSS-in-JS

C. To test React components by simulating user interactions and checking visible output

D. To optimize React components for faster rendering

Solution

1. Step 1: Understand React Testing Library's role

   It focuses on testing components by simulating how users interact with them and what they see.

2. Step 2: Compare options with this role

   Only To test React components by simulating user interactions and checking visible output describes testing user interactions and visible output, which matches React Testing Library's purpose.

3. Final Answer:

   To test React components by simulating user interactions and checking visible output -> Option C

4. Quick Check:

   Testing user behavior = D [OK]

Hint: React Testing Library tests user actions and visible UI [OK]

Common Mistakes:

• Confusing testing library with styling or state management tools
• Thinking it optimizes rendering performance
• Assuming it manages app state

2. Which of the following is the correct way to import the render function from React Testing Library?

easy

A. import { render } from '@testing-library/react';

B. import render from 'react-testing-library';

C. import { render } from 'react-dom';

D. import { render } from 'next/testing';

Solution

1. Step 1: Identify the official package for React Testing Library

   The correct package is '@testing-library/react' for React Testing Library functions.

2. Step 2: Check import syntax

   React Testing Library exports render as a named export, so use curly braces around render.

3. Final Answer:

   import { render } from '@testing-library/react'; -> Option A

4. Quick Check:

   Named import from '@testing-library/react' = B [OK]

Hint: Use named import from '@testing-library/react' for render [OK]

Common Mistakes:

• Using default import instead of named import
• Importing from wrong package like 'react-dom' or 'next/testing'
• Missing curly braces around render

3. Given this test code snippet, what will screen.getByText('Hello World') return?

import { render, screen } from '@testing-library/react';

function Greeting() {
  return <h1>Hello World</h1>;
}

test('renders greeting text', () => {
  render(<Greeting />);
  const element = screen.getByText('Hello World');
  return element;
});

medium

A. An error because screen is not defined

B. The <h1> element containing 'Hello World'

C. null because 'Hello World' is not found

D. An array of all elements with text 'Hello World'

Solution

1. Step 1: Understand what render and screen.getByText do

   render displays the component in a virtual DOM; screen.getByText finds the first element with matching text.

2. Step 2: Check the component output

   Greeting returns <h1>Hello World</h1>, so screen.getByText('Hello World') finds this <h1> element.

3. Final Answer:

   The <h1> element containing 'Hello World' -> Option B

4. Quick Check:

   getByText finds matching element = C [OK]

Hint: getByText returns the matching DOM element, not null or array [OK]

Common Mistakes:

• Thinking getByText returns null if found
• Confusing screen with undefined variable
• Assuming getByText returns multiple elements

4. Identify the error in this test code snippet:

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

function Button() {
  const [count, setCount] = React.useState(0);
  return <button onClick={() => setCount(count + 1)}>Clicked {count} times</button>;
}

test('increments count on click', () => {
  render(<Button />);
  const button = screen.getByRole('button');
  fireEvent.click(button);
  expect(button.textContent).toBe('Clicked 1 times');
});

medium

A. Expect statement should check button.innerHTML

B. Using fireEvent instead of userEvent

C. Incorrect role used in getByRole

D. Missing import of React from 'react'

Solution

1. Step 1: Check imports for React usage

   The component uses React.useState but React is not imported, causing a runtime error.

2. Step 2: Verify other parts

   fireEvent.click and getByRole('button') are correct usage; expect checks textContent correctly.

3. Final Answer:

   Missing import of React from 'react' -> Option D

4. Quick Check:

   React must be imported to use React.useState = A [OK]

Hint: Always import React when using React APIs like useState [OK]

Common Mistakes:

• Assuming fireEvent is wrong instead of userEvent
• Thinking getByRole('button') is incorrect
• Checking innerHTML instead of textContent

5. You want to test a Next.js component that fetches data on mount and displays it. Which approach correctly integrates React Testing Library with async data fetching?

import { render, screen, waitFor } from '@testing-library/react';
import React from 'react';

function DataDisplay() {
  const [data, setData] = React.useState(null);
  React.useEffect(() => {
    fetch('/api/data').then(res => res.json()).then(setData);
  }, []);
  if (!data) return <div>Loading...</div>;
  return <div>Data: {data.value}</div>;
}

test('shows fetched data', async () => {
  global.fetch = jest.fn(() => Promise.resolve({
    json: () => Promise.resolve({ value: 'Hello' })
  }));
  render(<DataDisplay />);
  await waitFor(() => screen.getByText('Data: Hello'));
  expect(screen.getByText('Data: Hello')).toBeInTheDocument();
});

hard

A. Correctly mocks fetch and waits for async update with waitFor

B. Should use fireEvent to trigger fetch manually

C. Missing cleanup of fetch mock after test

D. Should use getByText without waitFor for async content

Solution

1. Step 1: Check mocking of fetch

   The test mocks global.fetch to return a resolved promise with expected data, which is correct for simulating API calls.

2. Step 2: Verify waiting for async UI update

   Using waitFor to wait until the text 'Data: Hello' appears is the right way to handle async rendering in tests.

3. Final Answer:

   Correctly mocks fetch and waits for async update with waitFor -> Option A

4. Quick Check:

   Mock fetch + waitFor async UI = A [OK]

Hint: Mock fetch and use waitFor to handle async UI updates [OK]

Common Mistakes:

• Trying to trigger fetch with fireEvent instead of mocking
• Not waiting for async content before assertions
• Forgetting to cleanup mocks (not critical here)