view_to_iframe component (#188)

-   The `compatibility` argument on `reactpy_django.components.view_to_component` is deprecated.
-   Using `reactpy_django.components.view_to_component` as a decorator is deprecated.
-   `reactpy_django.utils.register_iframe` function has been added.
-   `reactpy_django.components.view_to_iframe` component has been added
-   It is now recommended to call `as_view()` when using `view_to_component` or `view_to_iframe` with Class Based Views.
-   Thread sensitivity has been enabled in all locations where ORM queries are possible.

Author: Archmonger

CHANGELOG.md

@@ -39,10 +39,19 @@ Using the following categories, list your changes in this order:
 -   ReactPy components can now use SEO compatible rendering!
     -   `settings.py:REACTPY_PRERENDER` can be set to `True` to enable this behavior by default
     -   Or, you can enable it on individual components via the template tag: `{% component "..." prerender="True" %}`
+-   `reactpy_django.components.view_to_iframe` component has been added, which uses an `<iframe>` to render a Django view.
+-   `reactpy_django.utils.register_iframe` function has been added, which is mandatory to use alongside `reactpy_django.components.view_to_iframe`.
 
 ### Changed
 
 -   Renamed undocumented utility function `reactpy_django.utils.ComponentPreloader` to `reactpy_django.utils.RootComponentFinder`.
+-   It is now recommended to call `as_view()` when using `view_to_component` or `view_to_iframe` with Class Based Views.
+-   Thread sensitivity has been enabled in all locations where ORM queries are possible.
+
+### Deprecated
+
+-   The `compatibility` argument on `reactpy_django.components.view_to_component` is deprecated. Use `reactpy_django.components.view_to_iframe` instead.
+-   Using `reactpy_django.components.view_to_component` as a decorator is deprecated. Check the docs on the new suggested usage.
 
 ## [3.5.1] - 2023-09-07
 

docs/python/hello_world_app_config_cbv.py

@@ -0,0 +1,11 @@
+from django.apps import AppConfig
+from reactpy_django.utils import register_iframe
+
+from . import views
+
+
+class ExampleAppConfig(AppConfig):
+    name = "example"
+
+    def ready(self):
+        register_iframe(views.HelloWorld)

docs/python/hello_world_app_config_fbv.py

@@ -0,0 +1,11 @@
+from django.apps import AppConfig
+from reactpy_django.utils import register_iframe
+
+from . import views
+
+
+class ExampleAppConfig(AppConfig):
+    name = "example"
+
+    def ready(self):
+        register_iframe(views.hello_world)

docs/python/hello_world_args_kwargs.py

@@ -0,0 +1,5 @@
+from django.http import HttpResponse
+
+
+def hello_world(request, arg1, arg2, kwarg1=None, kwarg2=None):
+    return HttpResponse(f"Hello World! {arg1} {arg2} {kwarg1} {kwarg2}")

docs/python/hello_world_cbv.py

@@ -0,0 +1,7 @@
+from django.http import HttpResponse
+from django.views import View
+
+
+class HelloWorld(View):
+    def get(self, request):
+        return HttpResponse("Hello World!")

docs/python/hello_world_fbv.py

@@ -0,0 +1,5 @@
+from django.http import HttpResponse
+
+
+def hello_world(request):
+    return HttpResponse("Hello World!")

docs/python/hello_world_fbv_with_id.py

@@ -0,0 +1,5 @@
+from django.http import HttpResponse
+
+
+def hello_world(request):
+    return HttpResponse('<div id="hello-world"> Hello World! </div>')

docs/python/register-component.py

@@ -2,7 +2,8 @@
 from reactpy_django.utils import register_component
 
 
-class ExampleConfig(AppConfig):
+class ExampleAppConfig(AppConfig):
+    name = "example"
+
     def ready(self):
-        # Add components to the ReactPy component registry when Django is ready
         register_component("example_project.my_app.components.hello_world")

docs/python/use-mutation-thread-sensitive.py

@@ -3,7 +3,7 @@
 from reactpy_django.types import MutationOptions
 
 
-def execute_thread_safe_mutation():
+def execute_thread_safe_mutation(text):
     """This is an example mutation function that does some thread-safe operation."""
     pass
 

docs/python/views.py

@@ -0,0 +1,7 @@
+from .hello_world_cbv import HelloWorld
+from .hello_world_fbv import hello_world
+
+__all__ = [
+    "HelloWorld",
+    "hello_world",
+]

docs/python/vtc-args-kwargs.py

@@ -0,0 +1,23 @@
+from django.http import HttpRequest
+from reactpy import component, html
+from reactpy_django.components import view_to_component
+
+from . import views
+
+hello_world_component = view_to_component(views.hello_world)
+
+
+@component
+def my_component():
+    request = HttpRequest()
+    request.method = "GET"
+
+    return html.div(
+        hello_world_component(
+            request,  # This request object is optional.
+            "value_1",
+            "value_2",
+            kwarg1="abc",
+            kwarg2="123",
+        ),
+    )

docs/python/vtc-args.py

@@ -1,19 +1,13 @@
-from django.http import HttpResponse
-from django.views import View
 from reactpy import component, html
 from reactpy_django.components import view_to_component
 
+from . import views
 
-class HelloWorldView(View):
-    def get(self, request):
-        return HttpResponse("Hello World!")
-
-
-vtc = view_to_component(HelloWorldView)
+hello_world_component = view_to_component(views.HelloWorld.as_view())
 
 
 @component
 def my_component():
     return html.div(
-        vtc(),
+        hello_world_component(),
     )

docs/python/vtc-cbv-compatibility.py

@@ -1,15 +1,13 @@
-from django.http import HttpResponse
 from reactpy import component, html
 from reactpy_django.components import view_to_component
 
+from . import views
 
-@view_to_component(strict_parsing=False)
-def hello_world_view(request):
-    return HttpResponse("<my-tag> Hello World </my-tag>")
+hello_world_component = view_to_component(views.hello_world)
 
 
 @component
 def my_component():
     return html.div(
-        hello_world_view(),
+        hello_world_component(),
     )

docs/python/vtc-cbv.py

@@ -1,21 +1,22 @@
-from django.http import HttpResponse
 from reactpy import component, html
 from reactpy_django.components import view_to_component
 
+from . import views
+
 
 def example_transform(vdom):
     attributes = vdom.get("attributes")
     if attributes and attributes.get("id") == "hello-world":
-        vdom["children"][0] = "Good Bye World!"
+        vdom["children"][0] = "Farewell World!"
 
 
-@view_to_component(transforms=[example_transform])
-def hello_world_view(request):
-    return HttpResponse("<div id='hello-world'> Hello World! <div>")
+hello_world_component = view_to_component(
+    views.hello_world, transforms=[example_transform]
+)
 
 
 @component
 def my_component():
     return html.div(
-        hello_world_view(),
+        hello_world_component(),
     )

docs/python/vtc-compatibility.py

@@ -1,15 +1,13 @@
-from django.http import HttpResponse
 from reactpy import component, html
 from reactpy_django.components import view_to_component
 
+from . import views
 
-@view_to_component
-def hello_world_view(request):
-    return HttpResponse("Hello World!")
+hello_world_component = view_to_component(views.hello_world)
 
 
 @component
 def my_component():
     return html.div(
-        hello_world_view(),
+        hello_world_component(),
     )

docs/python/vtc-fbv-compat.py

@@ -0,0 +1,20 @@
+from reactpy import component, html
+from reactpy_django.components import view_to_iframe
+
+from . import views
+
+hello_world_iframe = view_to_iframe(
+    views.hello_world,
+)
+
+
+@component
+def my_component():
+    return html.div(
+        hello_world_iframe(
+            "value_1",
+            "value_2",
+            kwarg1="abc",
+            kwarg2="123",
+        ),
+    )

docs/python/vtc-func.py

@@ -0,0 +1,13 @@
+from reactpy import component, html
+from reactpy_django.components import view_to_iframe
+
+from . import views
+
+hello_world_iframe = view_to_iframe(views.HelloWorld.as_view())
+
+
+@component
+def my_component():
+    return html.div(
+        hello_world_iframe(),
+    )

docs/python/vtc-request.py

@@ -0,0 +1,15 @@
+from reactpy import component, html
+from reactpy_django.components import view_to_iframe
+
+from . import views
+
+hello_world_iframe = view_to_iframe(
+    views.hello_world, extra_props={"title": "Hello World!"}
+)
+
+
+@component
+def my_component():
+    return html.div(
+        hello_world_iframe(),
+    )

docs/python/vtc-strict-parsing.py

@@ -0,0 +1,13 @@
+from reactpy import component, html
+from reactpy_django.components import view_to_iframe
+
+from . import views
+
+hello_world_iframe = view_to_iframe(views.hello_world)
+
+
+@component
+def my_component():
+    return html.div(
+        hello_world_iframe(),
+    )