Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Jinja support #199

Draft
wants to merge 4 commits into
base: main
Choose a base branch
from
Draft
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
67 changes: 67 additions & 0 deletions src/reactpy_django/templatetags/jinja.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
# Copyright © 2023 Innovatie Ltd. All rights reserved.
ShaheedHaque marked this conversation as resolved.
Show resolved Hide resolved
"""
Jinja support.
"""
import typing as t
ShaheedHaque marked this conversation as resolved.
Show resolved Hide resolved

from django.template import RequestContext, loader
from jinja2 import pass_context
from jinja2.ext import Extension
from jinja2.runtime import Context, Undefined

from .reactpy import component as djt_component
ShaheedHaque marked this conversation as resolved.
Show resolved Hide resolved
from .. import config
ShaheedHaque marked this conversation as resolved.
Show resolved Hide resolved


class ReactPyExtension(Extension):
"""
Jinja has more expressive power than core Django's templates, and can
directly handle expansions such as:

{{ component(*args, **kwargs) }}
"""
DJT_TEMPLATE = 'reactpy/component.html'
ShaheedHaque marked this conversation as resolved.
Show resolved Hide resolved
#
# Therefore, there is no new tag to parse().
#
tags = {}

def __init__(self, environment):
super().__init__(environment)
#
# All we need is to add global "component" to the environment.
#
environment.globals["component"] = self._jinja_component

@pass_context
def _jinja_component(self, __context: Context, dotted_path: str, *args: t.Any, host: str | None = None,
ShaheedHaque marked this conversation as resolved.
Show resolved Hide resolved
prerender: str = str(config.REACTPY_PRERENDER), **kwargs: t.Any) -> t.Union[t.Any, Undefined]:
"""
This method is used to embed an existing ReactPy component into your
Jinja2 template.

Args:
dotted_path: String of the fully qualified name of a component.
*args: The positional arguments to provide to the component.

Keyword Args:
class: The HTML class to apply to the top-level component div.
key: Force the component's root node to use a specific key value. \
Using key within a template tag is effectively useless.
host: The host to use for the ReactPy connections. If set to `None`, \
the host will be automatically configured. \
Example values include: `localhost:8000`, `example.com`, `example.com/subdir`
prerender: Configures whether to pre-render this component, which \
enables SEO compatibility and reduces perceived latency.
**kwargs: The keyword arguments to provide to the component.

Returns:
Whatever the components returns.
"""
djt_context = RequestContext(__context.parent['request'], autoescape=__context.eval_ctx.autoescape)
ShaheedHaque marked this conversation as resolved.
Show resolved Hide resolved
context = djt_component(djt_context, dotted_path, *args, host=host, prerender=prerender, **kwargs)
Archmonger marked this conversation as resolved.
Show resolved Hide resolved
#
# TODO: can this be usefully cached?
#
result = loader.render_to_string(self.DJT_TEMPLATE, context, __context.parent['request'])
return result
ShaheedHaque marked this conversation as resolved.
Show resolved Hide resolved