Rails Behaviors implements the
data-* behaviors generated by Rails 3.x.
This is an alternative to jquery-ujs. Firstly, it is all Coffee goodness. Well, thats mostly good for me. Second, it is written in a modular fashion. This makes it possible to cherry pick the components you need and replace specific functionaly without rewriting the whole thing. Third, it uses built in global ajax events rather than adding its own. O, one more thing, Zepto.
jQuery 1.6.4+ or Zepto 0.8+
(jQuery 1.7 already works and I'll probably requiring it in a month or so)
Theres a couple ways to get setup.
If you're using Rails 3.1, the best way is to use the gem. Add
gem 'rails-behaviors' to your
Gemfile and add
//= require rails to your
Other versions of Rails or even Sinatra can still use the gem as long as you're using Sprockets. Add
rails-behaviors to your
Gemfile. Depending on your setup, add
Rails::Behaviors.path to your Sprockets environment.
env = Sprockets::Environment.new env.append_path Rails::Behaviors.path
An alternative option is just to download the compiled single JS file under Downloads. This will be compatable with any generic JS setup. So if you're using something else, like Jammit, this way is your best bet.
Migrating from jquery-ujs
This library handles all the
data-* behaviors defined in Rails. So its roughly feature for feature identicial with respect to the HTML.
The differences are in the JS interface.
- There are no
ajax:*events. jQuery already has global ajax events built in, so there is no point in duplicating that functionality. Doing a find and replace for
"ajax:"events should give you a good start. You're looking to replace
- There are no global configuration options. Theres no equivalent for
$.rails. Your probably should have never used that in the first place.
NOTE You can not use rails-behaviors and jquery-ujs at the same time.
See http://josh.github.com/rails-behaviors/ for a markup and event reference.
$ git clone git://github.com/josh/rails-behaviors.git $ cd rails-behaviors/ $ bundle install
Compile and minify
$ bundle exec rake dist
$ bundle exec rake test
Copyright © 2011 Joshua Peek <email@example.com>
Rails Behaviors is distributed under an MIT-style license. See LICENSE for details.