forked from pengwynn/ujs_sort_helper
-
Notifications
You must be signed in to change notification settings - Fork 1
/
README
73 lines (47 loc) · 2.07 KB
/
README
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
=UnobtrusiveSortHelper
This is a plugin version of Stuart Rackham's most excellent SortHelper helper. The link_to_remote ajax calls have been removed in favor of unobtrusive javascript using lowpro.js.
=== Features
- Consecutive clicks toggle the column's sort order.
- Sort state is maintained by a session hash entry.
- Icon image identifies sort column and state.
- Typically used in conjunction with will_paginate plugin
=== Usage
====Controller:
def list
sort_init 'last_name'
sort_update
@items = Contact.find_all nil, sort_clause
end
====Controller (using will_paginate)
def list
sort_init 'last_name'
sort_update
options = {:page => params[:page], :include => :addresses, :order => sort_clause
@contacts = Contact.paginate(options)
end
====Layout (app/views/layouts/application.html.erb):
<%= stylesheet_link_tag "ujs_sort_helper"%>
styles for nifty sort arrow images
<%= javascript_include_tag :defaults%>
as long as prototype.js is included before lowpro and ujs_sort_helper
If you're not using jQuery, reference Dan Webb's lowpro and the Prototype version
of the ujs_sort_helper:
<%= javascript_include_tag "lowpro"%>
you SHOULD already have this ;-)
<%= javascript_include_tag "ujs_sort_helper"%>
If you're using jQuery, simply include the jQuery version (assuming you already
have jQuery and livequery installed)
<%= javascript_include_tag "ujs_sort_helper.jquery.js"%>
====View (table header in index.rhtml):
<thead>
<tr>
<%= sort_header_tag('id', :title => 'Sort by contact ID') %>
<%= sort_header_tag('last_name', :caption => 'Name') %>
<%= sort_header_tag('phone') %>
<%= sort_header_tag('address', :width => 200) %>
</tr>
</thead>
- The ascending and descending sort icon images are sort_asc.png and sort_desc.png and reside in the application's images directory.
- Introduces instance variables: @sort_name, @sort_default.
- Introduces params :sort_key and :sort_order.
Copyright (c) 2005 Stuart Rackham, (c) 2008 Wynn Netherland released under the MIT license