Skip to main content
Help improve PyPI by participating in a 5-minute user interface survey!

Extends Wagtail to use the Froala WYSIWYG editor in RichTextFields/RichTextBlocks.

Project Description

Extends Wagtail to use the amazing Froala editor. This Wagtail extension requires Wagtail 1.5.x, as it uses WAGTAILADMIN_RICH_TEXT_EDITORS.

Installation

Run the command pip install wagtailfroala

Add wagtailfroala to your INSTALLED_APPS.

Add wagtailfroala.rich_text.FroalaRichTextArea to WAGTAILADMIN_RICH_TEXT_EDITORS in your settings.

For example, to use Froala for all RichTextField and RichTextBlock instances:

WAGTAILADMIN_RICH_TEXT_EDITORS = {
    'default': {
        'WIDGET': 'wagtailfroala.rich_text.FroalaRichTextArea',
        'OPTIONS': {
            'key': 'xxxxxxxxxxxx'
         }
    }
}

Or, to use Froala only for defined instances…

WAGTAILADMIN_RICH_TEXT_EDITORS = {
    'default': {
        'WIDGET': 'wagtail.wagtailadmin.rich_text.HalloRichTextArea'
    },
    'froala': {
        'WIDGET': 'wagtailfroala.rich_text.FroalaRichTextArea',
        'OPTIONS': {
            'key': 'xxxxxxxxxxxx',
            'toolbarButtons': [
                'paragraphFormat', 'fontFamily', 'bold', 'italic',
                'underline', 'formatOL', 'formatUL', 'align',
                'color', '|', 'insertHR', 'insertLink', '|', 'undo', 'redo'
            ]
        }
    },
    'froala_small': {
        'WIDGET': 'wagtailfroala.rich_text.FroalaRichTextArea',
        'OPTIONS': {
            'key': 'xxxxxxxxxxxx',
            'toolbarButtons': ['fontFamily', 'bold', 'italic', 'underline', 'color', '|', 'insertLink'],
            'editorClass': 'editor-small'
        }
    }
}
html_field = RichTextField(editor='froala')
stream_field = StreamField([
    ('html', RichTextBlock(editor='froala_small'))
])

Options

You will need to ensure that the key option is correctly set with your Froala license key.

By default, Codemirror HTML syntax highlighting is enabled, you can disable it if you wish.

FROALA_CODEMIRROR = False

Font Awesome is required by Froala for toolbar icons, so it is included by default. If you don’t want to include it or already have a version included, you can disable it.

FROALA_FONT_AWESOME = False

To Do

Please feel free to contribute.

Release history Release notifications

This version
History Node

0.2.9

History Node

0.2.8

History Node

0.2.7

History Node

0.2.3

History Node

0.2.1

History Node

0.2

History Node

0.1

Download files

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

Filename, size & hash SHA256 hash help File type Python version Upload date
wagtailfroala-0.2.9.tar.gz (329.3 kB) Copy SHA256 hash SHA256 Source None Mar 16, 2017

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging CloudAMQP CloudAMQP RabbitMQ AWS AWS Cloud computing Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page