django-json-widget 2.0.4__tar.gz → 2.1.0__tar.gz

{django_json_widget-2.0.4 → django_json_widget-2.1.0}/CHANGELOG.rst

@@ -2,6 +2,11 @@
 Changelog
 =========
 
+2.1.0 (2025-10-24)
+------------------
+
+* Issue #114: expose editor instance to window object and DOM element.
+
 2.0.4 (2025-10-11)
 ------------------
 

{django_json_widget-2.0.4 → django_json_widget-2.1.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: django-json-widget
-Version: 2.0.4
+Version: 2.1.0
 Summary: Django json widget is an alternative widget that makes it easy to edit the jsonfield field of django.
 Home-page: https://github.com/jmrivas86/django-json-widget
 Author: José Manuel Rivas
@@ -108,6 +108,29 @@ You can customize the JSONEditorWidget with the following options:
 * **mode (deprecated)**: The default editor mode. This argument is redundant because it can be specified as a part of ``options``.  Preserved for backwards compatibility with version 0.2.0.
 * **attrs**: HTML attributes to be applied to the wrapper element. See the `Django Widget documentation`_.
 
+Accessing JsonEditor Instance
+-----------------------------
+
+The JsonEditor instance is automatically exposed for external access through two methods:
+
+1. **Window object**: Available as ``window['FIELD_ID_editor']`` where FIELD_ID is the field's HTML ID
+2. **DOM element**: Available as ``container.jsonEditor`` property on the widget's container element
+
+Example usage for external JavaScript access:
+
+.. code-block:: javascript
+
+    // Access via window object
+    var editor = window['id_jsonfield_editor'];
+    editor.set({'key': 'new value'});
+    
+    // Access via DOM element
+    var container = document.getElementById('id_jsonfield');
+    var editor = container.jsonEditor;
+    editor.set({'key': 'new value'});
+
+This allows you to programmatically call JsonEditor methods like ``set()``, ``get()``, ``update()``, etc. from custom JavaScript code running in your admin pages or forms.
+
 .. _json editor: https://github.com/josdejong/jsoneditor/blob/master/docs/api.md#configuration-options
 .. _Django Widget documentation: https://docs.djangoproject.com/en/2.1/ref/forms/widgets/#django.forms.Widget.attrs
 
@@ -146,6 +169,11 @@ Tools used in rendering this package:
 Changelog
 =========
 
+2.1.0 (2025-10-24)
+------------------
+
+* Issue #114: expose editor instance to window object and DOM element.
+
 2.0.4 (2025-10-11)
 ------------------
 

{django_json_widget-2.0.4 → django_json_widget-2.1.0}/README.rst

@@ -72,6 +72,29 @@ You can customize the JSONEditorWidget with the following options:
 * **mode (deprecated)**: The default editor mode. This argument is redundant because it can be specified as a part of ``options``.  Preserved for backwards compatibility with version 0.2.0.
 * **attrs**: HTML attributes to be applied to the wrapper element. See the `Django Widget documentation`_.
 
+Accessing JsonEditor Instance
+-----------------------------
+
+The JsonEditor instance is automatically exposed for external access through two methods:
+
+1. **Window object**: Available as ``window['FIELD_ID_editor']`` where FIELD_ID is the field's HTML ID
+2. **DOM element**: Available as ``container.jsonEditor`` property on the widget's container element
+
+Example usage for external JavaScript access:
+
+.. code-block:: javascript
+
+    // Access via window object
+    var editor = window['id_jsonfield_editor'];
+    editor.set({'key': 'new value'});
+    
+    // Access via DOM element
+    var container = document.getElementById('id_jsonfield');
+    var editor = container.jsonEditor;
+    editor.set({'key': 'new value'});
+
+This allows you to programmatically call JsonEditor methods like ``set()``, ``get()``, ``update()``, etc. from custom JavaScript code running in your admin pages or forms.
+
 .. _json editor: https://github.com/josdejong/jsoneditor/blob/master/docs/api.md#configuration-options
 .. _Django Widget documentation: https://docs.djangoproject.com/en/2.1/ref/forms/widgets/#django.forms.Widget.attrs
 

django_json_widget-2.1.0/django_json_widget/__init__.py

@@ -0,0 +1 @@
+__version__ = '2.1.0'

{django_json_widget-2.0.4 → django_json_widget-2.1.0}/django_json_widget/templates/django_json_widget.html

@@ -21,5 +21,9 @@
         var content = document.getElementById("{{ widget.name }}_data").textContent;
         textarea.value = content;
         editor.set(JSON.parse(content));
+        
+        // Expose editor instance for external access
+        window['{{ widget.attrs.id }}_editor'] = editor;
+        container.jsonEditor = editor;
     })();
 </script>

