Skip to main content

EditorJS as a widget for Wagtail, with Page- and Image chooser support

Project description

wagtail_editorjs

A Wagtail EditorJS widget with page/image chooser support, document support and more!

Quick start

  1. Add 'wagtail_editorjs' to your INSTALLED_APPS setting like this:

    INSTALLED_APPS = [
    ...,
    'wagtail_editorjs',
    ]
    
  2. Add the HTML to your template:

    <link rel="stylesheet" href="{% static 'wagtail_editorjs/css/frontend.css' %}">
    {% load editorjs %}
    {% editorjs self.editor_field %}
    
  3. Add the field to your model:

    ...
    from wagtail_editorjs.fields import EditorJSField
    
    
    class HomePage(Page):
        content_panels = [
            FieldPanel("editor_field"),
        ]
        editor_field = EditorJSField(
            # All supported features
            features=[
                'attaches',
                'checklist',
                'code',
                'delimiter',
                'header',
                'image',
                'inline-code',
                'marker',
                'nested-list',
                'paragraph',
                'quote',
                'raw',
                'table',
                'underline',
                'warning',
                'link',
                'text-alignment-tune',
                'text-variant-tune'
            ],
            blank=True,
            null=True,
        )
    

Settings

EDITORJS_CLEAN_HTML

Default: True
Clean the HTML output on rendering.
This happens every time the field is rendered.
It might be smart to set up some sort of caching mechanism.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

wagtail_editorjs-1.1.7.tar.gz (164.0 kB view details)

Uploaded Source

File details

Details for the file wagtail_editorjs-1.1.7.tar.gz.

File metadata

  • Download URL: wagtail_editorjs-1.1.7.tar.gz
  • Upload date:
  • Size: 164.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.11.6

File hashes

Hashes for wagtail_editorjs-1.1.7.tar.gz
Algorithm Hash digest
SHA256 88fc96b63196320151f5b170fd1bbb9eb03d6503c232dee86e291660cf9d11a9
MD5 f63e45263ce1767915ca8398d642faa8
BLAKE2b-256 3b471597e1b3328a399a6ae5a71f6da7a6bd3df86a7756a38b0a3f537e451765

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page