https://github.com/jalkoby/rjax

Elegant responder for ajax requests
https://github.com/jalkoby/rjax

Last synced: about 1 year ago
JSON representation

Elegant responder for ajax requests

• Host: GitHub
• URL: https://github.com/jalkoby/rjax
• Owner: jalkoby
• License: mit
• Created: 2013-10-01T16:38:03.000Z (almost 13 years ago)
• Default Branch: master
• Last Pushed: 2013-10-08T08:54:45.000Z (over 12 years ago)
• Last Synced: 2025-02-14T06:25:45.494Z (over 1 year ago)
• Language: Ruby
• Homepage:
• Size: 152 KB
• Stars: 1
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.rdoc
  • License: LICENSE.txt

Awesome Lists containing this project

README

          
= Rjax

Elegant responder for ajax requests

{}[https://codeclimate.com/github/jalkoby/rjax]

{}[https://travis-ci.org/jalkoby/rjax]

{}[http://badge.fury.io/rb/rjax]

== Installation

Add this line to your application's Gemfile:

  gem 'rjax'

And then execute:

  $ bundle

Or install it yourself as:

  $ gem install rjax

== Usage

Rjax will be useful if you have a lot actions which serve http and ajax requests. It might looks like:

  def index

    @users = User.all

    render :partials => 'users', :locals => { :users => @users }  if request.xhr?

    # or

    render :index_ajax if request.xhr?

  end

Rjax adds `rjax` method in rails controllers.

  class UsersController < ApplicationController

    def index

      @users = User.all

      rjax

    end

    # calling rjax method without arguments will render template;

    # the name of template will contain action_name and wrapper;

    # in this case expected `index_rjax` template;

    def index

      @users = User.all

      rjax @users

    end

    # calling rjax method with collection is similar to view helper `render %collection%`;

    # the only different is also looks for partial with wrapped name;

    # in this case it will look for partial `_user_rjax` or `_user` and pass variable `user`;

    def index

      @users = User.all

      rjax :users => @users, :other => :variable

    end

    # calling rjax method with Hash will render partial with locals specified in hash;

    # the name of partial might be specified in :partial key;

    # if :partial key is missed expected that view folder contains partial with plural form of controller with or without wrapper;

    # in this case it will be `_users_rjax` or `_users` partial

    def show

      @user = User.find(params[:id])

      rjax @user

    end

    # in other cases rjax will render partial and pass this variable into partial;

    # the name of partial will be singular form of controller with or without wrapper;

    # in this case it will be `_user_rjax` or `_user` partial and pass variable `user`;

    # it also support respond_with

    def index

      respond_with do |format|

        format.html { rjax }

        format.json

        format.xml

      end

    end

  end

If you don't like rjax default wrapper you can configure it:

  # config/initializers/rjax.rb

  Rjax.config do |config|

    config.suffix = "suffix"

    config.prefix = "prefix"

  end

  prefix_%template%_suffix

  _prefix_%partial%_suffix

== Contributing

1. Fork it

2. Create your feature branch (`git checkout -b my-new-feature`)

3. Commit your changes (`git commit -am 'Add some feature'`)

4. Push to the branch (`git push origin my-new-feature`)

5. Create new Pull Request