Merge pull request #1293 from hypothesis/user-focus-ui

Add first iteration of UI to user-focused mode

src/images/icons/cancel.svg

+<svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 16 16" aria-hidden="true" focusable="false" class="Icon Icon--cancel"><g fill-rule="evenodd"><rect fill="none" stroke="none" x="0" y="0" width="16" height="16"></rect><path fill="none" stroke="currentColor" stroke-linecap="round" stroke-linejoin="round" stroke-width="2" d="M8 8l3.536-3.536L8 8 4.464 4.464 8 8zm0 0l-3.536 3.536L8 8l3.536 3.536L8 8z"></path></g></svg>

src/sidebar/components/focused-mode-header.js

@@ -4,42 +4,59 @@ const { createElement } = require('preact');
 
 const useStore = require('../store/use-store');
 
+const SvgIcon = require('./svg-icon');
+
 /**
  * Render a control to interact with any focused "mode" in the sidebar.
  * Currently only a user-focus mode is supported but this could be broadened
  * and abstracted if needed. Allow user to toggle in and out of the focus "mode."
  */
 function FocusedModeHeader() {
-  const store = useStore(store => ({
-    actions: {
-      setFocusModeFocused: store.setFocusModeFocused,
-    },
-    selectors: {
-      focusModeFocused: store.focusModeFocused,
-      focusModeUserPrettyName: store.focusModeUserPrettyName,
-    },
+  const actions = useStore(store => ({
+    setFocusModeFocused: store.setFocusModeFocused,
+  }));
+  const selectors = useStore(store => ({
+    focusModeFocused: store.focusModeFocused(),
+    focusModeHasUser: store.focusModeHasUser(),
+    focusModeUserPrettyName: store.focusModeUserPrettyName(),
   }));
 
+  // Nothing to do here for now if we're not focused on a user
+  if (!selectors.focusModeHasUser) {
+    return null;
+  }
+
   const toggleFocusedMode = () => {
-    store.actions.setFocusModeFocused(!store.selectors.focusModeFocused());
+    actions.setFocusModeFocused(!selectors.focusModeFocused);
   };
 
-  const buttonText = () => {
-    if (store.selectors.focusModeFocused()) {
-      return `Annotations by ${store.selectors.focusModeUserPrettyName()}`;
+  const filterStatus = (
+    <div className="focused-mode-header__filter-status">
+      {selectors.focusModeFocused ? (
+        <span>
+          Annotations by <strong>{selectors.focusModeUserPrettyName}</strong>{' '}
+          only
+        </span>
+      ) : (
+        <span>Everybody&rsquo;s annotations</span>
+      )}
+    </div>
+  );
+
+  const buttonText = (() => {
+    if (selectors.focusModeFocused) {
+      return 'Show all';
     } else {
-      return 'All annotations';
+      return `Only ${selectors.focusModeUserPrettyName}`;
     }
-  };
+  })();
 
   return (
-    <div className="focused-mode-header">
-      <button
-        onClick={toggleFocusedMode}
-        className="primary-action-btn primary-action-btn--short"
-        title={`Toggle to show annotations only by ${store.selectors.focusModeUserPrettyName()}`}
-      >
-        {buttonText()}
+    <div className="focused-mode-header sheet">
+      {filterStatus}
+      <button onClick={toggleFocusedMode} className="focused-mode-header__btn">
+        <SvgIcon name="cancel" className="focused-mode-header__btn-icon" />
+        {buttonText}
       </button>
     </div>
   );

src/sidebar/components/svg-icon.js

@@ -7,6 +7,7 @@ const propTypes = require('prop-types');
 // The list of supported icons
 const icons = {
   add: require('../../images/icons/add.svg'),
+  cancel: require('../../images/icons/cancel.svg'),
   'collapse-menu': require('../../images/icons/collapse-menu.svg'),
   'expand-menu': require('../../images/icons/expand-menu.svg'),
   copy: require('../../images/icons/copy.svg'),

src/sidebar/components/test/focused-mode-header-test.js

@@ -19,8 +19,9 @@ describe('FocusedModeHeader', function() {
           focused: true,
         },
       },
-      focusModeFocused: sinon.stub().returns(false),
+      focusModeFocused: sinon.stub().returns(true),
       focusModeUserPrettyName: sinon.stub().returns('Fake User'),
+      focusModeHasUser: sinon.stub().returns(true),
       setFocusModeFocused: sinon.stub(),
     };
     FocusedModeHeader.$imports.$mock({
@@ -32,29 +33,71 @@ describe('FocusedModeHeader', function() {
     FocusedModeHeader.$imports.$restore();
   });
 
-  it('creates the component', () => {
-    const wrapper = createComponent();
-    assert.include(wrapper.text(), 'All annotations');
-  });
+  context('not in user-focused mode', () => {
+    it('should not render anything if not in user-focused mode', () => {
+      fakeStore.focusModeHasUser = sinon.stub().returns(false);
+
+      const wrapper = createComponent();
 
-  it("sets the button's text to the user's name when focused", () => {
-    fakeStore.focusModeFocused = sinon.stub().returns(true);
-    const wrapper = createComponent();
-    assert.include(wrapper.text(), 'Annotations by Fake User');
+      assert.isFalse(wrapper.exists('.focused-mode-header'));
+    });
   });
 
-  describe('clicking the button shall toggle the focused mode', function() {
-    it('when focused is false, toggle to true', () => {
-      const wrapper = createComponent();
-      wrapper.find('button').simulate('click');
-      assert.calledWith(fakeStore.setFocusModeFocused, true);
+  context('user-focused mode', () => {
+    context('focus is applied (focused/on)', () => {
+      it("should render status text indicating only that user's annotations are visible", () => {
+        const wrapper = createComponent();
+
+        assert.match(wrapper.text(), /Annotations by.+Fake User/);
+      });
+
+      it('should render a button allowing the user to view all annotations', () => {
+        const wrapper = createComponent();
+
+        const button = wrapper.find('button');
+
+        assert.include(button.text(), 'Show all');
+      });
     });
 
-    it('when focused is true, toggle to false', () => {
-      fakeStore.focusModeFocused = sinon.stub().returns(true);
-      const wrapper = createComponent();
-      wrapper.find('button').simulate('click');
-      assert.calledWith(fakeStore.setFocusModeFocused, false);
+    context('focus is not applied (unfocused/off)', () => {
+      beforeEach(() => {
+        fakeStore.focusModeFocused = sinon.stub().returns(false);
+      });
+
+      it("should render status text indicating that all user's annotations are visible", () => {
+        const wrapper = createComponent();
+
+        assert.match(wrapper.text(), /Everybody.*s annotations/);
+      });
+
+      it("should render a button allowing the user to view only focus user's annotations", () => {
+        const wrapper = createComponent();
+
+        const button = wrapper.find('button');
+
+        assert.include(button.text(), 'Only Fake User');
+      });
+    });
+
+    describe('toggle button', () => {
+      it('should toggle focus mode to false if clicked when focused', () => {
+        fakeStore.focusModeFocused = sinon.stub().returns(true);
+        const wrapper = createComponent();
+
+        wrapper.find('button').simulate('click');
+
+        assert.calledWith(fakeStore.setFocusModeFocused, false);
+      });
+
+      it('should toggle focus mode to true if clicked when not focused', () => {
+        fakeStore.focusModeFocused = sinon.stub().returns(false);
+        const wrapper = createComponent();
+
+        wrapper.find('button').simulate('click');
+
+        assert.calledWith(fakeStore.setFocusModeFocused, true);
+      });
     });
   });
 });

src/sidebar/services/root-thread.js

@@ -55,7 +55,8 @@ function RootThread($rootScope, store, searchFilter, viewFilter) {
     let filterFn;
     if (shouldFilterThread()) {
       const filters = searchFilter.generateFacetedFilter(state.filterQuery, {
-        user: store.focusModeUsername(), // `null` if no focused user
+        // if a focus mode is applied (focused) and we're focusing on a user
+        user: store.focusModeFocused() && store.focusModeUsername(),
       });
 
       filterFn = function(annot) {

src/styles/sidebar/components/focused-mode-header.scss

+// A dark grey button used for the primary action
+// in a form
 .focused-mode-header {
-  margin-bottom: 10px;
-  button {
-    width: 100%;
-    height: 24px;
-    margin-right: 10px;
-    &:focus {
-      outline: none;
+  display: flex;
+  align-items: center;
+
+  &__btn {
+    @include primary-action-btn;
+    @include outline-on-keyboard-focus;
+    display: flex;
+    margin-left: auto;
+    height: 30px;
+    padding-left: 6px;
+    padding-right: 10px;
+    background-color: $grey-2;
+    color: $grey-5;
+    &:hover:enabled {
+      background-color: $grey-3;
     }
   }
+
+  &__btn-icon {
+    margin-right: 3px;
+  }
+
+  &__filter-status {
+    font-weight: 400;
+  }
 }