From 9b01efe942ba60d938596db49f0826faf16b32de Mon Sep 17 00:00:00 2001
From: h1-the-swan <jason.portenoy@gmail.com>
Date: Fri, 22 Sep 2023 21:10:11 +0000
Subject: [PATCH] inject docstrings into filter dialog boxes

---
 src/components/FilterEdit/FilterEditBoolean.vue | 7 ++++++-
 src/components/FilterEdit/FilterEditRange.vue   | 7 +++++--
 src/components/FilterEdit/FilterEditSearch.vue  | 7 +++++--
 src/components/FilterEdit/FilterEditSelect.vue  | 6 ++++--
 4 files changed, 20 insertions(+), 7 deletions(-)

diff --git a/src/components/FilterEdit/FilterEditBoolean.vue b/src/components/FilterEdit/FilterEditBoolean.vue
index 5082baa8..2a443493 100644
--- a/src/components/FilterEdit/FilterEditBoolean.vue
+++ b/src/components/FilterEdit/FilterEditBoolean.vue
@@ -13,6 +13,8 @@
       </v-toolbar-items>
     </v-toolbar>
     <v-card-text class="pt-0">
+      {{ this.filterDocstrings[myConfig.key].docstring }} <a :href="this.filterDocstrings[myConfig.key].documentationLink" rel="noopener noreferrer" target="_blank">Learn more in the docs</a>
+      <br />
       <div>
         Show only {{ entityType | pluralize(1) }} that
         <span>
@@ -36,6 +38,7 @@
 
 import {mapActions, mapGetters, mapMutations} from "vuex";
 import {getFacetConfig} from "../../facetConfigs";
+import {api} from "@/api";
 
 export default {
   name: "FilterEditBoolean",
@@ -49,6 +52,7 @@ export default {
     return {
       foo: 42,
       myValue: (this.createMode) ? true : this.filterValue,
+      filterDocstrings: [],
     }
   },
   computed: {
@@ -74,7 +78,8 @@ export default {
   },
   created() {
   },
-  mounted() {
+  async mounted() {
+    this.filterDocstrings = await api.get("works/filters_docstrings")
   },
   watch: {}
 }
diff --git a/src/components/FilterEdit/FilterEditRange.vue b/src/components/FilterEdit/FilterEditRange.vue
index f47fc6af..adb68947 100644
--- a/src/components/FilterEdit/FilterEditRange.vue
+++ b/src/components/FilterEdit/FilterEditRange.vue
@@ -17,7 +17,7 @@
 
     </v-toolbar>
     <v-card-text>
-      Here's some information about this filter.
+      {{ this.filterDocstrings[myConfig.key].docstring }} <a :href="this.filterDocstrings[myConfig.key].documentationLink" rel="noopener noreferrer" target="_blank">Learn more in the docs</a>
     </v-card-text>
     <v-card-actions>
       <v-spacer/>
@@ -33,6 +33,7 @@
 
 import {mapActions, mapGetters, mapMutations} from "vuex";
 import {getFacetConfig} from "../../facetConfigs";
+import {api} from "@/api";
 
 export default {
   name: "FilterEditRange",
@@ -46,6 +47,7 @@ export default {
     return {
       foo: 42,
       myValue: this.filterValue,
+      filterDocstrings: [],
     }
   },
   computed: {
@@ -68,7 +70,8 @@ export default {
   },
   created() {
   },
-  mounted() {
+  async mounted() {
+    this.filterDocstrings = await api.get("works/filters_docstrings")
   },
   watch: {}
 }
diff --git a/src/components/FilterEdit/FilterEditSearch.vue b/src/components/FilterEdit/FilterEditSearch.vue
index cc80862c..0168fd5f 100644
--- a/src/components/FilterEdit/FilterEditSearch.vue
+++ b/src/components/FilterEdit/FilterEditSearch.vue
@@ -15,7 +15,7 @@
     </v-toolbar>
     <v-divider></v-divider>
     <v-card-text class="pt-4">
-      Here are a few words about this filter.
+      {{ this.filterDocstrings[myConfig.key].docstring }} <a :href="this.filterDocstrings[myConfig.key].documentationLink" rel="noopener noreferrer" target="_blank">Learn more in the docs</a>
     </v-card-text>
     <v-card-actions>
       <v-spacer/>
@@ -31,6 +31,7 @@
 
 import {mapActions, mapGetters, mapMutations} from "vuex";
 import {getFacetConfig} from "../../facetConfigs";
+import {api} from "@/api";
 
 export default {
   name: "FilterEditSearch",
@@ -44,6 +45,7 @@ export default {
     return {
       foo: 42,
       myValue: this.filterValue,
+      filterDocstrings: [],
     }
   },
   computed: {
@@ -69,7 +71,8 @@ export default {
   },
   created() {
   },
-  mounted() {
+  async mounted() {
+    this.filterDocstrings = await api.get("works/filters_docstrings")
   },
   watch: {}
 }
diff --git a/src/components/FilterEdit/FilterEditSelect.vue b/src/components/FilterEdit/FilterEditSelect.vue
index 8d2ec21f..469c3e70 100644
--- a/src/components/FilterEdit/FilterEditSelect.vue
+++ b/src/components/FilterEdit/FilterEditSelect.vue
@@ -14,7 +14,7 @@
     </div>
     <v-divider></v-divider>
     <v-card-text class="pt-4" v-if="!selectedOptionsToShow.length && !searchString">
-      Here's some information about this filter. I hope you find it useful.
+      {{ this.filterDocstrings[myConfig.key].docstring }} <a :href="this.filterDocstrings[myConfig.key].documentationLink" rel="noopener noreferrer" target="_blank">Learn more in the docs</a>
     </v-card-text>
     <v-list
     >
@@ -119,6 +119,7 @@ export default {
       selectedMatchMode: "any",
       searchString: "",
       mySelectedValues: [],
+      filterDocstrings: [],
     }
   },
   computed: {
@@ -135,7 +136,7 @@ export default {
     },
     selectedOptionsToShow() {
       return this.searchString ? [] : this.selectedOptions
-    }
+    },
   },
 
   methods: {
@@ -228,6 +229,7 @@ export default {
           autocompletePromises
       )
     }
+    this.filterDocstrings = await api.get("works/filters_docstrings")
   },
   watch: {
     searchString: {