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'
},
}
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'
},
}
html_field = RichTextField(editor='froala')
stream_field = StreamField([
('html', RichTextBlock(editor='froala'))
])
Options
You will need to add FROALA_LICENSE_KEY to your settings:
FROALA_LICENSE_KEY = 'xxxxxxxxxxxxxx'
You can also specify FROALA_OPTIONS, which should be a dict populated with official Froala options (https://www.froala.com/wysiwyg-editor/docs/options):
FROALA_OPTIONS = {
'toolbarButtonsMD': ['bold', 'italic', 'underline', 'fontFamily', 'fontSize', 'color'],
'toolbarButtonsXS': ['bold', 'italic', 'underline']
}
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
[ ] Implement image replace button.
[ ] Incoorperate Froala events https://www.froala.com/wysiwyg-editor/docs/events.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.