{django_json_widget-2.0.4 → django_json_widget-2.1.0}/django_json_widget.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: django-json-widget
-Version: 2.0.4
+Version: 2.1.0
 Summary: Django json widget is an alternative widget that makes it easy to edit the jsonfield field of django.
 Home-page: https://github.com/jmrivas86/django-json-widget
 Author: José Manuel Rivas
@@ -108,6 +108,29 @@ You can customize the JSONEditorWidget with the following options:
 * **mode (deprecated)**: The default editor mode. This argument is redundant because it can be specified as a part of ``options``.  Preserved for backwards compatibility with version 0.2.0.
 * **attrs**: HTML attributes to be applied to the wrapper element. See the `Django Widget documentation`_.
 
+Accessing JsonEditor Instance
+-----------------------------
+
+The JsonEditor instance is automatically exposed for external access through two methods:
+
+1. **Window object**: Available as ``window['FIELD_ID_editor']`` where FIELD_ID is the field's HTML ID
+2. **DOM element**: Available as ``container.jsonEditor`` property on the widget's container element
+
+Example usage for external JavaScript access:
+
+.. code-block:: javascript
+
+    // Access via window object
+    var editor = window['id_jsonfield_editor'];
+    editor.set({'key': 'new value'});
+    
+    // Access via DOM element
+    var container = document.getElementById('id_jsonfield');
+    var editor = container.jsonEditor;
+    editor.set({'key': 'new value'});
+
+This allows you to programmatically call JsonEditor methods like ``set()``, ``get()``, ``update()``, etc. from custom JavaScript code running in your admin pages or forms.
+
 .. _json editor: https://github.com/josdejong/jsoneditor/blob/master/docs/api.md#configuration-options
 .. _Django Widget documentation: https://docs.djangoproject.com/en/2.1/ref/forms/widgets/#django.forms.Widget.attrs
 
@@ -146,6 +169,11 @@ Tools used in rendering this package:
 Changelog
 =========
 
+2.1.0 (2025-10-24)
+------------------
+
+* Issue #114: expose editor instance to window object and DOM element.
+
 2.0.4 (2025-10-11)
 ------------------
 

{django_json_widget-2.0.4 → django_json_widget-2.1.0}/django_json_widget.egg-info/SOURCES.txt

@@ -56,5 +56,7 @@ imgs/jsonfield_0.png
 imgs/jsonfield_1.png
 tests/__init__.py
 tests/settings.py
+tests/test_jsoneditor_access.py
 tests/test_logic.py
-tests/test_widget_security.py
+tests/test_widget_security.py
+tests/templates/django/forms/widgets/attrs.html

{django_json_widget-2.0.4 → django_json_widget-2.1.0}/pyproject.toml

@@ -135,4 +135,19 @@ docstring-code-format = true
 
 # Set the line length limit used when formatting code snippets in
 # docstrings.
-docstring-code-line-length = "dynamic" 
+docstring-code-line-length = "dynamic"
+
+[tool.pytest.ini_options]
+python_files = ["test_*.py", "*_test.py"]
+testpaths = ["tests"]
+addopts = [
+    "--strict-markers",
+    "--strict-config",
+    "--verbose",
+    "--reuse-db",
+]
+markers = [
+    "slow: marks tests as slow (deselect with '-m \"not slow\"')",
+    "integration: marks tests as integration tests",
+]
+DJANGO_SETTINGS_MODULE = "tests.settings"

{django_json_widget-2.0.4 → django_json_widget-2.1.0}/setup.cfg

@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 2.0.4
+current_version = 2.1.0
 commit = True
 tag = True
 

{django_json_widget-2.0.4 → django_json_widget-2.1.0}/setup.py

