Skip to main content

A CKEditor widget for Django that includes an admin mixin.

Project description

A CKEditor widget for Django that includes an admin mixin.

How to use

Install using pip:

pip install django-ckeditor-widget

Then use as any other widget:

from django import forms
from ckeditor_widget.widgets import CKEditorWidget

class MyForm(forms.Form):
    body = forms.TextField(widget=CKEditorWidget)

https://docs.djangoproject.com/en/1.11/ref/forms/widgets/#specifying-widgets

Make sure that CKEditor is provided in static files as ckeditor/ckeditor.js.

Admin

The app conveniently provides an admin mixin that uses CKEditor for all text fields. Simply inherit from the mixin:

from django.contrib import admin
from ckeditor_widget.admin import CKEditorAdminMixin
from myapp import models

@admin.register(models.Product)
class ProductAdmin(CKEditorAdminMixin, admin.ModelAdmin):
    pass

Akternatively, specify formfield_overrides:

formfield_overrides = {
    models.TextField: {'widget': CKEditorWidget}
}

Project details


Release history Release notifications

This version
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
django_ckeditor_widget-0.1-py2.py3-none-any.whl (5.2 kB) Copy SHA256 hash SHA256 Wheel py2.py3 Jun 4, 2017
django-ckeditor-widget-0.1.tar.gz (3.9 kB) Copy SHA256 hash SHA256 Source None Jun 4, 2017

Supported by

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