Inlined CSS associated with this component.
property ¤input: Optional[RenderInput[ArgsType, KwargsType, SlotsType]]
Input holds the data (like arg, kwargs, slots) that were passsed to the current execution of the render method.
class-attribute instance-attribute ¤Inlined JS associated with this component.
instance-attribute ¤media: Media
-Normalized definition of JS and CSS media files associated with this component.
NOTE: This field is generated from Component.Media class.
class-attribute instance-attribute ¤Normalized definition of JS and CSS media files associated with this component.
NOTE: This field is generated from Component.Media class.
class-attribute instance-attribute ¤response_class = HttpResponse
This allows to configure what class is used to generate response from render_to_response
class-attribute instance-attribute ¤Inlined Django template associated with this component.
class-attribute ¤Relative filepath to the Django template associated with this component.
classmethod ¤as_view(**initkwargs: Any) -> ViewFn
@@ -305,7 +305,7 @@
comp = cls()
return comp._render(context, args, kwargs, slots, escape_slots_content)
-render_css_dependencies() -> SafeString
render_dependencies() -> SafeString
render_js_dependencies() -> SafeString
Render only JS dependencies available in the media class or provided as a string.
src/django_components/component.py260 261 262 @@ -359,7 +359,7 @@ kwargs: Optional[KwargsType] = None, *response_args: Any, **response_kwargs: Any -) -> HttpResponse +) -> HttpResponse Render the component and wrap the content in the response class. The response class is taken from This is the interface for the Inputs: - Any additional args and kwargs are passed to the Example: |
get_injected_context_var(component_name: str, context: Context, key: str, default: Optional[Any] = None) -> Any
Retrieve a 'provided' field. The field MUST have been previously 'provided' by the component's ancestors using the {% provide %} template tag.
We use the Context object to pass down info on inside of which component we are currently rendering.
'Provide' given data under given key. In other words, this data can be retrieved using self.inject(key) inside of get_context_data() method of components that are nested inside the {% provide %} tag.
src/django_components/context.py108 109 110 diff --git a/dev/reference/django_components/index.html b/dev/reference/django_components/index.html index 379729aa..8901c75b 100644 --- a/dev/reference/django_components/index.html +++ b/dev/reference/django_components/index.html @@ -244,7 +244,7 @@ Inlined CSS associated with this component. |
render_css_dependencies() -> SafeString
render_dependencies() -> SafeString
render_js_dependencies() -> SafeString
Render only JS dependencies available in the media class or provided as a string.
src/django_components/component.py260 261 262 @@ -543,7 +543,7 @@ kwargs: Optional[KwargsType] = None, *response_args: Any, **response_kwargs: Any -) -> HttpResponse +) -> HttpResponse Render the component and wrap the content in the response class. The response class is taken from This is the interface for the Inputs: - Any additional args and kwargs are passed to the Example: |
This file centralizes various ways we use Django's Context class pass data across components, nodes, slots, and contexts.
You can think of the Context as our storage system.
This file centralizes various ways we use Django's Context class pass data across components, nodes, slots, and contexts.
You can think of the Context as our storage system.
We use the Context object to pass down info on inside of which component we are currently rendering.
'Provide' given data under given key. In other words, this data can be retrieved using self.inject(key) inside of get_context_data() method of components that are nested inside the {% provide %} tag.
ComponentDependencyMiddleware(get_response: Callable[[HttpRequest], HttpResponse])
This snippet is taken directly from IncludeNode.render(). Unfortunately the render logic doesn't separate out template loading logic from rendering, so we have to copy the method.
SlotRef allows to treat a slot as a variable. The slot is rendered only once the instance is coerced to string.
This is used to access slots as variables inside the templates. When a SlotRef is rendered in the template with {{ my_lazy_slot }}, it will output the contents of the slot.
resolve_slots(
- context: Context,
- template: Template,
+ context: Context,
+ template: Template,
component_name: Optional[str],
context_data: Mapping[str, Any],
fill_content: Dict[SlotName, FillContent],
@@ -2430,7 +2430,7 @@
tag_formatter = formatter_cls_or_str
return InternalTagFormatter(tag_formatter)
-Template loader that loads templates from each Django app's "components" directory.
Template loader that loads templates from each Django app's "components" directory.
Bases: Loader
Prepare directories that may contain component files:
Searches for dirs set in STATICFILES_DIRS settings. If none set, defaults to searching for a "components" app. The dirs in STATICFILES_DIRS must be absolute paths.
Paths are accepted only if they resolve to a directory. E.g. /path/to/django_project/my_app/components/.
If STATICFILES_DIRS is not set or empty, then BASE_DIR is required.
component_css_dependencies(preload: str = '') -> SafeString
component_dependencies(preload: str = '') -> SafeString
component_js_dependencies(preload: str = '') -> SafeString
Marks location where JS script tags should be rendered.
src/django_components/templatetags/component_tags.py119 120 121 diff --git a/dev/reference/django_components/middleware/index.html b/dev/reference/django_components/middleware/index.html index cc531f5e..c791f4d7 100644 --- a/dev/reference/django_components/middleware/index.html +++ b/dev/reference/django_components/middleware/index.html @@ -1,4 +1,4 @@ - |
This snippet is taken directly from IncludeNode.render(). Unfortunately the render logic doesn't separate out template loading logic from rendering, so we have to copy the method.
walk_nodelist(nodes: NodeList, callback: Callable[[Node], Optional[str]], context: Optional[Context] = None) -> None
Recursively walk a NodeList, calling callback for each Node.
src/django_components/node.py44 45 46 diff --git a/dev/reference/django_components/slots/index.html b/dev/reference/django_components/slots/index.html index b6d5d795..2aade278 100644 --- a/dev/reference/django_components/slots/index.html +++ b/dev/reference/django_components/slots/index.html @@ -81,7 +81,7 @@ self.name = name self.is_required = is_required self.is_default = is_default - |
SlotRef allows to treat a slot as a variable. The slot is rendered only once the instance is coerced to string.
This is used to access slots as variables inside the templates. When a SlotRef is rendered in the template with {{ my_lazy_slot }}, it will output the contents of the slot.
resolve_slots(
- context: Context,
- template: Template,
+ context: Context,
+ template: Template,
component_name: Optional[str],
context_data: Mapping[str, Any],
fill_content: Dict[SlotName, FillContent],
diff --git a/dev/reference/django_components/template_loader/index.html b/dev/reference/django_components/template_loader/index.html
index 18519bb5..3ce67208 100644
--- a/dev/reference/django_components/template_loader/index.html
+++ b/dev/reference/django_components/template_loader/index.html
@@ -1,4 +1,4 @@
- template_loader - Django-Components template_loader - Django-Components" > template_loader - Django-Components" >
Template loader that loads templates from each Django app's "components" directory.
Bases: Loader
get_dirs() -> List[Path]
+ template_loader - Django-Components template_loader - Django-Components" > template_loader - Django-Components" >
Template loader that loads templates from each Django app's "components" directory.
Bases: Loader
Prepare directories that may contain component files:
Searches for dirs set in STATICFILES_DIRS settings. If none set, defaults to searching for a "components" app. The dirs in STATICFILES_DIRS must be absolute paths.
Paths are accepted only if they resolve to a directory. E.g. /path/to/django_project/my_app/components/.
If STATICFILES_DIRS is not set or empty, then BASE_DIR is required.
Source code in src/django_components/template_loader.py
15
16
17
diff --git a/dev/reference/django_components/templatetags/component_tags/index.html b/dev/reference/django_components/templatetags/component_tags/index.html
index 9f8840ce..adcc03d7 100644
--- a/dev/reference/django_components/templatetags/component_tags/index.html
+++ b/dev/reference/django_components/templatetags/component_tags/index.html
@@ -118,7 +118,7 @@
trace_msg("PARSE", "COMP", result.component_name, tag.id, "...Done!")
return component_node
-
component_css_dependencies(preload: str = '') -> SafeString
component_dependencies(preload: str = '') -> SafeString
component_js_dependencies(preload: str = '') -> SafeString
Marks location where JS script tags should be rendered.
Source code in src/django_components/templatetags/component_tags.py
119
120
121
diff --git a/dev/reference/django_components/templatetags/index.html b/dev/reference/django_components/templatetags/index.html
index 3559ad42..ab7208e7 100644
--- a/dev/reference/django_components/templatetags/index.html
+++ b/dev/reference/django_components/templatetags/index.html
@@ -118,7 +118,7 @@
trace_msg("PARSE", "COMP", result.component_name, tag.id, "...Done!")
return component_node
-
component_css_dependencies(preload: str = '') -> SafeString
component_dependencies(preload: str = '') -> SafeString
component_js_dependencies(preload: str = '') -> SafeString
Marks location where JS script tags should be rendered.
Source code in src/django_components/templatetags/component_tags.py
119
120
121
diff --git a/dev/sitemap.xml.gz b/dev/sitemap.xml.gz
index a0f46d8a..a80b311c 100644
Binary files a/dev/sitemap.xml.gz and b/dev/sitemap.xml.gz differ
diff --git a/versions.json b/versions.json
index 15eebdd1..9795cc4f 100644
--- a/versions.json
+++ b/versions.json
@@ -6,7 +6,7 @@
},
{
"version": "dev",
- "title": "dev (39cff5a)",
+ "title": "dev (6793aec)",
"aliases": []
},
{