django-richtextfield 1.6

Javascript souce(s)

'js'

A list of required javascript files. These can be URLs to a CDN or paths relative to your STATIC_URL e.g.:

'js': ['//cdn.ckeditor.com/4.14.0/standard/ckeditor.js']

or:

'js': ['path/to/editor.js', 'path/to/plugin.js']

CSS souce(s)

'css'

A dictionary of CSS files required. These can be URLs to a CDN or paths relative to your STATIC_URL e.g.:

'css': {
    'all': [
        'https://cdn.example.com/css/editor.css'
    ]
}

or:

'css': {'all': ['path/to/editor.css', 'path/to/plugin.css']}

Editor init template

'init_template'

Path to the init template for your editor. Currently django-richtextfield ships with two templates, either:

'init_template': 'djrichtextfield/init/tinymce.js'

or:

'init_template': 'djrichtextfield/init/ckeditor.js'

Editor settings

'settings'

A Python dictionary with the default configuration data for your editor e.g.:

'settings': {  # TinyMCE
    'menubar': False,
    'plugins': 'link image',
    'toolbar': 'bold italic | link image | removeformat',
    'width': 700
}

or:

'settings': {  # CKEditor
    'toolbar': [
        {'items': ['Format', '-', 'Bold', 'Italic', '-',
                   'RemoveFormat']},
        {'items': ['Link', 'Unlink', 'Image', 'Table']},
        {'items': ['Source']}
    ],
    'format_tags': 'p;h1;h2;h3',
    'width': 700
}

Editor profiles

'profiles'

This is an optional configuration key. Profiles are “named” custom settings used to configure specific type of fields. You can configure profiles like this:

'profiles': {
    'basic': {
        'toolbar': 'bold italic | removeformat'
    },
    'advanced': {
        'plugins': 'link image table code',
        'toolbar': 'formatselect | bold italic | removeformat |'
                   ' link unlink image table | code'
    }
}

Content sanitizers

'sanitizer'

This is an optional configuration key. A sanitizer can be used to process submitted values before it is returned by the widget. By default no processing is performed on submitted values. You can configure a sanitizer either by providing a function or an importable path to a function, like so:

'sanitizer': lambda value: '<h1>Title</h1>' + value

or:

'sanitizer': 'bleach.clean'

'sanitizer_profiles'

This is an optional configuration key. It is possible to override the default or configured sanitizer for each of the configured profiles. For example to set a custom sanitizer for the advanced profile:

'sanitizer_profiles': {
    'advanced': lambda value: value + 'This text has been sanitized.'
}

Init template

The init template is a Django template (so it should be in the template and not in the static directory). It contains a tiny bit of Javascript that’s called to initialize each editor. For example, the init template for Summernote would like this:

$('#' + id).summernote(settings)

The init template has the following Javascript variables available from the outer scope:

field

DOM node of the textarea to be replaced

id

The id attribute of the textarea

default_settings

DJRICHTEXTFIELD_CONFIG['settings'] as a JS object

custom_settings

The field_settings as a JS object

settings

Merge of default_settings and custom_settings

1.6 (2020-05-20)

• init.js no longer depends on jQuery. This might a backwards incompatible change for:

  • Users that have defined their own init script that dependeds on the $e var. This var has been replaced by field which is a plain DOM node instead of a jQuery object.

  • Users that depended on the implicit load of Django’s bundled version of jQuery now have explicitly load it themselves.

• Verified TinyMCE init/config works with TinyMCE 4 and 5

• Tested and verified to work with Django 3.1

1.5.0 (2019-12-04)

• Drop support for Python 2

• Drop support for Django < 2.2

• Add support for Django 3.0

1.4.0 (2019-01-31)

• NOTE: This is the final release that supports Python 2!

• Add support for plugable server side content sanitizers

1.3.0 (2018-11-05)

• Allow CSS files to be included by a RichTextWidget

1.2.4 (2018-09-25)

• Fix display issue in Django 2.1’s admin interface

1.2.3 (2018-09-11)

• Add support for Django 2.1

1.2.2 (2018-06-12)

• Conditionally load the (un)minified version of jquery depending on DEBUG

• Load jQuery before all other scripts

1.2.1 (2018-01-18)

• Add ['admin/js/vendor/jquery/jquery.min.js', 'admin/js/jquery.init.js'] to RichTextWidget.media.js. This makes the widget usable outside of the admin (but still requires django.contrib.admin to be in INSTALLED_APPS) and prevents javascript errors inside the admin in certain edge cases.

1.2 (2017-12-04)

• Remove support for Django < 1.11

• Add support for Django 2.0

1.1 (2016-01-14)

• Remove support for Django < 1.8

• Tested with Django 1.8 & Django 1.9

1.0.1 (2014-11-13)

• Fix unicode error

1.0 (2014-09-30)

• First release