Make 'term in tooltip header' optional

rohberg · Oct 25, 2024 · c7724ce · c7724ce
1 parent f734a75
commit c7724ce
Show file tree

Hide file tree

Showing 5 changed files with 22 additions and 6 deletions.
diff --git a/README.md b/README.md
@@ -55,3 +55,17 @@ config.settings.glossary.matchOnlyFirstOccurence = true;
 
 User can opt-out by setting glossarytooltips to false.
 Add a boolean member field *glossarytooltips* for it.
+
+## Further configurations
+
+Hide alphabet navigation of glossary view:
+
+```js
+config.settings.glossary.showAlphabetNavigation = false;
+```
+
+Show glossary term in tooltips header:
+
+```js
+config.settings.glossary.mentionTermInTooltip = true;
+```
diff --git a/packages/policy/src/index.js b/packages/policy/src/index.js
@@ -5,6 +5,7 @@ const applyConfig = (config) => {
   config.settings.glossary.caseSensitive = false;
   config.settings.glossary.matchOnlyFirstOccurence = false;
   config.settings.glossary.showAlphabetNavigation = true;
+  config.settings.glossary.mentionTermInTooltip = false;
 
   // Tooltips everywhere
   config.settings.appExtras = [

diff --git a/packages/volto-slate-glossary/news/12.feature b/packages/volto-slate-glossary/news/12.feature
@@ -1,3 +1 @@
-Show a header in the tooltip.
-This repeats the term, which can look nice.
-@mauritsvanrees
+Mention the term in the header of its tooltip. @mauritsvanrees, @ksuess
diff --git a/packages/volto-slate-glossary/src/components/Tooltips.jsx b/packages/volto-slate-glossary/src/components/Tooltips.jsx
@@ -99,8 +99,8 @@ export const applyLineBreakSupport = (children) => {
  */
 export const enhanceTextWithTooltips = (text, remainingGlossaryterms) => {
   const caseSensitive = config.settings.glossary.caseSensitive;
-  const matchOnlyFirstOccurence =
-    config.settings.glossary.matchOnlyFirstOccurence;
+  const { matchOnlyFirstOccurence, mentionTermInTooltip } =
+    config.settings.glossary;
   let result = [{ type: 'text', val: text }];
   let matchedGlossaryTerms = [];
   if (remainingGlossaryterms.length > 0) {
@@ -190,7 +190,9 @@ export const enhanceTextWithTooltips = (text, remainingGlossaryterms) => {
             key={j}
             className="tooltip"
           >
-            <Popup.Header>{el.val}</Popup.Header>
+            {mentionTermInTooltip ? (
+              <Popup.Header>{el.val}</Popup.Header>
+            ) : null}
             <Popup.Content>
               <div
                 className="tooltip_content"

diff --git a/packages/volto-slate-glossary/src/index.js b/packages/volto-slate-glossary/src/index.js
@@ -9,6 +9,7 @@ const applyConfig = (config) => {
     caseSensitive: false,
     matchOnlyFirstOccurence: false,
     showAlphabetNavigation: true,
+    mentionTermInTooltip: false,
   };
 
   config.settings.slate.leafs = {