Merge pull request #1540 from hypothesis/annotation-action-icons

Update annotation icons (footer icons) to newer, SVG variants

src/images/icons/edit.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--edit"><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="M11 4l1 1-9 9-2 1 1-2 9-9zm3-3l1 1-1 1-1-1 1-1z"></path></g></svg>

src/images/icons/flag--active.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--flag-filled"><g fill-rule="evenodd"><rect fill="none" stroke="none" x="0" y="0" width="16" height="16"></rect><path fill="currentColor" stroke="none" d="M2 1a1 1 0 01.883-.993L3 0h12c.852 0 1.297.986.783 1.623l-.076.084L12.415 5l3.292 3.293c.575.575.253 1.523-.485 1.684l-.108.017L15 10H4v5a1 1 0 01-1.993.117L2 15V1z"></path></g></svg>

src/images/icons/flag.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--flag"><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="M3 9v6V1h12l-4 4 4 4H3z"></path></g></svg>

src/images/icons/trash.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--trash"><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="M2 4h12l-2 11H4L2 4zM1 1h14H1z"></path></g></svg>

src/sidebar/components/annotation-action-button.js

@@ -4,22 +4,31 @@ const classnames = require('classnames');
 const propTypes = require('prop-types');
 const { createElement } = require('preact');
 
