Plone (Volto) add-on
Add and manage bookmarks of pages and searchkit queries.
Bookmarks are grouped by the value of a selectable content type field.
There are two options:
- Buttons in toolbar
- Buttons somewhere else
-
Provide the necessary REST API endpoints for your Plone backend by installing collective.bookmarks
-
Remember to install souper in Plone backend control panel.
-
Install this Plone (Volto) add-on
@plone-collective/volto-bookmarks
. See Volto docs for instructions.
This requires Volto >= 16.10.0 with a pluggable toolbar.
Include bookmarking in your Volto project by integrating the component Bookmarking
.
This component adds two buttons to the toolbar:
one for toggling the bookmark of the current page and
one for displaying a menu with a list of bookmarks.
config.js
:
import { Bookmarking } from '@plone-collective/volto-bookmarks/components';
import '@plone/volto/config';
export default function applyConfig(config) {
config.settings.appExtras = [
...config.settings.appExtras,
{
match: '/',
component: Bookmarking,
},
];
return config;
}
Add the two buttons to components of your choice:
import { ShowBookmarksContentButton } from '@plone-collective/volto-bookmarks/components';
<ShowBookmarksContentButton />
import { ToggleBookmarkButton } from '@plone-collective/volto-bookmarks/components';
<ToggleBookmarkButton />
Add a mapping for bookmark groups labels and the name of the field for grouping bookmarks list.
config.settings.bookmarks = {
...config.settings.bookmarks,
bookmarkgroupmapping: {
manual: 'Manuals and HowTos',
releasenote: 'Release Notes',
search: 'Search', // id of search page
'search-in-news': 'Search in News', // id of another search page
default_nogroup: 'Miscellaneous',
},
bookmarkgroupfield: 'type_title',
};
Add a mapping for search filters:
config.settings.bookmarks.filtermapping = {
facet_fields: {
'News Item': 'Nachricht',
Document: 'Seite',
Event: 'Veranstaltung',
},
search_sections: {
others: 'Website',
nachrichten: 'Nachrichten',
},
};
Author Katja Süss, Rohberg, @ksuess https://www.rohberg.ch
Copyright (c) 2023 Plone Foundation
See LICENSE.md for details.