1 // filterable.js shows/hides content when the user operates
2 // search/select widgets. For "infinite scroll" content, it passes the
3 // filters to the server and retrieves new content. For other content,
4 // it filters the existing DOM elements using jQuery show/hide.
8 // 1. Add the "filterable" class to each filterable content item.
9 // Typically, each item is a 'tr' or a 'div class="row"'.
12 // <div class="filterable row">First row</div>
13 // <div class="filterable row">Second row</div>
16 // 2. Add the "filterable-control" class to each search/select widget.
17 // Also add a data-filterable-target attribute with a jQuery selector
18 // for an ancestor of the filterable items, i.e., the container in
19 // which this widget should apply filtering.
21 // <input class="filterable-control" data-filterable-target="#results"
26 // <input type="text" ... />
28 // The input value is used as a regular expression. Rows with content
29 // matching the regular expression are shown.
31 // <select ... data-filterable-attribute="data-example-attr">
32 // <option value="foo">Foo</option>
33 // <option value="">Show all</option>
36 // When the user selects the "Foo" option, rows with
37 // data-example-attr="foo" are shown, and all others are hidden. When
38 // the user selects the "Show all" option, all rows are shown.
42 // When multiple filterable-control widgets operate on the same
43 // data-filterable-target, items must pass _all_ filters in order to
46 // If one data-filterable-target is the parent of another
47 // data-filterable-target, results are undefined. Don't do this.
49 // Combining "select" filterable-controls with infinite-scroll is not
52 function updateFilterableQueryNow($target) {
53 var newquery = $target.data('filterable-query-new');
54 var params = $target.data('infinite-content-params-filterable') || {};
55 if (newquery == null || newquery == '') {
58 params.filters = [['any', '@@', newquery.trim().concat(':*')]];
60 $target.data('infinite-content-params-filterable', params);
61 $target.data('filterable-query', newquery);
65 on('ready ajax:success', function() {
66 // Copy any initial input values into
67 // data-filterable-query[-new].
68 $('input[type=text].filterable-control').each(function() {
70 var $target = $($this.attr('data-filterable-target'));
71 if ($target.data('filterable-query-new') === undefined) {
72 $target.data('filterable-query', $this.val());
73 $target.data('filterable-query-new', $this.val());
74 updateFilterableQueryNow($target);
77 $('[data-infinite-scroller]').on('refresh-content', '[data-filterable-query]', function(e) {
78 // If some other event causes a refresh-content event while there
79 // is a new query waiting to cooloff, we should use the new query
80 // right away -- otherwise we'd launch an extra ajax request that
81 // would have to be reloaded as soon as the cooloff period ends.
84 if ($(this).data('filterable-query') == $(this).data('filterable-query-new'))
86 updateFilterableQueryNow($(this));
89 on('paste keyup input', 'input[type=text].filterable-control', function(e) {
91 if (this != e.target) return;
92 var $target = $($(this).attr('data-filterable-target'));
93 var currentquery = $target.data('filterable-query');
94 if (currentquery === undefined) currentquery = '';
95 if ($target.is('[data-infinite-scroller]')) {
96 // We already know how to load content dynamically, so we
97 // can do all filtering on the server side.
99 if ($target.data('infinite-cooloff-timer') > 0) {
100 // Clear a stale refresh-after-delay timer.
101 clearTimeout($target.data('infinite-cooloff-timer'));
103 // Stash the new query string in the filterable container.
104 $target.data('filterable-query-new', $(this).val());
105 if (currentquery == $(this).val()) {
106 // Don't mess with existing results or queries in
110 $target.data('infinite-cooloff-timer', setTimeout(function() {
111 // If the user doesn't do any query-changing actions
112 // in the next 1/4 second (like type or erase
113 // characters in the search box), hide the stale
114 // content and ask the server for new results.
115 updateFilterableQueryNow($target);
116 $target.trigger('refresh-content');
119 // Target does not have infinite-scroll capability. Just
120 // filter the rows in the browser using a RegExp.
123 regexp = new RegExp($(this).val(), 'i');
125 if (e instanceof SyntaxError) {
126 // Invalid/partial regexp. See 'has-error' below.
132 toggleClass('has-error', regexp === undefined).
133 addClass('filterable-container').
137 }).on('refresh', '.filterable-container', function() {
138 var $container = $(this);
139 var q = $(this).data('q');
140 var filters = $(this).data('filters');
141 $('.filterable', this).hide().filter(function() {
144 if (q && !$row.text().match(q))
147 $.each(filters, function(filterby, val) {
151 $.each(val.split(" "), function(i, e) {
152 if ($row.attr(filterby) == e)
160 // Show/hide each section heading depending on whether any
161 // content rows are visible in that section.
162 $('.row[data-section-heading]', this).each(function(){
163 $(this).toggle($('.row.filterable[data-section-name="' +
164 $(this).attr('data-section-name') +
165 '"]:visible').length > 0);
168 // Load more content if the last result is showing.
169 $('.infinite-scroller').add(window).trigger('scroll');
170 }).on('change', 'select.filterable-control', function() {
171 var val = $(this).val();
172 var filterby = $(this).attr('data-filterable-attribute');
173 var $target = $($(this).attr('data-filterable-target')).
174 addClass('filterable-container');
175 var filters = $target.data('filters') || {};
176 filters[filterby] = val;
178 data('filters', filters).
180 }).on('ajax:complete', function() {
181 $('.filterable-control').trigger('input');