mirror of
https://github.com/django-components/django-components.git
synced 2025-08-18 05:00:15 +00:00
Deployed a1cd97c to dev with MkDocs 1.5.3 and mike 2.0.0
This commit is contained in:
github-actions
parent
4c1b816664
commit
2c429f6beb
12 changed files with 83 additions and 83 deletions
|
|
@ -60,7 +60,7 @@
|
|||
</code></pre></div> <div class="doc doc-contents "> <p>Inlined CSS associated with this component.</p> </div> </div> <div class="doc doc-object doc-attribute"> <h3 id=django_components.component.Component.input class="doc doc-heading"> <code class="doc-symbol doc-symbol-heading doc-symbol-attribute"></code> <span class="doc doc-object-name doc-attribute-name">input</span> <span class="doc doc-labels"> <small class="doc doc-label doc-label-property"><code>property</code></small> </span> <a href=#django_components.component.Component.input class=headerlink title="Permanent link">¤</a></h3> <div class="doc-signature highlight"><pre><span></span><code><a id=__codelineno-0-1 name=__codelineno-0-1 href=#__codelineno-0-1></a><span class=nb>input</span><span class=p>:</span> <span class=n><a class="autorefs autorefs-external" title=typing.Optional href=https://docs.python.org/3.12/library/typing.html#typing.Optional>Optional</a></span><span class=p>[</span><span class=n><span title=django_components.component.RenderInput>RenderInput</span></span><span class=p>[</span><span class=n><span title=django_components.component.ArgsType>ArgsType</span></span><span class=p>,</span> <span class=n><span title=django_components.component.KwargsType>KwargsType</span></span><span class=p>,</span> <span class=n><span title=django_components.component.SlotsType>SlotsType</span></span><span class=p>]]</span>
|
||||
</code></pre></div> <div class="doc doc-contents "> <p>Input holds the data (like arg, kwargs, slots) that were passsed to the current execution of the <code>render</code> method.</p> </div> </div> <div class="doc doc-object doc-attribute"> <h3 id=django_components.component.Component.js class="doc doc-heading"> <code class="doc-symbol doc-symbol-heading doc-symbol-attribute"></code> <span class="doc doc-object-name doc-attribute-name">js</span> <span class="doc doc-labels"> <small class="doc doc-label doc-label-class-attribute"><code>class-attribute</code></small> <small class="doc doc-label doc-label-instance-attribute"><code>instance-attribute</code></small> </span> <a href=#django_components.component.Component.js class=headerlink title="Permanent link">¤</a></h3> <div class="doc-signature highlight"><pre><span></span><code><a id=__codelineno-0-1 name=__codelineno-0-1 href=#__codelineno-0-1></a><span class=n>js</span><span class=p>:</span> <span class=n><a class="autorefs autorefs-external" title=typing.Optional href=https://docs.python.org/3.12/library/typing.html#typing.Optional>Optional</a></span><span class=p>[</span><span class=n><a class="autorefs autorefs-external" href=https://docs.python.org/3.12/library/stdtypes.html#str>str</a></span><span class=p>]</span> <span class=o>=</span> <span class=kc>None</span>
|
||||
</code></pre></div> <div class="doc doc-contents "> <p>Inlined JS associated with this component.</p> </div> </div> <div class="doc doc-object doc-attribute"> <h3 id=django_components.component.Component.media class="doc doc-heading"> <code class="doc-symbol doc-symbol-heading doc-symbol-attribute"></code> <span class="doc doc-object-name doc-attribute-name">media</span> <span class="doc doc-labels"> <small class="doc doc-label doc-label-instance-attribute"><code>instance-attribute</code></small> </span> <a href=#django_components.component.Component.media class=headerlink title="Permanent link">¤</a></h3> <div class="doc-signature highlight"><pre><span></span><code><a id=__codelineno-0-1 name=__codelineno-0-1 href=#__codelineno-0-1></a><span class=n>media</span><span class=p>:</span> <span class=n><a class="autorefs autorefs-internal" title=django_components.component.Component.Media href=#django_components.component.Component.Media>Media</a></span>
|
||||
</code></pre></div> <div class="doc doc-contents "> <p>Normalized definition of JS and CSS media files associated with this component.</p> <p>NOTE: This field is generated from Component.Media class.</p> </div> </div> <div class="doc doc-object doc-attribute"> <h3 id=django_components.component.Component.response_class class="doc doc-heading"> <code class="doc-symbol doc-symbol-heading doc-symbol-attribute"></code> <span class="doc doc-object-name doc-attribute-name">response_class</span> <span class="doc doc-labels"> <small class="doc doc-label doc-label-class-attribute"><code>class-attribute</code></small> <small class="doc doc-label doc-label-instance-attribute"><code>instance-attribute</code></small> </span> <a href=#django_components.component.Component.response_class class=headerlink title="Permanent link">¤</a></h3> <div class="doc-signature highlight"><pre><span></span><code><a id=__codelineno-0-1 name=__codelineno-0-1 href=#__codelineno-0-1></a><span class=n>response_class</span> <span class=o>=</span> <span class=n><a class="autorefs autorefs-external" title=django.http.HttpResponse href=https://docs.djangoproject.com/en/5.0/ref/request-response/#django.http.HttpResponse>HttpResponse</a></span>
|
||||
</code></pre></div> <div class="doc doc-contents "> <p>Normalized definition of JS and CSS media files associated with this component.</p> <p>NOTE: This field is generated from Component.Media class.</p> </div> </div> <div class="doc doc-object doc-attribute"> <h3 id=django_components.component.Component.response_class class="doc doc-heading"> <code class="doc-symbol doc-symbol-heading doc-symbol-attribute"></code> <span class="doc doc-object-name doc-attribute-name">response_class</span> <span class="doc doc-labels"> <small class="doc doc-label doc-label-class-attribute"><code>class-attribute</code></small> <small class="doc doc-label doc-label-instance-attribute"><code>instance-attribute</code></small> </span> <a href=#django_components.component.Component.response_class class=headerlink title="Permanent link">¤</a></h3> <div class="doc-signature highlight"><pre><span></span><code><a id=__codelineno-0-1 name=__codelineno-0-1 href=#__codelineno-0-1></a><span class=n>response_class</span> <span class=o>=</span> <span class=n><span title=django.http.HttpResponse>HttpResponse</span></span>
|
||||
</code></pre></div> <div class="doc doc-contents "> <p>This allows to configure what class is used to generate response from <code>render_to_response</code></p> </div> </div> <div class="doc doc-object doc-attribute"> <h3 id=django_components.component.Component.template class="doc doc-heading"> <code class="doc-symbol doc-symbol-heading doc-symbol-attribute"></code> <span class="doc doc-object-name doc-attribute-name">template</span> <span class="doc doc-labels"> <small class="doc doc-label doc-label-class-attribute"><code>class-attribute</code></small> <small class="doc doc-label doc-label-instance-attribute"><code>instance-attribute</code></small> </span> <a href=#django_components.component.Component.template class=headerlink title="Permanent link">¤</a></h3> <div class="doc-signature highlight"><pre><span></span><code><a id=__codelineno-0-1 name=__codelineno-0-1 href=#__codelineno-0-1></a><span class=n>template</span><span class=p>:</span> <span class=n><a class="autorefs autorefs-external" title=typing.Optional href=https://docs.python.org/3.12/library/typing.html#typing.Optional>Optional</a></span><span class=p>[</span><span class=n><a class="autorefs autorefs-external" href=https://docs.python.org/3.12/library/stdtypes.html#str>str</a></span><span class=p>]</span> <span class=o>=</span> <span class=kc>None</span>
|
||||
</code></pre></div> <div class="doc doc-contents "> <p>Inlined Django template associated with this component.</p> </div> </div> <div class="doc doc-object doc-attribute"> <h3 id=django_components.component.Component.template_name class="doc doc-heading"> <code class="doc-symbol doc-symbol-heading doc-symbol-attribute"></code> <span class="doc doc-object-name doc-attribute-name">template_name</span> <span class="doc doc-labels"> <small class="doc doc-label doc-label-class-attribute"><code>class-attribute</code></small> </span> <a href=#django_components.component.Component.template_name class=headerlink title="Permanent link">¤</a></h3> <div class="doc-signature highlight"><pre><span></span><code><a id=__codelineno-0-1 name=__codelineno-0-1 href=#__codelineno-0-1></a><span class=n>template_name</span><span class=p>:</span> <span class=n><a class="autorefs autorefs-external" title=typing.Optional href=https://docs.python.org/3.12/library/typing.html#typing.Optional>Optional</a></span><span class=p>[</span><span class=n><a class="autorefs autorefs-external" href=https://docs.python.org/3.12/library/stdtypes.html#str>str</a></span><span class=p>]</span> <span class=o>=</span> <span class=kc>None</span>
|
||||
</code></pre></div> <div class="doc doc-contents "> <p>Relative filepath to the Django template associated with this component.</p> </div> </div> <div class="doc doc-object doc-function"> <h3 id=django_components.component.Component.as_view class="doc doc-heading"> <code class="doc-symbol doc-symbol-heading doc-symbol-method"></code> <span class="doc doc-object-name doc-function-name">as_view</span> <span class="doc doc-labels"> <small class="doc doc-label doc-label-classmethod"><code>classmethod</code></small> </span> <a href=#django_components.component.Component.as_view class=headerlink title="Permanent link">¤</a></h3> <div class="doc-signature highlight"><pre><span></span><code><a id=__codelineno-0-1 name=__codelineno-0-1 href=#__codelineno-0-1></a><span class=n>as_view</span><span class=p>(</span><span class=o>**</span><span class=n>initkwargs</span><span class=p>:</span> <span class=n><a class="autorefs autorefs-external" title=typing.Any href=https://docs.python.org/3.12/library/typing.html#typing.Any>Any</a></span><span class=p>)</span> <span class=o>-></span> <span class=n><span title=django_components.component.ViewFn>ViewFn</span></span>
|
||||
|
|
@ -305,7 +305,7 @@
|
|||
<a id=__codelineno-0-434 name=__codelineno-0-434></a> <span class=n>comp</span> <span class=o>=</span> <span class=bp>cls</span><span class=p>()</span>
|
||||
<a id=__codelineno-0-435 name=__codelineno-0-435></a>
|
||||
<a id=__codelineno-0-436 name=__codelineno-0-436></a> <span class=k>return</span> <span class=n>comp</span><span class=o>.</span><span class=n>_render</span><span class=p>(</span><span class=n>context</span><span class=p>,</span> <span class=n>args</span><span class=p>,</span> <span class=n>kwargs</span><span class=p>,</span> <span class=n>slots</span><span class=p>,</span> <span class=n>escape_slots_content</span><span class=p>)</span>
|
||||
</code></pre></div></td></tr></table></div> </details> </div> </div> <div class="doc doc-object doc-function"> <h3 id=django_components.component.Component.render_css_dependencies class="doc doc-heading"> <code class="doc-symbol doc-symbol-heading doc-symbol-method"></code> <span class="doc doc-object-name doc-function-name">render_css_dependencies</span> <a href=#django_components.component.Component.render_css_dependencies class=headerlink title="Permanent link">¤</a></h3> <div class="doc-signature highlight"><pre><span></span><code><a id=__codelineno-0-1 name=__codelineno-0-1 href=#__codelineno-0-1></a><span class=n>render_css_dependencies</span><span class=p>()</span> <span class=o>-></span> <span class=n><a class="autorefs autorefs-external" title=django.utils.safestring.SafeString href=https://docs.djangoproject.com/en/5.0/ref/utils/#django.utils.safestring.SafeString>SafeString</a></span>
|
||||
</code></pre></div></td></tr></table></div> </details> </div> </div> <div class="doc doc-object doc-function"> <h3 id=django_components.component.Component.render_css_dependencies class="doc doc-heading"> <code class="doc-symbol doc-symbol-heading doc-symbol-method"></code> <span class="doc doc-object-name doc-function-name">render_css_dependencies</span> <a href=#django_components.component.Component.render_css_dependencies class=headerlink title="Permanent link">¤</a></h3> <div class="doc-signature highlight"><pre><span></span><code><a id=__codelineno-0-1 name=__codelineno-0-1 href=#__codelineno-0-1></a><span class=n>render_css_dependencies</span><span class=p>()</span> <span class=o>-></span> <span class=n><span title=django.utils.safestring.SafeString>SafeString</span></span>
|
||||
</code></pre></div> <div class="doc doc-contents "> <p>Render only CSS dependencies available in the media class or provided as a string.</p> <details class=quote> <summary>Source code in <code>src/django_components/component.py</code></summary> <div class=highlight><table class=highlighttable><tr><td class=linenos><div class=linenodiv><pre><span></span><span class=normal><a href=#__codelineno-0-254>254</a></span>
|
||||
<span class=normal><a href=#__codelineno-0-255>255</a></span>
|
||||
<span class=normal><a href=#__codelineno-0-256>256</a></span>
|
||||
|
|
@ -315,7 +315,7 @@
|
|||
<a id=__codelineno-0-256 name=__codelineno-0-256></a> <span class=k>if</span> <span class=bp>self</span><span class=o>.</span><span class=n>css</span> <span class=ow>is</span> <span class=ow>not</span> <span class=kc>None</span><span class=p>:</span>
|
||||
<a id=__codelineno-0-257 name=__codelineno-0-257></a> <span class=k>return</span> <span class=n>mark_safe</span><span class=p>(</span><span class=sa>f</span><span class=s2>"<style></span><span class=si>{</span><span class=bp>self</span><span class=o>.</span><span class=n>css</span><span class=si>}</span><span class=s2></style>"</span><span class=p>)</span>
|
||||
<a id=__codelineno-0-258 name=__codelineno-0-258></a> <span class=k>return</span> <span class=n>mark_safe</span><span class=p>(</span><span class=s2>"</span><span class=se>\n</span><span class=s2>"</span><span class=o>.</span><span class=n>join</span><span class=p>(</span><span class=bp>self</span><span class=o>.</span><span class=n>media</span><span class=o>.</span><span class=n>render_css</span><span class=p>()))</span>
|
||||
</code></pre></div></td></tr></table></div> </details> </div> </div> <div class="doc doc-object doc-function"> <h3 id=django_components.component.Component.render_dependencies class="doc doc-heading"> <code class="doc-symbol doc-symbol-heading doc-symbol-method"></code> <span class="doc doc-object-name doc-function-name">render_dependencies</span> <a href=#django_components.component.Component.render_dependencies class=headerlink title="Permanent link">¤</a></h3> <div class="doc-signature highlight"><pre><span></span><code><a id=__codelineno-0-1 name=__codelineno-0-1 href=#__codelineno-0-1></a><span class=n>render_dependencies</span><span class=p>()</span> <span class=o>-></span> <span class=n><a class="autorefs autorefs-external" title=django.utils.safestring.SafeString href=https://docs.djangoproject.com/en/5.0/ref/utils/#django.utils.safestring.SafeString>SafeString</a></span>
|
||||
</code></pre></div></td></tr></table></div> </details> </div> </div> <div class="doc doc-object doc-function"> <h3 id=django_components.component.Component.render_dependencies class="doc doc-heading"> <code class="doc-symbol doc-symbol-heading doc-symbol-method"></code> <span class="doc doc-object-name doc-function-name">render_dependencies</span> <a href=#django_components.component.Component.render_dependencies class=headerlink title="Permanent link">¤</a></h3> <div class="doc-signature highlight"><pre><span></span><code><a id=__codelineno-0-1 name=__codelineno-0-1 href=#__codelineno-0-1></a><span class=n>render_dependencies</span><span class=p>()</span> <span class=o>-></span> <span class=n><span title=django.utils.safestring.SafeString>SafeString</span></span>
|
||||
</code></pre></div> <div class="doc doc-contents "> <p>Helper function to render all dependencies for a component.</p> <details class=quote> <summary>Source code in <code>src/django_components/component.py</code></summary> <div class=highlight><table class=highlighttable><tr><td class=linenos><div class=linenodiv><pre><span></span><span class=normal><a href=#__codelineno-0-240>240</a></span>
|
||||
<span class=normal><a href=#__codelineno-0-241>241</a></span>
|
||||
<span class=normal><a href=#__codelineno-0-242>242</a></span>
|
||||
|
|
@ -341,7 +341,7 @@
|
|||
<a id=__codelineno-0-250 name=__codelineno-0-250></a> <span class=n>dependencies</span><span class=o>.</span><span class=n>append</span><span class=p>(</span><span class=n>js_deps</span><span class=p>)</span>
|
||||
<a id=__codelineno-0-251 name=__codelineno-0-251></a>
|
||||
<a id=__codelineno-0-252 name=__codelineno-0-252></a> <span class=k>return</span> <span class=n>mark_safe</span><span class=p>(</span><span class=s2>"</span><span class=se>\n</span><span class=s2>"</span><span class=o>.</span><span class=n>join</span><span class=p>(</span><span class=n>dependencies</span><span class=p>))</span>
|
||||
</code></pre></div></td></tr></table></div> </details> </div> </div> <div class="doc doc-object doc-function"> <h3 id=django_components.component.Component.render_js_dependencies class="doc doc-heading"> <code class="doc-symbol doc-symbol-heading doc-symbol-method"></code> <span class="doc doc-object-name doc-function-name">render_js_dependencies</span> <a href=#django_components.component.Component.render_js_dependencies class=headerlink title="Permanent link">¤</a></h3> <div class="doc-signature highlight"><pre><span></span><code><a id=__codelineno-0-1 name=__codelineno-0-1 href=#__codelineno-0-1></a><span class=n>render_js_dependencies</span><span class=p>()</span> <span class=o>-></span> <span class=n><a class="autorefs autorefs-external" title=django.utils.safestring.SafeString href=https://docs.djangoproject.com/en/5.0/ref/utils/#django.utils.safestring.SafeString>SafeString</a></span>
|
||||
</code></pre></div></td></tr></table></div> </details> </div> </div> <div class="doc doc-object doc-function"> <h3 id=django_components.component.Component.render_js_dependencies class="doc doc-heading"> <code class="doc-symbol doc-symbol-heading doc-symbol-method"></code> <span class="doc doc-object-name doc-function-name">render_js_dependencies</span> <a href=#django_components.component.Component.render_js_dependencies class=headerlink title="Permanent link">¤</a></h3> <div class="doc-signature highlight"><pre><span></span><code><a id=__codelineno-0-1 name=__codelineno-0-1 href=#__codelineno-0-1></a><span class=n>render_js_dependencies</span><span class=p>()</span> <span class=o>-></span> <span class=n><span title=django.utils.safestring.SafeString>SafeString</span></span>
|
||||
</code></pre></div> <div class="doc doc-contents "> <p>Render only JS dependencies available in the media class or provided as a string.</p> <details class=quote> <summary>Source code in <code>src/django_components/component.py</code></summary> <div class=highlight><table class=highlighttable><tr><td class=linenos><div class=linenodiv><pre><span></span><span class=normal><a href=#__codelineno-0-260>260</a></span>
|
||||
<span class=normal><a href=#__codelineno-0-261>261</a></span>
|
||||
<span class=normal><a href=#__codelineno-0-262>262</a></span>
|
||||
|
|
@ -359,7 +359,7 @@
|
|||
<a id=__codelineno-0-6 name=__codelineno-0-6 href=#__codelineno-0-6></a> <span class=n>kwargs</span><span class=p>:</span> <span class=n><a class="autorefs autorefs-external" title=typing.Optional href=https://docs.python.org/3.12/library/typing.html#typing.Optional>Optional</a></span><span class=p>[</span><span class=n><span title=django_components.component.KwargsType>KwargsType</span></span><span class=p>]</span> <span class=o>=</span> <span class=kc>None</span><span class=p>,</span>
|
||||
<a id=__codelineno-0-7 name=__codelineno-0-7 href=#__codelineno-0-7></a> <span class=o>*</span><span class=n>response_args</span><span class=p>:</span> <span class=n><a class="autorefs autorefs-external" title=typing.Any href=https://docs.python.org/3.12/library/typing.html#typing.Any>Any</a></span><span class=p>,</span>
|
||||
<a id=__codelineno-0-8 name=__codelineno-0-8 href=#__codelineno-0-8></a> <span class=o>**</span><span class=n>response_kwargs</span><span class=p>:</span> <span class=n><a class="autorefs autorefs-external" title=typing.Any href=https://docs.python.org/3.12/library/typing.html#typing.Any>Any</a></span>
|
||||
<a id=__codelineno-0-9 name=__codelineno-0-9 href=#__codelineno-0-9></a><span class=p>)</span> <span class=o>-></span> <span class=n><a class="autorefs autorefs-external" title=django.http.HttpResponse href=https://docs.djangoproject.com/en/5.0/ref/request-response/#django.http.HttpResponse>HttpResponse</a></span>
|
||||
<a id=__codelineno-0-9 name=__codelineno-0-9 href=#__codelineno-0-9></a><span class=p>)</span> <span class=o>-></span> <span class=n><span title=django.http.HttpResponse>HttpResponse</span></span>
|
||||
</code></pre></div> <div class="doc doc-contents "> <p>Render the component and wrap the content in the response class.</p> <p>The response class is taken from <code>Component.response_class</code>. Defaults to <code>django.http.HttpResponse</code>.</p> <p>This is the interface for the <code>django.views.View</code> class which allows us to use components as Django views with <code>component.as_view()</code>.</p> <p>Inputs: - <code>args</code> - Positional args for the component. This is the same as calling the component as <code>{% component "my_comp" arg1 arg2 ... %}</code> - <code>kwargs</code> - Kwargs for the component. This is the same as calling the component as <code>{% component "my_comp" key1=val1 key2=val2 ... %}</code> - <code>slots</code> - Component slot fills. This is the same as pasing <code>{% fill %}</code> tags to the component. Accepts a dictionary of <code>{ slot_name: slot_content }</code> where <code>slot_content</code> can be a string or render function. - <code>escape_slots_content</code> - Whether the content from <code>slots</code> should be escaped. - <code>context</code> - A context (dictionary or Django's Context) within which the component is rendered. The keys on the context can be accessed from within the template. - NOTE: In "isolated" mode, context is NOT accessible, and data MUST be passed via component's args and kwargs.</p> <p>Any additional args and kwargs are passed to the <code>response_class</code>.</p> <p>Example: <div class=highlight><pre><span></span><code><a id=__codelineno-0-1 name=__codelineno-0-1 href=#__codelineno-0-1></a><span class=n>MyComponent</span><span class=o>.</span><span class=n>render_to_response</span><span class=p>(</span>
|
||||
<a id=__codelineno-0-2 name=__codelineno-0-2 href=#__codelineno-0-2></a> <span class=n>args</span><span class=o>=</span><span class=p>[</span><span class=mi>1</span><span class=p>,</span> <span class=s2>"two"</span><span class=p>,</span> <span class=p>{}],</span>
|
||||
<a id=__codelineno-0-3 name=__codelineno-0-3 href=#__codelineno-0-3></a> <span class=n>kwargs</span><span class=o>=</span><span class=p>{</span>
|
||||
|
|
|
|||
File diff suppressed because one or more lines are too long
|
|
@ -244,7 +244,7 @@
|
|||
</code></pre></div> <div class="doc doc-contents "> <p>Inlined CSS associated with this component.</p> </div> </div> <div class="doc doc-object doc-attribute"> <h4 id=django_components.component.Component.input class="doc doc-heading"> <code class="doc-symbol doc-symbol-heading doc-symbol-attribute"></code> <span class="doc doc-object-name doc-attribute-name">input</span> <span class="doc doc-labels"> <small class="doc doc-label doc-label-property"><code>property</code></small> </span> <a href=#django_components.component.Component.input class=headerlink title="Permanent link">¤</a></h4> <div class="doc-signature highlight"><pre><span></span><code><a id=__codelineno-0-1 name=__codelineno-0-1 href=#__codelineno-0-1></a><span class=nb>input</span><span class=p>:</span> <span class=n><a class="autorefs autorefs-external" title=typing.Optional href=https://docs.python.org/3.12/library/typing.html#typing.Optional>Optional</a></span><span class=p>[</span><span class=n><span title=django_components.component.RenderInput>RenderInput</span></span><span class=p>[</span><span class=n><span title=django_components.component.ArgsType>ArgsType</span></span><span class=p>,</span> <span class=n><span title=django_components.component.KwargsType>KwargsType</span></span><span class=p>,</span> <span class=n><span title=django_components.component.SlotsType>SlotsType</span></span><span class=p>]]</span>
|
||||
</code></pre></div> <div class="doc doc-contents "> <p>Input holds the data (like arg, kwargs, slots) that were passsed to the current execution of the <code>render</code> method.</p> </div> </div> <div class="doc doc-object doc-attribute"> <h4 id=django_components.component.Component.js class="doc doc-heading"> <code class="doc-symbol doc-symbol-heading doc-symbol-attribute"></code> <span class="doc doc-object-name doc-attribute-name">js</span> <span class="doc doc-labels"> <small class="doc doc-label doc-label-class-attribute"><code>class-attribute</code></small> <small class="doc doc-label doc-label-instance-attribute"><code>instance-attribute</code></small> </span> <a href=#django_components.component.Component.js class=headerlink title="Permanent link">¤</a></h4> <div class="doc-signature highlight"><pre><span></span><code><a id=__codelineno-0-1 name=__codelineno-0-1 href=#__codelineno-0-1></a><span class=n>js</span><span class=p>:</span> <span class=n><a class="autorefs autorefs-external" title=typing.Optional href=https://docs.python.org/3.12/library/typing.html#typing.Optional>Optional</a></span><span class=p>[</span><span class=n><a class="autorefs autorefs-external" href=https://docs.python.org/3.12/library/stdtypes.html#str>str</a></span><span class=p>]</span> <span class=o>=</span> <span class=kc>None</span>
|
||||
</code></pre></div> <div class="doc doc-contents "> <p>Inlined JS associated with this component.</p> </div> </div> <div class="doc doc-object doc-attribute"> <h4 id=django_components.component.Component.media class="doc doc-heading"> <code class="doc-symbol doc-symbol-heading doc-symbol-attribute"></code> <span class="doc doc-object-name doc-attribute-name">media</span> <span class="doc doc-labels"> <small class="doc doc-label doc-label-instance-attribute"><code>instance-attribute</code></small> </span> <a href=#django_components.component.Component.media class=headerlink title="Permanent link">¤</a></h4> <div class="doc-signature highlight"><pre><span></span><code><a id=__codelineno-0-1 name=__codelineno-0-1 href=#__codelineno-0-1></a><span class=n>media</span><span class=p>:</span> <span class=n><a class="autorefs autorefs-internal" title=django_components.component.Component.Media href=component/#django_components.component.Component.Media>Media</a></span>
|
||||
</code></pre></div> <div class="doc doc-contents "> <p>Normalized definition of JS and CSS media files associated with this component.</p> <p>NOTE: This field is generated from Component.Media class.</p> </div> </div> <div class="doc doc-object doc-attribute"> <h4 id=django_components.component.Component.response_class class="doc doc-heading"> <code class="doc-symbol doc-symbol-heading doc-symbol-attribute"></code> <span class="doc doc-object-name doc-attribute-name">response_class</span> <span class="doc doc-labels"> <small class="doc doc-label doc-label-class-attribute"><code>class-attribute</code></small> <small class="doc doc-label doc-label-instance-attribute"><code>instance-attribute</code></small> </span> <a href=#django_components.component.Component.response_class class=headerlink title="Permanent link">¤</a></h4> <div class="doc-signature highlight"><pre><span></span><code><a id=__codelineno-0-1 name=__codelineno-0-1 href=#__codelineno-0-1></a><span class=n>response_class</span> <span class=o>=</span> <span class=n><a class="autorefs autorefs-external" title=django.http.HttpResponse href=https://docs.djangoproject.com/en/5.0/ref/request-response/#django.http.HttpResponse>HttpResponse</a></span>
|
||||
</code></pre></div> <div class="doc doc-contents "> <p>Normalized definition of JS and CSS media files associated with this component.</p> <p>NOTE: This field is generated from Component.Media class.</p> </div> </div> <div class="doc doc-object doc-attribute"> <h4 id=django_components.component.Component.response_class class="doc doc-heading"> <code class="doc-symbol doc-symbol-heading doc-symbol-attribute"></code> <span class="doc doc-object-name doc-attribute-name">response_class</span> <span class="doc doc-labels"> <small class="doc doc-label doc-label-class-attribute"><code>class-attribute</code></small> <small class="doc doc-label doc-label-instance-attribute"><code>instance-attribute</code></small> </span> <a href=#django_components.component.Component.response_class class=headerlink title="Permanent link">¤</a></h4> <div class="doc-signature highlight"><pre><span></span><code><a id=__codelineno-0-1 name=__codelineno-0-1 href=#__codelineno-0-1></a><span class=n>response_class</span> <span class=o>=</span> <span class=n><span title=django.http.HttpResponse>HttpResponse</span></span>
|
||||
</code></pre></div> <div class="doc doc-contents "> <p>This allows to configure what class is used to generate response from <code>render_to_response</code></p> </div> </div> <div class="doc doc-object doc-attribute"> <h4 id=django_components.component.Component.template class="doc doc-heading"> <code class="doc-symbol doc-symbol-heading doc-symbol-attribute"></code> <span class="doc doc-object-name doc-attribute-name">template</span> <span class="doc doc-labels"> <small class="doc doc-label doc-label-class-attribute"><code>class-attribute</code></small> <small class="doc doc-label doc-label-instance-attribute"><code>instance-attribute</code></small> </span> <a href=#django_components.component.Component.template class=headerlink title="Permanent link">¤</a></h4> <div class="doc-signature highlight"><pre><span></span><code><a id=__codelineno-0-1 name=__codelineno-0-1 href=#__codelineno-0-1></a><span class=n>template</span><span class=p>:</span> <span class=n><a class="autorefs autorefs-external" title=typing.Optional href=https://docs.python.org/3.12/library/typing.html#typing.Optional>Optional</a></span><span class=p>[</span><span class=n><a class="autorefs autorefs-external" href=https://docs.python.org/3.12/library/stdtypes.html#str>str</a></span><span class=p>]</span> <span class=o>=</span> <span class=kc>None</span>
|
||||
</code></pre></div> <div class="doc doc-contents "> <p>Inlined Django template associated with this component.</p> </div> </div> <div class="doc doc-object doc-attribute"> <h4 id=django_components.component.Component.template_name class="doc doc-heading"> <code class="doc-symbol doc-symbol-heading doc-symbol-attribute"></code> <span class="doc doc-object-name doc-attribute-name">template_name</span> <span class="doc doc-labels"> <small class="doc doc-label doc-label-class-attribute"><code>class-attribute</code></small> </span> <a href=#django_components.component.Component.template_name class=headerlink title="Permanent link">¤</a></h4> <div class="doc-signature highlight"><pre><span></span><code><a id=__codelineno-0-1 name=__codelineno-0-1 href=#__codelineno-0-1></a><span class=n>template_name</span><span class=p>:</span> <span class=n><a class="autorefs autorefs-external" title=typing.Optional href=https://docs.python.org/3.12/library/typing.html#typing.Optional>Optional</a></span><span class=p>[</span><span class=n><a class="autorefs autorefs-external" href=https://docs.python.org/3.12/library/stdtypes.html#str>str</a></span><span class=p>]</span> <span class=o>=</span> <span class=kc>None</span>
|
||||
</code></pre></div> <div class="doc doc-contents "> <p>Relative filepath to the Django template associated with this component.</p> </div> </div> <div class="doc doc-object doc-function"> <h4 id=django_components.component.Component.as_view class="doc doc-heading"> <code class="doc-symbol doc-symbol-heading doc-symbol-method"></code> <span class="doc doc-object-name doc-function-name">as_view</span> <span class="doc doc-labels"> <small class="doc doc-label doc-label-classmethod"><code>classmethod</code></small> </span> <a href=#django_components.component.Component.as_view class=headerlink title="Permanent link">¤</a></h4> <div class="doc-signature highlight"><pre><span></span><code><a id=__codelineno-0-1 name=__codelineno-0-1 href=#__codelineno-0-1></a><span class=n>as_view</span><span class=p>(</span><span class=o>**</span><span class=n>initkwargs</span><span class=p>:</span> <span class=n><a class="autorefs autorefs-external" title=typing.Any href=https://docs.python.org/3.12/library/typing.html#typing.Any>Any</a></span><span class=p>)</span> <span class=o>-></span> <span class=n><span title=django_components.component.ViewFn>ViewFn</span></span>
|
||||
|
|
@ -489,7 +489,7 @@
|
|||
<a id=__codelineno-0-434 name=__codelineno-0-434></a> <span class=n>comp</span> <span class=o>=</span> <span class=bp>cls</span><span class=p>()</span>
|
||||
<a id=__codelineno-0-435 name=__codelineno-0-435></a>
|
||||
<a id=__codelineno-0-436 name=__codelineno-0-436></a> <span class=k>return</span> <span class=n>comp</span><span class=o>.</span><span class=n>_render</span><span class=p>(</span><span class=n>context</span><span class=p>,</span> <span class=n>args</span><span class=p>,</span> <span class=n>kwargs</span><span class=p>,</span> <span class=n>slots</span><span class=p>,</span> <span class=n>escape_slots_content</span><span class=p>)</span>
|
||||
</code></pre></div></td></tr></table></div> </details> </div> </div> <div class="doc doc-object doc-function"> <h4 id=django_components.component.Component.render_css_dependencies class="doc doc-heading"> <code class="doc-symbol doc-symbol-heading doc-symbol-method"></code> <span class="doc doc-object-name doc-function-name">render_css_dependencies</span> <a href=#django_components.component.Component.render_css_dependencies class=headerlink title="Permanent link">¤</a></h4> <div class="doc-signature highlight"><pre><span></span><code><a id=__codelineno-0-1 name=__codelineno-0-1 href=#__codelineno-0-1></a><span class=n>render_css_dependencies</span><span class=p>()</span> <span class=o>-></span> <span class=n><a class="autorefs autorefs-external" title=django.utils.safestring.SafeString href=https://docs.djangoproject.com/en/5.0/ref/utils/#django.utils.safestring.SafeString>SafeString</a></span>
|
||||
</code></pre></div></td></tr></table></div> </details> </div> </div> <div class="doc doc-object doc-function"> <h4 id=django_components.component.Component.render_css_dependencies class="doc doc-heading"> <code class="doc-symbol doc-symbol-heading doc-symbol-method"></code> <span class="doc doc-object-name doc-function-name">render_css_dependencies</span> <a href=#django_components.component.Component.render_css_dependencies class=headerlink title="Permanent link">¤</a></h4> <div class="doc-signature highlight"><pre><span></span><code><a id=__codelineno-0-1 name=__codelineno-0-1 href=#__codelineno-0-1></a><span class=n>render_css_dependencies</span><span class=p>()</span> <span class=o>-></span> <span class=n><span title=django.utils.safestring.SafeString>SafeString</span></span>
|
||||
</code></pre></div> <div class="doc doc-contents "> <p>Render only CSS dependencies available in the media class or provided as a string.</p> <details class=quote> <summary>Source code in <code>src/django_components/component.py</code></summary> <div class=highlight><table class=highlighttable><tr><td class=linenos><div class=linenodiv><pre><span></span><span class=normal><a href=#__codelineno-0-254>254</a></span>
|
||||
<span class=normal><a href=#__codelineno-0-255>255</a></span>
|
||||
<span class=normal><a href=#__codelineno-0-256>256</a></span>
|
||||
|
|
@ -499,7 +499,7 @@
|
|||
<a id=__codelineno-0-256 name=__codelineno-0-256></a> <span class=k>if</span> <span class=bp>self</span><span class=o>.</span><span class=n>css</span> <span class=ow>is</span> <span class=ow>not</span> <span class=kc>None</span><span class=p>:</span>
|
||||
<a id=__codelineno-0-257 name=__codelineno-0-257></a> <span class=k>return</span> <span class=n>mark_safe</span><span class=p>(</span><span class=sa>f</span><span class=s2>"<style></span><span class=si>{</span><span class=bp>self</span><span class=o>.</span><span class=n>css</span><span class=si>}</span><span class=s2></style>"</span><span class=p>)</span>
|
||||
<a id=__codelineno-0-258 name=__codelineno-0-258></a> <span class=k>return</span> <span class=n>mark_safe</span><span class=p>(</span><span class=s2>"</span><span class=se>\n</span><span class=s2>"</span><span class=o>.</span><span class=n>join</span><span class=p>(</span><span class=bp>self</span><span class=o>.</span><span class=n>media</span><span class=o>.</span><span class=n>render_css</span><span class=p>()))</span>
|
||||
</code></pre></div></td></tr></table></div> </details> </div> </div> <div class="doc doc-object doc-function"> <h4 id=django_components.component.Component.render_dependencies class="doc doc-heading"> <code class="doc-symbol doc-symbol-heading doc-symbol-method"></code> <span class="doc doc-object-name doc-function-name">render_dependencies</span> <a href=#django_components.component.Component.render_dependencies class=headerlink title="Permanent link">¤</a></h4> <div class="doc-signature highlight"><pre><span></span><code><a id=__codelineno-0-1 name=__codelineno-0-1 href=#__codelineno-0-1></a><span class=n>render_dependencies</span><span class=p>()</span> <span class=o>-></span> <span class=n><a class="autorefs autorefs-external" title=django.utils.safestring.SafeString href=https://docs.djangoproject.com/en/5.0/ref/utils/#django.utils.safestring.SafeString>SafeString</a></span>
|
||||
</code></pre></div></td></tr></table></div> </details> </div> </div> <div class="doc doc-object doc-function"> <h4 id=django_components.component.Component.render_dependencies class="doc doc-heading"> <code class="doc-symbol doc-symbol-heading doc-symbol-method"></code> <span class="doc doc-object-name doc-function-name">render_dependencies</span> <a href=#django_components.component.Component.render_dependencies class=headerlink title="Permanent link">¤</a></h4> <div class="doc-signature highlight"><pre><span></span><code><a id=__codelineno-0-1 name=__codelineno-0-1 href=#__codelineno-0-1></a><span class=n>render_dependencies</span><span class=p>()</span> <span class=o>-></span> <span class=n><span title=django.utils.safestring.SafeString>SafeString</span></span>
|
||||
</code></pre></div> <div class="doc doc-contents "> <p>Helper function to render all dependencies for a component.</p> <details class=quote> <summary>Source code in <code>src/django_components/component.py</code></summary> <div class=highlight><table class=highlighttable><tr><td class=linenos><div class=linenodiv><pre><span></span><span class=normal><a href=#__codelineno-0-240>240</a></span>
|
||||
<span class=normal><a href=#__codelineno-0-241>241</a></span>
|
||||
<span class=normal><a href=#__codelineno-0-242>242</a></span>
|
||||
|
|
@ -525,7 +525,7 @@
|
|||
<a id=__codelineno-0-250 name=__codelineno-0-250></a> <span class=n>dependencies</span><span class=o>.</span><span class=n>append</span><span class=p>(</span><span class=n>js_deps</span><span class=p>)</span>
|
||||
<a id=__codelineno-0-251 name=__codelineno-0-251></a>
|
||||
<a id=__codelineno-0-252 name=__codelineno-0-252></a> <span class=k>return</span> <span class=n>mark_safe</span><span class=p>(</span><span class=s2>"</span><span class=se>\n</span><span class=s2>"</span><span class=o>.</span><span class=n>join</span><span class=p>(</span><span class=n>dependencies</span><span class=p>))</span>
|
||||
</code></pre></div></td></tr></table></div> </details> </div> </div> <div class="doc doc-object doc-function"> <h4 id=django_components.component.Component.render_js_dependencies class="doc doc-heading"> <code class="doc-symbol doc-symbol-heading doc-symbol-method"></code> <span class="doc doc-object-name doc-function-name">render_js_dependencies</span> <a href=#django_components.component.Component.render_js_dependencies class=headerlink title="Permanent link">¤</a></h4> <div class="doc-signature highlight"><pre><span></span><code><a id=__codelineno-0-1 name=__codelineno-0-1 href=#__codelineno-0-1></a><span class=n>render_js_dependencies</span><span class=p>()</span> <span class=o>-></span> <span class=n><a class="autorefs autorefs-external" title=django.utils.safestring.SafeString href=https://docs.djangoproject.com/en/5.0/ref/utils/#django.utils.safestring.SafeString>SafeString</a></span>
|
||||
</code></pre></div></td></tr></table></div> </details> </div> </div> <div class="doc doc-object doc-function"> <h4 id=django_components.component.Component.render_js_dependencies class="doc doc-heading"> <code class="doc-symbol doc-symbol-heading doc-symbol-method"></code> <span class="doc doc-object-name doc-function-name">render_js_dependencies</span> <a href=#django_components.component.Component.render_js_dependencies class=headerlink title="Permanent link">¤</a></h4> <div class="doc-signature highlight"><pre><span></span><code><a id=__codelineno-0-1 name=__codelineno-0-1 href=#__codelineno-0-1></a><span class=n>render_js_dependencies</span><span class=p>()</span> <span class=o>-></span> <span class=n><span title=django.utils.safestring.SafeString>SafeString</span></span>
|
||||
</code></pre></div> <div class="doc doc-contents "> <p>Render only JS dependencies available in the media class or provided as a string.</p> <details class=quote> <summary>Source code in <code>src/django_components/component.py</code></summary> <div class=highlight><table class=highlighttable><tr><td class=linenos><div class=linenodiv><pre><span></span><span class=normal><a href=#__codelineno-0-260>260</a></span>
|
||||
<span class=normal><a href=#__codelineno-0-261>261</a></span>
|
||||
<span class=normal><a href=#__codelineno-0-262>262</a></span>
|
||||
|
|
@ -543,7 +543,7 @@
|
|||
<a id=__codelineno-0-6 name=__codelineno-0-6 href=#__codelineno-0-6></a> <span class=n>kwargs</span><span class=p>:</span> <span class=n><a class="autorefs autorefs-external" title=typing.Optional href=https://docs.python.org/3.12/library/typing.html#typing.Optional>Optional</a></span><span class=p>[</span><span class=n><span title=django_components.component.KwargsType>KwargsType</span></span><span class=p>]</span> <span class=o>=</span> <span class=kc>None</span><span class=p>,</span>
|
||||
<a id=__codelineno-0-7 name=__codelineno-0-7 href=#__codelineno-0-7></a> <span class=o>*</span><span class=n>response_args</span><span class=p>:</span> <span class=n><a class="autorefs autorefs-external" title=typing.Any href=https://docs.python.org/3.12/library/typing.html#typing.Any>Any</a></span><span class=p>,</span>
|
||||
<a id=__codelineno-0-8 name=__codelineno-0-8 href=#__codelineno-0-8></a> <span class=o>**</span><span class=n>response_kwargs</span><span class=p>:</span> <span class=n><a class="autorefs autorefs-external" title=typing.Any href=https://docs.python.org/3.12/library/typing.html#typing.Any>Any</a></span>
|
||||
<a id=__codelineno-0-9 name=__codelineno-0-9 href=#__codelineno-0-9></a><span class=p>)</span> <span class=o>-></span> <span class=n><a class="autorefs autorefs-external" title=django.http.HttpResponse href=https://docs.djangoproject.com/en/5.0/ref/request-response/#django.http.HttpResponse>HttpResponse</a></span>
|
||||
<a id=__codelineno-0-9 name=__codelineno-0-9 href=#__codelineno-0-9></a><span class=p>)</span> <span class=o>-></span> <span class=n><span title=django.http.HttpResponse>HttpResponse</span></span>
|
||||
</code></pre></div> <div class="doc doc-contents "> <p>Render the component and wrap the content in the response class.</p> <p>The response class is taken from <code>Component.response_class</code>. Defaults to <code>django.http.HttpResponse</code>.</p> <p>This is the interface for the <code>django.views.View</code> class which allows us to use components as Django views with <code>component.as_view()</code>.</p> <p>Inputs: - <code>args</code> - Positional args for the component. This is the same as calling the component as <code>{% component "my_comp" arg1 arg2 ... %}</code> - <code>kwargs</code> - Kwargs for the component. This is the same as calling the component as <code>{% component "my_comp" key1=val1 key2=val2 ... %}</code> - <code>slots</code> - Component slot fills. This is the same as pasing <code>{% fill %}</code> tags to the component. Accepts a dictionary of <code>{ slot_name: slot_content }</code> where <code>slot_content</code> can be a string or render function. - <code>escape_slots_content</code> - Whether the content from <code>slots</code> should be escaped. - <code>context</code> - A context (dictionary or Django's Context) within which the component is rendered. The keys on the context can be accessed from within the template. - NOTE: In "isolated" mode, context is NOT accessible, and data MUST be passed via component's args and kwargs.</p> <p>Any additional args and kwargs are passed to the <code>response_class</code>.</p> <p>Example: <div class=highlight><pre><span></span><code><a id=__codelineno-0-1 name=__codelineno-0-1 href=#__codelineno-0-1></a><span class=n>MyComponent</span><span class=o>.</span><span class=n>render_to_response</span><span class=p>(</span>
|
||||
<a id=__codelineno-0-2 name=__codelineno-0-2 href=#__codelineno-0-2></a> <span class=n>args</span><span class=o>=</span><span class=p>[</span><span class=mi>1</span><span class=p>,</span> <span class=s2>"two"</span><span class=p>,</span> <span class=p>{}],</span>
|
||||
<a id=__codelineno-0-3 name=__codelineno-0-3 href=#__codelineno-0-3></a> <span class=n>kwargs</span><span class=o>=</span><span class=p>{</span>
|
||||
|
|
@ -1176,7 +1176,7 @@
|
|||
<a id=__codelineno-0-306 name=__codelineno-0-306></a> <span class=k>return</span> <span class=n>component</span>
|
||||
<a id=__codelineno-0-307 name=__codelineno-0-307></a>
|
||||
<a id=__codelineno-0-308 name=__codelineno-0-308></a> <span class=k>return</span> <span class=n>decorator</span>
|
||||
</code></pre></div></td></tr></table></div> </details> </div> </div> </div> </div> </div> <div class="doc doc-object doc-module"> <h2 id=django_components.context class="doc doc-heading"> <code class="doc-symbol doc-symbol-heading doc-symbol-module"></code> <span class="doc doc-object-name doc-module-name">context</span> <a href=#django_components.context class=headerlink title="Permanent link">¤</a></h2> <div class="doc doc-contents "> <p>This file centralizes various ways we use Django's Context class pass data across components, nodes, slots, and contexts.</p> <p>You can think of the Context as our storage system.</p> <div class="doc doc-children"> <div class="doc doc-object doc-function"> <h3 id=django_components.context.copy_forloop_context class="doc doc-heading"> <code class="doc-symbol doc-symbol-heading doc-symbol-function"></code> <span class="doc doc-object-name doc-function-name">copy_forloop_context</span> <a href=#django_components.context.copy_forloop_context class=headerlink title="Permanent link">¤</a></h3> <div class="doc-signature highlight"><pre><span></span><code><a id=__codelineno-0-1 name=__codelineno-0-1 href=#__codelineno-0-1></a><span class=n>copy_forloop_context</span><span class=p>(</span><span class=n>from_context</span><span class=p>:</span> <span class=n><a class="autorefs autorefs-external" title=django.template.Context href=https://docs.djangoproject.com/en/5.0/ref/templates/api/#django.template.Context>Context</a></span><span class=p>,</span> <span class=n>to_context</span><span class=p>:</span> <span class=n><a class="autorefs autorefs-external" title=django.template.Context href=https://docs.djangoproject.com/en/5.0/ref/templates/api/#django.template.Context>Context</a></span><span class=p>)</span> <span class=o>-></span> <span class=kc>None</span>
|
||||
</code></pre></div></td></tr></table></div> </details> </div> </div> </div> </div> </div> <div class="doc doc-object doc-module"> <h2 id=django_components.context class="doc doc-heading"> <code class="doc-symbol doc-symbol-heading doc-symbol-module"></code> <span class="doc doc-object-name doc-module-name">context</span> <a href=#django_components.context class=headerlink title="Permanent link">¤</a></h2> <div class="doc doc-contents "> <p>This file centralizes various ways we use Django's Context class pass data across components, nodes, slots, and contexts.</p> <p>You can think of the Context as our storage system.</p> <div class="doc doc-children"> <div class="doc doc-object doc-function"> <h3 id=django_components.context.copy_forloop_context class="doc doc-heading"> <code class="doc-symbol doc-symbol-heading doc-symbol-function"></code> <span class="doc doc-object-name doc-function-name">copy_forloop_context</span> <a href=#django_components.context.copy_forloop_context class=headerlink title="Permanent link">¤</a></h3> <div class="doc-signature highlight"><pre><span></span><code><a id=__codelineno-0-1 name=__codelineno-0-1 href=#__codelineno-0-1></a><span class=n>copy_forloop_context</span><span class=p>(</span><span class=n>from_context</span><span class=p>:</span> <span class=n><span title=django.template.Context>Context</span></span><span class=p>,</span> <span class=n>to_context</span><span class=p>:</span> <span class=n><span title=django.template.Context>Context</span></span><span class=p>)</span> <span class=o>-></span> <span class=kc>None</span>
|
||||
</code></pre></div> <div class="doc doc-contents "> <p>Forward the info about the current loop</p> <details class=quote> <summary>Source code in <code>src/django_components/context.py</code></summary> <div class=highlight><table class=highlighttable><tr><td class=linenos><div class=linenodiv><pre><span></span><span class=normal><a href=#__codelineno-0-64>64</a></span>
|
||||
<span class=normal><a href=#__codelineno-0-65>65</a></span>
|
||||
<span class=normal><a href=#__codelineno-0-66>66</a></span>
|
||||
|
|
@ -1198,7 +1198,7 @@
|
|||
<a id=__codelineno-0-72 name=__codelineno-0-72></a> <span class=k>if</span> <span class=s2>"forloop"</span> <span class=ow>in</span> <span class=n>from_context</span><span class=p>:</span>
|
||||
<a id=__codelineno-0-73 name=__codelineno-0-73></a> <span class=n>forloop_dict_index</span> <span class=o>=</span> <span class=n>find_last_index</span><span class=p>(</span><span class=n>from_context</span><span class=o>.</span><span class=n>dicts</span><span class=p>,</span> <span class=k>lambda</span> <span class=n>d</span><span class=p>:</span> <span class=s2>"forloop"</span> <span class=ow>in</span> <span class=n>d</span><span class=p>)</span>
|
||||
<a id=__codelineno-0-74 name=__codelineno-0-74></a> <span class=n>to_context</span><span class=o>.</span><span class=n>update</span><span class=p>(</span><span class=n>from_context</span><span class=o>.</span><span class=n>dicts</span><span class=p>[</span><span class=n>forloop_dict_index</span><span class=p>])</span>
|
||||
</code></pre></div></td></tr></table></div> </details> </div> </div> <div class="doc doc-object doc-function"> <h3 id=django_components.context.get_injected_context_var class="doc doc-heading"> <code class="doc-symbol doc-symbol-heading doc-symbol-function"></code> <span class="doc doc-object-name doc-function-name">get_injected_context_var</span> <a href=#django_components.context.get_injected_context_var class=headerlink title="Permanent link">¤</a></h3> <div class="doc-signature highlight"><pre><span></span><code><a id=__codelineno-0-1 name=__codelineno-0-1 href=#__codelineno-0-1></a><span class=n>get_injected_context_var</span><span class=p>(</span><span class=n>component_name</span><span class=p>:</span> <span class=n><a class="autorefs autorefs-external" href=https://docs.python.org/3.12/library/stdtypes.html#str>str</a></span><span class=p>,</span> <span class=n>context</span><span class=p>:</span> <span class=n><a class="autorefs autorefs-external" title=django.template.Context href=https://docs.djangoproject.com/en/5.0/ref/templates/api/#django.template.Context>Context</a></span><span class=p>,</span> <span class=n>key</span><span class=p>:</span> <span class=n><a class="autorefs autorefs-external" href=https://docs.python.org/3.12/library/stdtypes.html#str>str</a></span><span class=p>,</span> <span class=n>default</span><span class=p>:</span> <span class=n><a class="autorefs autorefs-external" title=typing.Optional href=https://docs.python.org/3.12/library/typing.html#typing.Optional>Optional</a></span><span class=p>[</span><span class=n><a class="autorefs autorefs-external" title=typing.Any href=https://docs.python.org/3.12/library/typing.html#typing.Any>Any</a></span><span class=p>]</span> <span class=o>=</span> <span class=kc>None</span><span class=p>)</span> <span class=o>-></span> <span class=n><a class="autorefs autorefs-external" title=typing.Any href=https://docs.python.org/3.12/library/typing.html#typing.Any>Any</a></span>
|
||||
</code></pre></div></td></tr></table></div> </details> </div> </div> <div class="doc doc-object doc-function"> <h3 id=django_components.context.get_injected_context_var class="doc doc-heading"> <code class="doc-symbol doc-symbol-heading doc-symbol-function"></code> <span class="doc doc-object-name doc-function-name">get_injected_context_var</span> <a href=#django_components.context.get_injected_context_var class=headerlink title="Permanent link">¤</a></h3> <div class="doc-signature highlight"><pre><span></span><code><a id=__codelineno-0-1 name=__codelineno-0-1 href=#__codelineno-0-1></a><span class=n>get_injected_context_var</span><span class=p>(</span><span class=n>component_name</span><span class=p>:</span> <span class=n><a class="autorefs autorefs-external" href=https://docs.python.org/3.12/library/stdtypes.html#str>str</a></span><span class=p>,</span> <span class=n>context</span><span class=p>:</span> <span class=n><span title=django.template.Context>Context</span></span><span class=p>,</span> <span class=n>key</span><span class=p>:</span> <span class=n><a class="autorefs autorefs-external" href=https://docs.python.org/3.12/library/stdtypes.html#str>str</a></span><span class=p>,</span> <span class=n>default</span><span class=p>:</span> <span class=n><a class="autorefs autorefs-external" title=typing.Optional href=https://docs.python.org/3.12/library/typing.html#typing.Optional>Optional</a></span><span class=p>[</span><span class=n><a class="autorefs autorefs-external" title=typing.Any href=https://docs.python.org/3.12/library/typing.html#typing.Any>Any</a></span><span class=p>]</span> <span class=o>=</span> <span class=kc>None</span><span class=p>)</span> <span class=o>-></span> <span class=n><a class="autorefs autorefs-external" title=typing.Any href=https://docs.python.org/3.12/library/typing.html#typing.Any>Any</a></span>
|
||||
</code></pre></div> <div class="doc doc-contents "> <p>Retrieve a 'provided' field. The field MUST have been previously 'provided' by the component's ancestors using the <code>{% provide %}</code> template tag.</p> <details class=quote> <summary>Source code in <code>src/django_components/context.py</code></summary> <div class=highlight><table class=highlighttable><tr><td class=linenos><div class=linenodiv><pre><span></span><span class=normal><a href=#__codelineno-0-77> 77</a></span>
|
||||
<span class=normal><a href=#__codelineno-0-78> 78</a></span>
|
||||
<span class=normal><a href=#__codelineno-0-79> 79</a></span>
|
||||
|
|
@ -1256,7 +1256,7 @@
|
|||
<a id=__codelineno-0-103 name=__codelineno-0-103></a> <span class=sa>f</span><span class=s2>" To fix this, make sure that at least one ancestor of component '</span><span class=si>{</span><span class=n>component_name</span><span class=si>}</span><span class=s2>' has"</span>
|
||||
<a id=__codelineno-0-104 name=__codelineno-0-104></a> <span class=sa>f</span><span class=s2>" the variable '</span><span class=si>{</span><span class=n>key</span><span class=si>}</span><span class=s2>' in their 'provide' attribute."</span>
|
||||
<a id=__codelineno-0-105 name=__codelineno-0-105></a> <span class=p>)</span>
|
||||
</code></pre></div></td></tr></table></div> </details> </div> </div> <div class="doc doc-object doc-function"> <h3 id=django_components.context.prepare_context class="doc doc-heading"> <code class="doc-symbol doc-symbol-heading doc-symbol-function"></code> <span class="doc doc-object-name doc-function-name">prepare_context</span> <a href=#django_components.context.prepare_context class=headerlink title="Permanent link">¤</a></h3> <div class="doc-signature highlight"><pre><span></span><code><a id=__codelineno-0-1 name=__codelineno-0-1 href=#__codelineno-0-1></a><span class=n>prepare_context</span><span class=p>(</span><span class=n>context</span><span class=p>:</span> <span class=n><a class="autorefs autorefs-external" title=django.template.Context href=https://docs.djangoproject.com/en/5.0/ref/templates/api/#django.template.Context>Context</a></span><span class=p>,</span> <span class=n>component_id</span><span class=p>:</span> <span class=n><a class="autorefs autorefs-external" href=https://docs.python.org/3.12/library/stdtypes.html#str>str</a></span><span class=p>)</span> <span class=o>-></span> <span class=kc>None</span>
|
||||
</code></pre></div></td></tr></table></div> </details> </div> </div> <div class="doc doc-object doc-function"> <h3 id=django_components.context.prepare_context class="doc doc-heading"> <code class="doc-symbol doc-symbol-heading doc-symbol-function"></code> <span class="doc doc-object-name doc-function-name">prepare_context</span> <a href=#django_components.context.prepare_context class=headerlink title="Permanent link">¤</a></h3> <div class="doc-signature highlight"><pre><span></span><code><a id=__codelineno-0-1 name=__codelineno-0-1 href=#__codelineno-0-1></a><span class=n>prepare_context</span><span class=p>(</span><span class=n>context</span><span class=p>:</span> <span class=n><span title=django.template.Context>Context</span></span><span class=p>,</span> <span class=n>component_id</span><span class=p>:</span> <span class=n><a class="autorefs autorefs-external" href=https://docs.python.org/3.12/library/stdtypes.html#str>str</a></span><span class=p>)</span> <span class=o>-></span> <span class=kc>None</span>
|
||||
</code></pre></div> <div class="doc doc-contents "> <p>Initialize the internal context state.</p> <details class=quote> <summary>Source code in <code>src/django_components/context.py</code></summary> <div class=highlight><table class=highlighttable><tr><td class=linenos><div class=linenodiv><pre><span></span><span class=normal><a href=#__codelineno-0-22>22</a></span>
|
||||
<span class=normal><a href=#__codelineno-0-23>23</a></span>
|
||||
<span class=normal><a href=#__codelineno-0-24>24</a></span>
|
||||
|
|
@ -1278,7 +1278,7 @@
|
|||
<a id=__codelineno-0-30 name=__codelineno-0-30></a> <span class=n>context</span><span class=p>[</span><span class=n>_FILLED_SLOTS_CONTENT_CONTEXT_KEY</span><span class=p>]</span> <span class=o>=</span> <span class=p>{}</span>
|
||||
<a id=__codelineno-0-31 name=__codelineno-0-31></a>
|
||||
<a id=__codelineno-0-32 name=__codelineno-0-32></a> <span class=n>set_component_id</span><span class=p>(</span><span class=n>context</span><span class=p>,</span> <span class=n>component_id</span><span class=p>)</span>
|
||||
</code></pre></div></td></tr></table></div> </details> </div> </div> <div class="doc doc-object doc-function"> <h3 id=django_components.context.set_component_id class="doc doc-heading"> <code class="doc-symbol doc-symbol-heading doc-symbol-function"></code> <span class="doc doc-object-name doc-function-name">set_component_id</span> <a href=#django_components.context.set_component_id class=headerlink title="Permanent link">¤</a></h3> <div class="doc-signature highlight"><pre><span></span><code><a id=__codelineno-0-1 name=__codelineno-0-1 href=#__codelineno-0-1></a><span class=n>set_component_id</span><span class=p>(</span><span class=n>context</span><span class=p>:</span> <span class=n><a class="autorefs autorefs-external" title=django.template.Context href=https://docs.djangoproject.com/en/5.0/ref/templates/api/#django.template.Context>Context</a></span><span class=p>,</span> <span class=n>component_id</span><span class=p>:</span> <span class=n><a class="autorefs autorefs-external" href=https://docs.python.org/3.12/library/stdtypes.html#str>str</a></span><span class=p>)</span> <span class=o>-></span> <span class=kc>None</span>
|
||||
</code></pre></div></td></tr></table></div> </details> </div> </div> <div class="doc doc-object doc-function"> <h3 id=django_components.context.set_component_id class="doc doc-heading"> <code class="doc-symbol doc-symbol-heading doc-symbol-function"></code> <span class="doc doc-object-name doc-function-name">set_component_id</span> <a href=#django_components.context.set_component_id class=headerlink title="Permanent link">¤</a></h3> <div class="doc-signature highlight"><pre><span></span><code><a id=__codelineno-0-1 name=__codelineno-0-1 href=#__codelineno-0-1></a><span class=n>set_component_id</span><span class=p>(</span><span class=n>context</span><span class=p>:</span> <span class=n><span title=django.template.Context>Context</span></span><span class=p>,</span> <span class=n>component_id</span><span class=p>:</span> <span class=n><a class="autorefs autorefs-external" href=https://docs.python.org/3.12/library/stdtypes.html#str>str</a></span><span class=p>)</span> <span class=o>-></span> <span class=kc>None</span>
|
||||
</code></pre></div> <div class="doc doc-contents "> <p>We use the Context object to pass down info on inside of which component we are currently rendering.</p> <details class=quote> <summary>Source code in <code>src/django_components/context.py</code></summary> <div class=highlight><table class=highlighttable><tr><td class=linenos><div class=linenodiv><pre><span></span><span class=normal><a href=#__codelineno-0-53>53</a></span>
|
||||
<span class=normal><a href=#__codelineno-0-54>54</a></span>
|
||||
<span class=normal><a href=#__codelineno-0-55>55</a></span>
|
||||
|
|
@ -1296,7 +1296,7 @@
|
|||
<a id=__codelineno-0-59 name=__codelineno-0-59></a> <span class=c1># is the top-most or not. If it is, then "_parent_component_id" is None</span>
|
||||
<a id=__codelineno-0-60 name=__codelineno-0-60></a> <span class=n>context</span><span class=p>[</span><span class=n>_PARENT_COMP_CONTEXT_KEY</span><span class=p>]</span> <span class=o>=</span> <span class=n>context</span><span class=o>.</span><span class=n>get</span><span class=p>(</span><span class=n>_CURRENT_COMP_CONTEXT_KEY</span><span class=p>,</span> <span class=kc>None</span><span class=p>)</span>
|
||||
<a id=__codelineno-0-61 name=__codelineno-0-61></a> <span class=n>context</span><span class=p>[</span><span class=n>_CURRENT_COMP_CONTEXT_KEY</span><span class=p>]</span> <span class=o>=</span> <span class=n>component_id</span>
|
||||
</code></pre></div></td></tr></table></div> </details> </div> </div> <div class="doc doc-object doc-function"> <h3 id=django_components.context.set_provided_context_var class="doc doc-heading"> <code class="doc-symbol doc-symbol-heading doc-symbol-function"></code> <span class="doc doc-object-name doc-function-name">set_provided_context_var</span> <a href=#django_components.context.set_provided_context_var class=headerlink title="Permanent link">¤</a></h3> <div class="doc-signature highlight"><pre><span></span><code><a id=__codelineno-0-1 name=__codelineno-0-1 href=#__codelineno-0-1></a><span class=n>set_provided_context_var</span><span class=p>(</span><span class=n>context</span><span class=p>:</span> <span class=n><a class="autorefs autorefs-external" title=django.template.Context href=https://docs.djangoproject.com/en/5.0/ref/templates/api/#django.template.Context>Context</a></span><span class=p>,</span> <span class=n>key</span><span class=p>:</span> <span class=n><a class="autorefs autorefs-external" href=https://docs.python.org/3.12/library/stdtypes.html#str>str</a></span><span class=p>,</span> <span class=n>provided_kwargs</span><span class=p>:</span> <span class=n><a class="autorefs autorefs-external" title=typing.Dict href=https://docs.python.org/3.12/library/typing.html#typing.Dict>Dict</a></span><span class=p>[</span><span class=n><a class="autorefs autorefs-external" href=https://docs.python.org/3.12/library/stdtypes.html#str>str</a></span><span class=p>,</span> <span class=n><a class="autorefs autorefs-external" title=typing.Any href=https://docs.python.org/3.12/library/typing.html#typing.Any>Any</a></span><span class=p>])</span> <span class=o>-></span> <span class=kc>None</span>
|
||||
</code></pre></div></td></tr></table></div> </details> </div> </div> <div class="doc doc-object doc-function"> <h3 id=django_components.context.set_provided_context_var class="doc doc-heading"> <code class="doc-symbol doc-symbol-heading doc-symbol-function"></code> <span class="doc doc-object-name doc-function-name">set_provided_context_var</span> <a href=#django_components.context.set_provided_context_var class=headerlink title="Permanent link">¤</a></h3> <div class="doc-signature highlight"><pre><span></span><code><a id=__codelineno-0-1 name=__codelineno-0-1 href=#__codelineno-0-1></a><span class=n>set_provided_context_var</span><span class=p>(</span><span class=n>context</span><span class=p>:</span> <span class=n><span title=django.template.Context>Context</span></span><span class=p>,</span> <span class=n>key</span><span class=p>:</span> <span class=n><a class="autorefs autorefs-external" href=https://docs.python.org/3.12/library/stdtypes.html#str>str</a></span><span class=p>,</span> <span class=n>provided_kwargs</span><span class=p>:</span> <span class=n><a class="autorefs autorefs-external" title=typing.Dict href=https://docs.python.org/3.12/library/typing.html#typing.Dict>Dict</a></span><span class=p>[</span><span class=n><a class="autorefs autorefs-external" href=https://docs.python.org/3.12/library/stdtypes.html#str>str</a></span><span class=p>,</span> <span class=n><a class="autorefs autorefs-external" title=typing.Any href=https://docs.python.org/3.12/library/typing.html#typing.Any>Any</a></span><span class=p>])</span> <span class=o>-></span> <span class=kc>None</span>
|
||||
</code></pre></div> <div class="doc doc-contents "> <p>'Provide' given data under given key. In other words, this data can be retrieved using <code>self.inject(key)</code> inside of <code>get_context_data()</code> method of components that are nested inside the <code>{% provide %}</code> tag.</p> <details class=quote> <summary>Source code in <code>src/django_components/context.py</code></summary> <div class=highlight><table class=highlighttable><tr><td class=linenos><div class=linenodiv><pre><span></span><span class=normal><a href=#__codelineno-0-108>108</a></span>
|
||||
<span class=normal><a href=#__codelineno-0-109>109</a></span>
|
||||
<span class=normal><a href=#__codelineno-0-110>110</a></span>
|
||||
|
|
@ -1670,7 +1670,7 @@
|
|||
<a id=__codelineno-0-91 name=__codelineno-0-91></a> <span class=c1># NOTE: When debugging tests during development, it may be easier to change</span>
|
||||
<a id=__codelineno-0-92 name=__codelineno-0-92></a> <span class=c1># this to `print()`</span>
|
||||
<a id=__codelineno-0-93 name=__codelineno-0-93></a> <span class=n>trace</span><span class=p>(</span><span class=n>logger</span><span class=p>,</span> <span class=n>full_msg</span><span class=p>)</span>
|
||||
</code></pre></div></td></tr></table></div> </details> </div> </div> </div> </div> </div> <div class="doc doc-object doc-module"> <h2 id=django_components.management class="doc doc-heading"> <code class="doc-symbol doc-symbol-heading doc-symbol-module"></code> <span class="doc doc-object-name doc-module-name">management</span> <a href=#django_components.management class=headerlink title="Permanent link">¤</a></h2> <div class="doc doc-contents "> <div class="doc doc-children"> <div class="doc doc-object doc-module"> <h3 id=django_components.management.commands class="doc doc-heading"> <code class="doc-symbol doc-symbol-heading doc-symbol-module"></code> <span class="doc doc-object-name doc-module-name">commands</span> <a href=#django_components.management.commands class=headerlink title="Permanent link">¤</a></h3> <div class="doc doc-contents "> <div class="doc doc-children"> <div class="doc doc-object doc-module"> <h4 id=django_components.management.commands.upgradecomponent class="doc doc-heading"> <code class="doc-symbol doc-symbol-heading doc-symbol-module"></code> <span class="doc doc-object-name doc-module-name">upgradecomponent</span> <a href=#django_components.management.commands.upgradecomponent class=headerlink title="Permanent link">¤</a></h4> <div class="doc doc-contents "> <div class="doc doc-children"> </div> </div> </div> </div> </div> </div> </div> </div> </div> <div class="doc doc-object doc-module"> <h2 id=django_components.middleware class="doc doc-heading"> <code class="doc-symbol doc-symbol-heading doc-symbol-module"></code> <span class="doc doc-object-name doc-module-name">middleware</span> <a href=#django_components.middleware class=headerlink title="Permanent link">¤</a></h2> <div class="doc doc-contents "> <div class="doc doc-children"> <div class="doc doc-object doc-class"> <h3 id=django_components.middleware.ComponentDependencyMiddleware class="doc doc-heading"> <code class="doc-symbol doc-symbol-heading doc-symbol-class"></code> <span class="doc doc-object-name doc-class-name">ComponentDependencyMiddleware</span> <a href=#django_components.middleware.ComponentDependencyMiddleware class=headerlink title="Permanent link">¤</a></h3> <div class="doc-signature highlight"><pre><span></span><code><a id=__codelineno-0-1 name=__codelineno-0-1 href=#__codelineno-0-1></a><span class=n>ComponentDependencyMiddleware</span><span class=p>(</span><span class=n>get_response</span><span class=p>:</span> <span class=n><a class="autorefs autorefs-external" title=collections.abc.Callable href=https://docs.python.org/3.12/library/collections.abc.html#collections.abc.Callable>Callable</a></span><span class=p>[[</span><span class=n><a class="autorefs autorefs-external" title=django.http.HttpRequest href=https://docs.djangoproject.com/en/5.0/ref/request-response/#django.http.HttpRequest>HttpRequest</a></span><span class=p>],</span> <span class=n><a class="autorefs autorefs-external" title=django.http.HttpResponse href=https://docs.djangoproject.com/en/5.0/ref/request-response/#django.http.HttpResponse>HttpResponse</a></span><span class=p>])</span>
|
||||
</code></pre></div></td></tr></table></div> </details> </div> </div> </div> </div> </div> <div class="doc doc-object doc-module"> <h2 id=django_components.management class="doc doc-heading"> <code class="doc-symbol doc-symbol-heading doc-symbol-module"></code> <span class="doc doc-object-name doc-module-name">management</span> <a href=#django_components.management class=headerlink title="Permanent link">¤</a></h2> <div class="doc doc-contents "> <div class="doc doc-children"> <div class="doc doc-object doc-module"> <h3 id=django_components.management.commands class="doc doc-heading"> <code class="doc-symbol doc-symbol-heading doc-symbol-module"></code> <span class="doc doc-object-name doc-module-name">commands</span> <a href=#django_components.management.commands class=headerlink title="Permanent link">¤</a></h3> <div class="doc doc-contents "> <div class="doc doc-children"> <div class="doc doc-object doc-module"> <h4 id=django_components.management.commands.upgradecomponent class="doc doc-heading"> <code class="doc-symbol doc-symbol-heading doc-symbol-module"></code> <span class="doc doc-object-name doc-module-name">upgradecomponent</span> <a href=#django_components.management.commands.upgradecomponent class=headerlink title="Permanent link">¤</a></h4> <div class="doc doc-contents "> <div class="doc doc-children"> </div> </div> </div> </div> </div> </div> </div> </div> </div> <div class="doc doc-object doc-module"> <h2 id=django_components.middleware class="doc doc-heading"> <code class="doc-symbol doc-symbol-heading doc-symbol-module"></code> <span class="doc doc-object-name doc-module-name">middleware</span> <a href=#django_components.middleware class=headerlink title="Permanent link">¤</a></h2> <div class="doc doc-contents "> <div class="doc doc-children"> <div class="doc doc-object doc-class"> <h3 id=django_components.middleware.ComponentDependencyMiddleware class="doc doc-heading"> <code class="doc-symbol doc-symbol-heading doc-symbol-class"></code> <span class="doc doc-object-name doc-class-name">ComponentDependencyMiddleware</span> <a href=#django_components.middleware.ComponentDependencyMiddleware class=headerlink title="Permanent link">¤</a></h3> <div class="doc-signature highlight"><pre><span></span><code><a id=__codelineno-0-1 name=__codelineno-0-1 href=#__codelineno-0-1></a><span class=n>ComponentDependencyMiddleware</span><span class=p>(</span><span class=n>get_response</span><span class=p>:</span> <span class=n><a class="autorefs autorefs-external" title=collections.abc.Callable href=https://docs.python.org/3.12/library/collections.abc.html#collections.abc.Callable>Callable</a></span><span class=p>[[</span><span class=n><span title=django.http.HttpRequest>HttpRequest</span></span><span class=p>],</span> <span class=n><span title=django.http.HttpResponse>HttpResponse</span></span><span class=p>])</span>
|
||||
</code></pre></div> <div class="doc doc-contents "> <p>Middleware that inserts CSS/JS dependencies for all rendered components at points marked with template tags.</p> <details class=quote> <summary>Source code in <code>src/django_components/middleware.py</code></summary> <div class=highlight><table class=highlighttable><tr><td class=linenos><div class=linenodiv><pre><span></span><span class=normal><a href=#__codelineno-0-36>36</a></span>
|
||||
<span class=normal><a href=#__codelineno-0-37>37</a></span>
|
||||
<span class=normal><a href=#__codelineno-0-38>38</a></span>
|
||||
|
|
@ -1721,7 +1721,7 @@
|
|||
<a id=__codelineno-0-23 name=__codelineno-0-23></a> <span class=bp>self</span><span class=o>.</span><span class=n>node_id</span> <span class=o>=</span> <span class=n>node_id</span> <span class=ow>or</span> <span class=n>gen_id</span><span class=p>()</span>
|
||||
<a id=__codelineno-0-24 name=__codelineno-0-24></a> <span class=bp>self</span><span class=o>.</span><span class=n>args</span> <span class=o>=</span> <span class=n>args</span> <span class=ow>or</span> <span class=p>[]</span>
|
||||
<a id=__codelineno-0-25 name=__codelineno-0-25></a> <span class=bp>self</span><span class=o>.</span><span class=n>kwargs</span> <span class=o>=</span> <span class=n>kwargs</span> <span class=ow>or</span> <span class=n>RuntimeKwargs</span><span class=p>({})</span>
|
||||
</code></pre></div></td></tr></table></div> </details> <div class="doc doc-children"> </div> </div> </div> <div class="doc doc-object doc-function"> <h3 id=django_components.node.get_node_children class="doc doc-heading"> <code class="doc-symbol doc-symbol-heading doc-symbol-function"></code> <span class="doc doc-object-name doc-function-name">get_node_children</span> <a href=#django_components.node.get_node_children class=headerlink title="Permanent link">¤</a></h3> <div class="doc-signature highlight"><pre><span></span><code><a id=__codelineno-0-1 name=__codelineno-0-1 href=#__codelineno-0-1></a><span class=n>get_node_children</span><span class=p>(</span><span class=n>node</span><span class=p>:</span> <span class=n><span title=django.template.base.Node>Node</span></span><span class=p>,</span> <span class=n>context</span><span class=p>:</span> <span class=n><a class="autorefs autorefs-external" title=typing.Optional href=https://docs.python.org/3.12/library/typing.html#typing.Optional>Optional</a></span><span class=p>[</span><span class=n><a class="autorefs autorefs-external" title=django.template.Context href=https://docs.djangoproject.com/en/5.0/ref/templates/api/#django.template.Context>Context</a></span><span class=p>]</span> <span class=o>=</span> <span class=kc>None</span><span class=p>)</span> <span class=o>-></span> <span class=n><span title=django.template.base.NodeList>NodeList</span></span>
|
||||
</code></pre></div></td></tr></table></div> </details> <div class="doc doc-children"> </div> </div> </div> <div class="doc doc-object doc-function"> <h3 id=django_components.node.get_node_children class="doc doc-heading"> <code class="doc-symbol doc-symbol-heading doc-symbol-function"></code> <span class="doc doc-object-name doc-function-name">get_node_children</span> <a href=#django_components.node.get_node_children class=headerlink title="Permanent link">¤</a></h3> <div class="doc-signature highlight"><pre><span></span><code><a id=__codelineno-0-1 name=__codelineno-0-1 href=#__codelineno-0-1></a><span class=n>get_node_children</span><span class=p>(</span><span class=n>node</span><span class=p>:</span> <span class=n><span title=django.template.base.Node>Node</span></span><span class=p>,</span> <span class=n>context</span><span class=p>:</span> <span class=n><a class="autorefs autorefs-external" title=typing.Optional href=https://docs.python.org/3.12/library/typing.html#typing.Optional>Optional</a></span><span class=p>[</span><span class=n><span title=django.template.Context>Context</span></span><span class=p>]</span> <span class=o>=</span> <span class=kc>None</span><span class=p>)</span> <span class=o>-></span> <span class=n><span title=django.template.base.NodeList>NodeList</span></span>
|
||||
</code></pre></div> <div class="doc doc-contents "> <p>Get child Nodes from Node's nodelist atribute.</p> <p>This function is taken from <code>get_nodes_by_type</code> method of <code>django.template.base.Node</code>.</p> <details class=quote> <summary>Source code in <code>src/django_components/node.py</code></summary> <div class=highlight><table class=highlighttable><tr><td class=linenos><div class=linenodiv><pre><span></span><span class=normal><a href=#__codelineno-0-59>59</a></span>
|
||||
<span class=normal><a href=#__codelineno-0-60>60</a></span>
|
||||
<span class=normal><a href=#__codelineno-0-61>61</a></span>
|
||||
|
|
@ -1781,7 +1781,7 @@
|
|||
<a id=__codelineno-0-86 name=__codelineno-0-86></a> <span class=k>if</span> <span class=n>nodelist</span><span class=p>:</span>
|
||||
<a id=__codelineno-0-87 name=__codelineno-0-87></a> <span class=n>nodes</span><span class=o>.</span><span class=n>extend</span><span class=p>(</span><span class=n>nodelist</span><span class=p>)</span>
|
||||
<a id=__codelineno-0-88 name=__codelineno-0-88></a> <span class=k>return</span> <span class=n>nodes</span>
|
||||
</code></pre></div></td></tr></table></div> </details> </div> </div> <div class="doc doc-object doc-function"> <h3 id=django_components.node.get_template_for_include_node class="doc doc-heading"> <code class="doc-symbol doc-symbol-heading doc-symbol-function"></code> <span class="doc doc-object-name doc-function-name">get_template_for_include_node</span> <a href=#django_components.node.get_template_for_include_node class=headerlink title="Permanent link">¤</a></h3> <div class="doc-signature highlight"><pre><span></span><code><a id=__codelineno-0-1 name=__codelineno-0-1 href=#__codelineno-0-1></a><span class=n>get_template_for_include_node</span><span class=p>(</span><span class=n>include_node</span><span class=p>:</span> <span class=n><span title=django.template.loader_tags.IncludeNode>IncludeNode</span></span><span class=p>,</span> <span class=n>context</span><span class=p>:</span> <span class=n><a class="autorefs autorefs-external" title=django.template.Context href=https://docs.djangoproject.com/en/5.0/ref/templates/api/#django.template.Context>Context</a></span><span class=p>)</span> <span class=o>-></span> <span class=n><a class="autorefs autorefs-external" title=django.template.Template href=https://docs.djangoproject.com/en/5.0/ref/templates/api/#django.template.Template>Template</a></span>
|
||||
</code></pre></div></td></tr></table></div> </details> </div> </div> <div class="doc doc-object doc-function"> <h3 id=django_components.node.get_template_for_include_node class="doc doc-heading"> <code class="doc-symbol doc-symbol-heading doc-symbol-function"></code> <span class="doc doc-object-name doc-function-name">get_template_for_include_node</span> <a href=#django_components.node.get_template_for_include_node class=headerlink title="Permanent link">¤</a></h3> <div class="doc-signature highlight"><pre><span></span><code><a id=__codelineno-0-1 name=__codelineno-0-1 href=#__codelineno-0-1></a><span class=n>get_template_for_include_node</span><span class=p>(</span><span class=n>include_node</span><span class=p>:</span> <span class=n><span title=django.template.loader_tags.IncludeNode>IncludeNode</span></span><span class=p>,</span> <span class=n>context</span><span class=p>:</span> <span class=n><span title=django.template.Context>Context</span></span><span class=p>)</span> <span class=o>-></span> <span class=n><span title=django.template.Template>Template</span></span>
|
||||
</code></pre></div> <div class="doc doc-contents "> <p>This snippet is taken directly from <code>IncludeNode.render()</code>. Unfortunately the render logic doesn't separate out template loading logic from rendering, so we have to copy the method.</p> <details class=quote> <summary>Source code in <code>src/django_components/node.py</code></summary> <div class=highlight><table class=highlighttable><tr><td class=linenos><div class=linenodiv><pre><span></span><span class=normal><a href=#__codelineno-0-91> 91</a></span>
|
||||
<span class=normal><a href=#__codelineno-0-92> 92</a></span>
|
||||
<span class=normal><a href=#__codelineno-0-93> 93</a></span>
|
||||
|
|
@ -1839,7 +1839,7 @@
|
|||
<a id=__codelineno-0-117 name=__codelineno-0-117></a> <span class=k>elif</span> <span class=nb>hasattr</span><span class=p>(</span><span class=n>template</span><span class=p>,</span> <span class=s2>"template"</span><span class=p>):</span>
|
||||
<a id=__codelineno-0-118 name=__codelineno-0-118></a> <span class=n>template</span> <span class=o>=</span> <span class=n>template</span><span class=o>.</span><span class=n>template</span>
|
||||
<a id=__codelineno-0-119 name=__codelineno-0-119></a> <span class=k>return</span> <span class=n>template</span>
|
||||
</code></pre></div></td></tr></table></div> </details> </div> </div> <div class="doc doc-object doc-function"> <h3 id=django_components.node.walk_nodelist class="doc doc-heading"> <code class="doc-symbol doc-symbol-heading doc-symbol-function"></code> <span class="doc doc-object-name doc-function-name">walk_nodelist</span> <a href=#django_components.node.walk_nodelist class=headerlink title="Permanent link">¤</a></h3> <div class="doc-signature highlight"><pre><span></span><code><a id=__codelineno-0-1 name=__codelineno-0-1 href=#__codelineno-0-1></a><span class=n>walk_nodelist</span><span class=p>(</span><span class=n>nodes</span><span class=p>:</span> <span class=n><span title=django.template.base.NodeList>NodeList</span></span><span class=p>,</span> <span class=n>callback</span><span class=p>:</span> <span class=n><a class="autorefs autorefs-external" title=typing.Callable href=https://docs.python.org/3.12/library/typing.html#typing.Callable>Callable</a></span><span class=p>[[</span><span class=n><span title=django.template.base.Node>Node</span></span><span class=p>],</span> <span class=n><a class="autorefs autorefs-external" title=typing.Optional href=https://docs.python.org/3.12/library/typing.html#typing.Optional>Optional</a></span><span class=p>[</span><span class=n><a class="autorefs autorefs-external" href=https://docs.python.org/3.12/library/stdtypes.html#str>str</a></span><span class=p>]],</span> <span class=n>context</span><span class=p>:</span> <span class=n><a class="autorefs autorefs-external" title=typing.Optional href=https://docs.python.org/3.12/library/typing.html#typing.Optional>Optional</a></span><span class=p>[</span><span class=n><a class="autorefs autorefs-external" title=django.template.Context href=https://docs.djangoproject.com/en/5.0/ref/templates/api/#django.template.Context>Context</a></span><span class=p>]</span> <span class=o>=</span> <span class=kc>None</span><span class=p>)</span> <span class=o>-></span> <span class=kc>None</span>
|
||||
</code></pre></div></td></tr></table></div> </details> </div> </div> <div class="doc doc-object doc-function"> <h3 id=django_components.node.walk_nodelist class="doc doc-heading"> <code class="doc-symbol doc-symbol-heading doc-symbol-function"></code> <span class="doc doc-object-name doc-function-name">walk_nodelist</span> <a href=#django_components.node.walk_nodelist class=headerlink title="Permanent link">¤</a></h3> <div class="doc-signature highlight"><pre><span></span><code><a id=__codelineno-0-1 name=__codelineno-0-1 href=#__codelineno-0-1></a><span class=n>walk_nodelist</span><span class=p>(</span><span class=n>nodes</span><span class=p>:</span> <span class=n><span title=django.template.base.NodeList>NodeList</span></span><span class=p>,</span> <span class=n>callback</span><span class=p>:</span> <span class=n><a class="autorefs autorefs-external" title=typing.Callable href=https://docs.python.org/3.12/library/typing.html#typing.Callable>Callable</a></span><span class=p>[[</span><span class=n><span title=django.template.base.Node>Node</span></span><span class=p>],</span> <span class=n><a class="autorefs autorefs-external" title=typing.Optional href=https://docs.python.org/3.12/library/typing.html#typing.Optional>Optional</a></span><span class=p>[</span><span class=n><a class="autorefs autorefs-external" href=https://docs.python.org/3.12/library/stdtypes.html#str>str</a></span><span class=p>]],</span> <span class=n>context</span><span class=p>:</span> <span class=n><a class="autorefs autorefs-external" title=typing.Optional href=https://docs.python.org/3.12/library/typing.html#typing.Optional>Optional</a></span><span class=p>[</span><span class=n><span title=django.template.Context>Context</span></span><span class=p>]</span> <span class=o>=</span> <span class=kc>None</span><span class=p>)</span> <span class=o>-></span> <span class=kc>None</span>
|
||||
</code></pre></div> <div class="doc doc-contents "> <p>Recursively walk a NodeList, calling <code>callback</code> for each Node.</p> <details class=quote> <summary>Source code in <code>src/django_components/node.py</code></summary> <div class=highlight><table class=highlighttable><tr><td class=linenos><div class=linenodiv><pre><span></span><span class=normal><a href=#__codelineno-0-44>44</a></span>
|
||||
<span class=normal><a href=#__codelineno-0-45>45</a></span>
|
||||
<span class=normal><a href=#__codelineno-0-46>46</a></span>
|
||||
|
|
@ -1974,7 +1974,7 @@
|
|||
<a id=__codelineno-0-139 name=__codelineno-0-139></a> <span class=bp>self</span><span class=o>.</span><span class=n>name</span> <span class=o>=</span> <span class=n>name</span>
|
||||
<a id=__codelineno-0-140 name=__codelineno-0-140></a> <span class=bp>self</span><span class=o>.</span><span class=n>is_required</span> <span class=o>=</span> <span class=n>is_required</span>
|
||||
<a id=__codelineno-0-141 name=__codelineno-0-141></a> <span class=bp>self</span><span class=o>.</span><span class=n>is_default</span> <span class=o>=</span> <span class=n>is_default</span>
|
||||
</code></pre></div></td></tr></table></div> </details> <div class="doc doc-children"> </div> </div> </div> <div class="doc doc-object doc-class"> <h3 id=django_components.slots.SlotRef class="doc doc-heading"> <code class="doc-symbol doc-symbol-heading doc-symbol-class"></code> <span class="doc doc-object-name doc-class-name">SlotRef</span> <a href=#django_components.slots.SlotRef class=headerlink title="Permanent link">¤</a></h3> <div class="doc-signature highlight"><pre><span></span><code><a id=__codelineno-0-1 name=__codelineno-0-1 href=#__codelineno-0-1></a><span class=n>SlotRef</span><span class=p>(</span><span class=n>slot</span><span class=p>:</span> <span class=n><a class="autorefs autorefs-internal" title=django_components.slots.SlotNode href=slots/#django_components.slots.SlotNode>SlotNode</a></span><span class=p>,</span> <span class=n>context</span><span class=p>:</span> <span class=n><a class="autorefs autorefs-external" title=django.template.Context href=https://docs.djangoproject.com/en/5.0/ref/templates/api/#django.template.Context>Context</a></span><span class=p>)</span>
|
||||
</code></pre></div></td></tr></table></div> </details> <div class="doc doc-children"> </div> </div> </div> <div class="doc doc-object doc-class"> <h3 id=django_components.slots.SlotRef class="doc doc-heading"> <code class="doc-symbol doc-symbol-heading doc-symbol-class"></code> <span class="doc doc-object-name doc-class-name">SlotRef</span> <a href=#django_components.slots.SlotRef class=headerlink title="Permanent link">¤</a></h3> <div class="doc-signature highlight"><pre><span></span><code><a id=__codelineno-0-1 name=__codelineno-0-1 href=#__codelineno-0-1></a><span class=n>SlotRef</span><span class=p>(</span><span class=n>slot</span><span class=p>:</span> <span class=n><a class="autorefs autorefs-internal" title=django_components.slots.SlotNode href=slots/#django_components.slots.SlotNode>SlotNode</a></span><span class=p>,</span> <span class=n>context</span><span class=p>:</span> <span class=n><span title=django.template.Context>Context</span></span><span class=p>)</span>
|
||||
</code></pre></div> <div class="doc doc-contents "> <p>SlotRef allows to treat a slot as a variable. The slot is rendered only once the instance is coerced to string.</p> <p>This is used to access slots as variables inside the templates. When a SlotRef is rendered in the template with <code>{{ my_lazy_slot }}</code>, it will output the contents of the slot.</p> <details class=quote> <summary>Source code in <code>src/django_components/slots.py</code></summary> <div class=highlight><table class=highlighttable><tr><td class=linenos><div class=linenodiv><pre><span></span><span class=normal><a href=#__codelineno-0-118>118</a></span>
|
||||
<span class=normal><a href=#__codelineno-0-119>119</a></span>
|
||||
<span class=normal><a href=#__codelineno-0-120>120</a></span></pre></div></td><td class=code><div><pre><span></span><code><a id=__codelineno-0-118 name=__codelineno-0-118></a><span class=k>def</span> <span class=fm>__init__</span><span class=p>(</span><span class=bp>self</span><span class=p>,</span> <span class=n>slot</span><span class=p>:</span> <span class=s2>"SlotNode"</span><span class=p>,</span> <span class=n>context</span><span class=p>:</span> <span class=n>Context</span><span class=p>):</span>
|
||||
|
|
@ -2069,8 +2069,8 @@
|
|||
<a id=__codelineno-0-331 name=__codelineno-0-331></a> <span class=p>)</span>
|
||||
<a id=__codelineno-0-332 name=__codelineno-0-332></a> <span class=k>return</span> <span class=n>fill_nodes</span>
|
||||
</code></pre></div></td></tr></table></div> </details> </div> </div> <div class="doc doc-object doc-function"> <h3 id=django_components.slots.resolve_slots class="doc doc-heading"> <code class="doc-symbol doc-symbol-heading doc-symbol-function"></code> <span class="doc doc-object-name doc-function-name">resolve_slots</span> <a href=#django_components.slots.resolve_slots class=headerlink title="Permanent link">¤</a></h3> <div class="doc-signature highlight"><pre><span></span><code><a id=__codelineno-0-1 name=__codelineno-0-1 href=#__codelineno-0-1></a><span class=n>resolve_slots</span><span class=p>(</span>
|
||||
<a id=__codelineno-0-2 name=__codelineno-0-2 href=#__codelineno-0-2></a> <span class=n>context</span><span class=p>:</span> <span class=n><a class="autorefs autorefs-external" title=django.template.Context href=https://docs.djangoproject.com/en/5.0/ref/templates/api/#django.template.Context>Context</a></span><span class=p>,</span>
|
||||
<a id=__codelineno-0-3 name=__codelineno-0-3 href=#__codelineno-0-3></a> <span class=n>template</span><span class=p>:</span> <span class=n><a class="autorefs autorefs-external" title=django.template.Template href=https://docs.djangoproject.com/en/5.0/ref/templates/api/#django.template.Template>Template</a></span><span class=p>,</span>
|
||||
<a id=__codelineno-0-2 name=__codelineno-0-2 href=#__codelineno-0-2></a> <span class=n>context</span><span class=p>:</span> <span class=n><span title=django.template.Context>Context</span></span><span class=p>,</span>
|
||||
<a id=__codelineno-0-3 name=__codelineno-0-3 href=#__codelineno-0-3></a> <span class=n>template</span><span class=p>:</span> <span class=n><span title=django.template.Template>Template</span></span><span class=p>,</span>
|
||||
<a id=__codelineno-0-4 name=__codelineno-0-4 href=#__codelineno-0-4></a> <span class=n>component_name</span><span class=p>:</span> <span class=n><a class="autorefs autorefs-external" title=typing.Optional href=https://docs.python.org/3.12/library/typing.html#typing.Optional>Optional</a></span><span class=p>[</span><span class=n><a class="autorefs autorefs-external" href=https://docs.python.org/3.12/library/stdtypes.html#str>str</a></span><span class=p>],</span>
|
||||
<a id=__codelineno-0-5 name=__codelineno-0-5 href=#__codelineno-0-5></a> <span class=n>context_data</span><span class=p>:</span> <span class=n><a class="autorefs autorefs-external" title=typing.Mapping href=https://docs.python.org/3.12/library/typing.html#typing.Mapping>Mapping</a></span><span class=p>[</span><span class=n><a class="autorefs autorefs-external" href=https://docs.python.org/3.12/library/stdtypes.html#str>str</a></span><span class=p>,</span> <span class=n><a class="autorefs autorefs-external" title=typing.Any href=https://docs.python.org/3.12/library/typing.html#typing.Any>Any</a></span><span class=p>],</span>
|
||||
<a id=__codelineno-0-6 name=__codelineno-0-6 href=#__codelineno-0-6></a> <span class=n>fill_content</span><span class=p>:</span> <span class=n><a class="autorefs autorefs-external" title=typing.Dict href=https://docs.python.org/3.12/library/typing.html#typing.Dict>Dict</a></span><span class=p>[</span><span class=n><span title=django_components.slots.SlotName>SlotName</span></span><span class=p>,</span> <span class=n><a class="autorefs autorefs-internal" title=django_components.slots.FillContent href=slots/#django_components.slots.FillContent>FillContent</a></span><span class=p>],</span>
|
||||
|
|
@ -2430,7 +2430,7 @@
|
|||
<a id=__codelineno-0-212 name=__codelineno-0-212></a> <span class=n>tag_formatter</span> <span class=o>=</span> <span class=n>formatter_cls_or_str</span>
|
||||
<a id=__codelineno-0-213 name=__codelineno-0-213></a>
|
||||
<a id=__codelineno-0-214 name=__codelineno-0-214></a> <span class=k>return</span> <span class=n>InternalTagFormatter</span><span class=p>(</span><span class=n>tag_formatter</span><span class=p>)</span>
|
||||
</code></pre></div></td></tr></table></div> </details> </div> </div> </div> </div> </div> <div class="doc doc-object doc-module"> <h2 id=django_components.template_loader class="doc doc-heading"> <code class="doc-symbol doc-symbol-heading doc-symbol-module"></code> <span class="doc doc-object-name doc-module-name">template_loader</span> <a href=#django_components.template_loader class=headerlink title="Permanent link">¤</a></h2> <div class="doc doc-contents "> <p>Template loader that loads templates from each Django app's "components" directory.</p> <div class="doc doc-children"> <div class="doc doc-object doc-class"> <h3 id=django_components.template_loader.Loader class="doc doc-heading"> <code class="doc-symbol doc-symbol-heading doc-symbol-class"></code> <span class="doc doc-object-name doc-class-name">Loader</span> <a href=#django_components.template_loader.Loader class=headerlink title="Permanent link">¤</a></h3> <div class="doc doc-contents "> <p class="doc doc-class-bases"> Bases: <code><a class="autorefs autorefs-external" title=django.template.loaders.filesystem.Loader href=https://docs.djangoproject.com/en/5.0/ref/templates/api/#django.template.loaders.filesystem.Loader>Loader</a></code></p> <div class="doc doc-children"> <div class="doc doc-object doc-function"> <h4 id=django_components.template_loader.Loader.get_dirs class="doc doc-heading"> <code class="doc-symbol doc-symbol-heading doc-symbol-method"></code> <span class="doc doc-object-name doc-function-name">get_dirs</span> <a href=#django_components.template_loader.Loader.get_dirs class=headerlink title="Permanent link">¤</a></h4> <div class="doc-signature highlight"><pre><span></span><code><a id=__codelineno-0-1 name=__codelineno-0-1 href=#__codelineno-0-1></a><span class=n>get_dirs</span><span class=p>()</span> <span class=o>-></span> <span class=n><a class="autorefs autorefs-external" title=typing.List href=https://docs.python.org/3.12/library/typing.html#typing.List>List</a></span><span class=p>[</span><span class=n><a class="autorefs autorefs-external" title=pathlib.Path href=https://docs.python.org/3.12/library/pathlib.html#pathlib.Path>Path</a></span><span class=p>]</span>
|
||||
</code></pre></div></td></tr></table></div> </details> </div> </div> </div> </div> </div> <div class="doc doc-object doc-module"> <h2 id=django_components.template_loader class="doc doc-heading"> <code class="doc-symbol doc-symbol-heading doc-symbol-module"></code> <span class="doc doc-object-name doc-module-name">template_loader</span> <a href=#django_components.template_loader class=headerlink title="Permanent link">¤</a></h2> <div class="doc doc-contents "> <p>Template loader that loads templates from each Django app's "components" directory.</p> <div class="doc doc-children"> <div class="doc doc-object doc-class"> <h3 id=django_components.template_loader.Loader class="doc doc-heading"> <code class="doc-symbol doc-symbol-heading doc-symbol-class"></code> <span class="doc doc-object-name doc-class-name">Loader</span> <a href=#django_components.template_loader.Loader class=headerlink title="Permanent link">¤</a></h3> <div class="doc doc-contents "> <p class="doc doc-class-bases"> Bases: <code><span title=django.template.loaders.filesystem.Loader>Loader</span></code></p> <div class="doc doc-children"> <div class="doc doc-object doc-function"> <h4 id=django_components.template_loader.Loader.get_dirs class="doc doc-heading"> <code class="doc-symbol doc-symbol-heading doc-symbol-method"></code> <span class="doc doc-object-name doc-function-name">get_dirs</span> <a href=#django_components.template_loader.Loader.get_dirs class=headerlink title="Permanent link">¤</a></h4> <div class="doc-signature highlight"><pre><span></span><code><a id=__codelineno-0-1 name=__codelineno-0-1 href=#__codelineno-0-1></a><span class=n>get_dirs</span><span class=p>()</span> <span class=o>-></span> <span class=n><a class="autorefs autorefs-external" title=typing.List href=https://docs.python.org/3.12/library/typing.html#typing.List>List</a></span><span class=p>[</span><span class=n><a class="autorefs autorefs-external" title=pathlib.Path href=https://docs.python.org/3.12/library/pathlib.html#pathlib.Path>Path</a></span><span class=p>]</span>
|
||||
</code></pre></div> <div class="doc doc-contents "> <p>Prepare directories that may contain component files:</p> <p>Searches for dirs set in <code>STATICFILES_DIRS</code> settings. If none set, defaults to searching for a "components" app. The dirs in <code>STATICFILES_DIRS</code> must be absolute paths.</p> <p>Paths are accepted only if they resolve to a directory. E.g. <code>/path/to/django_project/my_app/components/</code>.</p> <p>If <code>STATICFILES_DIRS</code> is not set or empty, then <code>BASE_DIR</code> is required.</p> <details class=quote> <summary>Source code in <code>src/django_components/template_loader.py</code></summary> <div class=highlight><table class=highlighttable><tr><td class=linenos><div class=linenodiv><pre><span></span><span class=normal><a href=#__codelineno-0-15>15</a></span>
|
||||
<span class=normal><a href=#__codelineno-0-16>16</a></span>
|
||||
<span class=normal><a href=#__codelineno-0-17>17</a></span>
|
||||
|
|
@ -2832,7 +2832,7 @@
|
|||
<a id=__codelineno-0-255 name=__codelineno-0-255></a>
|
||||
<a id=__codelineno-0-256 name=__codelineno-0-256></a> <span class=n>trace_msg</span><span class=p>(</span><span class=s2>"PARSE"</span><span class=p>,</span> <span class=s2>"COMP"</span><span class=p>,</span> <span class=n>result</span><span class=o>.</span><span class=n>component_name</span><span class=p>,</span> <span class=n>tag</span><span class=o>.</span><span class=n>id</span><span class=p>,</span> <span class=s2>"...Done!"</span><span class=p>)</span>
|
||||
<a id=__codelineno-0-257 name=__codelineno-0-257></a> <span class=k>return</span> <span class=n>component_node</span>
|
||||
</code></pre></div></td></tr></table></div> </details> </div> </div> <div class="doc doc-object doc-function"> <h4 id=django_components.templatetags.component_tags.component_css_dependencies class="doc doc-heading"> <code class="doc-symbol doc-symbol-heading doc-symbol-function"></code> <span class="doc doc-object-name doc-function-name">component_css_dependencies</span> <a href=#django_components.templatetags.component_tags.component_css_dependencies class=headerlink title="Permanent link">¤</a></h4> <div class="doc-signature highlight"><pre><span></span><code><a id=__codelineno-0-1 name=__codelineno-0-1 href=#__codelineno-0-1></a><span class=n>component_css_dependencies</span><span class=p>(</span><span class=n>preload</span><span class=p>:</span> <span class=n><a class="autorefs autorefs-external" href=https://docs.python.org/3.12/library/stdtypes.html#str>str</a></span> <span class=o>=</span> <span class=s1>''</span><span class=p>)</span> <span class=o>-></span> <span class=n><a class="autorefs autorefs-external" title=django.utils.safestring.SafeString href=https://docs.djangoproject.com/en/5.0/ref/utils/#django.utils.safestring.SafeString>SafeString</a></span>
|
||||
</code></pre></div></td></tr></table></div> </details> </div> </div> <div class="doc doc-object doc-function"> <h4 id=django_components.templatetags.component_tags.component_css_dependencies class="doc doc-heading"> <code class="doc-symbol doc-symbol-heading doc-symbol-function"></code> <span class="doc doc-object-name doc-function-name">component_css_dependencies</span> <a href=#django_components.templatetags.component_tags.component_css_dependencies class=headerlink title="Permanent link">¤</a></h4> <div class="doc-signature highlight"><pre><span></span><code><a id=__codelineno-0-1 name=__codelineno-0-1 href=#__codelineno-0-1></a><span class=n>component_css_dependencies</span><span class=p>(</span><span class=n>preload</span><span class=p>:</span> <span class=n><a class="autorefs autorefs-external" href=https://docs.python.org/3.12/library/stdtypes.html#str>str</a></span> <span class=o>=</span> <span class=s1>''</span><span class=p>)</span> <span class=o>-></span> <span class=n><span title=django.utils.safestring.SafeString>SafeString</span></span>
|
||||
</code></pre></div> <div class="doc doc-contents "> <p>Marks location where CSS link tags should be rendered.</p> <details class=quote> <summary>Source code in <code>src/django_components/templatetags/component_tags.py</code></summary> <div class=highlight><table class=highlighttable><tr><td class=linenos><div class=linenodiv><pre><span></span><span class=normal><a href=#__codelineno-0-99> 99</a></span>
|
||||
<span class=normal><a href=#__codelineno-0-100>100</a></span>
|
||||
<span class=normal><a href=#__codelineno-0-101>101</a></span>
|
||||
|
|
@ -2862,7 +2862,7 @@
|
|||
<a id=__codelineno-0-111 name=__codelineno-0-111></a> <span class=n>rendered_dependencies</span><span class=o>.</span><span class=n>append</span><span class=p>(</span><span class=n>component</span><span class=o>.</span><span class=n>render_css_dependencies</span><span class=p>())</span>
|
||||
<a id=__codelineno-0-112 name=__codelineno-0-112></a>
|
||||
<a id=__codelineno-0-113 name=__codelineno-0-113></a> <span class=k>return</span> <span class=n>mark_safe</span><span class=p>(</span><span class=s2>"</span><span class=se>\n</span><span class=s2>"</span><span class=o>.</span><span class=n>join</span><span class=p>(</span><span class=n>rendered_dependencies</span><span class=p>))</span>
|
||||
</code></pre></div></td></tr></table></div> </details> </div> </div> <div class="doc doc-object doc-function"> <h4 id=django_components.templatetags.component_tags.component_dependencies class="doc doc-heading"> <code class="doc-symbol doc-symbol-heading doc-symbol-function"></code> <span class="doc doc-object-name doc-function-name">component_dependencies</span> <a href=#django_components.templatetags.component_tags.component_dependencies class=headerlink title="Permanent link">¤</a></h4> <div class="doc-signature highlight"><pre><span></span><code><a id=__codelineno-0-1 name=__codelineno-0-1 href=#__codelineno-0-1></a><span class=n>component_dependencies</span><span class=p>(</span><span class=n>preload</span><span class=p>:</span> <span class=n><a class="autorefs autorefs-external" href=https://docs.python.org/3.12/library/stdtypes.html#str>str</a></span> <span class=o>=</span> <span class=s1>''</span><span class=p>)</span> <span class=o>-></span> <span class=n><a class="autorefs autorefs-external" title=django.utils.safestring.SafeString href=https://docs.djangoproject.com/en/5.0/ref/utils/#django.utils.safestring.SafeString>SafeString</a></span>
|
||||
</code></pre></div></td></tr></table></div> </details> </div> </div> <div class="doc doc-object doc-function"> <h4 id=django_components.templatetags.component_tags.component_dependencies class="doc doc-heading"> <code class="doc-symbol doc-symbol-heading doc-symbol-function"></code> <span class="doc doc-object-name doc-function-name">component_dependencies</span> <a href=#django_components.templatetags.component_tags.component_dependencies class=headerlink title="Permanent link">¤</a></h4> <div class="doc-signature highlight"><pre><span></span><code><a id=__codelineno-0-1 name=__codelineno-0-1 href=#__codelineno-0-1></a><span class=n>component_dependencies</span><span class=p>(</span><span class=n>preload</span><span class=p>:</span> <span class=n><a class="autorefs autorefs-external" href=https://docs.python.org/3.12/library/stdtypes.html#str>str</a></span> <span class=o>=</span> <span class=s1>''</span><span class=p>)</span> <span class=o>-></span> <span class=n><span title=django.utils.safestring.SafeString>SafeString</span></span>
|
||||
</code></pre></div> <div class="doc doc-contents "> <p>Marks location where CSS link and JS script tags should be rendered.</p> <details class=quote> <summary>Source code in <code>src/django_components/templatetags/component_tags.py</code></summary> <div class=highlight><table class=highlighttable><tr><td class=linenos><div class=linenodiv><pre><span></span><span class=normal><a href=#__codelineno-0-82>82</a></span>
|
||||
<span class=normal><a href=#__codelineno-0-83>83</a></span>
|
||||
<span class=normal><a href=#__codelineno-0-84>84</a></span>
|
||||
|
|
@ -2892,7 +2892,7 @@
|
|||
<a id=__codelineno-0-94 name=__codelineno-0-94></a> <span class=n>rendered_dependencies</span><span class=o>.</span><span class=n>append</span><span class=p>(</span><span class=n>component</span><span class=o>.</span><span class=n>render_dependencies</span><span class=p>())</span>
|
||||
<a id=__codelineno-0-95 name=__codelineno-0-95></a>
|
||||
<a id=__codelineno-0-96 name=__codelineno-0-96></a> <span class=k>return</span> <span class=n>mark_safe</span><span class=p>(</span><span class=s2>"</span><span class=se>\n</span><span class=s2>"</span><span class=o>.</span><span class=n>join</span><span class=p>(</span><span class=n>rendered_dependencies</span><span class=p>))</span>
|
||||
</code></pre></div></td></tr></table></div> </details> </div> </div> <div class="doc doc-object doc-function"> <h4 id=django_components.templatetags.component_tags.component_js_dependencies class="doc doc-heading"> <code class="doc-symbol doc-symbol-heading doc-symbol-function"></code> <span class="doc doc-object-name doc-function-name">component_js_dependencies</span> <a href=#django_components.templatetags.component_tags.component_js_dependencies class=headerlink title="Permanent link">¤</a></h4> <div class="doc-signature highlight"><pre><span></span><code><a id=__codelineno-0-1 name=__codelineno-0-1 href=#__codelineno-0-1></a><span class=n>component_js_dependencies</span><span class=p>(</span><span class=n>preload</span><span class=p>:</span> <span class=n><a class="autorefs autorefs-external" href=https://docs.python.org/3.12/library/stdtypes.html#str>str</a></span> <span class=o>=</span> <span class=s1>''</span><span class=p>)</span> <span class=o>-></span> <span class=n><a class="autorefs autorefs-external" title=django.utils.safestring.SafeString href=https://docs.djangoproject.com/en/5.0/ref/utils/#django.utils.safestring.SafeString>SafeString</a></span>
|
||||
</code></pre></div></td></tr></table></div> </details> </div> </div> <div class="doc doc-object doc-function"> <h4 id=django_components.templatetags.component_tags.component_js_dependencies class="doc doc-heading"> <code class="doc-symbol doc-symbol-heading doc-symbol-function"></code> <span class="doc doc-object-name doc-function-name">component_js_dependencies</span> <a href=#django_components.templatetags.component_tags.component_js_dependencies class=headerlink title="Permanent link">¤</a></h4> <div class="doc-signature highlight"><pre><span></span><code><a id=__codelineno-0-1 name=__codelineno-0-1 href=#__codelineno-0-1></a><span class=n>component_js_dependencies</span><span class=p>(</span><span class=n>preload</span><span class=p>:</span> <span class=n><a class="autorefs autorefs-external" href=https://docs.python.org/3.12/library/stdtypes.html#str>str</a></span> <span class=o>=</span> <span class=s1>''</span><span class=p>)</span> <span class=o>-></span> <span class=n><span title=django.utils.safestring.SafeString>SafeString</span></span>
|
||||
</code></pre></div> <div class="doc doc-contents "> <p>Marks location where JS script tags should be rendered.</p> <details class=quote> <summary>Source code in <code>src/django_components/templatetags/component_tags.py</code></summary> <div class=highlight><table class=highlighttable><tr><td class=linenos><div class=linenodiv><pre><span></span><span class=normal><a href=#__codelineno-0-116>116</a></span>
|
||||
<span class=normal><a href=#__codelineno-0-117>117</a></span>
|
||||
<span class=normal><a href=#__codelineno-0-118>118</a></span>
|
||||
|
|
|
|||
File diff suppressed because one or more lines are too long
|
|
@ -25,7 +25,7 @@
|
|||
<a id=__codelineno-0-23 name=__codelineno-0-23></a> <span class=bp>self</span><span class=o>.</span><span class=n>node_id</span> <span class=o>=</span> <span class=n>node_id</span> <span class=ow>or</span> <span class=n>gen_id</span><span class=p>()</span>
|
||||
<a id=__codelineno-0-24 name=__codelineno-0-24></a> <span class=bp>self</span><span class=o>.</span><span class=n>args</span> <span class=o>=</span> <span class=n>args</span> <span class=ow>or</span> <span class=p>[]</span>
|
||||
<a id=__codelineno-0-25 name=__codelineno-0-25></a> <span class=bp>self</span><span class=o>.</span><span class=n>kwargs</span> <span class=o>=</span> <span class=n>kwargs</span> <span class=ow>or</span> <span class=n>RuntimeKwargs</span><span class=p>({})</span>
|
||||
</code></pre></div></td></tr></table></div> </details> <div class="doc doc-children"> </div> </div> </div> <div class="doc doc-object doc-function"> <h2 id=django_components.node.get_node_children class="doc doc-heading"> <code class="doc-symbol doc-symbol-heading doc-symbol-function"></code> <span class="doc doc-object-name doc-function-name">get_node_children</span> <a href=#django_components.node.get_node_children class=headerlink title="Permanent link">¤</a></h2> <div class="doc-signature highlight"><pre><span></span><code><a id=__codelineno-0-1 name=__codelineno-0-1 href=#__codelineno-0-1></a><span class=n>get_node_children</span><span class=p>(</span><span class=n>node</span><span class=p>:</span> <span class=n><span title=django.template.base.Node>Node</span></span><span class=p>,</span> <span class=n>context</span><span class=p>:</span> <span class=n><a class="autorefs autorefs-external" title=typing.Optional href=https://docs.python.org/3.12/library/typing.html#typing.Optional>Optional</a></span><span class=p>[</span><span class=n><a class="autorefs autorefs-external" title=django.template.Context href=https://docs.djangoproject.com/en/5.0/ref/templates/api/#django.template.Context>Context</a></span><span class=p>]</span> <span class=o>=</span> <span class=kc>None</span><span class=p>)</span> <span class=o>-></span> <span class=n><span title=django.template.base.NodeList>NodeList</span></span>
|
||||
</code></pre></div></td></tr></table></div> </details> <div class="doc doc-children"> </div> </div> </div> <div class="doc doc-object doc-function"> <h2 id=django_components.node.get_node_children class="doc doc-heading"> <code class="doc-symbol doc-symbol-heading doc-symbol-function"></code> <span class="doc doc-object-name doc-function-name">get_node_children</span> <a href=#django_components.node.get_node_children class=headerlink title="Permanent link">¤</a></h2> <div class="doc-signature highlight"><pre><span></span><code><a id=__codelineno-0-1 name=__codelineno-0-1 href=#__codelineno-0-1></a><span class=n>get_node_children</span><span class=p>(</span><span class=n>node</span><span class=p>:</span> <span class=n><span title=django.template.base.Node>Node</span></span><span class=p>,</span> <span class=n>context</span><span class=p>:</span> <span class=n><a class="autorefs autorefs-external" title=typing.Optional href=https://docs.python.org/3.12/library/typing.html#typing.Optional>Optional</a></span><span class=p>[</span><span class=n><span title=django.template.Context>Context</span></span><span class=p>]</span> <span class=o>=</span> <span class=kc>None</span><span class=p>)</span> <span class=o>-></span> <span class=n><span title=django.template.base.NodeList>NodeList</span></span>
|
||||
</code></pre></div> <div class="doc doc-contents "> <p>Get child Nodes from Node's nodelist atribute.</p> <p>This function is taken from <code>get_nodes_by_type</code> method of <code>django.template.base.Node</code>.</p> <details class=quote> <summary>Source code in <code>src/django_components/node.py</code></summary> <div class=highlight><table class=highlighttable><tr><td class=linenos><div class=linenodiv><pre><span></span><span class=normal><a href=#__codelineno-0-59>59</a></span>
|
||||
<span class=normal><a href=#__codelineno-0-60>60</a></span>
|
||||
<span class=normal><a href=#__codelineno-0-61>61</a></span>
|
||||
|
|
@ -85,7 +85,7 @@
|
|||
<a id=__codelineno-0-86 name=__codelineno-0-86></a> <span class=k>if</span> <span class=n>nodelist</span><span class=p>:</span>
|
||||
<a id=__codelineno-0-87 name=__codelineno-0-87></a> <span class=n>nodes</span><span class=o>.</span><span class=n>extend</span><span class=p>(</span><span class=n>nodelist</span><span class=p>)</span>
|
||||
<a id=__codelineno-0-88 name=__codelineno-0-88></a> <span class=k>return</span> <span class=n>nodes</span>
|
||||
</code></pre></div></td></tr></table></div> </details> </div> </div> <div class="doc doc-object doc-function"> <h2 id=django_components.node.get_template_for_include_node class="doc doc-heading"> <code class="doc-symbol doc-symbol-heading doc-symbol-function"></code> <span class="doc doc-object-name doc-function-name">get_template_for_include_node</span> <a href=#django_components.node.get_template_for_include_node class=headerlink title="Permanent link">¤</a></h2> <div class="doc-signature highlight"><pre><span></span><code><a id=__codelineno-0-1 name=__codelineno-0-1 href=#__codelineno-0-1></a><span class=n>get_template_for_include_node</span><span class=p>(</span><span class=n>include_node</span><span class=p>:</span> <span class=n><span title=django.template.loader_tags.IncludeNode>IncludeNode</span></span><span class=p>,</span> <span class=n>context</span><span class=p>:</span> <span class=n><a class="autorefs autorefs-external" title=django.template.Context href=https://docs.djangoproject.com/en/5.0/ref/templates/api/#django.template.Context>Context</a></span><span class=p>)</span> <span class=o>-></span> <span class=n><a class="autorefs autorefs-external" title=django.template.Template href=https://docs.djangoproject.com/en/5.0/ref/templates/api/#django.template.Template>Template</a></span>
|
||||
</code></pre></div></td></tr></table></div> </details> </div> </div> <div class="doc doc-object doc-function"> <h2 id=django_components.node.get_template_for_include_node class="doc doc-heading"> <code class="doc-symbol doc-symbol-heading doc-symbol-function"></code> <span class="doc doc-object-name doc-function-name">get_template_for_include_node</span> <a href=#django_components.node.get_template_for_include_node class=headerlink title="Permanent link">¤</a></h2> <div class="doc-signature highlight"><pre><span></span><code><a id=__codelineno-0-1 name=__codelineno-0-1 href=#__codelineno-0-1></a><span class=n>get_template_for_include_node</span><span class=p>(</span><span class=n>include_node</span><span class=p>:</span> <span class=n><span title=django.template.loader_tags.IncludeNode>IncludeNode</span></span><span class=p>,</span> <span class=n>context</span><span class=p>:</span> <span class=n><span title=django.template.Context>Context</span></span><span class=p>)</span> <span class=o>-></span> <span class=n><span title=django.template.Template>Template</span></span>
|
||||
</code></pre></div> <div class="doc doc-contents "> <p>This snippet is taken directly from <code>IncludeNode.render()</code>. Unfortunately the render logic doesn't separate out template loading logic from rendering, so we have to copy the method.</p> <details class=quote> <summary>Source code in <code>src/django_components/node.py</code></summary> <div class=highlight><table class=highlighttable><tr><td class=linenos><div class=linenodiv><pre><span></span><span class=normal><a href=#__codelineno-0-91> 91</a></span>
|
||||
<span class=normal><a href=#__codelineno-0-92> 92</a></span>
|
||||
<span class=normal><a href=#__codelineno-0-93> 93</a></span>
|
||||
|
|
@ -143,7 +143,7 @@
|
|||
<a id=__codelineno-0-117 name=__codelineno-0-117></a> <span class=k>elif</span> <span class=nb>hasattr</span><span class=p>(</span><span class=n>template</span><span class=p>,</span> <span class=s2>"template"</span><span class=p>):</span>
|
||||
<a id=__codelineno-0-118 name=__codelineno-0-118></a> <span class=n>template</span> <span class=o>=</span> <span class=n>template</span><span class=o>.</span><span class=n>template</span>
|
||||
<a id=__codelineno-0-119 name=__codelineno-0-119></a> <span class=k>return</span> <span class=n>template</span>
|
||||
</code></pre></div></td></tr></table></div> </details> </div> </div> <div class="doc doc-object doc-function"> <h2 id=django_components.node.walk_nodelist class="doc doc-heading"> <code class="doc-symbol doc-symbol-heading doc-symbol-function"></code> <span class="doc doc-object-name doc-function-name">walk_nodelist</span> <a href=#django_components.node.walk_nodelist class=headerlink title="Permanent link">¤</a></h2> <div class="doc-signature highlight"><pre><span></span><code><a id=__codelineno-0-1 name=__codelineno-0-1 href=#__codelineno-0-1></a><span class=n>walk_nodelist</span><span class=p>(</span><span class=n>nodes</span><span class=p>:</span> <span class=n><span title=django.template.base.NodeList>NodeList</span></span><span class=p>,</span> <span class=n>callback</span><span class=p>:</span> <span class=n><a class="autorefs autorefs-external" title=typing.Callable href=https://docs.python.org/3.12/library/typing.html#typing.Callable>Callable</a></span><span class=p>[[</span><span class=n><span title=django.template.base.Node>Node</span></span><span class=p>],</span> <span class=n><a class="autorefs autorefs-external" title=typing.Optional href=https://docs.python.org/3.12/library/typing.html#typing.Optional>Optional</a></span><span class=p>[</span><span class=n><a class="autorefs autorefs-external" href=https://docs.python.org/3.12/library/stdtypes.html#str>str</a></span><span class=p>]],</span> <span class=n>context</span><span class=p>:</span> <span class=n><a class="autorefs autorefs-external" title=typing.Optional href=https://docs.python.org/3.12/library/typing.html#typing.Optional>Optional</a></span><span class=p>[</span><span class=n><a class="autorefs autorefs-external" title=django.template.Context href=https://docs.djangoproject.com/en/5.0/ref/templates/api/#django.template.Context>Context</a></span><span class=p>]</span> <span class=o>=</span> <span class=kc>None</span><span class=p>)</span> <span class=o>-></span> <span class=kc>None</span>
|
||||
</code></pre></div></td></tr></table></div> </details> </div> </div> <div class="doc doc-object doc-function"> <h2 id=django_components.node.walk_nodelist class="doc doc-heading"> <code class="doc-symbol doc-symbol-heading doc-symbol-function"></code> <span class="doc doc-object-name doc-function-name">walk_nodelist</span> <a href=#django_components.node.walk_nodelist class=headerlink title="Permanent link">¤</a></h2> <div class="doc-signature highlight"><pre><span></span><code><a id=__codelineno-0-1 name=__codelineno-0-1 href=#__codelineno-0-1></a><span class=n>walk_nodelist</span><span class=p>(</span><span class=n>nodes</span><span class=p>:</span> <span class=n><span title=django.template.base.NodeList>NodeList</span></span><span class=p>,</span> <span class=n>callback</span><span class=p>:</span> <span class=n><a class="autorefs autorefs-external" title=typing.Callable href=https://docs.python.org/3.12/library/typing.html#typing.Callable>Callable</a></span><span class=p>[[</span><span class=n><span title=django.template.base.Node>Node</span></span><span class=p>],</span> <span class=n><a class="autorefs autorefs-external" title=typing.Optional href=https://docs.python.org/3.12/library/typing.html#typing.Optional>Optional</a></span><span class=p>[</span><span class=n><a class="autorefs autorefs-external" href=https://docs.python.org/3.12/library/stdtypes.html#str>str</a></span><span class=p>]],</span> <span class=n>context</span><span class=p>:</span> <span class=n><a class="autorefs autorefs-external" title=typing.Optional href=https://docs.python.org/3.12/library/typing.html#typing.Optional>Optional</a></span><span class=p>[</span><span class=n><span title=django.template.Context>Context</span></span><span class=p>]</span> <span class=o>=</span> <span class=kc>None</span><span class=p>)</span> <span class=o>-></span> <span class=kc>None</span>
|
||||
</code></pre></div> <div class="doc doc-contents "> <p>Recursively walk a NodeList, calling <code>callback</code> for each Node.</p> <details class=quote> <summary>Source code in <code>src/django_components/node.py</code></summary> <div class=highlight><table class=highlighttable><tr><td class=linenos><div class=linenodiv><pre><span></span><span class=normal><a href=#__codelineno-0-44>44</a></span>
|
||||
<span class=normal><a href=#__codelineno-0-45>45</a></span>
|
||||
<span class=normal><a href=#__codelineno-0-46>46</a></span>
|
||||
|
|
|
|||
|
|
@ -81,7 +81,7 @@
|
|||
<a id=__codelineno-0-139 name=__codelineno-0-139></a> <span class=bp>self</span><span class=o>.</span><span class=n>name</span> <span class=o>=</span> <span class=n>name</span>
|
||||
<a id=__codelineno-0-140 name=__codelineno-0-140></a> <span class=bp>self</span><span class=o>.</span><span class=n>is_required</span> <span class=o>=</span> <span class=n>is_required</span>
|
||||
<a id=__codelineno-0-141 name=__codelineno-0-141></a> <span class=bp>self</span><span class=o>.</span><span class=n>is_default</span> <span class=o>=</span> <span class=n>is_default</span>
|
||||
</code></pre></div></td></tr></table></div> </details> <div class="doc doc-children"> </div> </div> </div> <div class="doc doc-object doc-class"> <h2 id=django_components.slots.SlotRef class="doc doc-heading"> <code class="doc-symbol doc-symbol-heading doc-symbol-class"></code> <span class="doc doc-object-name doc-class-name">SlotRef</span> <a href=#django_components.slots.SlotRef class=headerlink title="Permanent link">¤</a></h2> <div class="doc-signature highlight"><pre><span></span><code><a id=__codelineno-0-1 name=__codelineno-0-1 href=#__codelineno-0-1></a><span class=n>SlotRef</span><span class=p>(</span><span class=n>slot</span><span class=p>:</span> <span class=n><a class="autorefs autorefs-internal" title=django_components.slots.SlotNode href=#django_components.slots.SlotNode>SlotNode</a></span><span class=p>,</span> <span class=n>context</span><span class=p>:</span> <span class=n><a class="autorefs autorefs-external" title=django.template.Context href=https://docs.djangoproject.com/en/5.0/ref/templates/api/#django.template.Context>Context</a></span><span class=p>)</span>
|
||||
</code></pre></div></td></tr></table></div> </details> <div class="doc doc-children"> </div> </div> </div> <div class="doc doc-object doc-class"> <h2 id=django_components.slots.SlotRef class="doc doc-heading"> <code class="doc-symbol doc-symbol-heading doc-symbol-class"></code> <span class="doc doc-object-name doc-class-name">SlotRef</span> <a href=#django_components.slots.SlotRef class=headerlink title="Permanent link">¤</a></h2> <div class="doc-signature highlight"><pre><span></span><code><a id=__codelineno-0-1 name=__codelineno-0-1 href=#__codelineno-0-1></a><span class=n>SlotRef</span><span class=p>(</span><span class=n>slot</span><span class=p>:</span> <span class=n><a class="autorefs autorefs-internal" title=django_components.slots.SlotNode href=#django_components.slots.SlotNode>SlotNode</a></span><span class=p>,</span> <span class=n>context</span><span class=p>:</span> <span class=n><span title=django.template.Context>Context</span></span><span class=p>)</span>
|
||||
</code></pre></div> <div class="doc doc-contents "> <p>SlotRef allows to treat a slot as a variable. The slot is rendered only once the instance is coerced to string.</p> <p>This is used to access slots as variables inside the templates. When a SlotRef is rendered in the template with <code>{{ my_lazy_slot }}</code>, it will output the contents of the slot.</p> <details class=quote> <summary>Source code in <code>src/django_components/slots.py</code></summary> <div class=highlight><table class=highlighttable><tr><td class=linenos><div class=linenodiv><pre><span></span><span class=normal><a href=#__codelineno-0-118>118</a></span>
|
||||
<span class=normal><a href=#__codelineno-0-119>119</a></span>
|
||||
<span class=normal><a href=#__codelineno-0-120>120</a></span></pre></div></td><td class=code><div><pre><span></span><code><a id=__codelineno-0-118 name=__codelineno-0-118></a><span class=k>def</span> <span class=fm>__init__</span><span class=p>(</span><span class=bp>self</span><span class=p>,</span> <span class=n>slot</span><span class=p>:</span> <span class=s2>"SlotNode"</span><span class=p>,</span> <span class=n>context</span><span class=p>:</span> <span class=n>Context</span><span class=p>):</span>
|
||||
|
|
@ -176,8 +176,8 @@
|
|||
<a id=__codelineno-0-331 name=__codelineno-0-331></a> <span class=p>)</span>
|
||||
<a id=__codelineno-0-332 name=__codelineno-0-332></a> <span class=k>return</span> <span class=n>fill_nodes</span>
|
||||
</code></pre></div></td></tr></table></div> </details> </div> </div> <div class="doc doc-object doc-function"> <h2 id=django_components.slots.resolve_slots class="doc doc-heading"> <code class="doc-symbol doc-symbol-heading doc-symbol-function"></code> <span class="doc doc-object-name doc-function-name">resolve_slots</span> <a href=#django_components.slots.resolve_slots class=headerlink title="Permanent link">¤</a></h2> <div class="doc-signature highlight"><pre><span></span><code><a id=__codelineno-0-1 name=__codelineno-0-1 href=#__codelineno-0-1></a><span class=n>resolve_slots</span><span class=p>(</span>
|
||||
<a id=__codelineno-0-2 name=__codelineno-0-2 href=#__codelineno-0-2></a> <span class=n>context</span><span class=p>:</span> <span class=n><a class="autorefs autorefs-external" title=django.template.Context href=https://docs.djangoproject.com/en/5.0/ref/templates/api/#django.template.Context>Context</a></span><span class=p>,</span>
|
||||
<a id=__codelineno-0-3 name=__codelineno-0-3 href=#__codelineno-0-3></a> <span class=n>template</span><span class=p>:</span> <span class=n><a class="autorefs autorefs-external" title=django.template.Template href=https://docs.djangoproject.com/en/5.0/ref/templates/api/#django.template.Template>Template</a></span><span class=p>,</span>
|
||||
<a id=__codelineno-0-2 name=__codelineno-0-2 href=#__codelineno-0-2></a> <span class=n>context</span><span class=p>:</span> <span class=n><span title=django.template.Context>Context</span></span><span class=p>,</span>
|
||||
<a id=__codelineno-0-3 name=__codelineno-0-3 href=#__codelineno-0-3></a> <span class=n>template</span><span class=p>:</span> <span class=n><span title=django.template.Template>Template</span></span><span class=p>,</span>
|
||||
<a id=__codelineno-0-4 name=__codelineno-0-4 href=#__codelineno-0-4></a> <span class=n>component_name</span><span class=p>:</span> <span class=n><a class="autorefs autorefs-external" title=typing.Optional href=https://docs.python.org/3.12/library/typing.html#typing.Optional>Optional</a></span><span class=p>[</span><span class=n><a class="autorefs autorefs-external" href=https://docs.python.org/3.12/library/stdtypes.html#str>str</a></span><span class=p>],</span>
|
||||
<a id=__codelineno-0-5 name=__codelineno-0-5 href=#__codelineno-0-5></a> <span class=n>context_data</span><span class=p>:</span> <span class=n><a class="autorefs autorefs-external" title=typing.Mapping href=https://docs.python.org/3.12/library/typing.html#typing.Mapping>Mapping</a></span><span class=p>[</span><span class=n><a class="autorefs autorefs-external" href=https://docs.python.org/3.12/library/stdtypes.html#str>str</a></span><span class=p>,</span> <span class=n><a class="autorefs autorefs-external" title=typing.Any href=https://docs.python.org/3.12/library/typing.html#typing.Any>Any</a></span><span class=p>],</span>
|
||||
<a id=__codelineno-0-6 name=__codelineno-0-6 href=#__codelineno-0-6></a> <span class=n>fill_content</span><span class=p>:</span> <span class=n><a class="autorefs autorefs-external" title=typing.Dict href=https://docs.python.org/3.12/library/typing.html#typing.Dict>Dict</a></span><span class=p>[</span><span class=n><span title=django_components.slots.SlotName>SlotName</span></span><span class=p>,</span> <span class=n><a class="autorefs autorefs-internal" title=django_components.slots.FillContent href=#django_components.slots.FillContent>FillContent</a></span><span class=p>],</span>
|
||||
|
|
|
|||
File diff suppressed because one or more lines are too long
|
|
@ -114,7 +114,7 @@
|
|||
<a id=__codelineno-0-255 name=__codelineno-0-255></a>
|
||||
<a id=__codelineno-0-256 name=__codelineno-0-256></a> <span class=n>trace_msg</span><span class=p>(</span><span class=s2>"PARSE"</span><span class=p>,</span> <span class=s2>"COMP"</span><span class=p>,</span> <span class=n>result</span><span class=o>.</span><span class=n>component_name</span><span class=p>,</span> <span class=n>tag</span><span class=o>.</span><span class=n>id</span><span class=p>,</span> <span class=s2>"...Done!"</span><span class=p>)</span>
|
||||
<a id=__codelineno-0-257 name=__codelineno-0-257></a> <span class=k>return</span> <span class=n>component_node</span>
|
||||
</code></pre></div></td></tr></table></div> </details> </div> </div> <div class="doc doc-object doc-function"> <h2 id=django_components.templatetags.component_tags.component_css_dependencies class="doc doc-heading"> <code class="doc-symbol doc-symbol-heading doc-symbol-function"></code> <span class="doc doc-object-name doc-function-name">component_css_dependencies</span> <a href=#django_components.templatetags.component_tags.component_css_dependencies class=headerlink title="Permanent link">¤</a></h2> <div class="doc-signature highlight"><pre><span></span><code><a id=__codelineno-0-1 name=__codelineno-0-1 href=#__codelineno-0-1></a><span class=n>component_css_dependencies</span><span class=p>(</span><span class=n>preload</span><span class=p>:</span> <span class=n><a class="autorefs autorefs-external" href=https://docs.python.org/3.12/library/stdtypes.html#str>str</a></span> <span class=o>=</span> <span class=s1>''</span><span class=p>)</span> <span class=o>-></span> <span class=n><a class="autorefs autorefs-external" title=django.utils.safestring.SafeString href=https://docs.djangoproject.com/en/5.0/ref/utils/#django.utils.safestring.SafeString>SafeString</a></span>
|
||||
</code></pre></div></td></tr></table></div> </details> </div> </div> <div class="doc doc-object doc-function"> <h2 id=django_components.templatetags.component_tags.component_css_dependencies class="doc doc-heading"> <code class="doc-symbol doc-symbol-heading doc-symbol-function"></code> <span class="doc doc-object-name doc-function-name">component_css_dependencies</span> <a href=#django_components.templatetags.component_tags.component_css_dependencies class=headerlink title="Permanent link">¤</a></h2> <div class="doc-signature highlight"><pre><span></span><code><a id=__codelineno-0-1 name=__codelineno-0-1 href=#__codelineno-0-1></a><span class=n>component_css_dependencies</span><span class=p>(</span><span class=n>preload</span><span class=p>:</span> <span class=n><a class="autorefs autorefs-external" href=https://docs.python.org/3.12/library/stdtypes.html#str>str</a></span> <span class=o>=</span> <span class=s1>''</span><span class=p>)</span> <span class=o>-></span> <span class=n><span title=django.utils.safestring.SafeString>SafeString</span></span>
|
||||
</code></pre></div> <div class="doc doc-contents "> <p>Marks location where CSS link tags should be rendered.</p> <details class=quote> <summary>Source code in <code>src/django_components/templatetags/component_tags.py</code></summary> <div class=highlight><table class=highlighttable><tr><td class=linenos><div class=linenodiv><pre><span></span><span class=normal><a href=#__codelineno-0-99> 99</a></span>
|
||||
<span class=normal><a href=#__codelineno-0-100>100</a></span>
|
||||
<span class=normal><a href=#__codelineno-0-101>101</a></span>
|
||||
|
|
@ -144,7 +144,7 @@
|
|||
<a id=__codelineno-0-111 name=__codelineno-0-111></a> <span class=n>rendered_dependencies</span><span class=o>.</span><span class=n>append</span><span class=p>(</span><span class=n>component</span><span class=o>.</span><span class=n>render_css_dependencies</span><span class=p>())</span>
|
||||
<a id=__codelineno-0-112 name=__codelineno-0-112></a>
|
||||
<a id=__codelineno-0-113 name=__codelineno-0-113></a> <span class=k>return</span> <span class=n>mark_safe</span><span class=p>(</span><span class=s2>"</span><span class=se>\n</span><span class=s2>"</span><span class=o>.</span><span class=n>join</span><span class=p>(</span><span class=n>rendered_dependencies</span><span class=p>))</span>
|
||||
</code></pre></div></td></tr></table></div> </details> </div> </div> <div class="doc doc-object doc-function"> <h2 id=django_components.templatetags.component_tags.component_dependencies class="doc doc-heading"> <code class="doc-symbol doc-symbol-heading doc-symbol-function"></code> <span class="doc doc-object-name doc-function-name">component_dependencies</span> <a href=#django_components.templatetags.component_tags.component_dependencies class=headerlink title="Permanent link">¤</a></h2> <div class="doc-signature highlight"><pre><span></span><code><a id=__codelineno-0-1 name=__codelineno-0-1 href=#__codelineno-0-1></a><span class=n>component_dependencies</span><span class=p>(</span><span class=n>preload</span><span class=p>:</span> <span class=n><a class="autorefs autorefs-external" href=https://docs.python.org/3.12/library/stdtypes.html#str>str</a></span> <span class=o>=</span> <span class=s1>''</span><span class=p>)</span> <span class=o>-></span> <span class=n><a class="autorefs autorefs-external" title=django.utils.safestring.SafeString href=https://docs.djangoproject.com/en/5.0/ref/utils/#django.utils.safestring.SafeString>SafeString</a></span>
|
||||
</code></pre></div></td></tr></table></div> </details> </div> </div> <div class="doc doc-object doc-function"> <h2 id=django_components.templatetags.component_tags.component_dependencies class="doc doc-heading"> <code class="doc-symbol doc-symbol-heading doc-symbol-function"></code> <span class="doc doc-object-name doc-function-name">component_dependencies</span> <a href=#django_components.templatetags.component_tags.component_dependencies class=headerlink title="Permanent link">¤</a></h2> <div class="doc-signature highlight"><pre><span></span><code><a id=__codelineno-0-1 name=__codelineno-0-1 href=#__codelineno-0-1></a><span class=n>component_dependencies</span><span class=p>(</span><span class=n>preload</span><span class=p>:</span> <span class=n><a class="autorefs autorefs-external" href=https://docs.python.org/3.12/library/stdtypes.html#str>str</a></span> <span class=o>=</span> <span class=s1>''</span><span class=p>)</span> <span class=o>-></span> <span class=n><span title=django.utils.safestring.SafeString>SafeString</span></span>
|
||||
</code></pre></div> <div class="doc doc-contents "> <p>Marks location where CSS link and JS script tags should be rendered.</p> <details class=quote> <summary>Source code in <code>src/django_components/templatetags/component_tags.py</code></summary> <div class=highlight><table class=highlighttable><tr><td class=linenos><div class=linenodiv><pre><span></span><span class=normal><a href=#__codelineno-0-82>82</a></span>
|
||||
<span class=normal><a href=#__codelineno-0-83>83</a></span>
|
||||
<span class=normal><a href=#__codelineno-0-84>84</a></span>
|
||||
|
|
@ -174,7 +174,7 @@
|
|||
<a id=__codelineno-0-94 name=__codelineno-0-94></a> <span class=n>rendered_dependencies</span><span class=o>.</span><span class=n>append</span><span class=p>(</span><span class=n>component</span><span class=o>.</span><span class=n>render_dependencies</span><span class=p>())</span>
|
||||
<a id=__codelineno-0-95 name=__codelineno-0-95></a>
|
||||
<a id=__codelineno-0-96 name=__codelineno-0-96></a> <span class=k>return</span> <span class=n>mark_safe</span><span class=p>(</span><span class=s2>"</span><span class=se>\n</span><span class=s2>"</span><span class=o>.</span><span class=n>join</span><span class=p>(</span><span class=n>rendered_dependencies</span><span class=p>))</span>
|
||||
</code></pre></div></td></tr></table></div> </details> </div> </div> <div class="doc doc-object doc-function"> <h2 id=django_components.templatetags.component_tags.component_js_dependencies class="doc doc-heading"> <code class="doc-symbol doc-symbol-heading doc-symbol-function"></code> <span class="doc doc-object-name doc-function-name">component_js_dependencies</span> <a href=#django_components.templatetags.component_tags.component_js_dependencies class=headerlink title="Permanent link">¤</a></h2> <div class="doc-signature highlight"><pre><span></span><code><a id=__codelineno-0-1 name=__codelineno-0-1 href=#__codelineno-0-1></a><span class=n>component_js_dependencies</span><span class=p>(</span><span class=n>preload</span><span class=p>:</span> <span class=n><a class="autorefs autorefs-external" href=https://docs.python.org/3.12/library/stdtypes.html#str>str</a></span> <span class=o>=</span> <span class=s1>''</span><span class=p>)</span> <span class=o>-></span> <span class=n><a class="autorefs autorefs-external" title=django.utils.safestring.SafeString href=https://docs.djangoproject.com/en/5.0/ref/utils/#django.utils.safestring.SafeString>SafeString</a></span>
|
||||
</code></pre></div></td></tr></table></div> </details> </div> </div> <div class="doc doc-object doc-function"> <h2 id=django_components.templatetags.component_tags.component_js_dependencies class="doc doc-heading"> <code class="doc-symbol doc-symbol-heading doc-symbol-function"></code> <span class="doc doc-object-name doc-function-name">component_js_dependencies</span> <a href=#django_components.templatetags.component_tags.component_js_dependencies class=headerlink title="Permanent link">¤</a></h2> <div class="doc-signature highlight"><pre><span></span><code><a id=__codelineno-0-1 name=__codelineno-0-1 href=#__codelineno-0-1></a><span class=n>component_js_dependencies</span><span class=p>(</span><span class=n>preload</span><span class=p>:</span> <span class=n><a class="autorefs autorefs-external" href=https://docs.python.org/3.12/library/stdtypes.html#str>str</a></span> <span class=o>=</span> <span class=s1>''</span><span class=p>)</span> <span class=o>-></span> <span class=n><span title=django.utils.safestring.SafeString>SafeString</span></span>
|
||||
</code></pre></div> <div class="doc doc-contents "> <p>Marks location where JS script tags should be rendered.</p> <details class=quote> <summary>Source code in <code>src/django_components/templatetags/component_tags.py</code></summary> <div class=highlight><table class=highlighttable><tr><td class=linenos><div class=linenodiv><pre><span></span><span class=normal><a href=#__codelineno-0-116>116</a></span>
|
||||
<span class=normal><a href=#__codelineno-0-117>117</a></span>
|
||||
<span class=normal><a href=#__codelineno-0-118>118</a></span>
|
||||
|
|
|
|||
|
|
@ -114,7 +114,7 @@
|
|||
<a id=__codelineno-0-255 name=__codelineno-0-255></a>
|
||||
<a id=__codelineno-0-256 name=__codelineno-0-256></a> <span class=n>trace_msg</span><span class=p>(</span><span class=s2>"PARSE"</span><span class=p>,</span> <span class=s2>"COMP"</span><span class=p>,</span> <span class=n>result</span><span class=o>.</span><span class=n>component_name</span><span class=p>,</span> <span class=n>tag</span><span class=o>.</span><span class=n>id</span><span class=p>,</span> <span class=s2>"...Done!"</span><span class=p>)</span>
|
||||
<a id=__codelineno-0-257 name=__codelineno-0-257></a> <span class=k>return</span> <span class=n>component_node</span>
|
||||
</code></pre></div></td></tr></table></div> </details> </div> </div> <div class="doc doc-object doc-function"> <h3 id=django_components.templatetags.component_tags.component_css_dependencies class="doc doc-heading"> <code class="doc-symbol doc-symbol-heading doc-symbol-function"></code> <span class="doc doc-object-name doc-function-name">component_css_dependencies</span> <a href=#django_components.templatetags.component_tags.component_css_dependencies class=headerlink title="Permanent link">¤</a></h3> <div class="doc-signature highlight"><pre><span></span><code><a id=__codelineno-0-1 name=__codelineno-0-1 href=#__codelineno-0-1></a><span class=n>component_css_dependencies</span><span class=p>(</span><span class=n>preload</span><span class=p>:</span> <span class=n><a class="autorefs autorefs-external" href=https://docs.python.org/3.12/library/stdtypes.html#str>str</a></span> <span class=o>=</span> <span class=s1>''</span><span class=p>)</span> <span class=o>-></span> <span class=n><a class="autorefs autorefs-external" title=django.utils.safestring.SafeString href=https://docs.djangoproject.com/en/5.0/ref/utils/#django.utils.safestring.SafeString>SafeString</a></span>
|
||||
</code></pre></div></td></tr></table></div> </details> </div> </div> <div class="doc doc-object doc-function"> <h3 id=django_components.templatetags.component_tags.component_css_dependencies class="doc doc-heading"> <code class="doc-symbol doc-symbol-heading doc-symbol-function"></code> <span class="doc doc-object-name doc-function-name">component_css_dependencies</span> <a href=#django_components.templatetags.component_tags.component_css_dependencies class=headerlink title="Permanent link">¤</a></h3> <div class="doc-signature highlight"><pre><span></span><code><a id=__codelineno-0-1 name=__codelineno-0-1 href=#__codelineno-0-1></a><span class=n>component_css_dependencies</span><span class=p>(</span><span class=n>preload</span><span class=p>:</span> <span class=n><a class="autorefs autorefs-external" href=https://docs.python.org/3.12/library/stdtypes.html#str>str</a></span> <span class=o>=</span> <span class=s1>''</span><span class=p>)</span> <span class=o>-></span> <span class=n><span title=django.utils.safestring.SafeString>SafeString</span></span>
|
||||
</code></pre></div> <div class="doc doc-contents "> <p>Marks location where CSS link tags should be rendered.</p> <details class=quote> <summary>Source code in <code>src/django_components/templatetags/component_tags.py</code></summary> <div class=highlight><table class=highlighttable><tr><td class=linenos><div class=linenodiv><pre><span></span><span class=normal><a href=#__codelineno-0-99> 99</a></span>
|
||||
<span class=normal><a href=#__codelineno-0-100>100</a></span>
|
||||
<span class=normal><a href=#__codelineno-0-101>101</a></span>
|
||||
|
|
@ -144,7 +144,7 @@
|
|||
<a id=__codelineno-0-111 name=__codelineno-0-111></a> <span class=n>rendered_dependencies</span><span class=o>.</span><span class=n>append</span><span class=p>(</span><span class=n>component</span><span class=o>.</span><span class=n>render_css_dependencies</span><span class=p>())</span>
|
||||
<a id=__codelineno-0-112 name=__codelineno-0-112></a>
|
||||
<a id=__codelineno-0-113 name=__codelineno-0-113></a> <span class=k>return</span> <span class=n>mark_safe</span><span class=p>(</span><span class=s2>"</span><span class=se>\n</span><span class=s2>"</span><span class=o>.</span><span class=n>join</span><span class=p>(</span><span class=n>rendered_dependencies</span><span class=p>))</span>
|
||||
</code></pre></div></td></tr></table></div> </details> </div> </div> <div class="doc doc-object doc-function"> <h3 id=django_components.templatetags.component_tags.component_dependencies class="doc doc-heading"> <code class="doc-symbol doc-symbol-heading doc-symbol-function"></code> <span class="doc doc-object-name doc-function-name">component_dependencies</span> <a href=#django_components.templatetags.component_tags.component_dependencies class=headerlink title="Permanent link">¤</a></h3> <div class="doc-signature highlight"><pre><span></span><code><a id=__codelineno-0-1 name=__codelineno-0-1 href=#__codelineno-0-1></a><span class=n>component_dependencies</span><span class=p>(</span><span class=n>preload</span><span class=p>:</span> <span class=n><a class="autorefs autorefs-external" href=https://docs.python.org/3.12/library/stdtypes.html#str>str</a></span> <span class=o>=</span> <span class=s1>''</span><span class=p>)</span> <span class=o>-></span> <span class=n><a class="autorefs autorefs-external" title=django.utils.safestring.SafeString href=https://docs.djangoproject.com/en/5.0/ref/utils/#django.utils.safestring.SafeString>SafeString</a></span>
|
||||
</code></pre></div></td></tr></table></div> </details> </div> </div> <div class="doc doc-object doc-function"> <h3 id=django_components.templatetags.component_tags.component_dependencies class="doc doc-heading"> <code class="doc-symbol doc-symbol-heading doc-symbol-function"></code> <span class="doc doc-object-name doc-function-name">component_dependencies</span> <a href=#django_components.templatetags.component_tags.component_dependencies class=headerlink title="Permanent link">¤</a></h3> <div class="doc-signature highlight"><pre><span></span><code><a id=__codelineno-0-1 name=__codelineno-0-1 href=#__codelineno-0-1></a><span class=n>component_dependencies</span><span class=p>(</span><span class=n>preload</span><span class=p>:</span> <span class=n><a class="autorefs autorefs-external" href=https://docs.python.org/3.12/library/stdtypes.html#str>str</a></span> <span class=o>=</span> <span class=s1>''</span><span class=p>)</span> <span class=o>-></span> <span class=n><span title=django.utils.safestring.SafeString>SafeString</span></span>
|
||||
</code></pre></div> <div class="doc doc-contents "> <p>Marks location where CSS link and JS script tags should be rendered.</p> <details class=quote> <summary>Source code in <code>src/django_components/templatetags/component_tags.py</code></summary> <div class=highlight><table class=highlighttable><tr><td class=linenos><div class=linenodiv><pre><span></span><span class=normal><a href=#__codelineno-0-82>82</a></span>
|
||||
<span class=normal><a href=#__codelineno-0-83>83</a></span>
|
||||
<span class=normal><a href=#__codelineno-0-84>84</a></span>
|
||||
|
|
@ -174,7 +174,7 @@
|
|||
<a id=__codelineno-0-94 name=__codelineno-0-94></a> <span class=n>rendered_dependencies</span><span class=o>.</span><span class=n>append</span><span class=p>(</span><span class=n>component</span><span class=o>.</span><span class=n>render_dependencies</span><span class=p>())</span>
|
||||
<a id=__codelineno-0-95 name=__codelineno-0-95></a>
|
||||
<a id=__codelineno-0-96 name=__codelineno-0-96></a> <span class=k>return</span> <span class=n>mark_safe</span><span class=p>(</span><span class=s2>"</span><span class=se>\n</span><span class=s2>"</span><span class=o>.</span><span class=n>join</span><span class=p>(</span><span class=n>rendered_dependencies</span><span class=p>))</span>
|
||||
</code></pre></div></td></tr></table></div> </details> </div> </div> <div class="doc doc-object doc-function"> <h3 id=django_components.templatetags.component_tags.component_js_dependencies class="doc doc-heading"> <code class="doc-symbol doc-symbol-heading doc-symbol-function"></code> <span class="doc doc-object-name doc-function-name">component_js_dependencies</span> <a href=#django_components.templatetags.component_tags.component_js_dependencies class=headerlink title="Permanent link">¤</a></h3> <div class="doc-signature highlight"><pre><span></span><code><a id=__codelineno-0-1 name=__codelineno-0-1 href=#__codelineno-0-1></a><span class=n>component_js_dependencies</span><span class=p>(</span><span class=n>preload</span><span class=p>:</span> <span class=n><a class="autorefs autorefs-external" href=https://docs.python.org/3.12/library/stdtypes.html#str>str</a></span> <span class=o>=</span> <span class=s1>''</span><span class=p>)</span> <span class=o>-></span> <span class=n><a class="autorefs autorefs-external" title=django.utils.safestring.SafeString href=https://docs.djangoproject.com/en/5.0/ref/utils/#django.utils.safestring.SafeString>SafeString</a></span>
|
||||
</code></pre></div></td></tr></table></div> </details> </div> </div> <div class="doc doc-object doc-function"> <h3 id=django_components.templatetags.component_tags.component_js_dependencies class="doc doc-heading"> <code class="doc-symbol doc-symbol-heading doc-symbol-function"></code> <span class="doc doc-object-name doc-function-name">component_js_dependencies</span> <a href=#django_components.templatetags.component_tags.component_js_dependencies class=headerlink title="Permanent link">¤</a></h3> <div class="doc-signature highlight"><pre><span></span><code><a id=__codelineno-0-1 name=__codelineno-0-1 href=#__codelineno-0-1></a><span class=n>component_js_dependencies</span><span class=p>(</span><span class=n>preload</span><span class=p>:</span> <span class=n><a class="autorefs autorefs-external" href=https://docs.python.org/3.12/library/stdtypes.html#str>str</a></span> <span class=o>=</span> <span class=s1>''</span><span class=p>)</span> <span class=o>-></span> <span class=n><span title=django.utils.safestring.SafeString>SafeString</span></span>
|
||||
</code></pre></div> <div class="doc doc-contents "> <p>Marks location where JS script tags should be rendered.</p> <details class=quote> <summary>Source code in <code>src/django_components/templatetags/component_tags.py</code></summary> <div class=highlight><table class=highlighttable><tr><td class=linenos><div class=linenodiv><pre><span></span><span class=normal><a href=#__codelineno-0-116>116</a></span>
|
||||
<span class=normal><a href=#__codelineno-0-117>117</a></span>
|
||||
<span class=normal><a href=#__codelineno-0-118>118</a></span>
|
||||
|
|
|
|||
|
|
@ -2,187 +2,187 @@
|
|||
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
|
||||
<url>
|
||||
<loc>https://emilstenstrom.github.io/django-components/latest/</loc>
|
||||
<lastmod>2024-08-24</lastmod>
|
||||
<lastmod>2024-08-25</lastmod>
|
||||
<changefreq>daily</changefreq>
|
||||
</url>
|
||||
<url>
|
||||
<loc>https://emilstenstrom.github.io/django-components/latest/CHANGELOG/</loc>
|
||||
<lastmod>2024-08-24</lastmod>
|
||||
<lastmod>2024-08-25</lastmod>
|
||||
<changefreq>daily</changefreq>
|
||||
</url>
|
||||
<url>
|
||||
<loc>https://emilstenstrom.github.io/django-components/latest/CODE_OF_CONDUCT/</loc>
|
||||
<lastmod>2024-08-24</lastmod>
|
||||
<lastmod>2024-08-25</lastmod>
|
||||
<changefreq>daily</changefreq>
|
||||
</url>
|
||||
<url>
|
||||
<loc>https://emilstenstrom.github.io/django-components/latest/SUMMARY/</loc>
|
||||
<lastmod>2024-08-24</lastmod>
|
||||
<lastmod>2024-08-25</lastmod>
|
||||
<changefreq>daily</changefreq>
|
||||
</url>
|
||||
<url>
|
||||
<loc>https://emilstenstrom.github.io/django-components/latest/license/</loc>
|
||||
<lastmod>2024-08-24</lastmod>
|
||||
<lastmod>2024-08-25</lastmod>
|
||||
<changefreq>daily</changefreq>
|
||||
</url>
|
||||
<url>
|
||||
<loc>https://emilstenstrom.github.io/django-components/latest/slot_rendering/</loc>
|
||||
<lastmod>2024-08-24</lastmod>
|
||||
<lastmod>2024-08-25</lastmod>
|
||||
<changefreq>daily</changefreq>
|
||||
</url>
|
||||
<url>
|
||||
<loc>https://emilstenstrom.github.io/django-components/latest/slots_and_blocks/</loc>
|
||||
<lastmod>2024-08-24</lastmod>
|
||||
<lastmod>2024-08-25</lastmod>
|
||||
<changefreq>daily</changefreq>
|
||||
</url>
|
||||
<url>
|
||||
<loc>https://emilstenstrom.github.io/django-components/latest/reference/SUMMARY/</loc>
|
||||
<lastmod>2024-08-24</lastmod>
|
||||
<lastmod>2024-08-25</lastmod>
|
||||
<changefreq>daily</changefreq>
|
||||
</url>
|
||||
<url>
|
||||
<loc>https://emilstenstrom.github.io/django-components/latest/reference/django_components/</loc>
|
||||
<lastmod>2024-08-24</lastmod>
|
||||
<lastmod>2024-08-25</lastmod>
|
||||
<changefreq>daily</changefreq>
|
||||
</url>
|
||||
<url>
|
||||
<loc>https://emilstenstrom.github.io/django-components/latest/reference/django_components/app_settings/</loc>
|
||||
<lastmod>2024-08-24</lastmod>
|
||||
<lastmod>2024-08-25</lastmod>
|
||||
<changefreq>daily</changefreq>
|
||||
</url>
|
||||
<url>
|
||||
<loc>https://emilstenstrom.github.io/django-components/latest/reference/django_components/apps/</loc>
|
||||
<lastmod>2024-08-24</lastmod>
|
||||
<lastmod>2024-08-25</lastmod>
|
||||
<changefreq>daily</changefreq>
|
||||
</url>
|
||||
<url>
|
||||
<loc>https://emilstenstrom.github.io/django-components/latest/reference/django_components/attributes/</loc>
|
||||
<lastmod>2024-08-24</lastmod>
|
||||
<lastmod>2024-08-25</lastmod>
|
||||
<changefreq>daily</changefreq>
|
||||
</url>
|
||||
<url>
|
||||
<loc>https://emilstenstrom.github.io/django-components/latest/reference/django_components/autodiscover/</loc>
|
||||
<lastmod>2024-08-24</lastmod>
|
||||
<lastmod>2024-08-25</lastmod>
|
||||
<changefreq>daily</changefreq>
|
||||
</url>
|
||||
<url>
|
||||
<loc>https://emilstenstrom.github.io/django-components/latest/reference/django_components/component/</loc>
|
||||
<lastmod>2024-08-24</lastmod>
|
||||
<lastmod>2024-08-25</lastmod>
|
||||
<changefreq>daily</changefreq>
|
||||
</url>
|
||||
<url>
|
||||
<loc>https://emilstenstrom.github.io/django-components/latest/reference/django_components/component_media/</loc>
|
||||
<lastmod>2024-08-24</lastmod>
|
||||
<lastmod>2024-08-25</lastmod>
|
||||
<changefreq>daily</changefreq>
|
||||
</url>
|
||||
<url>
|
||||
<loc>https://emilstenstrom.github.io/django-components/latest/reference/django_components/component_registry/</loc>
|
||||
<lastmod>2024-08-24</lastmod>
|
||||
<lastmod>2024-08-25</lastmod>
|
||||
<changefreq>daily</changefreq>
|
||||
</url>
|
||||
<url>
|
||||
<loc>https://emilstenstrom.github.io/django-components/latest/reference/django_components/context/</loc>
|
||||
<lastmod>2024-08-24</lastmod>
|
||||
<lastmod>2024-08-25</lastmod>
|
||||
<changefreq>daily</changefreq>
|
||||
</url>
|
||||
<url>
|
||||
<loc>https://emilstenstrom.github.io/django-components/latest/reference/django_components/expression/</loc>
|
||||
<lastmod>2024-08-24</lastmod>
|
||||
<lastmod>2024-08-25</lastmod>
|
||||
<changefreq>daily</changefreq>
|
||||
</url>
|
||||
<url>
|
||||
<loc>https://emilstenstrom.github.io/django-components/latest/reference/django_components/library/</loc>
|
||||
<lastmod>2024-08-24</lastmod>
|
||||
<lastmod>2024-08-25</lastmod>
|
||||
<changefreq>daily</changefreq>
|
||||
</url>
|
||||
<url>
|
||||
<loc>https://emilstenstrom.github.io/django-components/latest/reference/django_components/logger/</loc>
|
||||
<lastmod>2024-08-24</lastmod>
|
||||
<lastmod>2024-08-25</lastmod>
|
||||
<changefreq>daily</changefreq>
|
||||
</url>
|
||||
<url>
|
||||
<loc>https://emilstenstrom.github.io/django-components/latest/reference/django_components/management/</loc>
|
||||
<lastmod>2024-08-24</lastmod>
|
||||
<lastmod>2024-08-25</lastmod>
|
||||
<changefreq>daily</changefreq>
|
||||
</url>
|
||||
<url>
|
||||
<loc>https://emilstenstrom.github.io/django-components/latest/reference/django_components/management/commands/</loc>
|
||||
<lastmod>2024-08-24</lastmod>
|
||||
<lastmod>2024-08-25</lastmod>
|
||||
<changefreq>daily</changefreq>
|
||||
</url>
|
||||
<url>
|
||||
<loc>https://emilstenstrom.github.io/django-components/latest/reference/django_components/management/commands/startcomponent/</loc>
|
||||
<lastmod>2024-08-24</lastmod>
|
||||
<lastmod>2024-08-25</lastmod>
|
||||
<changefreq>daily</changefreq>
|
||||
</url>
|
||||
<url>
|
||||
<loc>https://emilstenstrom.github.io/django-components/latest/reference/django_components/management/commands/upgradecomponent/</loc>
|
||||
<lastmod>2024-08-24</lastmod>
|
||||
<lastmod>2024-08-25</lastmod>
|
||||
<changefreq>daily</changefreq>
|
||||
</url>
|
||||
<url>
|
||||
<loc>https://emilstenstrom.github.io/django-components/latest/reference/django_components/middleware/</loc>
|
||||
<lastmod>2024-08-24</lastmod>
|
||||
<lastmod>2024-08-25</lastmod>
|
||||
<changefreq>daily</changefreq>
|
||||
</url>
|
||||
<url>
|
||||
<loc>https://emilstenstrom.github.io/django-components/latest/reference/django_components/node/</loc>
|
||||
<lastmod>2024-08-24</lastmod>
|
||||
<lastmod>2024-08-25</lastmod>
|
||||
<changefreq>daily</changefreq>
|
||||
</url>
|
||||
<url>
|
||||
<loc>https://emilstenstrom.github.io/django-components/latest/reference/django_components/provide/</loc>
|
||||
<lastmod>2024-08-24</lastmod>
|
||||
<lastmod>2024-08-25</lastmod>
|
||||
<changefreq>daily</changefreq>
|
||||
</url>
|
||||
<url>
|
||||
<loc>https://emilstenstrom.github.io/django-components/latest/reference/django_components/safer_staticfiles/</loc>
|
||||
<lastmod>2024-08-24</lastmod>
|
||||
<lastmod>2024-08-25</lastmod>
|
||||
<changefreq>daily</changefreq>
|
||||
</url>
|
||||
<url>
|
||||
<loc>https://emilstenstrom.github.io/django-components/latest/reference/django_components/safer_staticfiles/apps/</loc>
|
||||
<lastmod>2024-08-24</lastmod>
|
||||
<lastmod>2024-08-25</lastmod>
|
||||
<changefreq>daily</changefreq>
|
||||
</url>
|
||||
<url>
|
||||
<loc>https://emilstenstrom.github.io/django-components/latest/reference/django_components/slots/</loc>
|
||||
<lastmod>2024-08-24</lastmod>
|
||||
<lastmod>2024-08-25</lastmod>
|
||||
<changefreq>daily</changefreq>
|
||||
</url>
|
||||
<url>
|
||||
<loc>https://emilstenstrom.github.io/django-components/latest/reference/django_components/tag_formatter/</loc>
|
||||
<lastmod>2024-08-24</lastmod>
|
||||
<lastmod>2024-08-25</lastmod>
|
||||
<changefreq>daily</changefreq>
|
||||
</url>
|
||||
<url>
|
||||
<loc>https://emilstenstrom.github.io/django-components/latest/reference/django_components/template_loader/</loc>
|
||||
<lastmod>2024-08-24</lastmod>
|
||||
<lastmod>2024-08-25</lastmod>
|
||||
<changefreq>daily</changefreq>
|
||||
</url>
|
||||
<url>
|
||||
<loc>https://emilstenstrom.github.io/django-components/latest/reference/django_components/template_parser/</loc>
|
||||
<lastmod>2024-08-24</lastmod>
|
||||
<lastmod>2024-08-25</lastmod>
|
||||
<changefreq>daily</changefreq>
|
||||
</url>
|
||||
<url>
|
||||
<loc>https://emilstenstrom.github.io/django-components/latest/reference/django_components/templatetags/</loc>
|
||||
<lastmod>2024-08-24</lastmod>
|
||||
<lastmod>2024-08-25</lastmod>
|
||||
<changefreq>daily</changefreq>
|
||||
</url>
|
||||
<url>
|
||||
<loc>https://emilstenstrom.github.io/django-components/latest/reference/django_components/templatetags/component_tags/</loc>
|
||||
<lastmod>2024-08-24</lastmod>
|
||||
<lastmod>2024-08-25</lastmod>
|
||||
<changefreq>daily</changefreq>
|
||||
</url>
|
||||
<url>
|
||||
<loc>https://emilstenstrom.github.io/django-components/latest/reference/django_components/types/</loc>
|
||||
<lastmod>2024-08-24</lastmod>
|
||||
<lastmod>2024-08-25</lastmod>
|
||||
<changefreq>daily</changefreq>
|
||||
</url>
|
||||
<url>
|
||||
<loc>https://emilstenstrom.github.io/django-components/latest/reference/django_components/utils/</loc>
|
||||
<lastmod>2024-08-24</lastmod>
|
||||
<lastmod>2024-08-25</lastmod>
|
||||
<changefreq>daily</changefreq>
|
||||
</url>
|
||||
</urlset>
|
||||
Binary file not shown.
|
|
@ -6,7 +6,7 @@
|
|||
},
|
||||
{
|
||||
"version": "dev",
|
||||
"title": "dev (d6ec62c)",
|
||||
"title": "dev (a1cd97c)",
|
||||
"aliases": []
|
||||
},
|
||||
{
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue