From fddcd1c6cfe868cee0c639d8bc5599360e5c6360 Mon Sep 17 00:00:00 2001
From: JC Brand <jc@opkode.com>
Date: Mon, 13 Feb 2017 15:05:43 +0000
Subject: [PATCH] Improved roster filter UX.

Keep the focus in the input after filtering.
Prevent form submission from reloading the page.
---
 css/converse.css           | 12 ++++++------
 docs/CHANGES.md            |  1 +
 sass/_roster.scss          |  2 +-
 src/converse-rosterview.js | 17 ++++++++++++++---
 src/templates/roster.html  |  2 +-
 5 files changed, 23 insertions(+), 11 deletions(-)

diff --git a/css/converse.css b/css/converse.css
index d615961cc..f9d42c212 100644
--- a/css/converse.css
+++ b/css/converse.css
@@ -2112,13 +2112,13 @@
     display: none; }
   #conversejs #converse-roster .search-xmpp ul li.chat-info {
     padding-left: 10px; }
-  #conversejs #converse-roster .roster-filter-group {
+  #conversejs #converse-roster .roster-filter-form {
     margin: 0 1em;
     width: 100%;
     padding-right: 2em;
     /* (jQ addClass:) if input has value: */
     /* (jQ addClass:) if mouse is over the 'x' input area*/ }
-    #conversejs #converse-roster .roster-filter-group .roster-filter {
+    #conversejs #converse-roster .roster-filter-form .roster-filter {
       float: left;
       background: url(data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAcAAAAHCAYAAADEUlfTAAAACXBIWXMAAAsTAAALEwEAmpwYAAAAIGNIUk0AAHolAACAgwAA+f8AAIDpAAB1MAAA6mAAADqYAAAXb5JfxUYAAABNSURBVHjaXI7BDcAwCAMvyQjMyQ6dAbZiKfqoUK34g2zJh1dENIC7M8pMAPYdzAVY3d0ajNz9aypS/b5R6o+ZPdqoKgCq6h80KH3xDgBqNR97p8oAGQAAAABJRU5ErkJggg==) no-repeat right -20px center;
       border: 1px solid #999;
@@ -2128,11 +2128,11 @@
       padding: 0;
       padding-left: 0.4em;
       width: 53%; }
-    #conversejs #converse-roster .roster-filter-group .roster-filter.x {
+    #conversejs #converse-roster .roster-filter-form .roster-filter.x {
       background-position: right 3px center; }
-    #conversejs #converse-roster .roster-filter-group .roster-filter.onX {
+    #conversejs #converse-roster .roster-filter-form .roster-filter.onX {
       cursor: pointer; }
-    #conversejs #converse-roster .roster-filter-group .state-type {
+    #conversejs #converse-roster .roster-filter-form .state-type {
       float: left;
       border: 1px solid #999;
       font-size: calc(14px - 2px);
@@ -2141,7 +2141,7 @@
       padding: 0;
       padding-left: 0.4em;
       width: 53%; }
-    #conversejs #converse-roster .roster-filter-group .filter-type {
+    #conversejs #converse-roster .roster-filter-form .filter-type {
       display: table-cell;
       float: right;
       font-size: calc(14px - 2px);
diff --git a/docs/CHANGES.md b/docs/CHANGES.md
index fea754fa5..620ae7a60 100755
--- a/docs/CHANGES.md
+++ b/docs/CHANGES.md
@@ -8,6 +8,7 @@
   object as first parameter. [jcbrand]
 - Use lodash instead of underscore.js [jcbrand]
 - Escape user-generated input to prevent JS-injection attacks. (Thanks to SamWhited) [jcbrand]
+- Improved roster filter UX. [jcbrand]
 - #486 Honor existing mam user configuration [throwaway42]
 - #749 /me will show your contact's name in the sent field [jcbrand]
 - #774 Browser language (fr-fr or fr) is not detected by default [jcbrand]
diff --git a/sass/_roster.scss b/sass/_roster.scss
index ffc47684b..31f2bd5d8 100644
--- a/sass/_roster.scss
+++ b/sass/_roster.scss
@@ -26,7 +26,7 @@
         }
     }
 
-    .roster-filter-group {
+    .roster-filter-form {
         margin: 0 1em;
         width: 100%;
         padding-right: 1em + 2*$chat-gutter;
diff --git a/src/converse-rosterview.js b/src/converse-rosterview.js
index 404a5d0ee..e0794d1d0 100644
--- a/src/converse-rosterview.js
+++ b/src/converse-rosterview.js
@@ -139,6 +139,7 @@
                 tagName: 'span',
                 events: {
                     "keydown .roster-filter": "liveFilter",
+                    "submit form.roster-filter-form": "submitFilter",
                     "click .onX": "clearFilter",
                     "mousemove .x": "toggleX",
                     "change .filter-type": "changeTypeFilter",
@@ -146,7 +147,8 @@
                 },
 
                 initialize: function () {
-                    this.model.on('change', this.render, this);
+                    this.model.on('change:filter_type', this.render, this);
+                    this.model.on('change:filter_text', this.render, this);
                 },
 
                 render: function () {
@@ -165,9 +167,13 @@
                             label_offline: __('Offline')
                         })
                     ));
+                    this.renderClearButton();
+                    return this.$el;
+                },
+
+                renderClearButton: function () {
                     var $roster_filter = this.$('.roster-filter');
                     $roster_filter[this.tog($roster_filter.val())]('x');
-                    return this.$el;
                 },
 
                 tog: function (v) {
@@ -204,13 +210,18 @@
                 },
 
                 liveFilter: _.debounce(function (ev) {
-                    if (ev && ev.preventDefault) { ev.preventDefault(); }
                     this.model.save({
                         'filter_type': this.$('.filter-type').val(),
                         'filter_text': this.$('.roster-filter').val()
                     });
                 }, 250),
 
+                submitFilter: function (ev) {
+                    if (ev && ev.preventDefault) { ev.preventDefault(); }
+                    this.liveFilter();
+                    this.render();
+                },
+
                 isActive: function () {
                     /* Returns true if the filter is enabled (i.e. if the user
                      * has added values to the filter).
diff --git a/src/templates/roster.html b/src/templates/roster.html
index d77d7d336..c6c9f0f33 100644
--- a/src/templates/roster.html
+++ b/src/templates/roster.html
@@ -1,4 +1,4 @@
-<form class="pure-form roster-filter-group input-button-group">
+<form class="pure-form roster-filter-form input-button-group">
     <input value="{{filter_text}}" class="roster-filter"
            placeholder="{{placeholder}}"
            {[ if (filter_type === 'state') { ]}  style="display: none" {[ } ]} >