Skip to content

Commit 7cb9f21

Browse files
committed
Fix jsdoc
1 parent 539e742 commit 7cb9f21

File tree

1 file changed

+12
-3
lines changed

1 file changed

+12
-3
lines changed

docs/additional_reading/rails_view_rendering_from_inline_javascript.md

+12-3
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,18 @@
22
You can easily render React components in your JavaScript with `render` method that returns a [reference to the component](https://facebook.github.io/react/docs/more-about-refs.html) (virtual DOM element).
33

44
```js
5-
// componentName - name of your registered component;
6-
// props - Object which contains the properties to pass to the react object;
7-
// elementId - id of an element where we render our React component;
5+
/**
6+
* ReactOnRails.render("HelloWorldApp", {name: "Stranger"}, 'app');
7+
*
8+
* Does this:
9+
* ReactDOM.render(React.createElement(HelloWorldApp, {name: "Stranger"}),
10+
* document.getElementById('app'))
11+
*
12+
* @param name Name of your registered component
13+
* @param props Props to pass to your component
14+
* @param domNodeId
15+
* @returns {virtualDomElement} Reference to your component's backing instance
16+
*/
817
ReactOnRails.render(componentName, props, elementId)
918
```
1019

0 commit comments

Comments
 (0)