Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Fetching contributors…

Cannot retrieve contributors at this time

129 lines (91 sloc) 6.877 kB

AJAX Pagination

Build Status

Wiki | RDoc | Changelog

Loads page content into AJAX sections with AJAX links, handling the details for you, load content with javascript into designated page containers. Supports multiple and/or nested AJAX sections. Designed to be easy to use, customizable, supports browser history robustly, supports AJAX forms and has many more features. Degrades gracefully when javascript is disabled.

Each webpage can have multiple ajax_section containers, whether they are side by side, or even nested. Links can reference an ajax_section to load new content into the section using AJAX. Watch as the URL in the browser address bar updates, with fully working back/forward buttons.

For more, see Introduction and Background.

This gem requires Rails 3.0+. When using the asset pipeline in Rails 3.1+, follow the general installation instructions. Otherwise, use the ajax_pagination:assets generator, which puts the assets into the public/ directory.

Demonstration Video

To see this gem in action, watch the demonstration video, as shown left. It shows a built-in animation on loading, fully working history and AJAX requests which can perform POST and DELETE requests, whether via a link or a form submission and redirects.

Installation

Assuming, you are using the asset pipeline, add to your Gemfile:

gem 'ajax_pagination'

and run the bundle install command.

Then add ajax_pagination to your asset manifests,

// app/assets/javascripts/application.js
//= require ajax_pagination
/* app/assets/stylesheets/application.css
 *= require ajax_pagination
 */

To use this on Rails 3.0, or without using the asset pipeline, read the Installation without the Asset Pipeline guide.

Basic Usage

In the ActionView, use ajax_section to declare a section, and ajax_link_to to create a link loading content into the section:

<%= ajax_link_to "Link", link_url, :section_id => "section_name" %>
<%= ajax_section :id => "section_name", :render => "mypartial" %>

Then, in the ActionController, use ajax_respond to render only the partial when an AJAX request is made:

Class ObjectsController < ApplicationController
  def index
    ...
    respond_to do |format|
      format.html # index.html.erb
      ajax_respond format, :section_id => "section_name", :render => "_mypartial"
    end
  end
  ...
end

Much more information can be found in the wiki.

Getting Started

To learn how to use this gem, read one of the usage guides below (found in the wiki):

For more, including how specific features work, look in the wiki.

Alternatively, to see the API, see RDoc.

Features

  • So easy to use, you don't need to touch a single line of javascript
  • Supports multiple and nested sections
  • Supports browser history, for more see Robust Support for Browser History in AJAX Pagination
  • Supports links, but also POST, DELETE, PUT links and forms, which can all be used to change the content in a section
  • Supports redirects - a necessary feature when used with forms
  • Custom javascript events
  • Built in visual cues when loading new content - can be altered with css.

Example Application

This gem contains an example application (actually, it is there also for testing purposes), however it is nevertheless a good example.

Clone this repository, and run the server, using:

git clone git://github.com/ronalchn/ajax_pagination.git
cd ajax_pagination
cd spec/rails_app
bundle install
bundle exec rails server

Then point your browser to http://localhost:3000/

Javascript Dependency

As well as the included ajax_pagination.js file, this gem uses jquery.ba-bbq.js and jquery.url.js, which are jquery plugins. They are included in the gem as assets already to simplify installation. ajax_pagination.js will automatically require jquery.ba-bbq.js, and jquery.url.js.

However, if you are already using them (especially if using a different version), simply ensure that your assets directory contains javascript files of the same name to shadow/override the file in the gem.

The other javascript dependencies rely on gems: jquery-rails, and jquery-historyjs. So if they are used, AJAX Pagination should play well with other gems using the libraries.

Development

You are welcome to submit pull requests on GitHub at https://github.com/ronalchn/ajax_pagination, however, please be aware that submitting a pull request is assumed to grant to me non-exclusive, perpetual rights to the use of the software for any use whatsoever. This allows me to release the software under a more permissible license in the future if I want.

If you do not submit a pull request, your modifications will not be merged into the codebase.

License

Copyright © 2012 Ronald Ping Man Chan

If you want to use this program under a different license, please contact me. All pull requests to my repository will be assumed to assign to me non-exclusive rights for perpertual usage for any use whatsoever for those modifications to Ronald Ping Man Chan. If you do not have the power to assign that right, do not submit a pull request. This allows me to release the software under a more permissible license in the future if I want. Ronald

The software is released under LGPL. This means that this Gem can be used in any software (proprietary or otherwise), by using the gem command for installation. However, the gem cannot be included directly in proprietary software (eg. as a plugin), without distributions of the software being under LGPL. Distribution of this Gem may only be released under a license LGPL is compatible with.

Jump to Line
Something went wrong with that request. Please try again.