Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/collective/volto-bookmarks
Save favorites / bookmarks of pages and parameterised pages, like search urls of faceted navigation.
https://github.com/collective/volto-bookmarks
volto volto-addon
Last synced: about 1 month ago
JSON representation
Save favorites / bookmarks of pages and parameterised pages, like search urls of faceted navigation.
- Host: GitHub
- URL: https://github.com/collective/volto-bookmarks
- Owner: collective
- License: mit
- Created: 2021-02-11T15:39:05.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2023-05-11T07:28:52.000Z (about 1 year ago)
- Last Synced: 2024-04-24T21:22:18.372Z (3 months ago)
- Topics: volto, volto-addon
- Language: JavaScript
- Homepage:
- Size: 1.25 MB
- Stars: 3
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Lists
- awesome-volto - volto-bookmarks
README
# volto-bookmarks
[Plone (Volto)](https://github.com/plone/volto) add-on
## Features
Add and manage bookmarks of pages and searchkit queries.
Bookmarks are grouped by the value of a selectable content type field.
## Getting started
There are two options:
- Buttons in toolbar
- Buttons somewhere else
## Installation
- Provide the necessary REST API endpoints for your Plone backend by installing [collective.bookmarks](https://github.com/collective/collective.bookmarks.git)
- Remember to install souper in Plone backend control panel.
- Install this Plone (Volto) add-on `@plone-collective/volto-bookmarks`. See [Volto docs](https://6.docs.plone.org/volto/addons/index.html#configuring-a-volto-project-to-use-an-add-on) for instructions.
- Merge add-on translations into your Volto app. Available translations so far:
- german.
```bash
yarn
yarn i18n
```
## Integration of the two bookmark buttons
### Option 1 - buttons in toolbar
> This requires Volto >= 16.10.0 with a pluggable toolbar.
Include bookmarking in your Volto project by creating and integrating a component `Bookmarking`.
`Bookmarking.jsx`:
```jsx
import { Plug } from '@plone/volto/components/manage/Pluggable';
import {
ToggleBookmarkButton,
ShowBookmarksToolbarButton,
} from '@plone-collective/volto-bookmarks/components';
const Bookmarks = () => {
return (
<>
>
);
};
export default Bookmarks;
```
`config.js`:
```js
import Bookmarking from './components/Bookmarking';
import '@plone/volto/config';
export default function applyConfig(config) {
config.settings.appExtras = [
...config.settings.appExtras,
{
match: '/',
component: Bookmarking,
},
];
return config;
}
```
This adds two buttons in toolbar: one for toggling the bookmark of the current page and one for displaying a menu with a list of bookmarks.
### Option 2 - buttons not in toolbar, but somewhere else
Add the two buttons to components of your choice:
```jsx
import { ShowBookmarksContentButton } from '@plone-collective/volto-bookmarks/components';
```
```jsx
import { ToggleBookmarkButton } from '@plone-collective/volto-bookmarks/components';
```
### Further configuration for both options
Add a mapping for bookmark groups labels and the name of the field for grouping bookmarks list.
```js
config.settings.bookmarks = {
...config.settings.bookmarks,
bookmarkgroupmapping: {
manual: 'Manuals and HowTos',
releasenote: 'Release Notes',
default_search: 'Search',
default_nogroup: 'Miscellaneous',
},
bookmarkgroupfield: 'informationtype',
};
```
Add a mapping for search filters:
```js
config.settings.bookmarks.filtermapping = {
facet_fields: {
'5237dc43-c573-4651-a5b8-cf24bfde13a6': 'Datendrehscheibe',
allgemeines: 'Allgemeines',
arbeitsliste: 'Arbeitsliste',
beb2k: 'BEB2k',
'release-note': 'Release-Note',
tutorial: 'Tutorial',
'superuser-innen': 'Superuser/innen',
ai: 'AI',
andere: 'Andere',
tg: 'TG',
zh: 'ZH',
},
search_sections: {
others: 'Website',
dokumentation: 'Dokumentation',
inside: 'IGIB-Inside',
geologie: 'Geologie',
},
},
```
## Copyright and License
Author Katja Süss, Rohberg, @ksuess
https://www.rohberg.ch
Copyright (c) 2023 Plone Foundation
See [LICENSE.md](https://github.com/collective/volto-bookmarks/blob/master/LICENSE.md) for details.