Wagtail Froala
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
[ ] Implement image replace button.
[ ] Incoorperate Froala events https://www.froala.com/wysiwyg-editor/docs/events.
Please feel free to contribute.
Metadata
Release files for wagtailfroala 0.2.11
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| wagtailfroala-0.2.11.tar.gz | 330.0 kB | Without provenance | Details for wagtailfroala-0.2.11.tar.gz |
Release files / wagtailfroala-0.2.11.tar.gz
| Download URL | wagtailfroala-0.2.11.tar.gz |
|---|---|
| Size | 330.0 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
106aea06d59fdefe790322b5f2241d03134e88bce63f8d79ca5ac6721001cd47
|
|
BLAKE2b-256 checksum How to use checksums |
52946a3953de034d3ef0a2624a1393eaea892870ce9a6d3c18b44d7104b6a4e4
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
Security for wagtailfroala 0.2.11
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.