Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix several typos in README file #1181

Merged
merged 3 commits into from
Dec 19, 2018
Merged

Conversation

stephane-rbn
Copy link
Contributor

@stephane-rbn stephane-rbn commented Dec 17, 2018

This change is Reviewable

@@ -270,7 +270,7 @@ ReactOnRails will automatically detect a registered generator function. Thus, th

Another reason to use a generator function is that sometimes in server rendering, specifically with React Router, you need to return the result of calling ReactDOMServer.renderToString(element). You can do this by returning an object with the following shape: { renderedHtml, redirectLocation, error }. Make sure you use this function with `react_component_hash`.

For server rendering, if you wish to return multiple HTML strings from a generator function, you may return an Object from your generator function with a single top level property of `renderedHtml`. Inside this Object, place a key called `componentHtml`, along with any other needed keys. An example scenario of this is when you are using side effects libraries like [React Helmet](https://github.com/nfl/react-helmet). Your Ruby code will get this Object as a Hash containing keys componentHtml and any other custom keys that you added:
For server rendering, if you wish to return multiple HTML strings from a generator function, you may return an Object from your generator function with a single top-level property of `renderedHtml`. Inside this Object, place a key called `componentHtml`, along with any other needed keys. An example scenario of this is when you are using side effects libraries like [React Helmet](https://github.com/nfl/react-helmet). Your Ruby code will get this Object as a Hash containing keys componentHtml and any other custom keys that you added:
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"top level" -> "top-level"

@coveralls
Copy link

Coverage Status

Coverage remained the same at ?% when pulling 2d0448e on stephanyan:master into 4bd7e81 on shakacode:master.

1 similar comment
@coveralls
Copy link

Coverage Status

Coverage remained the same at ?% when pulling 2d0448e on stephanyan:master into 4bd7e81 on shakacode:master.

@coveralls
Copy link

coveralls commented Dec 17, 2018

Coverage Status

Coverage remained the same at ?% when pulling 96aaa2a on stephanyan:master into 4bd7e81 on shakacode:master.

stephane-rbn and others added 2 commits December 17, 2018 14:45
Change "setup" to "set up" because used as a verb
@justin808 justin808 merged commit 503c97f into shakacode:master Dec 19, 2018
@justin808
Copy link
Member

Thank you @stephanyan

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants