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.8.0.tar.gz (337.6 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.8.0-py3-none-any.whl (165.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: django_tiptap_editor-0.8.0.tar.gz
  • Upload date:
  • Size: 337.6 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.8.0.tar.gz
Algorithm Hash digest
SHA256 0aceb5606633352076c359df25b556f4b84f0ad00b148f6f22497f6258c2807a
MD5 7248417bcadd17dcd1a275441b03f4bd
BLAKE2b-256 9c42593aa93c0231a754444fc81cad77db50058a2ed2d69e1b11633d6082351d

See more details on using hashes here.

Provenance

The following attestation bundles were made for django_tiptap_editor-0.8.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.8.0-py3-none-any.whl.

File metadata

File hashes

Hashes for django_tiptap_editor-0.8.0-py3-none-any.whl
Algorithm Hash digest
SHA256 41c29bab8910089c693d9ecfb942bd82ad1d483704e5203a2b298a069e91d0a1
MD5 37e50874081e134a78bb2bc18fe6742f
BLAKE2b-256 bd416cc0565082dbbcc242966d01cd386a899500bc905a8732b55e3e4021bb4b

See more details on using hashes here.

Provenance

The following attestation bundles were made for django_tiptap_editor-0.8.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

0.9.0

2 files

This release

0.8.0 This release

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