RAILS_INTEGRATION.md

Ralix + Rails

Ralix pairs really well with Turbo-based (Turbo or Turbolinks) Rails applications. In fact, the controllers hierarchy was inspired by Rails controllers and originally, Ralix was built and extracted from a Rails app.

It also integrates with the RailsUJS adapter. In that case, you need to pass the instance via the rails_ujs option in the constructor.

Your main entrypoint (app/javascript/application.js) should look like something similar to:

// Dependencies
import Rails        from '@rails/ujs'
import Turbolinks   from 'turbolinks'
import { RalixApp } from 'ralix'

// Controllers
import AppCtrl      from './controllers/app'
import UsersCtrl    from './controllers/users'
import ProductsCtrl from './controllers/products'

// Components
import Modal        from './components/modal'
import Table        from './components/table'
import Tooltip      from './components/tooltip'

const App = new RalixApp({
  rails_ujs: Rails,
  routes: {
    '/users':    UsersCtrl,
    '/products': ProductsCtrl,
    '/.*':       AppCtrl
  },
  components: [
    Modal,
    Table,
    Tooltip
  ]
})

Rails.start()
Turbolinks.start()
App.start()

Check out a full Rails example with Ralix integrated in the following repository.