update docs

Author: Archmonger

CHANGELOG.md

@@ -39,14 +39,16 @@ 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.
 
 ### Changed
 
 -   Renamed undocumented utility function `reactpy_django.utils.ComponentPreloader` to `reactpy_django.utils.RootComponentFinder`.
 
 ### Deprecated
 
--   The `compatibility` argument on `reactpy_django.components.view_to_component` is deprecated. Use `view_to_iframe_component` instead.
+-   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 `#!python @decorator` is deprecated. Check the docs on the new suggested usage.
 
 ## [3.5.1] - 2023-09-07
 

docs/python/hello_world_args_kwargs.py

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

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/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",
+            key1="abc",
+            key2="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)
 
 
 @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,17 @@
+from reactpy import component, html
+from reactpy_django.components import view_to_iframe
+
+from . import views
+
+
+@component
+def my_component():
+    return html.div(
+        view_to_iframe(
+            views.hello_world,
+            "value_1",
+            "value_2",
+            key1="abc",
+            key2="123",
+        ),
+    )

docs/python/vtc-func.py

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

docs/python/vtc-request.py

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

docs/python/vtc-strict-parsing.py

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