Prose editor for the Django admin based on ProseMirror
Project description
Prose editor for the Django admin based on ProseMirror. Announcement blog post.
About rich text editors
Copied from the django-content-editor documentation.
We have been struggling with rich text editors for a long time. To be honest, I do not think it was a good idea to add that many features to the rich text editor. Resizing images uploaded into a rich text editor is a real pain, and what if you’d like to reuse these images or display them using a lightbox script or something similar? You have to resort to writing loads of JavaScript code which will only work on one browser. You cannot really filter the HTML code generated by the user to kick out ugly HTML code generated by copy-pasting from word. The user will upload 10mb JPEGs and resize them to 50x50 pixels in the rich text editor.
All of this convinced me that offering the user a rich text editor with too much capabilities is a really bad idea. The rich text editor in FeinCMS only has bold, italic, bullets, link and headlines activated (and the HTML code button, because that’s sort of inevitable – sometimes the rich text editor messes up and you cannot fix it other than going directly into the HTML code. Plus, if someone really knows what they are doing, I’d still like to give them the power to shot their own foot).
If this does not seem convincing you can always add your own rich text plugin with a different configuration (or just override the rich text editor initialization template in your own project). We do not want to force our world view on you, it’s just that we think that in this case, more choice has the bigger potential to hurt than to help.
Installation
Install the package:
venv/bin/pip install django-prose-editorAdd django_prose_editor to INSTALLED_APPS:
INSTALLED_APPS = [
# ...
"django_prose_editor",
]Replace models.TextField with ProseEditorField where appropriate:
from django_prose_editor.fields import ProseEditorField
class Project(models.Model):
description = ProseEditorField()Note! No migrations will be generated when switching from and to models.TextField. That’s by design. Those migrations are mostly annoying.
Security
ProseMirror does a really good job of only allowing content which confirms to a particular scheme. Of course users can submit what they want, they are not constrainted by the HTML widgets you’re using. You should still always sanitize the HTML submitted on the server side. A good way to do this is by using the sanitize argument to the ProseEditorField. You can use the following snippet to always pass HTML through nh3:
from django_prose_editor.sanitized import SanitizedProseEditorField
description = SanitizedProseEditorField()Convenience
Sometimes it may be useful to show an excerpt of the HTML field; the ProseEditorField automatically adds a get_*_excerpt method to models which returns the truncated and stripped beginning of your HTML field’s content. The name would be Project.get_description_excerpt in the example above.
Customization
It’s possible to slightly customize the field or widget by passing an optional config dictionary. The default configuration is:
config = {
"types": None, # Allow all nodes and marks
"history": True, # Enable undo and redo
"html": True, # Add a button which allows editing the raw HTML
}If you only want to support paragraphs, strong, emphasis, sub- and superset and no history or HTML editing you could add the following field:
text = SanitizedProseEditorField(
config={"types": ["strong", "em", "sub", "sup"]},
)Paragraphs cannot be removed at the moment. Note that the backend doesn’t sanitize the content to ensure that the HTML doesn’t contain only the provided tags, that’s out of scope for now.
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
File details
Details for the file django_prose_editor-0.3.3.tar.gz.
File metadata
- Download URL: django_prose_editor-0.3.3.tar.gz
- Upload date:
- Size: 208.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: python-httpx/0.25.1
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 6046c98642af73b84acbc592389e9396b64eb87dc5cc516da960682d035ac609 |
|
| MD5 | badb3a5065704c5306a674e36ae97736 |
|
| BLAKE2b-256 | 8571f41f7a9d6ef9614765ef36d62295cd2da789bf8be762db662ec71a58d07f |
File details
Details for the file django_prose_editor-0.3.3-py3-none-any.whl.
File metadata
- Download URL: django_prose_editor-0.3.3-py3-none-any.whl
- Upload date:
- Size: 208.3 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: python-httpx/0.25.1
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 3eb498128b0018f57cedabc8a05d5d1f61608d2dcaad6bb56bca4e1770d3484c |
|
| MD5 | c8843dbbb6f95416cfcb365e9306ca25 |
|
| BLAKE2b-256 | a722f150efc1b6552bdaa1178f0d88a0511ee260df50e79a992077cd057dd48b |
