paint-brush
How to get your Rails data into your React component with webpackerby@hrishio
10,362 reads
10,362 reads

How to get your Rails data into your React component with webpacker

by Hrishi MittalJuly 4th, 2017
Read on Terminal Reader
Read this story w/o Javascript
tldt arrow

Too Long; Didn't Read

The <a href="https://github.com/rails/webpacker" target="_blank"><strong>webpacker gem</strong></a> has given us an easy way to use <a href="https://hackernoon.com/tagged/javascript" target="_blank">JavaScript</a> libraries, including React, inside Rails while using native JS <a href="https://hackernoon.com/tagged/tools" target="_blank">tools</a> like yarn and Webpack.

Company Mentioned

Mention Thumbnail
featured image - How to get your Rails data into your React component with webpacker
Hrishi Mittal HackerNoon profile picture

The webpacker gem has given us an easy way to use JavaScript libraries, including React, inside Rails while using native JS tools like yarn and Webpack.

If you’re using Rails 5.1 or higher, you can directly create a new app with React support out of the box simply by running:

$ rails new myapp --webpack=react

If you’re using an older version of Rails (4.2+), you can install the webpacker gem and then run

$ ./bin/rails webpacker:install

$ ./bin/rails webpacker:install:react

Then you simply put your React components in the newly created app/javascript/packs directory and use them with the javascript_pack_tag helper method in a view.

But if you’ve previously used the react-rails or react_on_rails gem, one thing you might be wondering about is how to get your Rails model data into a React component with webpacker.

Both react-rails and react_on_rails provide a helper method called react_component which you can use in a view to render a component and pass data to it as props.

If we look under the hood, the react_component method puts the Rails data inside a data attribute of a div on the page:

react_component(‘Appointments’, appointments: @appointments)

If you inspect the source code of the page, you can see the data loaded inside a div with the data attributes react-class and react-props:

Then, on page load, some JavaScript code (react_ujs) is used to parse the data and pass it on to the React component:

webpacker doesn’t provide any such convenience methods by default.

So we have to write our own code to do the same.

First let’s put the data as JSON inside the data attribute of a div in the view where we want to render the React component:




<%= content_tag :div,id: "appointments_data",data: @appointments.to_json do %><% end %>

If you use HAML, you can simply do:

#appointments_data{data: @appointments.to_json}

Then parse the data once all DOM content is loaded and pass it on to the Appointments component:



document.addEventListener('DOMContentLoaded', () => {const node = document.getElementById('appointments_data')const data = JSON.parse(node.getAttribute('data'))





ReactDOM.render(<Appointments appointments={data} />,document.body.appendChild(document.createElement('div')),)})

And that’s all! Your data will now be passed on to the React component.

If you’d rather not do this, you can also use the webpacker-react gem which provides a react_component helper method.

See the full code of this example app on Github:


learnetto/calreact_calreact - React and Rails 5 calendar appointment app_github.com

If you’d like to learn how to use React with Rails for free, check out the free React on Rails tutorials on Learnetto.

You might also like these articles:


3 ways to use React with Ruby on Rails 5_IMPORTANT UPDATE (6 July 2017): With the release of Rails 5.1, Rails now has native support for using React via the…_medium.com


✅ Every time you build a to-do list app, a puppy 🐕 dies 😢_You know when you’re trying to learn something new, but get reeeeeeallly bored of building the default example app?_medium.freecodecamp.org

Originally published at learnetto.com.