3.1
Built-in Reactivity
Custom Reactivity
Integrations
Installation & Update
Depenencies
matestack-ui-vuejs requires matestack-ui-core. Make sure to follow the install guide from https://docs.matestack.io/matestack-ui-core/getting-started/installation-update and understand the concepts of matestack-ui-core.Installation
Add 'matestack-ui-vuejs' to your Gemfile
1
gem 'matestack-ui-vuejs', "~> 3.1.0"
Copied!
and run
1
$ bundle install
Copied!
Matestack Ui Core install steps (if not already happened)
Create a folder called 'matestack' in your app directory. All your Matestack apps, pages and components will be defined there.
1
$ mkdir app/matestack
Copied!
Add the Matestack helper to your controllers. If you want to make the helpers available in all controllers, add it to your 'ApplicationController' this way:
app/controllers/application_controller.rb1
class ApplicationController < ActionController::Base
2
include Matestack::Ui::Core::Helper
3
#...
4
end
Copied!
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:1
<!DOCTYPE html>
2
<html>
3
<head>
4
<title>My App</title>
5
<%= csrf_meta_tags %>
6
<%= csp_meta_tag %>
7
​
8
<%= stylesheet_link_tag 'application', media: 'all' %>
9
​
10
<!-- if you are using webpacker: -->
11
<%= javascript_pack_tag 'application' %>
12
​
13
<!-- if you are using importmap: -->
14
<%= javascript_importmap_tags %>
15
</head>
16
​
17
<body>
18
<div id="matestack-ui">
19
<%= yield %>
20
</div>
21
</body>
22
</html>
Copied!
Don't apply the "matestack-ui" id to the body tag.
Rails 7 importmap based JavaScript installation
Webpacker > 5.x based JavaScript installation
Usage with Turbolinks
If you want to use
matestack-ui-vuejs alongside with Turbolinks or Turbo, please add:1
yarn add vue-turbolinks
Copied!
And use following snippet instead:
1
import { createApp } from 'vue'
2
import MatestackUiVueJs from 'matestack-ui-vuejs'
3
import TurbolinksAdapter from 'vue-turbolinks'; // import vue-turbolinks
4
​
5
const appInstance = createApp({})
6
​
7
appInstance.use(TurbolinksAdapter); // tell Vue to use it
8
​
9
// change the trigger event
10
document.addEventListener('turbolinks:load', () => {
11
MatestackUiVueJs.mount(appInstance)
12
})
Copied!
Usage with Turbo
Not tested yet!
1
import { createApp } from 'vue'
2
import MatestackUiVueJs from 'matestack-ui-vuejs'
3
​
4
const appInstance = createApp({})
5
​
6
// change the trigger event
7
document.addEventListener('turbo:load', () => {
8
MatestackUiVueJs.mount(appInstance)
9
}
Copied!
ActionCable Integration
Some of Matestack's reactive components may be used with or require ActionCable. If you want to use ActionCable, please read the action cable guide:
Update
Ruby Gem
Depending on the entry in your Gemfile, you might need to adjust the allowed version ranges in order to update the Gem. After checked and adjusted the version ranges, run:
1
bundle update matestack-ui-vuejs
Copied!
and then check the installed version:
1
bundle info matestack-ui-vuejs
Copied!
If you've installed the JavaScript dependecies via Yarn/Webpacker you need to update the JavaScript assets via yarn:
1
yarn update matestack-ui-vuejs
Copied!
and finally check if the correct version is installed:
1
yarn list --pattern "matestack-ui-vuejs"
Copied!
The Ruby gem version and the npm package version should match!
Last modified 26d ago