Skip to main content

django-tiptap-editor

CI PyPI Python versions Django versions Docs Coverage Ruff License

A reusable, pip-installable Django package providing a drop-in rich-text editor backed by TipTap (headless ProseMirror): a form Widget, an admin widget, a ModelAdmin mixin, a settings default, and vendored static assets — node-free for consumers.

What this is

A reusable rich-text editor for Django: a form Widget, an admin widget, a ModelAdmin mixin, a settings-driven config, and committed static assets — with a clean, options-object surface and its own config schema.

  • Stored value is HTML by default (render it with |safe); optional JSON storage via TipTapJSONField keeps the canonical ProseMirror doc plus a safe, server-derived HTML mirror.
  • ProseMirror's schema is a sanitizer: scripts and unknown nodes are dropped on parse, and link/image protocols are allowlisted — so |safe is justified.
  • Node-free for consumers: the editor ships as a committed, self-contained bundle. An optional glue-only ESM build lets you bring your own TipTap via CDN / import maps.
  • Extensible without a build step: a runtime registry for custom extensions, toolbar buttons, and layered (CSS-variable) theming.
  • Full toolbar (formatting, font size/family, colour, highlight, lists, alignment, links, images, tables, source view), image upload + library picker, merge tags, and en/sv i18n out of the box.

Installation

pip install django-tiptap-editor

Add the app to INSTALLED_APPS (it ships the static bundle):

INSTALLED_APPS = [
    # ...
    "django_tiptap_editor",
]

Quickstart

from django import forms
from django_tiptap_editor.forms.fields import TipTapFormField


class ArticleForm(forms.Form):
    body = TipTapFormField()

In the admin:

from django.contrib import admin
from django_tiptap_editor.admin.mixin import TipTapModelAdminMixin


@admin.register(Article)
class ArticleAdmin(TipTapModelAdminMixin, admin.ModelAdmin):
    pass  # every TextField (and TipTapJSONField) becomes a TipTap editor

Render the field with {{ form.media }} (or {% tiptap_media %}) in your template, and display the stored HTML with {{ article.body|safe }}. See the documentation for configuration, the upload/image-list contracts, theming, extension authoring, asset modes, and the migration guide.

Documentation

Full documentation is published at artui.github.io/django-tiptap-editor.

License

MIT — see LICENSE.

Download files

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

Source Distribution

django_tiptap_editor-0.9.0.tar.gz (352.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

django_tiptap_editor-0.9.0-py3-none-any.whl (169.2 kB view details)

Uploaded Python 3

File details

Details for the file django_tiptap_editor-0.9.0.tar.gz.

File metadata

  • Download URL: django_tiptap_editor-0.9.0.tar.gz
  • Upload date:
  • Size: 352.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for django_tiptap_editor-0.9.0.tar.gz
Algorithm Hash digest
SHA256 7321c944a62cd65ff9a592bbc75bdae4a60bf683128bb0966598f768f03b2364
MD5 71a9b85a96c36f0a509f89d9cdc33bf2
BLAKE2b-256 5a942d98f08588db389005d9a9f4e0229646a28a743e2b0d0fab3db173c33580

See more details on using hashes here.

Provenance

The following attestation bundles were made for django_tiptap_editor-0.9.0.tar.gz:

Publisher: release.yml on Artui/django-tiptap-editor

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file django_tiptap_editor-0.9.0-py3-none-any.whl.

File metadata

File hashes

Hashes for django_tiptap_editor-0.9.0-py3-none-any.whl
Algorithm Hash digest
SHA256 cd66685b262f0057ee0bf7801d5c7532eee2ac49fa6f15981a9a9758956830d5
MD5 f26492cc5d32b8b3786d3661c05f8614
BLAKE2b-256 eb7b2e2d5921f2028a14e6e4a4ee7d6bfe86cfaa61abb875d038ca9b21450b44

See more details on using hashes here.

Provenance

The following attestation bundles were made for django_tiptap_editor-0.9.0-py3-none-any.whl:

Publisher: release.yml on Artui/django-tiptap-editor

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

0.10.0

2 files

This release

0.9.0 This release

2 files

0.8.0

2 files

0.7.0

2 files

0.6.0

2 files

0.5.0

2 files

0.4.0

2 files

0.3.1

2 files

0.3.0

2 files

0.2.0

2 files

0.1.0

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page