Skip to content

Commit

Permalink
Add example views for description block and teaser block
Browse files Browse the repository at this point in the history
  • Loading branch information
ksuess committed Jan 30, 2025
1 parent b424559 commit c649b20
Show file tree
Hide file tree
Showing 3 changed files with 52 additions and 2 deletions.
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
import { TextWithGlossaryTooltips } from '@rohberg/volto-slate-glossary/utils';

const DescriptionBlockView = ({ properties, metadata, id }) => {
let description = (metadata || properties)['description'] || '';
description = TextWithGlossaryTooltips({ text: description });

return <p className="documentDescription">{description}</p>;
};

export default DescriptionBlockView;
21 changes: 21 additions & 0 deletions packages/policy/src/components/TeaserViewWithTooltips.jsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
import TeaserBody from '@plone/volto/components/manage/Blocks/Teaser/Body';
import { withBlockExtensions } from '@plone/volto/helpers/Extensions';
import { TextWithGlossaryTooltips } from '@rohberg/volto-slate-glossary/utils';

const TeaserView = (props) => {
return (
<TeaserBody
{...{
...props,
data: {
...props.data,
description: TextWithGlossaryTooltips({
text: props.data.description,
}),
},
}}
/>
);
};

export default withBlockExtensions(TeaserView);
23 changes: 21 additions & 2 deletions packages/policy/src/index.js
Original file line number Diff line number Diff line change
@@ -1,11 +1,25 @@
import { Tooltips } from '@rohberg/volto-slate-glossary/components';
import DescriptionBlockViewWithTooltips from './components/DescriptionBlockViewWithTooltips';

Check warning on line 2 in packages/policy/src/index.js

View workflow job for this annotation

GitHub Actions / codeanalysis

'DescriptionBlockViewWithTooltips' is defined but never used
import TeaserViewWithTooltips from './components/TeaserViewWithTooltips';

Check warning on line 3 in packages/policy/src/index.js

View workflow job for this annotation

GitHub Actions / codeanalysis

'TeaserViewWithTooltips' is defined but never used

const applyConfig = (config) => {
// glossary tooltips
/**
* Tooltip configuration
*/
config.settings.glossary.caseSensitive = false;
config.settings.glossary.matchOnlyFirstOccurence = false;
config.settings.glossary.showAlphabetNavigation = true;
config.settings.glossary.mentionTermInTooltip = false;
// Further configuration
// config.settings.glossary.includeAccordionBlock = true;

// // description block with tooltips
// config.blocks.blocksConfig.description.view =
// DescriptionBlockViewWithTooltips;

// // teaser block with tooltips (teaser and teaser in grid block)
// config.blocks.blocksConfig.teaser.view = TeaserViewWithTooltips;
// config.blocks.blocksConfig.gridBlock.blocksConfig.teaser.view =
// TeaserViewWithTooltips;

// Tooltips everywhere
config.settings.appExtras = [
Expand All @@ -16,6 +30,11 @@ const applyConfig = (config) => {
},
];

/**
* Glossary configuration
*/
config.settings.glossary.showAlphabetNavigation = true;

return config;
};

Expand Down

0 comments on commit c649b20

Please sign in to comment.