rename idom_view to idom_component

rmorshea · rmorshea · commit aee70a7d3895 · 2021-08-18T18:00:03.000-07:00
diff --git a/README.md b/README.md
@@ -151,12 +151,12 @@ def Hello(greeting_recipient):  # component names are camelcase by convention
 ## `example_app/templates/your-template.html`
 
 In your templates, you may inject a view of an IDOM component into your templated HTML
-by using the `idom_view` template tag. This tag which requires the name of a component
+by using the `idom_component` template tag. This tag which requires the name of a component
 to render (of the form `module_name.ComponentName`) and keyword arguments you'd like to
 pass it from the template.
 
 ```python
-idom_view module_name.ComponentName param_1="something" param_2="something-else"
+idom_component module_name.ComponentName param_1="something" param_2="something-else"
 ```
 
 In context this will look a bit like the following...
@@ -170,7 +170,7 @@ In context this will look a bit like the following...
 <html>
   <body>
     ...
-    {% idom_view "your_app.example_app.components.Hello" greeting_recipient="World" %}
+    {% idom_component "your_app.example_app.components.Hello" greeting_recipient="World" %}
   </body>
 </html>
 ```
diff --git a/src/django_idom/templates/idom/view.html b/src/django_idom/templates/idom/view.html
@@ -7,7 +7,7 @@
     mountPoint,
     "{{ idom_websocket_url }}",
     "{{ idom_web_modules_url }}",
-    "{{ idom_view_id }}",
-    "{{ idom_view_params }}"
+    "{{ idom_component_id }}",
+    "{{ idom_component_params }}"
   );
 </script>
diff --git a/src/django_idom/templatetags/idom.py b/src/django_idom/templatetags/idom.py
@@ -17,7 +17,7 @@
 
 
 @register.inclusion_tag("idom/view.html")
-def idom_view(_component_id_, **kwargs):
+def idom_component(_component_id_, **kwargs):
     _register_component(_component_id_)
 
     json_kwargs = json.dumps(kwargs, separators=(",", ":"))
@@ -26,8 +26,8 @@ def idom_view(_component_id_, **kwargs):
         "idom_websocket_url": IDOM_WEBSOCKET_URL,
         "idom_web_modules_url": IDOM_WEB_MODULES_URL,
         "idom_mount_uuid": uuid4().hex,
-        "idom_view_id": _component_id_,
-        "idom_view_params": urlencode({"kwargs": json_kwargs}),
+        "idom_component_id": _component_id_,
+        "idom_component_params": urlencode({"kwargs": json_kwargs}),
     }
 
 
diff --git a/tests/test_app/templates/base.html b/tests/test_app/templates/base.html
@@ -15,11 +15,12 @@
 
   <body>
     <h1>IDOM Test Page</h1>
-    <div>{% idom_view "test_app.components.HelloWorld" %}</div>
-    <div>{% idom_view "test_app.components.Button" %}</div>
+    <div>{% idom_component "test_app.components.HelloWorld" %}</div>
+    <div>{% idom_component "test_app.components.Button" %}</div>
     <div>
-      {% idom_view "test_app.components.ParametrizedComponent" x=123 y=456 %}
+      {% idom_component "test_app.components.ParametrizedComponent" x=123 y=456
+      %}
     </div>
-    <div>{% idom_view "test_app.components.SimpleBarChart" %}</div>
+    <div>{% idom_component "test_app.components.SimpleBarChart" %}</div>
   </body>
 </html>
