# Rails Integration ## JavaScript Setup Matestack's JavaScript needs to be integrated into your Rails application in order to use the reactive, JavaScript driven features. You can use Webpacker (recommended) or Rails assets pipeline to do this. ### Webpacker Add 'matestack-ui-core' to your `package.json` by running: ``` $ yarn add https://github.com/matestack/matestack-ui-core#v1.3.2 $ yarn install ``` This adds the npm package that provides the JavaScript corresponding to the matestack-ui-core ruby gem. Make sure that the npm package version matches the gem version. To find out what gem version you are using, you may use `bundle info matestack-ui-core`. Next, import 'matestack-ui-core' in your `app/javascript/packs/application.js` ```javascript import MatestackUiCore from 'matestack-ui-core' ``` and compile the JavaScript code with webpack: ``` $ bin/webpack --watch ``` **When you update the matestack-ui-core gem, make sure to update the npm package as well.** ### Asset Pipeline If you are using the asset pipeline, you don't need to install the separate npm package. All required JavaScript libraries are provided by the matestack-ui-core gem. Require 'matestack-ui-core' in your `app/assets/javascript/application.js` ```javascript //= require matestack-ui-core ``` ### Turbolinks We recommend to (remove/deactivate)() turbolinks, as there is no reason to use it alongside matestack-ui-core and there might appear some strange side effects. If you encounter strange page-transition/form-submit/action-submit behavior and have turbolinks activated, try to deactivate it first. ## Application layout adjustments You need to add the ID "matestack-ui" to some part of your application layout (or any layout you use). That's required for Matestack's Vue.js to work properly! For Example, your `app/views/layouts/application.html.erb` should look like this: ``` My App <%= csrf_meta_tags %> <%= csp_meta_tag %> <%= stylesheet_link_tag 'application', media: 'all' %> <%= javascript_pack_tag 'application' %> <%= javascript_include_tag 'application' %>
<%= yield %>
``` Don't apply the "matestack-ui" id to the body tag. ### ActionCable Integration Some of Matestack's reactive core components may be used with ActionCable. If you want to use ActionCable, please read our [action cable](/matestack-ui-core/1.5.0/integrations/action-cable.md) guide. --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://docs.matestack.io/matestack-ui-core/1.5.0/reactivity/rails-integration.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.