Integrate Quill editor with Django project.
Project description
django-quill-editor
django-quill-editor makes Quill.js easy to use on Django Forms and admin sites
- No configuration required for static files!
- The entire code for inserting WYSIWYG editor is less than 30 lines
- It can be used in both admin and Django views
Setup
-
Install
django-quill-editorto your Python environmentpip install django-quill-editor
-
Add
django_quilltoINSTALLED_APPSinsettings.py# settings.py INSTALLED_APPS = [ 'django.contrib.admin', ... 'django_quill', ]
Run Sample project
Repo: django-quill-editor-sample
# Clone repo git clone https://github.com/LeeHanYeong/django-quill-editor-sample cd django-quill-editor-sample # Create virtualenv (I used pyenv, but you can use other methods) pyenv virtualenv 3.7.5 django-quill pyenv local django-quill # Install Python packages pip install -r requirements.txt python app/manage.py runserver
Documentation
Documentation for django-quill-editor is located at https://django-quill-editor.readthedocs.io/
Usage
Add QuillField to the Model class you want to use
# models.py from django.db import models from django_quill.fields import QuillField class QuillPost(models.Model): content = QuillField()
1. Django admin
Just register the Model in admin.py of the app.
from django.contrib import admin from .models import QuillPost @admin.register(QuillPost) class QuillPostAdmin(admin.ModelAdmin): pass
2. Form
-
Add
QuillFormFieldto the Form class you want to use -
There are two ways to add CSS and JS files to a template.
-
If there is a Form with QuillField added, add
{{ form.media }}to the<head>tag.<head> {{ form.media }} </head>
-
Or, import CSS and JS files directly using
{% include %}template tags.<head> <!-- django-quill-editor Media --> {% include 'django_quill/media.html' %} </head>
-
# forms.py from django import forms from django_quill.forms import QuillFormField class QuillFieldForm(forms.Form): content = QuillFormField()
# views.py from django.shortcuts import render from .forms import QuillFieldForm def form(request): return render(request, 'form.html', {'form': QuillFieldForm()})
<!-- Template --> <form action="" method="POST">{% csrf_token %} {{ form.content }} </form>
3. ModelForm
Just define and use ModelForm of Model class
# forms.py from django import forms from .models import QuillPost class QuillPostForm(forms.ModelForm): class Meta: model = QuillPost fields = ( 'content', )
# views.py from django.shortcuts import render from .forms import QuillPostForm def model_form(request): return render(request, 'model_form.html', {'form': QuillPostForm()})
<!-- Template --> <form action="" method="POST">{% csrf_token %} {{ form.content }} </form>
Form, ModelForm's Output:
Contributing
As an open source project, we welcome contributions. The code lives on GitHub
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for django-quill-editor-0.1.12.tar.gz
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | adf81002d69ae481c260a96b59cfda97d97c9437de7a6e4a0b53267e00b03f4e |
|
| MD5 | a61923e760df914eb057c135bb34c631 |
|
| BLAKE2-256 | 5a96544395477f14e5bf157915ab0482154429c776a441aa011f03f73242b41b |
Hashes for django_quill_editor-0.1.12-py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 8eeb7d5a487b2e0136d90c01cab75e82c5316d5b654d78452fb9c8b8715c0e11 |
|
| MD5 | 2d42b3e738459fde4e51b2431f8be41d |
|
| BLAKE2-256 | 615597121d03a074fb7ac4d67b3698966eb6402958c2aeee6a038c39af897f6c |