mirror of
https://github.com/django-components/django-components.git
synced 2025-10-05 11:40:19 +00:00
Deployed dd6d668 to dev with MkDocs 1.6.1 and mike 2.1.3
This commit is contained in:
github-actions
parent
4f11d81445
commit
8d07637918
8 changed files with 347 additions and 347 deletions
|
|
@ -583,35 +583,35 @@
|
|||
<a id=__codelineno-0-7 name=__codelineno-0-7 href=#__codelineno-0-7></a> <span class=n>nodelist</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.base.NodeList>NodeList</span></span><span class=p>]</span> <span class=o>=</span> <span class=kc>None</span><span class=p>,</span>
|
||||
<a id=__codelineno-0-8 name=__codelineno-0-8 href=#__codelineno-0-8></a> <span class=n>node_id</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><span class=p>,</span>
|
||||
<a id=__codelineno-0-9 name=__codelineno-0-9 href=#__codelineno-0-9></a><span class=p>)</span>
|
||||
</code></pre></div> <div class="doc doc-contents "> <p class="doc doc-class-bases"> Bases: <code><a class="autorefs autorefs-internal" title=django_components.node.BaseNode href=../#django_components.node.BaseNode>BaseNode</a></code></p> <p>Django.template.Node subclass that renders a django-components 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-859>859</a></span>
|
||||
<span class=normal><a href=#__codelineno-0-860>860</a></span>
|
||||
<span class=normal><a href=#__codelineno-0-861>861</a></span>
|
||||
<span class=normal><a href=#__codelineno-0-862>862</a></span>
|
||||
<span class=normal><a href=#__codelineno-0-863>863</a></span>
|
||||
<span class=normal><a href=#__codelineno-0-864>864</a></span>
|
||||
<span class=normal><a href=#__codelineno-0-865>865</a></span>
|
||||
<span class=normal><a href=#__codelineno-0-866>866</a></span>
|
||||
<span class=normal><a href=#__codelineno-0-867>867</a></span>
|
||||
<span class=normal><a href=#__codelineno-0-868>868</a></span>
|
||||
<span class=normal><a href=#__codelineno-0-869>869</a></span>
|
||||
<span class=normal><a href=#__codelineno-0-870>870</a></span>
|
||||
<span class=normal><a href=#__codelineno-0-871>871</a></span>
|
||||
<span class=normal><a href=#__codelineno-0-872>872</a></span>
|
||||
<span class=normal><a href=#__codelineno-0-873>873</a></span></pre></div></td><td class=code><div><pre><span></span><code><a id=__codelineno-0-859 name=__codelineno-0-859></a><span class=k>def</span> <span class=fm>__init__</span><span class=p>(</span>
|
||||
<a id=__codelineno-0-860 name=__codelineno-0-860></a> <span class=bp>self</span><span class=p>,</span>
|
||||
<a id=__codelineno-0-861 name=__codelineno-0-861></a> <span class=n>name</span><span class=p>:</span> <span class=nb>str</span><span class=p>,</span>
|
||||
<a id=__codelineno-0-862 name=__codelineno-0-862></a> <span class=n>args</span><span class=p>:</span> <span class=n>List</span><span class=p>[</span><span class=n>Expression</span><span class=p>],</span>
|
||||
<a id=__codelineno-0-863 name=__codelineno-0-863></a> <span class=n>kwargs</span><span class=p>:</span> <span class=n>RuntimeKwargs</span><span class=p>,</span>
|
||||
<a id=__codelineno-0-864 name=__codelineno-0-864></a> <span class=n>registry</span><span class=p>:</span> <span class=n>ComponentRegistry</span><span class=p>,</span> <span class=c1># noqa F811</span>
|
||||
<a id=__codelineno-0-865 name=__codelineno-0-865></a> <span class=n>isolated_context</span><span class=p>:</span> <span class=nb>bool</span> <span class=o>=</span> <span class=kc>False</span><span class=p>,</span>
|
||||
<a id=__codelineno-0-866 name=__codelineno-0-866></a> <span class=n>nodelist</span><span class=p>:</span> <span class=n>Optional</span><span class=p>[</span><span class=n>NodeList</span><span class=p>]</span> <span class=o>=</span> <span class=kc>None</span><span class=p>,</span>
|
||||
<a id=__codelineno-0-867 name=__codelineno-0-867></a> <span class=n>node_id</span><span class=p>:</span> <span class=n>Optional</span><span class=p>[</span><span class=nb>str</span><span class=p>]</span> <span class=o>=</span> <span class=kc>None</span><span class=p>,</span>
|
||||
<a id=__codelineno-0-868 name=__codelineno-0-868></a><span class=p>)</span> <span class=o>-></span> <span class=kc>None</span><span class=p>:</span>
|
||||
<a id=__codelineno-0-869 name=__codelineno-0-869></a> <span class=nb>super</span><span class=p>()</span><span class=o>.</span><span class=fm>__init__</span><span class=p>(</span><span class=n>nodelist</span><span class=o>=</span><span class=n>nodelist</span> <span class=ow>or</span> <span class=n>NodeList</span><span class=p>(),</span> <span class=n>args</span><span class=o>=</span><span class=n>args</span><span class=p>,</span> <span class=n>kwargs</span><span class=o>=</span><span class=n>kwargs</span><span class=p>,</span> <span class=n>node_id</span><span class=o>=</span><span class=n>node_id</span><span class=p>)</span>
|
||||
<a id=__codelineno-0-870 name=__codelineno-0-870></a>
|
||||
<a id=__codelineno-0-871 name=__codelineno-0-871></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-872 name=__codelineno-0-872></a> <span class=bp>self</span><span class=o>.</span><span class=n>isolated_context</span> <span class=o>=</span> <span class=n>isolated_context</span>
|
||||
<a id=__codelineno-0-873 name=__codelineno-0-873></a> <span class=bp>self</span><span class=o>.</span><span class=n>registry</span> <span class=o>=</span> <span class=n>registry</span>
|
||||
</code></pre></div> <div class="doc doc-contents "> <p class="doc doc-class-bases"> Bases: <code><a class="autorefs autorefs-internal" title=django_components.node.BaseNode href=../#django_components.node.BaseNode>BaseNode</a></code></p> <p>Django.template.Node subclass that renders a django-components 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-883>883</a></span>
|
||||
<span class=normal><a href=#__codelineno-0-884>884</a></span>
|
||||
<span class=normal><a href=#__codelineno-0-885>885</a></span>
|
||||
<span class=normal><a href=#__codelineno-0-886>886</a></span>
|
||||
<span class=normal><a href=#__codelineno-0-887>887</a></span>
|
||||
<span class=normal><a href=#__codelineno-0-888>888</a></span>
|
||||
<span class=normal><a href=#__codelineno-0-889>889</a></span>
|
||||
<span class=normal><a href=#__codelineno-0-890>890</a></span>
|
||||
<span class=normal><a href=#__codelineno-0-891>891</a></span>
|
||||
<span class=normal><a href=#__codelineno-0-892>892</a></span>
|
||||
<span class=normal><a href=#__codelineno-0-893>893</a></span>
|
||||
<span class=normal><a href=#__codelineno-0-894>894</a></span>
|
||||
<span class=normal><a href=#__codelineno-0-895>895</a></span>
|
||||
<span class=normal><a href=#__codelineno-0-896>896</a></span>
|
||||
<span class=normal><a href=#__codelineno-0-897>897</a></span></pre></div></td><td class=code><div><pre><span></span><code><a id=__codelineno-0-883 name=__codelineno-0-883></a><span class=k>def</span> <span class=fm>__init__</span><span class=p>(</span>
|
||||
<a id=__codelineno-0-884 name=__codelineno-0-884></a> <span class=bp>self</span><span class=p>,</span>
|
||||
<a id=__codelineno-0-885 name=__codelineno-0-885></a> <span class=n>name</span><span class=p>:</span> <span class=nb>str</span><span class=p>,</span>
|
||||
<a id=__codelineno-0-886 name=__codelineno-0-886></a> <span class=n>args</span><span class=p>:</span> <span class=n>List</span><span class=p>[</span><span class=n>Expression</span><span class=p>],</span>
|
||||
<a id=__codelineno-0-887 name=__codelineno-0-887></a> <span class=n>kwargs</span><span class=p>:</span> <span class=n>RuntimeKwargs</span><span class=p>,</span>
|
||||
<a id=__codelineno-0-888 name=__codelineno-0-888></a> <span class=n>registry</span><span class=p>:</span> <span class=n>ComponentRegistry</span><span class=p>,</span> <span class=c1># noqa F811</span>
|
||||
<a id=__codelineno-0-889 name=__codelineno-0-889></a> <span class=n>isolated_context</span><span class=p>:</span> <span class=nb>bool</span> <span class=o>=</span> <span class=kc>False</span><span class=p>,</span>
|
||||
<a id=__codelineno-0-890 name=__codelineno-0-890></a> <span class=n>nodelist</span><span class=p>:</span> <span class=n>Optional</span><span class=p>[</span><span class=n>NodeList</span><span class=p>]</span> <span class=o>=</span> <span class=kc>None</span><span class=p>,</span>
|
||||
<a id=__codelineno-0-891 name=__codelineno-0-891></a> <span class=n>node_id</span><span class=p>:</span> <span class=n>Optional</span><span class=p>[</span><span class=nb>str</span><span class=p>]</span> <span class=o>=</span> <span class=kc>None</span><span class=p>,</span>
|
||||
<a id=__codelineno-0-892 name=__codelineno-0-892></a><span class=p>)</span> <span class=o>-></span> <span class=kc>None</span><span class=p>:</span>
|
||||
<a id=__codelineno-0-893 name=__codelineno-0-893></a> <span class=nb>super</span><span class=p>()</span><span class=o>.</span><span class=fm>__init__</span><span class=p>(</span><span class=n>nodelist</span><span class=o>=</span><span class=n>nodelist</span> <span class=ow>or</span> <span class=n>NodeList</span><span class=p>(),</span> <span class=n>args</span><span class=o>=</span><span class=n>args</span><span class=p>,</span> <span class=n>kwargs</span><span class=o>=</span><span class=n>kwargs</span><span class=p>,</span> <span class=n>node_id</span><span class=o>=</span><span class=n>node_id</span><span class=p>)</span>
|
||||
<a id=__codelineno-0-894 name=__codelineno-0-894></a>
|
||||
<a id=__codelineno-0-895 name=__codelineno-0-895></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-896 name=__codelineno-0-896></a> <span class=bp>self</span><span class=o>.</span><span class=n>isolated_context</span> <span class=o>=</span> <span class=n>isolated_context</span>
|
||||
<a id=__codelineno-0-897 name=__codelineno-0-897></a> <span class=bp>self</span><span class=o>.</span><span class=n>registry</span> <span class=o>=</span> <span class=n>registry</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.component.ComponentVars class="doc doc-heading"> <code class="doc-symbol doc-symbol-heading doc-symbol-class"></code> <span class="doc doc-object-name doc-class-name">ComponentVars</span> <a href=#django_components.component.ComponentVars class=headerlink title="Permanent link">¤</a></h2> <div class="doc doc-contents "> <p class="doc doc-class-bases"> Bases: <code><a class="autorefs autorefs-external" title=typing.NamedTuple href=https://docs.python.org/3.12/library/typing.html#typing.NamedTuple>NamedTuple</a></code></p> <p>Type for the variables available inside the component templates.</p> <p>All variables here are scoped under <code>component_vars.</code>, so e.g. attribute <code>is_filled</code> on this class is accessible inside the template as:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-0-1 name=__codelineno-0-1 href=#__codelineno-0-1></a><span class=cp>{{</span> <span class=nv>component_vars.is_filled</span> <span class=cp>}}</span>
|
||||
</code></pre></div> <p><span class=doc-section-title>Attributes:</span></p> <ul> <li class="doc-section-item field-body"> <b><code><a class="autorefs autorefs-internal" title=django_components.component.ComponentVars.is_filled href=../#django_components.component.ComponentVars.is_filled>is_filled</a></code></b> (<code><a class="autorefs autorefs-external" title=typing.Dict href=https://docs.python.org/3.12/library/typing.html#typing.Dict>Dict</a>[<a class="autorefs autorefs-external" href=https://docs.python.org/3.12/library/stdtypes.html#str>str</a>, <a class="autorefs autorefs-external" href=https://docs.python.org/3.12/library/functions.html#bool>bool</a>]</code>) – <div class=doc-md-description> <p>Dictonary describing which component slots are filled (<code>True</code>) or are not (<code>False</code>).</p> </div> </li> </ul> <div class="doc doc-children"> <div class="doc doc-object doc-attribute"> <h3 id=django_components.component.ComponentVars.is_filled class="doc doc-heading"> <code class="doc-symbol doc-symbol-heading doc-symbol-attribute"></code> <span class="doc doc-object-name doc-attribute-name">is_filled</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.ComponentVars.is_filled 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>is_filled</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" href=https://docs.python.org/3.12/library/functions.html#bool>bool</a></span><span class=p>]</span>
|
||||
</code></pre></div> <div class="doc doc-contents "> <p>Dictonary describing which component slots are filled (<code>True</code>) or are not (<code>False</code>).</p> <p><i>New in version 0.70</i></p> <p>Use as <code>{{ component_vars.is_filled }}</code></p> <p>Example:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-0-1 name=__codelineno-0-1 href=#__codelineno-0-1></a><span class=c>{# Render wrapping HTML only if the slot is defined #}</span>
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue