mirrors/django-components
1
0
Fork 0
mirror of https://github.com/django-components/django-components.git synced 2025-08-09 00:37:59 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

refactor: Backbone for passing JS and CSS variables (#861)

Browse source 
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
This commit is contained in:
Juro Oravec 2024-12-28 19:27:19 +01:00 • committed by GitHub
parent 296da4a1e8
commit fe67d90547
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
28 changed files with 1181 additions and 594 deletions
Download patch file Download diff file Expand all files Collapse all files

42
src/django_components/component.py
View file

@ -45,7 +45,14 @@ from django_components.context import (
get_injected_context_var,
make_isolated_context_copy,
)
from django_components.dependencies import RenderType, cache_inlined_css, cache_inlined_js, postprocess_component_html
from django_components.dependencies import (
RenderType,
cache_component_css,
cache_component_css_vars,
cache_component_js,
cache_component_js_vars,
postprocess_component_html,
)
from django_components.expression import Expression, RuntimeKwargs, safe_resolve_list
from django_components.node import BaseNode
from django_components.slots import (
@ -92,6 +99,7 @@ _type = type
@dataclass(frozen=True)
class RenderInput(Generic[ArgsType, KwargsType, SlotsType]):
id: str
context: Context
args: ArgsType
kwargs: KwargsType
@ -297,7 +305,6 @@ class Component(
def __init__(
self,
registered_name: Optional[str] = None,
component_id: Optional[str] = None,
outer_context: Optional[Context] = None,
registry: Optional[ComponentRegistry] = None, # noqa F811
):
@ -318,7 +325,6 @@ class Component(
self.registered_name: Optional[str] = registered_name
self.outer_context: Context = outer_context or Context()
self.component_id = component_id or gen_id()
self.registry = registry or registry_
self._render_stack: Deque[RenderStackItem[ArgsType, KwargsType, SlotsType]] = deque()
# None == uninitialized, False == No types, Tuple == types
@ -331,6 +337,19 @@ class Component(
def name(self) -> str:
return self.registered_name or self.__class__.__name__
@property
def id(self) -> str:
"""
Render ID - This ID is unique for every time a `Component.render()` (or equivalent) is called.
This is useful for logging or debugging.
Render IDs have the chance of collision 1 in 3.3M.
Raises RuntimeError if called outside of rendering execution.
"""
return self.input.id
@property
def input(self) -> RenderInput[ArgsType, KwargsType, SlotsType]:
"""
@ -702,6 +721,7 @@ class Component(
self._render_stack.append(
RenderStackItem(
input=RenderInput(
id=gen_id(),
context=context,
slots=slots,
args=args,
@ -716,9 +736,14 @@ class Component(
context_data = self.get_context_data(*args, **kwargs)
self._validate_outputs(data=context_data)
# Process JS and CSS files
cache_inlined_js(self.__class__, self.js or "")
cache_inlined_css(self.__class__, self.css or "")
# Process Component's JS and CSS
js_data: Dict = {} # TODO
cache_component_js(self.__class__)
js_input_hash = cache_component_js_vars(self.__class__, js_data) if js_data else None
css_data: Dict = {} # TODO
cache_component_css(self.__class__)
css_input_hash = cache_component_css_vars(self.__class__, css_data) if css_data else None
with _prepare_template(self, context, context_data) as template:
# For users, we expose boolean variables that they may check
@ -763,8 +788,10 @@ class Component(
output = postprocess_component_html(
component_cls=self.__class__,
component_id=self.component_id,
component_id=self.id,
html_content=html_content,
css_input_hash=css_input_hash,
js_input_hash=js_input_hash,
type=type,
render_dependencies=render_dependencies,
)
@ -951,7 +978,6 @@ class ComponentNode(BaseNode):
component: Component = component_cls(
registered_name=self.name,
outer_context=context,
component_id=self.node_id,
registry=self.registry,
)