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     params.filters = [['any', 'ilike', '%' + newquery + '%']];
  56     $target.data('infinite-content-params-filterable', params);
  57     $target.data('filterable-query', newquery);
  58 }
  59
  60 $(document).
  61     on('ready ajax:success', function() {
  62         // Copy any initial input values into
  63         // data-filterable-query[-new].
  64         $('input[type=text].filterable-control').each(function() {
  65             var $this = $(this);
  66             var $target = $($this.attr('data-filterable-target'));
  67             if ($target.data('filterable-query-new') === undefined) {
  68                 $target.data('filterable-query', $this.val());
  69                 $target.data('filterable-query-new', $this.val());
  70                 updateFilterableQueryNow($target);
  71             }
  72         });
  73         $('[data-infinite-scroller]').on('refresh-content', '[data-filterable-query]', function(e) {
  74             // If some other event causes a refresh-content event while there
  75             // is a new query waiting to cooloff, we should use the new query
  76             // right away -- otherwise we'd launch an extra ajax request that
  77             // would have to be reloaded as soon as the cooloff period ends.
  78             if (this != e.target)
  79                 return;
  80             if ($(this).data('filterable-query') == $(this).data('filterable-query-new'))
  81                 return;
  82             updateFilterableQueryNow($(this));
  83         });
  84     }).
  85     on('paste keyup input', 'input[type=text].filterable-control', function(e) {
  86         var regexp;
  87         if (this != e.target) return;
  88         var $target = $($(this).attr('data-filterable-target'));
  89         var currentquery = $target.data('filterable-query');
  90         if (currentquery === undefined) currentquery = '';
  91         if ($target.is('[data-infinite-scroller]')) {
  92             // We already know how to load content dynamically, so we
  93             // can do all filtering on the server side.
  94
  95             if ($target.data('infinite-cooloff-timer') > 0) {
  96                 // Clear a stale refresh-after-delay timer.
  97                 clearTimeout($target.data('infinite-cooloff-timer'));
  98             }
  99             // Stash the new query string in the filterable container.
 100             $target.data('filterable-query-new', $(this).val());
 101             if (currentquery == $(this).val()) {
 102                 // Don't mess with existing results or queries in
 103                 // progress.
 104                 return;
 105             }
 106             $target.data('infinite-cooloff-timer', setTimeout(function() {
 107                 // If the user doesn't do any query-changing actions
 108                 // in the next 1/4 second (like type or erase
 109                 // characters in the search box), hide the stale
 110                 // content and ask the server for new results.
 111                 updateFilterableQueryNow($target);
 112                 $target.trigger('refresh-content');
 113             }, 250));
 114         } else {
 115             // Target does not have infinite-scroll capability. Just
 116             // filter the rows in the browser using a RegExp.
 117             regexp = undefined;
 118             try {
 119                 regexp = new RegExp($(this).val(), 'i');
 120             } catch(e) {
 121                 if (e instanceof SyntaxError) {
 122                     // Invalid/partial regexp. See 'has-error' below.
 123                 } else {
 124                     throw e;
 125                 }
 126             }
 127             $target.
 128                 toggleClass('has-error', regexp === undefined).
 129                 addClass('filterable-container').
 130                 data('q', regexp).
 131                 trigger('refresh');
 132         }
 133     }).on('refresh', '.filterable-container', function() {
 134         var $container = $(this);
 135         var q = $(this).data('q');
 136         var filters = $(this).data('filters');
 137         $('.filterable', this).hide().filter(function() {
 138             var $row = $(this);
 139             var pass = true;
 140             if (q && !$row.text().match(q))
 141                 return false;
 142             if (filters) {
 143                 $.each(filters, function(filterby, val) {
 144                     if (!val) return;
 145                     if (!pass) return;
 146                     pass = false;
 147                     $.each(val.split(" "), function(i, e) {
 148                         if ($row.attr(filterby) == e)
 149                             pass = true;
 150                     });
 151                 });
 152             }
 153             return pass;
 154         }).show();
 155
 156         // Show/hide each section heading depending on whether any
 157         // content rows are visible in that section.
 158         $('.row[data-section-heading]', this).each(function(){
 159             $(this).toggle($('.row.filterable[data-section-name="' +
 160                              $(this).attr('data-section-name') +
 161                              '"]:visible').length > 0);
 162         });
 163
 164         // Load more content if the last result is showing.
 165         $('.infinite-scroller').add(window).trigger('scroll');
 166     }).on('change', 'select.filterable-control', function() {
 167         var val = $(this).val();
 168         var filterby = $(this).attr('data-filterable-attribute');
 169         var $target = $($(this).attr('data-filterable-target')).
 170             addClass('filterable-container');
 171         var filters = $target.data('filters') || {};
 172         filters[filterby] = val;
 173         $target.
 174             data('filters', filters).
 175             trigger('refresh');
 176     }).on('ajax:complete', function() {
 177         $('.filterable-control').trigger('input');
 178     });