Jest fails with window.matchMedia is not a function
TypeError: window.matchMedia is not a functionShort answer
jsdom does not implement window.matchMedia, so any component or library that calls it breaks under Jest. Define a mock with Object.defineProperty. Put it in the test file when the call happens at render time, or in a setup file listed in setupFilesAfterEnv when the module calls it as soon as it is imported.
Fix it fast
1Find out which cause you have
Read the top of the stack trace. If it points into your component's function body, the call runs at render time. If it points to module level code or a library import, it runs on import.
npx jest path/to/Component.test.js2Match what you see, then jump to its fix
- 1
The stack trace shows your component or a hook calling window.matchMediaThe call happens inside a function that the test runsFix - 2
The error is thrown while Jest loads the file, before any test starts, even though the mock is defined in the test bodyThe module calls matchMedia the moment it is importedFix
- 1
What does the error look like?
TypeError: window.matchMedia is not a function
Cause 1 of 2
The call happens inside a function that the test runs
1Check
The jest docs list matchMedia among methods not implemented in jsdom and give a mock for it.
grep -rn 'matchMedia' src/2Fix
Define the mock in the test file before rendering.
Object.defineProperty(window, 'matchMedia', {
writable: true,
value: jest.fn().mockImplementation(query => ({
matches: false,
media: query,
onchange: null,
addListener: jest.fn(), // deprecated
removeListener: jest.fn(), // deprecated
addEventListener: jest.fn(),
removeEventListener: jest.fn(),
dispatchEvent: jest.fn(),
})),
});3Verify
Run the test again.
npx jest path/to/Component.test.jsConfirmed by jestjs.io
Cause 2 of 2
The module calls matchMedia the moment it is imported
1Check
Imports run in order, and a mock written below an import is defined too late.
head -5 path/to/Component.test.js2Fix
Move the mock into its own file and import it first, or load it for all tests with setupFilesAfterEnv.
// matchMedia.mock.js holds the Object.defineProperty block above
// Component.test.js
import './matchMedia.mock'; // must come first
import { Component } from './Component';
// or, for every test file, in jest.config.js:
module.exports = {
setupFilesAfterEnv: ['<rootDir>/matchMedia.mock.js'],
};3Verify
Run the whole suite.
npx jestConfirmed by jestjs.io
How do I stop it coming back?
- Keep jsdom mocks in one setup file so new tests inherit them.
- Make the mock return matches: false for light layouts, and override it in tests that need a media query to match.
Sources
How was this page made?
I drafted this page with AI assistance from the official documents listed under Sources. Every cause above names the document that confirms it. I have not reproduced this fix on a machine of my own yet, so read it as documented guidance, not a test report. Found a mistake? Tell me.
Which stack is behind this page?
Projects of mine built on the same technologies:
- TaxiDexMy own multi-tenant taxi dispatch SaaS: API, dispatcher portal, driver and passenger apps, and the servers underneath.
- QistLockA NestJS and React SaaS driving an Android Device Owner agent that locks financed phones when payments lapse.
- TaskvareA task and project-management suite: React on the web, Flutter on mobile, TypeScript underneath.
Related fixes
Web apps
Module not found for antd/dist/antd.less after upgrading to Ant Design 5
Module not found: Error: Can't resolve 'antd/dist/antd.less'
Ant Design 5 dropped Less and the bundled CSS file for CSS-in-JS, so antd/dist/antd.less no longer exists.
3 causes, each with a fixWeb apps
Astro Code component fails inside a React component
Astro components cannot be rendered directly via function call
Astro components such as Code only exist on the server and render static HTML.
2 causes, each with a fixWeb apps
React shows Attempted import error when importing a component or function
Attempted import error:
The build found the file but not the name you asked for.
2 causes, each with a fixWeb apps
How to catch and handle a 422 from Axios in a Redux thunk
action.error.message is 'Rejected' and action.payload is undefined
A 422 means the server read the request but cannot process its content, so repeating it unchanged fails again.
4 causes, each with a fixWeb apps
axios gets 429 Too Many Requests from a React app
429 (Too Many Requests)
A 429 comes from the server or an API gateway, not from axios: your client sent too many requests in a window.
4 causes, each with a fixWeb apps
Axios request is not cancelled when a React component unmounts
A cancelled request is logged as an error in the catch block
Axios cancels a request when you pass it an AbortSignal and later call abort() on its controller.
4 causes, each with a fix