Skip to content

ibaciulis/gi-dom-rails

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

30 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Getting started

Add gem to Gemfile

gem 'gi-dom-rails', github: 'ibaciulis/gi-dom-rails'

After you install, you need to run the generator:

rails generate dom:install

Require gi-dom-rails and generated JS files:

//= require gi-dom-rails

//= require core/core
//= require core/widgets
//= require core/pages
//= require pages

Add controller and action values to body attribute:

<body data-controller="#{controller.controller_path}" data-action="#{controller.action_name}">

Or

= content_tag :body, data: { controller: controller.controller_path, action: controller.action_name }

Usage

For example, you want to generate page specific JS for Account::Orders#index:

rails generate dom:page account/orders/index

It will generate these JS files:

app/assets/javascripts/pages/account.coffee
app/assets/javascripts/pages/account/orders.coffee
app/assets/javascripts/pages/account/orders/index.coffee

Define custom namespace and path

rails generate dom:page search_logs/index --namespace Admin --path engines/admin/app/assets/javascripts/admin

Generated files:

engines/admin/app/assets/javascripts/admin/pages/search_logs.coffee
engines/admin/app/assets/javascripts/admin/pages/search_logs/index.coffee

About

Rails gem for Garber-Irish DOM-ready execution

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published