# jest-enzyme [![npm version](https://img.shields.io/npm/v/jest-enzyme.svg)](https://www.npmjs.com/package/jest-enzyme) ![License](https://img.shields.io/npm/l/chai-enzyme.svg) **Quick Links** * [Setup](#setup) * [Assertions](#assertions) * [Jest Enzyme Environment](#jest-enzyme-environment) * [Create React App](#usage-with-create-react-app) * [TypeScript](#usage-with-typescript) ### Setup The best setup is to use our jest environment [`jest-environment-enzyme`](/packages/jest-environment-enzyme). If you prefer not to use the environment, you can also do this: ```js // package.json "jest": { "setupFilesAfterEnv": ['./node_modules/jest-enzyme/lib/index.js'], } ``` ### Assertions > * Not all assertions work with every rendering strategy. > If you are wondering what rendering mechanism to use when, refer to > [enzyme's documentation](https://github.com/airbnb/enzyme). * [toBeChecked()](#tobechecked) * [toBeDisabled()](#tobedisabled) * [toBeEmptyRender()](#tobeemptyrender) * [toExist()](#toexist) * [toContainMatchingElement()](#tocontainmatchingelement) * [toContainMatchingElements()](#tocontainmatchingelements) * [toContainExactlyOneMatchingElement()](#tocontainexactlyonematchingelement) * [toContainReact()](#tocontainreact) * [toHaveClassName()](#tohaveclassname) * [toHaveDisplayName()](#tohavedisplayname) * [toHaveHTML()](#tohavehtml) * [toHaveProp()](#tohaveprop) * [toHaveRef()](#tohaveref) * [toHaveState()](#tohavestate) * [toHaveStyle()](#tohavestyle) * [toHaveTagName()](#tohavetagname) * [toHaveText()](#tohavetext) * [toIncludeText()](#toincludetext) * [toHaveValue()](#tohavevalue) * [toMatchElement()](#tomatchelement) * [toMatchSelector()](#tomatchselector) #### `toBeChecked()` | render | mount | shallow | | -------|-------|-------- | | no | yes | yes | Ways to use this API: ```js expect().toBeChecked(); ``` Assert that the given wrapper is checked: ```js import React from 'react' import {mount, shallow} from 'enzyme' function Fixture() { return (

); } const wrapper = mount(); // mount/render/shallow when applicable expect(wrapper.find('#checked')).toBeChecked(); expect(wrapper.find('#not')).not.toBeChecked(); ``` #### `toBeDisabled()` | render | mount | shallow | | -------|-------|-------- | | no | yes | yes | Ways to use this API: ```js expect().toBeDisabled(); ``` Assert that the given wrapper is disabled: ```js import React from 'react' import {mount, shallow} from 'enzyme' function Fixture() { return (

); } const wrapper = mount(); // mount/render/shallow when applicable expect(wrapper.find('#disabled')).toBeDisabled(); expect(wrapper.find('#not')).not.toBeDisabled(); ``` #### `toBeEmptyRender()` | render | mount | shallow | | -------|-------|-------- | | no | yes | yes | Ways to use this API: ```js expect().toBeEmptyRender(); ``` Assert that the given wrapper has an empty render (`null` or `false`): ```js function EmptyRenderFixture() { return null; } function NonEmptyRenderFixture() { return (

); } const wrapper = mount(); // mount/render/shallow when applicable expect(wrapper.find('EmptyRenderFixture')).toBeEmptyRender(); expect(wrapper).not.toBeEmptyRender(); ``` #### `toExist()` | render | mount | shallow | | -------|-------|-------- | | no | yes | yes | Ways to use this API: ```js expect().toExist(); ``` Assert that the given enzyme wrapper has rendered content. ```js function Fixture() { return (

); } const wrapper = mount(); // mount/render/shallow when applicable expect(wrapper.find('span')).toExist(); expect(wrapper.find('ul')).not.toExist(); ``` #### `toContainMatchingElement()` | render | mount | shallow | | -------|-------|-------- | | no | yes | yes | Ways to use this API: ```js expect().toContainMatchingElement('.foo'); ``` Assert that the given wrapper contains at least one match for the given selector: ```js function User(props) { return ( User {props.index} ); } User.propTypes = { index: PropTypes.number.isRequired, className: PropTypes.string, }; function Fixture() { return (

); } const wrapper = mount(); // mount/render/shallow when applicable expect(wrapper).toContainMatchingElement('.userOne'); expect(wrapper).not.toContainMatchingElement('.userThree'); ``` #### `toContainMatchingElements()` | render | mount | shallow | | -------|-------|-------- | | no | yes | yes | Ways to use this API: ```js expect().toContainMatchingElements(2, '.foo'); ``` Assert that the given wrapper contains a given number of matches for the given selector: ```js function User(props) { return ( User {props.index} ); } User.propTypes = { index: PropTypes.number.isRequired, className: PropTypes.string, }; function Fixture() { return (

); } const wrapper = mount(); // mount/render/shallow when applicable expect(wrapper).toContainMatchingElements(2, 'User'); expect(wrapper).not.toContainMatchingElements(2, '.userTwo'); ``` #### `toContainExactlyOneMatchingElement()` | render | mount | shallow | | -------|-------|-------- | | no | yes | yes | Ways to use this API: ```js expect().toContainExactlyOneMatchingElement('.foo'); ``` Assert that the given wrapper contains exactly one match for the given selector: ```js function User(props) { return ( User {props.index} ); } User.propTypes = { index: PropTypes.number.isRequired, className: PropTypes.string, }; function Fixture() { return (

); } const wrapper = mount(); // mount/render/shallow when applicable expect(wrapper).toContainExactlyOneMatchingElement('.userOne'); expect(wrapper).not.toContainExactlyOneMatchingElement('User'); ``` #### `toContainReact()` | render | mount | shallow | | -------|-------|-------- | | no | yes | yes | Ways to use this API: ```js expect().toContainReact(

