with event

  • <ReactTestRenderer> with event <string> <assertion?>
  • <ReactTestRenderer> with event <string> <object> <assertion?>

with event .... [on]

with event can trigger events in the shallow, full and test renderers. For the normal full renderer, TestUtils.Simulate is used to simulate the event. For the shallow and test renderers, it is expected that there is a prop with the name on[EventName], where the first letter of the event is capitalised.

e.g. with a button that counts its own clicks

var renderer = TestRenderer.create(<MyButton />)
expect(renderer, 'with event', 'click', 'to have rendered', <button>Button was clicked 1 times</button>);

Also note that due to unexpected's clever string handling, you can often concatenate the with event and the event name.

Given the following todo list:

var renderer = TestRenderer.create(
    <TodoItem id={1} label="Buy flowers for the wife"/>
    <TodoItem id={2} label="Mow the lawn"/>
    <TodoItem id={3} label="Buy groceries"/>

If you want to trigger an event on a specific component, (i.e. not the top level component), use on after the event.

  'with event click', 'on', <div id="todo-3" />,
  'to contain', <div id="todo-3"><span>Completed!</span></div>

To pass arguments to the event, simply include the event object after the event name

  'with event mouseDown', { mouseX: 150, mouseY: 50 },
  'on', <div id="todo-2" />,
  'not to contain', <div id="todo-2"><span>Completed!</span></div>

This will call the function passed in the onMouseDown prop of the <TodoItem>.

You can take the renderer after the event has been triggered by using the promise returned from expect. This is often used to test that spy or mock callbacks have been called (using for instance sinon.js).

  'with event click', 'on', <div id="todo-2" />
return expect(
  'with event click', 'on', <div id="todo-2" />
).then(function (renderer) {
  var todoListInstance = renderer.getInstance();
  expect(todoListInstance.state, 'to satisfy', { clicked: { 2: true } });


You can add an eventTarget prop to the expected to trigger the event on a child component. e.g.

var renderer = TestRenderer.create(<App />);
    'with event', 'click', 'on', <div className="click-test"><button eventTarget /></div>, 
    'to have rendered', 
        <div className="other-button"><button>Not clicked</button></div>
        <div className="click-test"><button>Button was clicked</button></div>