Template Tag
Overview¶
Django template tags can be used within your HTML templates to provide ReactPy features.
Component¶
This template tag can be used to insert any number of ReactPy components onto your page.
1 2 3 4 5 6 7 |
|
See Interface
Parameters
Name | Type | Description | Default |
---|---|---|---|
dotted_path | str | The dotted path to the component to render. | N/A |
*args | Any | The positional arguments to provide to the component. | N/A |
class | str | None | The HTML class to apply to the top-level component div. | None |
key | Any | Force the component's root node to use a specific key value. Using key within a template tag is effectively useless. | None |
host | str | None | The host to use for the ReactPy connections. If unset, the host will be automatically configured. Example values include: localhost:8000 , example.com , example.com/subdir | None |
prerender | str | If "True" , the component will pre-rendered, which enables SEO compatibility and reduces perceived latency. | "False" |
**kwargs | Any | The keyword arguments to provide to the component. | N/A |
Returns
Type | Description |
---|---|
Component | A ReactPy component. |
Do not use context variables for the component path
The ReactPy component finder requires that your component path is a string.
Do not use Django template/context variables for the component path. Failure to follow this warning can result in unexpected behavior, such as components that will not render.
For example, do not do the following:
1 2 3 4 5 |
|
1 2 3 4 5 6 |
|
Can I render components on a different server (distributed computing)?
Yes! By using the host
keyword argument, you can render components from a completely separate ASGI server.
1 2 3 |
|
This configuration most commonly involves you deploying multiple instances of your project. But, you can also create dedicated Django project(s) that only render specific ReactPy components if you wish.
Here's a couple of things to keep in mind:
- If your host address are completely separate (
origin1.com != origin2.com
) you will need to configure CORS headers on your main application during deployment. - You will not need to register ReactPy WebSocket or HTTP paths on any applications that do not perform any component rendering.
- Your component will only be able to access your template tag's
*args
/**kwargs
if your applications share a common database.
Can I use multiple components on one page?
You can add as many components to a webpage as needed by using the template tag multiple times. Retrofitting legacy sites to use ReactPy will typically involve many components on one page.
1 2 3 4 5 6 7 8 9 |
|
Please note that components separated like this will not be able to interact with each other, except through database queries.
Additionally, in scenarios where you are trying to create a Single Page Application (SPA) within Django, you will only have one component within your <body>
tag.
Can I use positional arguments instead of keyword arguments?
You can use any combination of *args
/**kwargs
in your template tag.
1 |
|
1 2 3 4 5 6 |
|