foo

); ``` Assert that the given wrapper contains the provided react instance: ```js class User extends React.Component { render () { return ( User {this.props.index} ) } } User.propTypes = { index: PropTypes.number.isRequired } class Fixture extends React.Component { render () { return (

) } } const wrapper = mount(); // mount/render/shallow when applicable expect(wrapper).toContainReact(); expect(wrapper).not.toContainReact(); ``` #### `toHaveClassName()` | render | mount | shallow | | -------|-------|-------- | | no | yes | yes | Ways to use this API: ```js expect().toHaveClassName('foo'); ``` Assert that the given wrapper has the provided className: ```js function Fixture() { return (

); } const wrapper = mount(); // mount/render/shallow when applicable expect(wrapper.find('.foo')).toHaveClassName('foo'); expect(wrapper.find('.foo')).not.toHaveClassName('baz'); expect(wrapper.find('.bar')).toHaveClassName('bar baz'); expect(wrapper.find('.bar')).toHaveClassName('baz'); ``` #### `toHaveDisplayName()` | render | mount | shallow | | -------|-------|-------- | | no | yes | yes | Ways to use this API: ```js expect().toHaveDisplayName('div'); ``` Assert that the wrapper is of a certain tag type: ```js function Fixture() { return (

); } const wrapper = mount(); expect(wrapper.find('#span')).toHaveDisplayName('span'); expect(wrapper.find('#span')).not.toHaveDisplayName('div'); ``` #### `toHaveHTML()` | render | mount | shallow | | -------|-------|-------- | | no | yes | yes | Ways to use this API: ```js expect().toHaveHTML('

html

'); ``` Assert that the given wrapper has the provided html: > **Note** Quotations are normalized. ```js function Fixture() { return (

Test

); } const wrapper = mount(); // mount/render/shallow when applicable expect(wrapper.find('#child')).toHaveHTML( 'Test' ); ``` #### `toHaveProp()` | render | mount | shallow | | -------|-------|-------- | | no | yes | yes | Ways to use this API: ```js expect().toHaveProp('foo', 'value'); expect().toHaveProp('foo'); expect().toHaveProp({foo: 'value'}); ``` Assert that the given wrapper has the provided propKey and associated value if specified: ```js function User() { ... } User.propTypes = { foo: PropTypes.string, bar: PropTypes.array, }; function Fixture() { return (

); } const wrapper = mount(); // mount/render/shallow when applicable expect(wrapper.find(User)).toHaveProp('foo'); expect(wrapper.find(User)).toHaveProp('foo', 'baz'); expect(wrapper.find(User)).toHaveProp('bar'); expect(wrapper.find(User)).toHaveProp('bar', [1,2,3]); expect(wrapper.find(User)).toHaveProp({ bar: [1, 2, 3], foo: 'baz', }); ``` #### `toHaveRef()` | render | mount | shallow | | -------|-------|-------- | | no | yes | yes | Ways to use this API: ```js expect().toHaveRef('foo'); ``` Assert that the mounted wrapper has the provided ref: ```js class Fixture extends React.Component { render() { return (

); } } const wrapper = mount(); expect(wrapper).toHaveRef('child'); expect(wrapper).not.toHaveRef('foo'); ``` #### `toHaveState()` | render | mount | shallow | | -------|-------|-------- | | no | yes | yes | Ways to use this API: ```js expect().toHaveState('foo'); expect().toHaveState('foo', 'bar'); expect().toHaveState({ foo: 'bar' }); ``` Assert that the component has the provided stateKey and optional value if specified: ```js class Fixture extends React.Component { constructor() { super(); this.state = { foo: false, }; } render() { return (

); } } const wrapper = mount(); // mount/render/shallow when applicable expect(wrapper).toHaveState('foo'); expect(wrapper).toHaveState('foo', false); expect(wrapper).toHaveState({ foo: false }); ``` #### `toHaveStyle()` | render | mount | shallow | | -------|-------|-------- | | no | yes | yes | Ways to use this API: ```js expect().toHaveStyle('height'); expect().toHaveStyle('height', '100%'); expect().toHaveStyle({ height: '100%' }); ``` Assert that the component has style of the provided key and value: ```js function Fixture() { const style1 = { height: '100%' }; const style2 = { flex: 8 }; return (

); } const wrapper = mount(); // mount/render/shallow when applicable expect(wrapper.find('#style1')).toHaveStyle('height', '100%'); expect(wrapper.find('#style2')).toHaveStyle('flex', 8); ``` #### `toHaveTagName()` **Deprecated:** Matcher `toHaveTagName` is deprecated. Use the replacement, [`toHaveDisplayName()`](#tohavedisplayname) instead. #### `toHaveText()` | render | mount | shallow | | -------|-------|-------- | | no | yes | yes | Ways to use this API: ```js expect().toHaveText('bar'); ``` Assert that the wrapper's text matches the provided text exactly, using a strict comparison (`===`). ```js function Fixture() { return (

