will_paginate-bootstrap

Code Climate

Bootstrap Pagination Component

This gem integrates the Twitter Bootstrap pagination component with the will_paginate pagination gem.

As with will_paginate itself, Rails and Sinatra are supported.

Install

  • gem install will_paginate-bootstrap, or
  • For projects using Bundler, add gem 'will_paginate-bootstrap' to your Gemfile (and then run bundle install).

Usage

Rails

  1. Load the Bootstrap CSS in your template.
  2. In your view, use the renderer: BootstrapPagination::Rails option with the will_paginate helper, for example:
<%= will_paginate @collection, renderer: BootstrapPagination::Rails %>

Sinatra

  1. Load the Bootstrap CSS in your template.
  2. require "will_paginate-bootstrap" in your Sinatra app.
  3. In your view, use the renderer: BootstrapPagination::Sinatra option with the will_paginate helper, for example:
<%= will_paginate @collection, renderer: BootstrapPagination::Sinatra %>

Bootstrap 3

For Bootstrap 3, the markup required has changed slightly from version 2. You can pass the bootstrap option with a value >= 3 when calling will_paginate to generate Bootstrap 3 compatible markup. For example:

<%= will_paginate @collection, renderer: BootstrapPagination::Rails, bootstrap: 3 %>

By default version 2 compatible markup will be generated.

Compatibility

Ruby >= 1.9.2
will_paginate >= 3.0.3
Bootstrap >= 2.0.0