Merge pull request #2107 from laws-africa/search-tips

prompt user to try using "quotes" in search
laws-africa · Oct 16, 2024 · 44cbeb4 · 44cbeb4
2 parents 1dab8dd + 7e91eee
commit 44cbeb4
Showing 1 changed file with 23 additions and 3 deletions.
diff --git a/peachjam/js/components/FindDocuments/index.vue b/peachjam/js/components/FindDocuments/index.vue
@@ -49,7 +49,7 @@
           >
             <input
               v-model="q"
-              type="text"
+              type="search"
               class="form-control"
               :placeholder="searchPlaceholder"
               :aria-label="$t('Search documents')"
@@ -58,7 +58,7 @@
             >
             <button
               type="submit"
-              class="btn btn-primary ms-1"
+              class="btn btn-primary ms-2"
               :disabled="loading"
             >
               <span
@@ -79,6 +79,10 @@
           <div class="my-2">
             <HelpBtn page="search/" />
           </div>
+          <div v-if="searchTip" class="alert alert-primary">
+            {{ searchTip.prompt }}
+            <a href="#" @click.stop.prevent="useSearchTip()">{{ searchTip.q }}</a>
+          </div>
         </div>
         <div
           id="nav-advanced-search"
@@ -263,6 +267,7 @@ export default {
       ordering: '-score',
       q: '',
       drawerOpen: false,
+      searchTip: null,
       advancedSearchCriteria: [{
         text: '',
         fields: [],
@@ -552,6 +557,11 @@ export default {
       this.search();
     },
 
+    useSearchTip () {
+      this.q = this.searchTip.q;
+      this.search();
+    },
+
     formatFacets () {
       const generateOptions = (buckets, labels) => {
         return buckets.map((bucket) => ({
@@ -672,13 +682,23 @@ export default {
     },
 
     async search (pushState = true) {
+      this.searchTip = null;
+
       // if one of the search fields is true perform search
       if (this.q || (Array.isArray(this.advancedSearchCriteria) && this.advancedSearchCriteria.some(f => f.text))) {
         this.loadingCount = this.loadingCount + 1;
 
         // scroll to put the search box at the top of the window
         scrollToElement(this.$refs['search-box']);
 
+        // search tip
+        if (this.q && this.q.indexOf('"') === -1) {
+          this.searchTip = {
+            prompt: this.$t('Try using quotes to search for an exact phrase: '),
+            q: `"${this.q}"`
+          };
+        }
+
         try {
           const params = this.generateSearchParams();
           const previousId = this.searchInfo.trace_id || '';
@@ -778,7 +798,7 @@ export default {
         date_to: null,
         date_from: null
       };
-    },
+    }
 
   }
 };