Text

); } const wrapper = mount(); // mount/render/shallow when applicable expect(wrapper.find('#full')).toHaveText('Text'); expect(wrapper.find('#full')).not.toHaveText('Wrong'); expect(wrapper.find('#full')).toHaveText(); expect(wrapper.find('#empty')).not.toHaveText(); ``` #### `toIncludeText()` | render | mount | shallow | | -------|-------|-------- | | no | yes | yes | Ways to use this API: ```js expect().toIncludeText('bar'); ``` Assert that the wrapper includes the provided text: ```js function Fixture() { return (

Some important text

); } const wrapper = mount(); // mount/render/shallow when applicable expect(wrapper.find('#full')).toIncludeText('important'); expect(wrapper.find('#full')).not.toIncludeText('Wrong'); ``` #### `toHaveValue()` | render | mount | shallow | | -------|-------|-------- | | no | yes | yes | Ways to use this API: ```js expect().toHaveValue('bar'); ``` Assert that the given wrapper has the provided `value`: ```js function Fixture() { return (

); } const wrapper = mount(); // mount/render/shallow when applicable expect(wrapper.find('input').at(0)).toHaveValue('test'); expect(wrapper.find('input').at(1)).toHaveValue('bar'); ``` #### `toMatchElement()` | render | mount | shallow | | -------|-------|-------- | | no | yes | yes | Ways to use this API: ```js expect().toMatchElement(); expect().toMatchElement(, { ignoreProps: false }); expect().toMatchElement(, { ignoreProps: false, verbose: false }); ``` Assert the wrapper matches the provided react instance. This is a matcher form of Enzyme's wrapper.matchesElement(), which returns a bool with no indication of what caused a failed match. This matcher includes the actual and expected debug trees as contextual information when it fails. Like matchesElement(), props are ignored. If you want to compare prop values as well, pass `{ ignoreProps: false }` as options. Uses enzyme's [debug()](http://airbnb.io/enzyme/docs/api/ShallowWrapper/debug.html) under the hood and compares debug strings, which makes for a human readable diff when expects fail. Example: ```js function Fixture() { return (

); } const wrapper = shallow(); // mount/render/shallow when applicable expect(wrapper).toMatchElement(); expect(wrapper.find('span')).toMatchElement(); expect(wrapper.find('span')).toMatchElement( , { ignoreProps: false } ); expect(wrapper).not.toMatchElement(

); ``` #### `toMatchSelector()` | render | mount | shallow | | -------|-------|-------- | | no | yes | yes | Ways to use this API: ```js expect().toMatchSelector('.foo'); ``` Assert that the wrapper matches the provided `selector`: ```js function Fixture() { return (

); } const wrapper = mount(); // mount/render/shallow when applicable expect(wrapper.find('span')).toMatchSelector('span'); expect(wrapper.find('span')).toMatchSelector('#foo'); expect(wrapper.find('span')).toMatchSelector('.bar'); ``` ### Jest Enzyme Environment There is a special environment to simplify using enzyme with jest. Check it out [here](/packages/jest-environment-enzyme#readme) #### Usage with [Create React App](https://github.com/facebookincubator/create-react-app) If you are using Create React App, instead of adding to your `package.json` as above, you will need to add a `src/setupTests.js` file to your app, to import jest-enzyme: ``` js // src/setupTests.js import 'jest-enzyme'; ``` This is documented on Create React App at the bottom of the [Testing Components](https://github.com/facebookincubator/create-react-app/blob/master/packages/react-scripts/template/README.md#testing-components) section. There is also more information about [Initializing Test Environment](https://github.com/facebookincubator/create-react-app/blob/master/packages/react-scripts/template/README.md#initializing-test-environment). #### Usage with TypeScript As with Create React App, when using jest-enzyme with [TypeScript](http://typescriptlang.org/) and [ts-jest](https://github.com/kulshekhar/ts-jest), you'll need to add a `setupTests.ts` file to your app that explicitly imports jest-enzyme, and point the `setupFilesAfterEnv` field in your `package.json` file towards it: ``` typescript // src/setupTests.ts import 'jest-enzyme'; ``` ```js "jest": { "setupFilesAfterEnv": ["./src/setupTests.ts"], }, ``` This ensures that the type definitions bundled with jest-enzyme (which add extra Jest matchers and globals like `shallow` and `mount`) are included in your TypeScript project.

	Stars	Issues	Version	Updated	Created
enzyme	19,963	283	3.11.0	4 years ago	8 years ago
jest	43,594	366	29.7.0	8 months ago	12 years ago
jest-enzyme	894	50	7.1.2	4 years ago	8 years ago
react-testing-library			8.0.1	5 years ago	6 years ago

enzyme vs jest vs jest-enzyme vs react-testing-library

Downloads in past1 Month3 Months6 Months1 Year2 Years5 YearsAll time

Stats

Popular Searches

Sick of boring JavaScript newsletters?

Downloads in past