From 62e34bf5b0ed8aa807c8f557a1047d8c2636faf9 Mon Sep 17 00:00:00 2001
From: Alina Beck <alina.beck@mail.com>
Date: Mon, 26 Aug 2019 12:46:46 +0100
Subject: [PATCH] refactor suggestion list

---
 webapp/components/Editor/Editor.vue         |  34 ------
 webapp/components/Editor/SuggestionList.vue | 114 ++++++++++++--------
 2 files changed, 70 insertions(+), 78 deletions(-)

diff --git a/webapp/components/Editor/Editor.vue b/webapp/components/Editor/Editor.vue
index d08257347..c511eae8e 100644
--- a/webapp/components/Editor/Editor.vue
+++ b/webapp/components/Editor/Editor.vue
@@ -4,14 +4,12 @@
     <editor-content ref="editor" :editor="editor" />
     <context-menu ref="contextMenu" />
     <suggestion-list
-      v-show="showSuggestions"
       ref="suggestions"
       :suggestion-type="suggestionType"
       :filtered-items="filteredItems"
       :navigated-item-index="navigatedItemIndex"
       :query="query"
       :select-item="selectItem"
-      :has-results="hasResults"
     />
     <link-input v-show="linkMenuIsActive" ref="linkMenu" :editorCommand="editor.commands.link" />
   </div>
@@ -68,12 +66,6 @@ export default {
   },
   computed: {
     ...mapGetters({ placeholder: 'editor/placeholder' }),
-    hasResults() {
-      return this.filteredItems.length
-    },
-    showSuggestions() {
-      return this.query || this.hasResults
-    },
     optionalExtensions() {
       const extensions = []
       // Don't change the following line. The functionallity is in danger!
@@ -290,32 +282,6 @@ export default {
 </script>
 
 <style lang="scss">
-.suggestion-list {
-  padding: 0.2rem;
-  border: 2px solid rgba($color-neutral-0, 0.1);
-  font-size: 0.8rem;
-  font-weight: bold;
-  &__no-results {
-    padding: 0.2rem 0.5rem;
-  }
-  &__item {
-    border-radius: 5px;
-    padding: 0.2rem 0.5rem;
-    margin-bottom: 0.2rem;
-    cursor: pointer;
-    &:last-child {
-      margin-bottom: 0;
-    }
-    &.is-selected,
-    &:hover {
-      background-color: rgba($color-neutral-100, 0.2);
-    }
-    &.is-empty {
-      opacity: 0.5;
-    }
-  }
-}
-
 .tippy-tooltip.dark-theme {
   background-color: $color-neutral-0;
   padding: 0;
diff --git a/webapp/components/Editor/SuggestionList.vue b/webapp/components/Editor/SuggestionList.vue
index 5eed66c79..f4a1966a0 100644
--- a/webapp/components/Editor/SuggestionList.vue
+++ b/webapp/components/Editor/SuggestionList.vue
@@ -1,48 +1,29 @@
 <template>
-  <div class="suggestion-list">
-    <!-- "filteredItems" array is not empty -->
-    <template v-if="hasResults">
-      <div
-        v-for="(item, index) in filteredItems"
-        :key="item.id"
-        class="suggestion-list__item"
-        :class="{ 'is-selected': navigatedItemIndex === index }"
-        @click="selectItem(item)"
-      >
-        <div v-if="isMention">@{{ item.slug }}</div>
-        <div v-if="isHashtag">#{{ item.id }}</div>
-      </div>
-      <div v-if="isHashtag">
-        <!-- if query is not empty and is find fully in the suggestions array ... -->
-        <div v-if="query && !filteredItems.find(el => el.id === query)">
-          <div class="suggestion-list__item is-empty">{{ $t('editor.hashtag.addHashtag') }}</div>
-          <div class="suggestion-list__item" @click="selectItem({ id: query })">#{{ query }}</div>
-        </div>
-        <!-- otherwise if sanitized query is empty advice the user to add a char -->
-        <div v-else-if="!query">
-          <div class="suggestion-list__item is-empty">{{ $t('editor.hashtag.addLetter') }}</div>
-        </div>
-      </div>
+  <ul v-show="showSuggestions" class="suggestion-list">
+    <li
+      v-for="(item, index) in filteredItems"
+      :key="item.id"
+      class="suggestion-list__item"
+      :class="{ 'is-selected': navigatedItemIndex === index }"
+      @click="selectItem(item)"
+    >
+      {{ createItemLabel(item) }}
+    </li>
+    <template v-if="isHashtag">
+      <li v-if="!query" class="suggestion-list__item hint">
+        {{ $t('editor.hashtag.addLetter') }}
+      </li>
+      <template v-else-if="!filteredItems.find(el => el.id === query)">
+        <li class="suggestion-list__item hint">{{ $t('editor.hashtag.addHashtag') }}</li>
+        <li class="suggestion-list__item" @click="selectItem({ id: query })">#{{ query }}</li>
+      </template>
     </template>
-    <!-- if "!hasResults" -->
-    <div v-else>
-      <div
-        v-if="isMention"
-        class="suggestion-list__item is-empty"
-      >{{ $t('editor.mention.noUsersFound') }}</div>
-      <div v-if="isHashtag">
-        <div
-          v-if="query === ''"
-          class="suggestion-list__item is-empty"
-        >{{ $t('editor.hashtag.noHashtagsFound') }}</div>
-        <!-- if "query" is not empty -->
-        <div v-else>
-          <div class="suggestion-list__item is-empty">{{ $t('editor.hashtag.addHashtag') }}</div>
-          <div class="suggestion-list__item" @click="selectItem({ id: query })">#{{ query }}</div>
-        </div>
-      </div>
-    </div>
-  </div>
+    <template v-else-if="isMention">
+      <li v-if="!hasResults" class="suggestion-list__item hint">
+        {{ $t('editor.mention.noUsersFound') }}
+      </li>
+    </template>
+  </ul>
 </template>
 
 <script>
@@ -55,15 +36,60 @@ export default {
     query: String,
     navigatedItemIndex: Number,
     selectItem: Function,
-    hasResults: Number,
   },
   computed: {
+    hasResults() {
+      return this.filteredItems.length > 0
+    },
     isMention() {
       return this.suggestionType === MENTION
     },
     isHashtag() {
       return this.suggestionType === HASHTAG
     },
+    showSuggestions() {
+      return this.query || this.hasResults
+    },
+  },
+  methods: {
+    createItemLabel(item) {
+      if (this.isMention) {
+        return `@${item.slug}`
+      } else {
+        return `#${item.id}`
+      }
+    },
   },
 }
 </script>
+
+<style lang="scss">
+.suggestion-list {
+  list-style-type: none;
+  padding: 0.2rem;
+  border: 2px solid rgba($color-neutral-0, 0.1);
+  font-size: 0.8rem;
+  font-weight: bold;
+}
+
+.suggestion-list__item {
+  border-radius: 5px;
+  padding: 0.2rem 0.5rem;
+  margin-bottom: 0.2rem;
+  cursor: pointer;
+
+  &:last-child {
+    margin-bottom: 0;
+  }
+
+  &.is-selected,
+  &:hover {
+    background-color: rgba($color-neutral-100, 0.2);
+  }
+
+  &.hint {
+    opacity: 0.5;
+    pointer-events: none;
+  }
+}
+</style>