Browse Source

fix docs

main
petehunt 11 years ago
parent
commit
b22ba84b1d
  1. 10
      docs/09.4-test-utils.md

10
docs/09.4-test-utils.md

@ -7,11 +7,11 @@ prev: class-name-manipulation.html
next: examples.html next: examples.html
--- ---
`React.addons.TestUtils` makes it easy to test React components in the testing framework of your choice (we use [Jasmine](http://pivotal.github.io/jasmine/)). All functions except for `renderIntoDocument()` work without a browser DOM. `React.addons.TestUtils` makes it easy to test React components in the testing framework of your choice (we use [Jasmine](http://pivotal.github.io/jasmine/) with [jsdom](https://github.com/tmpvar/jsdom)).
#### ReactComponent renderIntoDocument(ReactComponent instance) #### ReactComponent renderIntoDocument(ReactComponent instance)
Render a component into a detached DOM node in the document. **This is the only function that requires a DOM.** Render a component into a detached DOM node in the document. **This function requires a DOM.**
#### boolean isComponentOfType(ReactComponent instance, function componentClass) #### boolean isComponentOfType(ReactComponent instance, function componentClass)
@ -67,9 +67,11 @@ Pass a mocked component module to this method to augment it with useful methods
#### Simulate.{eventName}({ReactComponent|DOMElement} element, object nativeEventData) #### Simulate.{eventName}({ReactComponent|DOMElement} element, object nativeEventData)
Simulate an event dispatch on a React component instance or browser DOM node with optional `nativeEventData` event data. This uses React's event system so it works outside of the browser. **This is possibly the single most useful utility in `ReactTestUtils`.** Simulate an event dispatch on a React component instance or browser DOM node with optional `nativeEventData` event data. **This is possibly the single most useful utility in `ReactTestUtils`.**
**NOTE:** this helper is used to simulate browser events, so synthetic React events like `change` are not available. If you want to test `change`, simulate the underlying `input` browser event. > Note:
>
> This helper is used to simulate browser events, so synthetic React events like `change` are not available. If you want to test `change`, simulate the underlying `input` browser event.
Example usage: `React.addons.TestUtils.Simulate.click(myComponent)` Example usage: `React.addons.TestUtils.Simulate.click(myComponent)`

Loading…
Cancel
Save