Skip to content

Commit

Permalink
documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
amatsuda committed Feb 8, 2011
1 parent 0c12f5b commit 0499de6
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 4 deletions.
4 changes: 4 additions & 0 deletions CHANGELOG
@@ -1,3 +1,7 @@
== 0.8.0

* using HTML5 <nav> tag rather than <div> for the container tag

== 0.7.0

* Ajaxified paginator templates
Expand Down
12 changes: 8 additions & 4 deletions README.rdoc
Expand Up @@ -18,6 +18,9 @@ No special collection class or something for the paginated values but uses a gen
* Engine based customizable helper
As the whole pagination helper is basically just a collection of links and non-links, Kaminari renders each of them through its own partial template inside the Engine. So, you can easily modify their behaviour or style or whatever by overriding partial templates.

* Modern
The pagination helper outputs the HTML5 <nav> tag by default. Plus, the helper supports the Rails 3 unobtrusive Ajax.


== Rails versions

Expand Down Expand Up @@ -56,18 +59,19 @@ Then bundle:
* Just call the "paginate" helper

<%= paginate @users %>
This will render several "?page=N" pagination links surrounded by an HTML5 <nav> tag.

* Specifing the "window" size
=== Helper Options

# "inner window" (4 by default)
* Specifing the "inner window" size (4 by default)

<%= paginate @users, :window => 3 %>

# "outer window" (1 by default)
* Specifing the "outer window" size (1 by default)

<%= paginate @users, :outer_window => 3 %>

# outer window can be separetely specified by "left", "right" (1 by default)
* outer window can be separetely specified by "left", "right" (1 by default)

<%= paginate @users, :left => 0, :right => 2 %>

Expand Down

0 comments on commit 0499de6

Please sign in to comment.