Component views and URLs
New in version 0.34
Note: Since 0.92, Component is no longer a subclass of Django's View. Instead, the nested Component.View class is a subclass of Django's View.
For web applications, it's common to define endpoints that serve HTML content (AKA views).
django-components has a suite of features that help you write and manage views and their URLs:
-
For each component, you can define methods for handling HTTP requests (GET, POST, etc.) -
get(),post(), etc. -
Use
Component.as_view()to be able to use your Components with Django'surlpatterns. This works the same way asView.as_view(). -
To avoid having to manually define the endpoints for each component, you can set the component to be "public" with
Component.Url.public = True. This will automatically create a URL for the component. To retrieve the component URL, useget_component_url(). -
In addition,
Componenthas arender_to_response()method that renders the component template based on the provided input and returns anHttpResponseobject.
Define handlers¤
Here's an example of a calendar component defined as a view. Simply define a View class with your custom get() method to handle GET requests:
from django_components import Component, ComponentView, register
+ Component views and URLs - Django-Components Component views and URLs
New in version 0.34
Note: Since 0.92, Component is no longer a subclass of Django's View. Instead, the nested Component.View class is a subclass of Django's View.
For web applications, it's common to define endpoints that serve HTML content (AKA views).
django-components has a suite of features that help you write and manage views and their URLs:
-
For each component, you can define methods for handling HTTP requests (GET, POST, etc.) - get(), post(), etc.
-
Use Component.as_view() to be able to use your Components with Django's urlpatterns. This works the same way as View.as_view().
-
To avoid having to manually define the endpoints for each component, you can set the component to be "public" with Component.View.public = True. This will automatically create a URL for the component. To retrieve the component URL, use get_component_url().
-
In addition, Component has a render_to_response() method that renders the component template based on the provided input and returns an HttpResponse object.
Define handlers¤
Here's an example of a calendar component defined as a view. Simply define a View class with your custom get() method to handle GET requests:
[project root]/components/calendar.pyfrom django_components import Component, ComponentView, register
@register("calendar")
class Calendar(Component):
@@ -47,15 +47,14 @@
urlpatterns = [
path("calendar/", Calendar.as_view()),
]
-
Component.as_view() internally calls View.as_view(), passing the component instance as one of the arguments.
Register URLs automatically¤
If you don't care about the exact URL of the component, you can let django-components manage the URLs for you by setting the Component.Url.public attribute to True:
Component.as_view() internally calls View.as_view(), passing the component instance as one of the arguments.
Register URLs automatically¤
If you don't care about the exact URL of the component, you can let django-components manage the URLs for you by setting the Component.View.public attribute to True:
class MyComponent(Component):
+ class View:
public = True
- class View:
- def get(self, request):
- return self.component.render_to_response(request=request)
- ...
+ def get(self, request):
+ return self.component.render_to_response(request=request)
+ ...
Then, to get the URL for the component, use get_component_url():
This way you don't have to mix your app URLs with component URLs.
\ No newline at end of file
+This way you don't have to mix your app URLs with component URLs.