Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/eea/volto-pdf-block
A Volto pdf integration block
https://github.com/eea/volto-pdf-block
Last synced: 3 months ago
JSON representation
A Volto pdf integration block
- Host: GitHub
- URL: https://github.com/eea/volto-pdf-block
- Owner: eea
- License: mit
- Created: 2021-03-29T09:33:43.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2024-04-22T12:23:41.000Z (7 months ago)
- Last Synced: 2024-04-22T13:42:53.006Z (7 months ago)
- Language: JavaScript
- Size: 322 KB
- Stars: 2
- Watchers: 29
- Forks: 0
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
- awesome-volto - volto-pdf-block - Flexible PDF integration in Volto (Addons / Layout addons)
README
# volto-pdf-block
[](https://github.com/eea/volto-pdf-block/releases)
[](https://ci.eionet.europa.eu/view/Github/job/volto-addons/job/volto-pdf-block/job/master/display/redirect)
[](https://sonarqube.eea.europa.eu/dashboard?id=volto-pdf-block-master)
[](https://sonarqube.eea.europa.eu/dashboard?id=volto-pdf-block-master)
[](https://sonarqube.eea.europa.eu/dashboard?id=volto-pdf-block-master)
[](https://sonarqube.eea.europa.eu/dashboard?id=volto-pdf-block-master)
[](https://ci.eionet.europa.eu/view/Github/job/volto-addons/job/volto-pdf-block/job/develop/display/redirect)
[](https://sonarqube.eea.europa.eu/dashboard?id=volto-pdf-block-develop)
[](https://sonarqube.eea.europa.eu/dashboard?id=volto-pdf-block-develop)
[](https://sonarqube.eea.europa.eu/dashboard?id=volto-pdf-block-develop)
[](https://sonarqube.eea.europa.eu/dashboard?id=volto-pdf-block-develop)
[Volto](https://github.com/plone/volto) add-on
## Features
- Flexible PDF integration in Volto.
NOTE: this addon assumes that, if you're trying to load external hosted PDF
files, you will be using
[@eeacms/volto-corsproxy](https://github.com/eea/volto-corsproxy)
## Getting started
### Add volto-pdf-block to your Volto project
1. Make sure you have a [Plone backend](https://plone.org/download) up-and-running at http://localhost:8080/Plone
1. Start Volto frontend
- If you already have a volto project, just update `package.json`:
```JSON
"addons": [
"@eeacms/volto-pdf-block"
],
"dependencies": {
"@eeacms/volto-pdf-block": "*"
}
```
- If not, create one:
```
npm install -g yo @plone/generator-volto
yo @plone/volto my-volto-project --canary --addon @eeacms/volto-pdf-block
cd my-volto-project
```
1. Install new add-ons and restart Volto:
```
yarn
yarn start
```
1. Go to http://localhost:3000
1. Happy editing!
## Internal use of PDF library
```JS
import config from '@plone/volto/registry';
import PDF from '@mikecousins/react-pdf';
export const PdfViwer = (props) => {
return (
{({ pdfDocument, pdfPage, canvas }) => (
<>
{!pdfDocument && loaderComponent(canvas)}
{pdfDocument && canvas}
>
)}
)}
```
## workerSrc
Allows you to specify your own url for the pdf worker.
Default is set by the library to:
```
"//cdnjs.cloudflare.com/ajax/libs/pdf.js/${pdfjs.version}/pdf.worker.js"
```
For cases where it is needed to have the library on a different CDN this can be configured on `config.settings.pdfWorkerSrc` the way it is done on [volto-ims-policy](https://github.com/eea/volto-ims-policy/blob/master/src/index.js) which is an add-on that centrilazes configurations for Volto for different add-ons.
```JS
const applyConfig = (config) => {
...
// PDF worker url
config.settings.pdfWorkerSrc = '//www.eea.europa.eu/pdfjs/pdf.worker.min.js';
return config;
};
```
## Release
See [RELEASE.md](https://github.com/eea/volto-pdf-block/blob/master/RELEASE.md).
## How to contribute
See [DEVELOP.md](https://github.com/eea/volto-pdf-block/blob/master/DEVELOP.md).
## Copyright and license
The Initial Owner of the Original Code is European Environment Agency (EEA).
All Rights Reserved.
See [LICENSE.md](https://github.com/eea/volto-pdf-block/blob/master/LICENSE.md) for details.
## Funding
[European Environment Agency (EU)](http://eea.europa.eu)