@@ -46,7 +46,7 @@ history = open('CHANGELOG.rst').read().replace('.. :changelog:', '')
 
 setup(
     name='django-json-widget',
-    version='2.0.4',
+    version='2.1.0',
     description="""Django json widget is an alternative widget that makes it easy to edit the jsonfield field of django.""",
     long_description=readme + '\n\n' + history,
     author='José Manuel Rivas',

django_json_widget-2.1.0/tests/settings.py

@@ -0,0 +1,49 @@
+DEBUG = True
+USE_TZ = True
+
+# SECURITY WARNING: keep the secret key used in production secret!
+SECRET_KEY = "uuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuu"
+
+DATABASES = {
+    "default": {
+        "ENGINE": "django.db.backends.sqlite3",
+        "NAME": ":memory:",
+    }
+}
+
+INSTALLED_APPS = [
+    "django.contrib.auth",
+    "django.contrib.contenttypes",
+    "django.contrib.sites",
+    "django_json_widget",
+]
+
+SITE_ID = 1
+
+MIDDLEWARE = ()
+
+# JSON Editor Widget Settings
+JSON_EDITOR_JS = 'dist/jsoneditor.min.js'
+JSON_EDITOR_CSS = 'dist/jsoneditor.min.css'
+
+# Template configuration
+TEMPLATES = [
+    {
+        'BACKEND': 'django.template.backends.django.DjangoTemplates',
+        'DIRS': ['tests/templates'],
+        'APP_DIRS': True,
+        'OPTIONS': {
+            'context_processors': [
+                'django.template.context_processors.debug',
+                'django.template.context_processors.request',
+                'django.contrib.auth.context_processors.auth',
+                'django.contrib.messages.context_processors.messages',
+            ],
+            'builtins': [
+                'django.template.defaulttags',
+                'django.template.defaultfilters',
+                'django.template.loader_tags',
+            ],
+        },
+    },
+]

django_json_widget-2.1.0/tests/templates/django/forms/widgets/attrs.html

@@ -0,0 +1 @@
+{% for name, value in widget.attrs.items %}{% if value is not False %} {{ name }}{% if value is not True %}="{{ value|stringformat:'s' }}"{% endif %}{% endif %}{% endfor %}

django_json_widget-2.1.0/tests/test_jsoneditor_access.py

@@ -0,0 +1,60 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+
+"""
+test_jsoneditor_access
+----------------------
+
+Tests for JsonEditor instance accessibility from external JavaScript.
+"""
+
+from django.template import Context, Template
+from django.test import TestCase
+
+from django_json_widget.widgets import JSONEditorWidget
+
+
+class JSONEditorAccessTests(TestCase):
+    """Test JsonEditor instance accessibility"""
+
+    def test_template_exposes_editor_to_window(self):
+        """Test that JsonEditor instance is exposed to window object"""
+        widget = JSONEditorWidget()
+        context = widget.get_context("test_field", '{"key": "value"}', {"id": "test_id"})
+
+        # Render the template
+        template = Template('{% load static %}{% include "django_json_widget.html" %}')
+        rendered = template.render(Context({"widget": context["widget"]}))
+
+        # Check that the window assignment code is present
+        self.assertIn("window['test_id_editor'] = editor", rendered)
+
+    def test_template_exposes_editor_to_dom(self):
+        """Test that JsonEditor instance is attached to DOM container"""
+        widget = JSONEditorWidget()
+        context = widget.get_context("test_field", '{"key": "value"}', {"id": "test_id"})
+
+        # Render the template
+        template = Template('{% load static %}{% include "django_json_widget.html" %}')
+        rendered = template.render(Context({"widget": context["widget"]}))
+
+        # Check that the DOM assignment code is present
+        self.assertIn("container.jsonEditor = editor", rendered)
+
+    def test_multiple_widgets_different_ids(self):
+        """Test that multiple widgets get different window object names"""
+        widget1 = JSONEditorWidget()
+        widget2 = JSONEditorWidget()
+
+        context1 = widget1.get_context("field1", "{}", {"id": "id_field1"})
+        context2 = widget2.get_context("field2", "{}", {"id": "id_field2"})
+
+        template = Template('{% load static %}{% include "django_json_widget.html" %}')
+
+        rendered1 = template.render(Context({"widget": context1["widget"]}))
+        rendered2 = template.render(Context({"widget": context2["widget"]}))
+
+        # Each widget should have its own unique window object name
+        self.assertIn("window['id_field1_editor'] = editor", rendered1)
+        self.assertIn("window['id_field2_editor'] = editor", rendered2)
+        self.assertNotEqual(rendered1, rendered2)

django_json_widget-2.0.4/django_json_widget/__init__.py

@@ -1 +0,0 @@
-__version__ = '2.0.4'

django_json_widget-2.0.4/tests/settings.py

@@ -1,23 +0,0 @@
-DEBUG = True
-USE_TZ = True
-
-# SECURITY WARNING: keep the secret key used in production secret!
-SECRET_KEY = "uuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuu"
-
-DATABASES = {
-    "default": {
-        "ENGINE": "django.db.backends.sqlite3",
-        "NAME": ":memory:",
-    }
-}
-
-INSTALLED_APPS = [
-    "django.contrib.auth",
-    "django.contrib.contenttypes",
-    "django.contrib.sites",
-    "django_json_widget",
-]
-
-SITE_ID = 1
-
-MIDDLEWARE = ()