-function AnnotationActionButton({ icon, isDisabled, label, onClick }) {
+const SvgIcon = require('./svg-icon');
+
+function AnnotationActionButton({
+  className = '',
+  icon,
+  isDisabled,
+  label,
+  onClick,
+}) {
   return (
     <button
-      className="btn btn-clean annotation-action-btn"
+      className={classnames('annotation-action-button', className)}
       onClick={onClick}
       disabled={isDisabled}
       aria-label={label}
-      h-tooltip
+      title={label}
     >
-      <i className={classnames(icon, 'btn-icon')} />
+      <SvgIcon name={icon} className="annotation-action-button__icon" />
     </button>
   );
 }
 
 AnnotationActionButton.propTypes = {
-  /** A CSS classname corresponding to an `h` icon */
+  className: propTypes.string,
+  /** The name of the SVGIcon to render */
   icon: propTypes.string.isRequired,
   isDisabled: propTypes.bool.isRequired,
   label: propTypes.string.isRequired,

src/sidebar/components/annotation-share-control.js

@@ -85,7 +85,7 @@ function AnnotationShareControl({
   return (
     <div className="annotation-share-control" ref={shareRef}>
       <AnnotationActionButton
-        icon="h-icon-annotation-share"
+        icon="share"
         isDisabled={false}
         label="Share"
         onClick={toggleSharePanel}

src/sidebar/components/svg-icon.js

@@ -15,10 +15,13 @@ const icons = {
   'collapse-menu': require('../../images/icons/collapse-menu.svg'),
   copy: require('../../images/icons/copy.svg'),
   cursor: require('../../images/icons/cursor.svg'),
+  edit: require('../../images/icons/edit.svg'),
   email: require('../../images/icons/email.svg'),
   'expand-menu': require('../../images/icons/expand-menu.svg'),
   external: require('../../images/icons/external.svg'),
   facebook: require('../../images/icons/facebook.svg'),
+  flag: require('../../images/icons/flag.svg'),
+  'flag--active': require('../../images/icons/flag--active.svg'),
   'format-bold': require('../../images/icons/format-bold.svg'),
   'format-functions': require('../../images/icons/format-functions.svg'),
   'format-italic': require('../../images/icons/format-italic.svg'),
@@ -38,6 +41,7 @@ const icons = {
   refresh: require('../../images/icons/refresh.svg'),
   reply: require('../../images/icons/reply.svg'),
   share: require('../../images/icons/share.svg'),
+  trash: require('../../images/icons/trash.svg'),
   twitter: require('../../images/icons/twitter.svg'),
 };
 

src/sidebar/components/test/annotation-action-button-test.js

+'use strict';
+
+const { createElement } = require('preact');
+const { mount } = require('enzyme');
+
+const AnnotationActionButton = require('../annotation-action-button');
+const mockImportedComponents = require('./mock-imported-components');
+
+describe('AnnotationActionButton', () => {
+  let fakeOnClick;
+
+  function createComponent(props = {}) {
+    return mount(
+      <AnnotationActionButton
+        icon="fakeIcon"
+        isDisabled={false}
+        label="My Action"
+        onClick={fakeOnClick}
+        {...props}
+      />
+    );
+  }
+
+  beforeEach(() => {
+    fakeOnClick = sinon.stub();
+    AnnotationActionButton.$imports.$mock(mockImportedComponents());
+  });
+
+  afterEach(() => {
+    AnnotationActionButton.$imports.$restore();
+  });
+
+  it('applies any provided className to the button', () => {
+    const wrapper = createComponent({ className: 'my-class' });
+    assert.isTrue(wrapper.hasClass('my-class'));
+  });
+});

src/sidebar/templates/annotation.html

@@ -53,14 +53,15 @@
   <!-- / Tags -->
 
   <footer class="annotation-footer">
+
     <div class="annotation-form-actions" ng-if="vm.editing()">
-    <annotation-publish-control
-      group="vm.group()"
-      is-disabled="!vm.hasContent()"
-      is-shared="vm.isShared()"
-      on-cancel="vm.revert()"
-      on-save="vm.save()"
-      on-set-privacy="vm.setPrivacy(level)"></annotation-publish-control>
+      <annotation-publish-control
+        group="vm.group()"
+        is-disabled="!vm.hasContent()"
+        is-shared="vm.isShared()"
+        on-cancel="vm.revert()"
+        on-save="vm.save()"
+        on-set-privacy="vm.setPrivacy(level)"></annotation-publish-control>
     </div>
 
     <div class="annotation-section annotation-license"
@@ -88,21 +89,21 @@
     <div class="annotation-actions" ng-if="!vm.isSaving && !vm.editing() && vm.id()">
       <div ng-show="vm.isSaving">Saving…</div>
       <annotation-action-button
-        icon="'h-icon-annotation-edit'"
+        icon="'edit'"
         is-disabled="vm.isDeleted()"
         label="'Edit'"
         ng-show="vm.authorize('update') && !vm.isSaving"
         on-click="vm.edit()"
       ></annotation-action-button>
       <annotation-action-button
-        icon="'h-icon-annotation-delete'"
+        icon="'trash'"
         is-disabled="vm.isDeleted()"
         label="'Delete'"
         ng-show="vm.authorize('delete')"
         on-click="vm.delete()"
       ></annotation-action-button>
       <annotation-action-button
-        icon="'h-icon-annotation-reply'"
+        icon="'reply'"
         is-disabled="vm.isDeleted()"
         label="'Reply'"
         on-click="vm.reply()"
@@ -112,14 +113,15 @@
       </span>
       <span ng-if="vm.canFlag()">
         <annotation-action-button
-         icon="'h-icon-annotation-flag'"
+         icon="'flag'"
          is-disabled="vm.isDeleted()"
          label="'Report this annotation to the moderators'"
          ng-if="!vm.isFlagged()"
          on-click="vm.flag()"
         ></annotation-action-button>
         <annotation-action-button
-         icon="'h-icon-annotation-flag annotation--flagged'"
+         class-name="'annotation-action-button--active'"
+         icon="'flag--active'"
          is-disabled="vm.isDeleted()"
          label="'Annotation has been reported to the moderators'"
          ng-if="vm.isFlagged()"

src/styles/mixins/buttons.scss

@@ -10,15 +10,33 @@
   border-style: none;
 }
 
+/**
+ * Basic color, sizing, padding and hover for any button
+ */
+@mixin button-base {
+  @include reset-native-btn-styles;
+  padding: 0.5em;
+  color: var.$grey-5;
+
+  &__icon {
+    width: 16px;
+    height: 16px;
+  }
+
+  &:hover {
+    transition: 0.2s ease-out;
+    color: var.$grey-6;
+  }
+}
+
 /**
  * A <button> composed of an SVG icon (left) and text (right) with some
  * hover transition effects
  */
 @mixin action-button($icon-margin: 0 5px) {
-  @include reset-native-btn-styles;
+  @include button-base;
   display: flex;
   align-items: center;
-  padding: 0.5em;
   border-radius: 2px;
   border: none;
   background-color: var.$grey-1;
@@ -31,9 +49,7 @@
   }
 
   &:hover {
-    transition: 0.2s ease-out;
     background-color: var.$grey-2;
-    color: var.$grey-6;
   }
 }
 

src/styles/sidebar/components/annotation-action-button.scss

+@use "../../mixins/buttons";
+@use "../../variables" as var;
+
+.annotation-action-button {
+  @include buttons.button-base;
+
+  &--active {
+    color: var.$brand;
+
+    &:hover {
+      color: var.$brand;
+    }
+  }
+}
+
+@media (pointer: coarse) {
+  .annotation-action-button {
+    min-width: var.$touch-target-size;
+    min-height: var.$touch-target-size;
+  }
+}

src/styles/sidebar/components/annotation-share-control.scss

@@ -10,8 +10,8 @@
 .annotation-share-panel {
   @include panel.panel--compact;
   position: absolute;
-  right: -5px;
-  bottom: 30px;
+  right: 5px;
+  bottom: 32px;
   width: 275px;
   box-shadow: 0px 0px 5px 0px rgba(0, 0, 0, 0.15);
   cursor: default;

src/styles/sidebar/sidebar.scss

@@ -25,6 +25,7 @@
 // Components
 // ----------
 @use './components/action-button';
+@use './components/annotation-action-button';
 @use './components/annotation';
 @use './components/annotation-document-info';
 @use './components/annotation-header';