djangocms-embedpdf 1.0.1

No project description provided

djangocms-embedpdf

django CMS plugin to embed a PDF from django-filer directly into a page, using the EmbedPDF Snippet viewer.

Features

• Pick a PDF from Filer and display it inline
• Configurable viewer height (CSS value, e.g. 80vh, 600px)
• Viewer UI localized from the active Django language
• Simplified interface by default (View mode only, with fullscreen in the toolbar)
• Optional override of EmbedPDF disabled UI categories via settings

Requirements

• Python 3.10+
• Django 3.2+
• django CMS 3.11+
• django-filer

Installation

pip install djangocms-embedpdf

Add the app to your INSTALLED_APPS:

INSTALLED_APPS = [
    # ...
    "filer",
    "djangocms_embedpdf",
]

Run migrations:

python manage.py migrate djangocms_embedpdf

Usage

1. Edit a CMS page.
2. Add the Embedded PDF plugin (under Files).
3. Select a PDF from Filer and optionally set the viewer height.

The plugin loads EmbedPDF from the CDN and mounts it on the page.

Configuration

EmbedPDF JavaScript URL

By default the viewer is loaded from the jsDelivr CDN. Override the script URL with:

DJANGOCMS_EMBEDPDF_JS_URL = "https://cdn.jsdelivr.net/npm/@embedpdf/snippet@2/dist/embedpdf.js"

Useful for pinning a version, using a mirror, or serving the file from your own static files.

Disabled UI categories

By default, editing features are hidden so editors get a read-oriented viewer. You can override this with:

DJANGOCMS_EMBEDPDF_DISABLED_CATEGORIES = [
    "mode-annotate",
    "mode-shapes",
    "mode-redact",
    "annotation",
    "redaction",
    "form",
    "insert",
    "history",
    "document-open",
    "document-close",
    "document-protect",
    "security",
    "panel-comment",
]

See the EmbedPDF customizing UI docs for the full list of categories.