Skip to main content

Extends Wagtail to use the Froala WYSIWYG editor in RichTextField/RichTextBlock.

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']
}

To Do

  • [ ] Incoorperate page chooser for links (like hallo.js).

  • [ ] Incoorperate document chooser for links (like hallo.js).

  • [ ] Incoorperate image chooser (like hallo.js).

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

wagtailfroala-0.2.1.tar.gz (327.0 kB view details)

Uploaded Source

File details

Details for the file wagtailfroala-0.2.1.tar.gz.

File metadata

  • Download URL: wagtailfroala-0.2.1.tar.gz
  • Upload date:
  • Size: 327.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for wagtailfroala-0.2.1.tar.gz
Algorithm Hash digest
SHA256 ec35786e0e3b2904af3b57c6be63915711a4d3e61de4d87fb28427750e742cfe
MD5 8945c0d4e0ded5b7f095ecc8f334fdc8
BLAKE2b-256 e8842a12f3c679ac7eedf6d8af136c075b8d6b4cef200763fae6e8ca3b287848

See more details on using hashes here.

Supported by

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