Have ideas to improve npm?Join in the discussion! »

    enzyme-adapter-react-15
    DefinitelyTyped icon, indicating that this package has TypeScript declarations provided by the separate @types/enzyme-adapter-react-15 package

    1.4.3 • Public • Published

    Enzyme

    Join the chat at https://gitter.im/enzymejs/enzyme

    npm Version License Build Status Coverage Status

    Enzyme is a JavaScript Testing utility for React that makes it easier to test your React Components' output. You can also manipulate, traverse, and in some ways simulate runtime given the output.

    Enzyme's API is meant to be intuitive and flexible by mimicking jQuery's API for DOM manipulation and traversal.

    Upgrading from Enzyme 2.x or React < 16

    Are you here to check whether or not Enzyme is compatible with React 16? Are you currently using Enzyme 2.x? Great! Check out our migration guide for help moving on to Enzyme v3 where React 16 is supported.

    Installation

    To get started with enzyme, you can simply install it via npm. You will need to install enzyme along with an Adapter corresponding to the version of react (or other UI Component library) you are using. For instance, if you are using enzyme with React 16, you can run:

    npm i --save-dev enzyme enzyme-adapter-react-16

    Each adapter may have additional peer dependencies which you will need to install as well. For instance, enzyme-adapter-react-16 has peer dependencies on react and react-dom.

    At the moment, Enzyme has adapters that provide compatibility with React 16.x, React 15.x, React 0.14.x and React 0.13.x.

    The following adapters are officially provided by enzyme, and have the following compatibility with React:

    Enzyme Adapter Package React semver compatibility
    enzyme-adapter-react-16 ^16.4.0-0
    enzyme-adapter-react-16.3 ~16.3.0-0
    enzyme-adapter-react-16.2 ~16.2
    enzyme-adapter-react-16.1 ~16.0.0-0 || ~16.1
    enzyme-adapter-react-15 ^15.5.0
    enzyme-adapter-react-15.4 15.0.0-0 - 15.4.x
    enzyme-adapter-react-14 ^0.14.0
    enzyme-adapter-react-13 ^0.13.0

    Finally, you need to configure enzyme to use the adapter you want it to use. To do this, you can use the top level configure(...) API.

    import Enzyme from 'enzyme';
    import Adapter from 'enzyme-adapter-react-16';
    
    Enzyme.configure({ adapter: new Adapter() });

    3rd Party Adapters

    It is possible for the community to create additional (non-official) adapters that will make enzyme work with other libraries. If you have made one and it's not included in the list below, feel free to make a PR to this README and add a link to it! The known 3rd party adapters are:

    Adapter Package For Library Status
    enzyme-adapter-preact-pure preact (stable)
    enzyme-adapter-inferno inferno (work in progress)

    Running Enzyme Tests

    Enzyme is unopinionated regarding which test runner or assertion library you use, and should be compatible with all major test runners and assertion libraries out there. The documentation and examples for enzyme use Mocha and Chai, but you should be able to extrapolate to your framework of choice.

    If you are interested in using enzyme with custom assertions and convenience functions for testing your React components, you can consider using:

    Using Enzyme with Mocha

    Using Enzyme with Karma

    Using Enzyme with Browserify

    Using Enzyme with SystemJS

    Using Enzyme with Webpack

    Using Enzyme with JSDOM

    Using Enzyme with React Native

    Using Enzyme with Jest

    Using Enzyme with Lab

    Using Enzyme with Tape and AVA

    Basic Usage

    Shallow Rendering

    import React from 'react';
    import { expect } from 'chai';
    import { shallow } from 'enzyme';
    import sinon from 'sinon';
    
    import MyComponent from './MyComponent';
    import Foo from './Foo';
    
    describe('<MyComponent />', () => {
      it('renders three <Foo /> components', () => {
        const wrapper = shallow(<MyComponent />);
        expect(wrapper.find(Foo)).to.have.lengthOf(3);
      });
    
      it('renders an `.icon-star`', () => {
        const wrapper = shallow(<MyComponent />);
        expect(wrapper.find('.icon-star')).to.have.lengthOf(1);
      });
    
      it('renders children when passed in', () => {
        const wrapper = shallow((
          <MyComponent>
            <div className="unique" />
          </MyComponent>
        ));
        expect(wrapper.contains(<div className="unique" />)).to.equal(true);
      });
    
      it('simulates click events', () => {
        const onButtonClick = sinon.spy();
        const wrapper = shallow(<Foo onButtonClick={onButtonClick} />);
        wrapper.find('button').simulate('click');
        expect(onButtonClick).to.have.property('callCount', 1);
      });
    });

    Read the full API Documentation

    Full DOM Rendering

    import React from 'react';
    import sinon from 'sinon';
    import { expect } from 'chai';
    import { mount } from 'enzyme';
    
    import Foo from './Foo';
    
    describe('<Foo />', () => {
      it('allows us to set props', () => {
        const wrapper = mount(<Foo bar="baz" />);
        expect(wrapper.props().bar).to.equal('baz');
        wrapper.setProps({ bar: 'foo' });
        expect(wrapper.props().bar).to.equal('foo');
      });
    
      it('simulates click events', () => {
        const onButtonClick = sinon.spy();
        const wrapper = mount((
          <Foo onButtonClick={onButtonClick} />
        ));
        wrapper.find('button').simulate('click');
        expect(onButtonClick).to.have.property('callCount', 1);
      });
    
      it('calls componentDidMount', () => {
        sinon.spy(Foo.prototype, 'componentDidMount');
        const wrapper = mount(<Foo />);
        expect(Foo.prototype.componentDidMount).to.have.property('callCount', 1);
        Foo.prototype.componentDidMount.restore();
      });
    });

    Read the full API Documentation

    Static Rendered Markup

    import React from 'react';
    import { expect } from 'chai';
    import { render } from 'enzyme';
    
    import Foo from './Foo';
    
    describe('<Foo />', () => {
      it('renders three `.foo-bar`s', () => {
        const wrapper = render(<Foo />);
        expect(wrapper.find('.foo-bar')).to.have.lengthOf(3);
      });
    
      it('renders the title', () => {
        const wrapper = render(<Foo title="unique" />);
        expect(wrapper.text()).to.contain('unique');
      });
    });

    Read the full API Documentation

    React Hooks support

    Enzyme supports react hooks with some limitations in .shallow() due to upstream issues in React's shallow renderer:

    • useEffect() and useLayoutEffect() don't get called in the React shallow renderer. Related issue

    • useCallback() doesn't memoize callback in React shallow renderer. Related issue

    ReactTestUtils.act() wrap

    If you're using React 16.8+ and .mount(), Enzyme will wrap apis including .simulate(), .setProps(), .setContext(), .invoke() with ReactTestUtils.act() so you don't need to manually wrap it.

    A common pattern to trigger handlers with .act() and assert is:

    const wrapper = mount(<SomeComponent />);
    act(() => wrapper.prop('handler')());
    wrapper.update();
    expect(/* ... */);

    We cannot wrap the result of .prop() (or .props()) with .act() in Enzyme internally since it will break the equality of the returned value. However, you could use .invoke() to simplify the code:

    const wrapper = mount(<SomeComponent />);
    wrapper.invoke('handler')();
    expect(/* ... */);

    Future

    Enzyme Future

    Contributing

    See the Contributors Guide

    In the wild

    Organizations and projects using enzyme can list themselves here.

    License

    MIT

    Install

    npm i enzyme-adapter-react-15

    DownloadsWeekly Downloads

    14,888

    Version

    1.4.3

    License

    MIT

    Unpacked Size

    87 kB

    Total Files

    10

    Last publish

    Collaborators

    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar