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 | RSS feed

This version

0.1

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

django-ckeditor-widget-0.1.tar.gz (3.9 kB view hashes)

Uploaded source

Built Distribution

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page