Tag Formatters¤
Tag formatters allow you to change the syntax for calling components from within the Django templates.
Tag formatter are set via the tag_formatter setting.
Available tag formatters¤
-
django_components.component_formatterfor ComponentFormatter -
django_components.component_shorthand_formatterfor ShorthandComponentFormatter
ComponentFormatter ¤
Bases: django_components.tag_formatter.TagFormatterABC
The original django_component's component tag formatter, it uses the {% component %} and {% endcomponent %} tags, and the component name is given as the first positional arg.
Example as block:
{% component "mycomp" abc=123 %}
+ Tag formatters - Django-Components Tag Formatters¤
Tag formatters allow you to change the syntax for calling components from within the Django templates.
Tag formatter are set via the tag_formatter setting.
Available tag formatters¤
-
django_components.component_formatter for ComponentFormatter
-
django_components.component_shorthand_formatter for ShorthandComponentFormatter
ComponentFormatter ¤
Bases: django_components.tag_formatter.TagFormatterABC
The original django_component's component tag formatter, it uses the {% component %} and {% endcomponent %} tags, and the component name is given as the first positional arg.
Example as block:
Example as inlined tag:
ShorthandComponentFormatter ¤
Bases: django_components.tag_formatter.TagFormatterABC
The component tag formatter that uses {% <name> %} / {% end<name> %} tags.
This is similar to django-web-components and django-slippers syntax.
Example as block:
ShorthandComponentFormatter ¤
Bases: django_components.tag_formatter.TagFormatterABC
The component tag formatter that uses {% <name> %} / {% end<name> %} tags.
This is similar to django-web-components and django-slippers syntax.
Example as block:
{% mycomp abc=123 %}
{% fill "myfill" %}
...
{% endfill %}
diff --git a/dev/reference/template_tags/index.html b/dev/reference/template_tags/index.html
index ca4d03f9..e9e25be0 100644
--- a/dev/reference/template_tags/index.html
+++ b/dev/reference/template_tags/index.html
@@ -1,7 +1,7 @@
Template tags - Django-Components Template tags¤
All following template tags are defined in
django_components.templatetags.component_tags
Import as
component¤
Renders one of the components that was previously registered with @register() decorator.
Args:
name (str, required): Registered name of the component to render- All other args and kwargs are defined based on the component itself.
If you defined a component "my_table"
Renders one of the components that was previously registered with @register() decorator.
Args:
name (str, required): Registered name of the component to render- All other args and kwargs are defined based on the component itself.
If you defined a component "my_table"
from django_component import Component, register
@register("my_table")
class MyTable(Component):
@@ -39,10 +39,10 @@
{% endcomponent %}
Isolating components¤
By default, components behave similarly to Django's {% include %}, and the template inside the component has access to the variables defined in the outer template.
You can selectively isolate a component, using the only flag, so that the inner template can access only the data that was explicitly passed to it:
component_css_dependencies¤
Marks location where CSS link tags should be rendered after the whole HTML has been generated.
Generally, this should be inserted into the <head> tag of the HTML.
If the generated HTML does NOT contain any {% component_css_dependencies %} tags, CSS links are by default inserted into the <head> tag of the HTML. (See JS and CSS output locations)
Note that there should be only one {% component_css_dependencies %} for the whole HTML document. If you insert this tag multiple times, ALL CSS links will be duplicately inserted into ALL these places.
component_js_dependencies¤
Marks location where JS link tags should be rendered after the whole HTML has been generated.
Generally, this should be inserted at the end of the <body> tag of the HTML.
If the generated HTML does NOT contain any {% component_js_dependencies %} tags, JS scripts are by default inserted at the end of the <body> tag of the HTML. (See JS and CSS output locations)
Note that there should be only one {% component_js_dependencies %} for the whole HTML document. If you insert this tag multiple times, ALL JS scripts will be duplicately inserted into ALL these places.
fill¤
Marks location where CSS link tags should be rendered after the whole HTML has been generated.
Generally, this should be inserted into the <head> tag of the HTML.
If the generated HTML does NOT contain any {% component_css_dependencies %} tags, CSS links are by default inserted into the <head> tag of the HTML. (See JS and CSS output locations)
Note that there should be only one {% component_css_dependencies %} for the whole HTML document. If you insert this tag multiple times, ALL CSS links will be duplicately inserted into ALL these places.
component_js_dependencies¤
Marks location where JS link tags should be rendered after the whole HTML has been generated.
Generally, this should be inserted at the end of the <body> tag of the HTML.
If the generated HTML does NOT contain any {% component_js_dependencies %} tags, JS scripts are by default inserted at the end of the <body> tag of the HTML. (See JS and CSS output locations)
Note that there should be only one {% component_js_dependencies %} for the whole HTML document. If you insert this tag multiple times, ALL JS scripts will be duplicately inserted into ALL these places.
fill¤
Use this tag to insert content into component's slots.
{% fill %} tag may be used only within a {% component %}..{% endcomponent %} block. Runtime checks should prohibit other usages.
Args:
name (str, required): Name of the slot to insert this content into. Use "default" for the default slot.default (str, optional): This argument allows you to access the original content of the slot under the specified variable name. See Accessing original content of slotsdata (str, optional): This argument allows you to access the data passed to the slot under the specified variable name. See Scoped slots
Examples:
Basic usage:
Use this tag to insert content into component's slots.
{% fill %} tag may be used only within a {% component %}..{% endcomponent %} block. Runtime checks should prohibit other usages.
Args:
name (str, required): Name of the slot to insert this content into. Use "default" for the default slot.default (str, optional): This argument allows you to access the original content of the slot under the specified variable name. See Accessing original content of slotsdata (str, optional): This argument allows you to access the data passed to the slot under the specified variable name. See Scoped slots
Examples:
Basic usage:
{% component "my_table" %}
{% fill "pagination" %}
< 1 | 2 | 3 >
{% endfill %}
@@ -84,7 +84,7 @@
{% endfill %}
{% endcomponent %}
html_attrs¤
Generate HTML attributes (key="value"), combining data from multiple sources, whether its template variables or static text.
It is designed to easily merge HTML attributes passed from outside with the internal. See how to in Passing HTML attributes to components.
Args:
attrs (dict, optional): Optional dictionary that holds HTML attributes. On conflict, overrides values in the default dictionary.default (str, optional): Optional dictionary that holds HTML attributes. On conflict, is overriden with values in the attrs dictionary.- Any extra kwargs will be appended to the corresponding keys
The attributes in attrs and defaults are merged and resulting dict is rendered as HTML attributes (key="value").
Extra kwargs (key=value) are concatenated to existing keys. So if we have
Generate HTML attributes (key="value"), combining data from multiple sources, whether its template variables or static text.
It is designed to easily merge HTML attributes passed from outside with the internal. See how to in Passing HTML attributes to components.
Args:
attrs (dict, optional): Optional dictionary that holds HTML attributes. On conflict, overrides values in the default dictionary.default (str, optional): Optional dictionary that holds HTML attributes. On conflict, is overriden with values in the attrs dictionary.- Any extra kwargs will be appended to the corresponding keys
The attributes in attrs and defaults are merged and resulting dict is rendered as HTML attributes (key="value").
Extra kwargs (key=value) are concatenated to existing keys. So if we have
Then
will result in class="my-class extra-class".
Example:
renders
See more usage examples in HTML attributes.
provide¤
The "provider" part of the provide / inject feature. Pass kwargs to this tag to define the provider's data. Any components defined within the {% provide %}..{% endprovide %} tags will be able to access this data with Component.inject().
This is similar to React's ContextProvider, or Vue's provide().
Args:
name (str, required): Provider name. This is the name you will then use in Component.inject().**kwargs: Any extra kwargs will be passed as the provided data.
Example:
Provide the "user_data" in parent component:
The "provider" part of the provide / inject feature. Pass kwargs to this tag to define the provider's data. Any components defined within the {% provide %}..{% endprovide %} tags will be able to access this data with Component.inject().
This is similar to React's ContextProvider, or Vue's provide().
Args:
name (str, required): Provider name. This is the name you will then use in Component.inject().**kwargs: Any extra kwargs will be passed as the provided data.
Example:
Provide the "user_data" in parent component:
❌ Don't do this
slot¤
Slot tag marks a place inside a component where content can be inserted from outside.
Learn more about using slots.
This is similar to slots as seen in Web components, Vue or React's children.
Args:
name (str, required): Registered name of the component to renderdefault: Optional flag. If there is a default slot, you can pass the component slot content without using the {% fill %} tag. See Default slotrequired: Optional flag. Will raise an error if a slot is required but not given.**kwargs: Any extra kwargs will be passed as the slot data.
Example:
Slot tag marks a place inside a component where content can be inserted from outside.
Learn more about using slots.
This is similar to slots as seen in Web components, Vue or React's children.
Args:
name (str, required): Registered name of the component to renderdefault: Optional flag. If there is a default slot, you can pass the component slot content without using the {% fill %} tag. See Default slotrequired: Optional flag. Will raise an error if a slot is required but not given.**kwargs: Any extra kwargs will be passed as the slot data.
Example: