Trix rich text editor widget for Django (Fork of https://github.com/tortillagroup/django-trix)
Project description
django-trix
Trix rich text editor widget for Django, using Trix 1.2.3.
Installation
-
From PyPI:
pip install django-trix-fork -
Install
trixas app in django Add to INSTALLED_APPS:INSTALLED_APPS = ( ... 'trix', ... ) -
Add route to urls.py:
urlpatterns = [ ... url(r'^trix/', include('trix.urls')), ... ] -
Add django-trix variables to your
app/settings.py:... # valid file extentions for attachment TRIX_EXTENSIONS = ['.jpg', '.png'] # folder where attachments will be saved TRIX_URI = 'trix' ... -
Set-Up trix-django tables:
python manage.py makemigrations trix python manage.py migrate
Done
How to use django-trix
django-trix includes a form widget, a model field, and a model admin mixin that enables the rich text editor. You can use any of these methods, but you do not need to use all.
Model
To enable the editor in the Django admin (or any form) via the model field, use the Trix model field TrixField which inherits from django.db.models.TextField:
from django.db import models
from trix.fields import TrixField
class Post(models.Model):
content = TrixField('Content')
Admin
To enable the editor in the Django admin, inherit from TrixAdmin and set the trix_fields attribute to a list of the fields that use an editor:
from myawesomeblogapp.models import Post
from trix.admin import TrixAdmin
@admin.register(Post)
class PostAdmin(TrixAdmin, admin.ModelAdmin):
trix_fields = ('content',)
Forms and Templates
The editor can be used in forms and templates by adding the TrixEditor widget to a form field:
from django import forms
from trix.widgets import TrixEditor
class EditorForm(forms.Form):
content = forms.CharField(widget=TrixEditor)
In the template, just use the form as you normally would, but be sure to include the associated media:
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>Trix Editor Test</title>
{{ form.media.css }}
</head>
<body>
<form>
{{ form }}
</form>
{{ form.media.js }}
</body>
</html>
CSS in head, JS at end of body, because you are a responsible developer.
What Works
Basically Everything :) from Rich Text formatting to Uploading Attachments !
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_trix_fork-0.3.2.0-py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 6b57bf0f14e59919e5f2a8877a0ff6a48fc58b60621ef8fd2f4a605549afff7b |
|
| MD5 | 20ab5d8781ec497d6f1bf698b88d4ce3 |
|
| BLAKE2b-256 | 06b1a612f69ad15867285c22c1af09dd8649fc4fec65f857dfab46af0c6f6c53 |
