Django JSON Widget

2.1.1 · active · verified Sun Apr 12

Django JSON Widget provides an alternative, user-friendly widget for editing Django's JSONField, featuring syntax highlighting, automatic indentation, and validation. It leverages the JSONEditor JavaScript library to enhance the default Django form experience. The library is actively maintained, with frequent updates, and is currently at version 2.1.1.

Warnings

deprecated The `mode` argument for `JSONEditorWidget` is deprecated since version 0.2.0. Instead, specify the editor mode (e.g., 'tree', 'code', 'form') via the `options` dictionary, which accepts arguments directly from the underlying JSON Editor JavaScript library.
Fix: Replace `JSONEditorWidget(mode='tree')` with `JSONEditorWidget(options={'mode': 'tree'})`.
gotcha Using inline scripts in the widget might conflict with Content Security Policies (CSP) if not properly configured, potentially leading to script blocking and functionality issues.
Fix: Review and update your Django project's CSP to allow for the necessary inline scripts or consider alternative methods for integrating the widget if strict CSP is required.
gotcha There are reported issues with the widget not functioning correctly or rendering improperly when used within Django's `TabularInline` or when integrated with third-party admin themes like `Grappelli`.
Fix: Test thoroughly when using with inlines or custom admin themes. For inlines, a custom form for the inline might be needed. For admin themes, custom CSS overrides may be required.
breaking Prior to version 2.0.0, users experienced issues with Django 4.x due to missing sourcemaps and incorrect default paths for static files, leading to improper rendering or functionality.
Fix: Upgrade to `django-json-widget` version 2.0.0 or higher to resolve static file and sourcemap issues with Django 4.x and newer.

Install

pip install django-json-widget Install stable version

Imports

JSONEditorWidget
```
from django_json_widget.widgets import JSONEditorWidget
```
Used to override the default widget for JSONField in Django forms or admin.

Quickstart

To quickly integrate `django-json-widget` into your Django admin, add `django_json_widget` to your `INSTALLED_APPS` and then override the default widget for `JSONField` in your `admin.py` using `formfield_overrides`.

from django.contrib import admin
from django.db import models
from django_json_widget.widgets import JSONEditorWidget

# models.py (example)
class MyModel(models.Model):
    name = models.CharField(max_length=255)
    data = models.JSONField(default=dict)

    def __str__(self):
        return self.name

# admin.py (example)
from django.contrib import admin
from .models import MyModel
from django_json_widget.widgets import JSONEditorWidget

@admin.register(MyModel)
class MyModelAdmin(admin.ModelAdmin):
    list_display = ('name',)
    formfield_overrides = {
        models.JSONField: {'widget': JSONEditorWidget},
    }

# Alternatively, in a custom form:
# from django import forms
# from .models import MyModel
# from django_json_widget.widgets import JSONEditorWidget
#
# class MyForm(forms.ModelForm):
#     class Meta:
#         model = MyModel
#         fields = ('name', 'data')
#         widgets = {
#             'data': JSONEditorWidget,
#         }

view raw JSON →