Skip to content

Commit

Permalink
Merge pull request #12 from rohberg/maurits-tooltip-header
Browse files Browse the repository at this point in the history
Show a header in the tooltip.
  • Loading branch information
ksuess authored Oct 25, 2024
2 parents 517f885 + c7724ce commit 5f4a11b
Show file tree
Hide file tree
Showing 7 changed files with 28 additions and 8 deletions.
14 changes: 14 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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;
```
1 change: 1 addition & 0 deletions packages/policy/src/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -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 = [
Expand Down
1 change: 1 addition & 0 deletions packages/volto-slate-glossary/news/12.feature
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Mention the term in the header of its tooltip. @mauritsvanrees, @ksuess
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import React from 'react';
import { Link } from 'react-router-dom';
import { Container } from 'semantic-ui-react';
import { useSelector, useDispatch } from 'react-redux';
import { Container } from 'semantic-ui-react';
import cx from 'classnames';
import { getGlossaryTerms } from '../actions';
import config from '@plone/volto/registry';
Expand Down
2 changes: 1 addition & 1 deletion packages/volto-slate-glossary/src/components/TermView.jsx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import React from 'react';
import { Container } from 'semantic-ui-react';
import { Link } from 'react-router-dom';
import { Container } from 'semantic-ui-react';
import { Icon } from '@plone/volto/components';
import { flattenToAppURL } from '@plone/volto/helpers';
import backSVG from '@plone/volto/icons/back.svg';
Expand Down
15 changes: 9 additions & 6 deletions packages/volto-slate-glossary/src/components/Tooltips.jsx
Original file line number Diff line number Diff line change
Expand Up @@ -71,19 +71,19 @@ export const applyLineBreakSupport = (children) => {
const klass = undefined;

return typeof children === 'string'
? children.split('\n').map((t, i) => {
? children.split('\n').map((toot, i) => {
return (
<React.Fragment key={`${i}`}>
{children.indexOf('\n') > -1 &&
children.split('\n').length - 1 > i ? (
<>
{klass ? <span className={klass}>{t}</span> : t}
{klass ? <span className={klass}>{toot}</span> : toot}
<br />
</>
) : klass ? (
<span className={klass}>{t}</span>
<span className={klass}>{toot}</span>
) : (
t
toot
)}
</React.Fragment>
);
Expand All @@ -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) {
Expand Down Expand Up @@ -190,6 +190,9 @@ export const enhanceTextWithTooltips = (text, remainingGlossaryterms) => {
key={j}
className="tooltip"
>
{mentionTermInTooltip ? (
<Popup.Header>{el.val}</Popup.Header>
) : null}
<Popup.Content>
<div
className="tooltip_content"
Expand Down
1 change: 1 addition & 0 deletions packages/volto-slate-glossary/src/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ const applyConfig = (config) => {
caseSensitive: false,
matchOnlyFirstOccurence: false,
showAlphabetNavigation: true,
mentionTermInTooltip: false,
};

config.settings.slate.leafs = {
Expand Down

0 comments on commit 5f4a11b

Please sign in to comment.