apps/workbench/app/assets/javascripts/filterable.js

   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.
   5 //
   6 // Usage:
   7 //
   8 // 1. Add the "filterable" class to each filterable content item.
   9 // Typically, each item is a 'tr' or a 'div class="row"'.
  10 //
  11 // <div id="results">
  12 //   <div class="filterable row">First row</div>
  13 //   <div class="filterable row">Second row</div>
  14 // </div>
  15 //
  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.
  20 //
  21 // <input class="filterable-control" data-filterable-target="#results"
  22 //        type="text" />
  23 //
  24 // Supported widgets:
  25 //
  26 // <input type="text" ... />
  27 //
  28 // The input value is used as a regular expression. Rows with content
  29 // matching the regular expression are shown.
  30 //
  31 // <select ... data-filterable-attribute="data-example-attr">
  32 //  <option value="foo">Foo</option>
  33 //  <option value="">Show all</option>
  34 // </select>
  35 //
  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.
  39 //
  40 // Notes:
  41 //
  42 // When multiple filterable-control widgets operate on the same
  43 // data-filterable-target, items must pass _all_ filters in order to
  44 // be shown.
  45 //
  46 // If one data-filterable-target is the parent of another
  47 // data-filterable-target, results are undefined. Don't do this.
  48 //
  49 // Combining "select" filterable-controls with infinite-scroll is not
  50 // yet supported.
  51
  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 == '') {
  56       params.filters = [];
  57     } else {
  58       params.filters = [['any', '@@', newquery.concat(':*')]];
  59     }
  60     $target.data('infinite-content-params-filterable', params);
  61     $target.data('filterable-query', newquery);
  62 }
  63
  64 $(document).
  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() {
  69             var $this = $(this);
  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);
  75             }
  76         });
  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.
  82             if (this != e.target)
  83                 return;
  84             if ($(this).data('filterable-query') == $(this).data('filterable-query-new'))
  85                 return;
  86             updateFilterableQueryNow($(this));
  87         });
  88     }).
  89     on('paste keyup input', 'input[type=text].filterable-control', function(e) {
  90         var regexp;
  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.
  98
  99             if ($target.data('infinite-cooloff-timer') > 0) {
 100                 // Clear a stale refresh-after-delay timer.
 101                 clearTimeout($target.data('infinite-cooloff-timer'));
 102             }
 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
 107                 // progress.
 108                 return;
 109             }
 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');
 117             }, 250));
 118         } else {
 119             // Target does not have infinite-scroll capability. Just
 120             // filter the rows in the browser using a RegExp.
 121             regexp = undefined;
 122             try {
 123                 regexp = new RegExp($(this).val(), 'i');
 124             } catch(e) {
 125                 if (e instanceof SyntaxError) {
 126                     // Invalid/partial regexp. See 'has-error' below.
 127                 } else {
 128                     throw e;
 129                 }
 130             }
 131             $target.
 132                 toggleClass('has-error', regexp === undefined).
 133                 addClass('filterable-container').
 134                 data('q', regexp).
 135                 trigger('refresh');
 136         }
 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() {
 142             var $row = $(this);
 143             var pass = true;
 144             if (q && !$row.text().match(q))
 145                 return false;
 146             if (filters) {
 147                 $.each(filters, function(filterby, val) {
 148                     if (!val) return;
 149                     if (!pass) return;
 150                     pass = false;
 151                     $.each(val.split(" "), function(i, e) {
 152                         if ($row.attr(filterby) == e)
 153                             pass = true;
 154                     });
 155                 });
 156             }
 157             return pass;
 158         }).show();
 159
 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);
 166         });
 167
 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;
 177         $target.
 178             data('filters', filters).
 179             trigger('refresh');
 180     }).on('ajax:complete', function() {
 181         $('.filterable-control').trigger('input');
 182     });