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

Deployed 5fc27a0 to dev with MkDocs 1.6.1 and mike 2.1.3

Browse source
This commit is contained in:
github-actions 2024-11-26 21:56:17 +00:00
parent bfdc54035e
commit d7f74eb35a
4 changed files with 45 additions and 45 deletions
Download patch file Download diff file Expand all files Collapse all files

22
dev/reference/django_components/dependencies/index.html
View file

File diff suppressed because one or more lines are too long

44
dev/reference/django_components/index.html
View file

@ -5874,17 +5874,17 @@
<a id=__codelineno-0-110 name=__codelineno-0-110></a> <span class=n>internal_key</span> <span class=o>=</span> <span class=n>_INJECT_CONTEXT_KEY_PREFIX</span> <span class=o>+</span> <span class=n>key</span>
<a id=__codelineno-0-111 name=__codelineno-0-111></a> <span class=n>context</span><span class=p>[</span><span class=n>internal_key</span><span class=p>]</span> <span class=o>=</span> <span class=n>payload</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.dependencies class="doc doc-heading"> <code class="doc-symbol doc-symbol-heading doc-symbol-module"></code> <span class="doc doc-object-name doc-module-name">dependencies</span> <a href=#django_components.dependencies class=headerlink title="Permanent link">¤</a></h2> <div class="doc doc-contents "> <p>All code related to management of component dependencies (JS and CSS scripts)</p> <p><span class=doc-section-title>Modules:</span></p> <ul> <li class="doc-section-item field-body"> <b><code><a class="autorefs autorefs-internal" title=django_components.dependencies.types href=#django_components.types>types</a></code></b> – <div class=doc-md-description> <p>Helper types for IDEs.</p> </div> </li> </ul> <p><span class=doc-section-title>Classes:</span></p> <ul> <li class="doc-section-item field-body"> <b><code><a class="autorefs autorefs-internal" title=django_components.dependencies.ComponentDependencyMiddleware href=#django_components.dependencies.ComponentDependencyMiddleware>ComponentDependencyMiddleware</a></code></b> – <div class=doc-md-description> <p>Middleware that inserts CSS/JS dependencies for all rendered</p> </div> </li> </ul> <p><span class=doc-section-title>Functions:</span></p> <ul> <li class="doc-section-item field-body"> <b><code><a class="autorefs autorefs-internal" title=django_components.dependencies.render_dependencies href=#django_components.dependencies.render_dependencies>render_dependencies</a></code></b> – <div class=doc-md-description> <p>Given a string that contains parts that were rendered by components,</p> </div> </li> </ul> <div class="doc doc-children"> <div class="doc doc-object doc-class"> <h3 id=django_components.dependencies.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.dependencies.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=nf>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=typing.Callable href=https://docs.python.org/3.12/library/typing.html#typing.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> <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/dependencies.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-766>766</a></span>
<span class=normal><a href=#__codelineno-0-767>767</a></span>
<span class=normal><a href=#__codelineno-0-768>768</a></span>
<span class=normal><a href=#__codelineno-0-769>769</a></span>
<span class=normal><a href=#__codelineno-0-770>770</a></span>
<span class=normal><a href=#__codelineno-0-771>771</a></span></pre></div></td><td class=code><div><pre><span></span><code><a id=__codelineno-0-766 name=__codelineno-0-766></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>get_response</span><span class=p>:</span> <span class=s2>&quot;Callable[[HttpRequest], HttpResponse]&quot;</span><span class=p>)</span> <span class=o>-&gt;</span> <span class=kc>None</span><span class=p>:</span>
<a id=__codelineno-0-767 name=__codelineno-0-767></a> <span class=bp>self</span><span class=o>.</span><span class=n>get_response</span> <span class=o>=</span> <span class=n>get_response</span>
<a id=__codelineno-0-768 name=__codelineno-0-768></a>
<a id=__codelineno-0-769 name=__codelineno-0-769></a> <span class=c1># NOTE: Required to work with async</span>
<a id=__codelineno-0-770 name=__codelineno-0-770></a> <span class=k>if</span> <span class=n>iscoroutinefunction</span><span class=p>(</span><span class=bp>self</span><span class=o>.</span><span class=n>get_response</span><span class=p>):</span>
<a id=__codelineno-0-771 name=__codelineno-0-771></a> <span class=n>markcoroutinefunction</span><span class=p>(</span><span class=bp>self</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/dependencies.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-773>773</a></span>
<span class=normal><a href=#__codelineno-0-774>774</a></span>
<span class=normal><a href=#__codelineno-0-775>775</a></span>
<span class=normal><a href=#__codelineno-0-776>776</a></span>
<span class=normal><a href=#__codelineno-0-777>777</a></span>
<span class=normal><a href=#__codelineno-0-778>778</a></span></pre></div></td><td class=code><div><pre><span></span><code><a id=__codelineno-0-773 name=__codelineno-0-773></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>get_response</span><span class=p>:</span> <span class=s2>&quot;Callable[[HttpRequest], HttpResponse]&quot;</span><span class=p>)</span> <span class=o>-&gt;</span> <span class=kc>None</span><span class=p>:</span>
<a id=__codelineno-0-774 name=__codelineno-0-774></a> <span class=bp>self</span><span class=o>.</span><span class=n>get_response</span> <span class=o>=</span> <span class=n>get_response</span>
<a id=__codelineno-0-775 name=__codelineno-0-775></a>
<a id=__codelineno-0-776 name=__codelineno-0-776></a> <span class=c1># NOTE: Required to work with async</span>
<a id=__codelineno-0-777 name=__codelineno-0-777></a> <span class=k>if</span> <span class=n>iscoroutinefunction</span><span class=p>(</span><span class=bp>self</span><span class=o>.</span><span class=n>get_response</span><span class=p>):</span>
<a id=__codelineno-0-778 name=__codelineno-0-778></a> <span class=n>markcoroutinefunction</span><span class=p>(</span><span class=bp>self</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.dependencies.render_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">render_dependencies</span> <a href=#django_components.dependencies.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=nf>render_dependencies</span><span class=p>(</span><span class=n>content</span><span class=p>:</span> <span class=n><span title=django_components.dependencies.TContent>TContent</span></span><span class=p>,</span> <span class=nb>type</span><span class=p>:</span> <span class=n><span title=django_components.dependencies.RenderType>RenderType</span></span> <span class=o>=</span> <span class=s1>&#39;document&#39;</span><span class=p>)</span> <span class=o>-&gt;</span> <span class=n><span title=django_components.dependencies.TContent>TContent</span></span>
</code></pre></div> <div class="doc doc-contents "> <p>Given a string that contains parts that were rendered by components, this function inserts all used JS and CSS.</p> <p>By default, the string is parsed as an HTML and: - CSS is inserted at the end of <code>&lt;head&gt;</code> (if present) - JS is inserted at the end of <code>&lt;body&gt;</code> (if present)</p> <p>If you used <code>{% component_js_dependencies %}</code> or <code>{% component_css_dependencies %}</code>, then the JS and CSS will be inserted only at these locations.</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=k>def</span> <span class=nf>my_view</span><span class=p>(</span><span class=n>request</span><span class=p>):</span>
<a id=__codelineno-0-2 name=__codelineno-0-2 href=#__codelineno-0-2></a> <span class=n>template</span> <span class=o>=</span> <span class=n>Template</span><span class=p>(</span><span class=s1>&#39;&#39;&#39;</span>
@ -6409,17 +6409,17 @@
</code></pre></div> <p>This will create a new component named <code>new_component</code> in the <code>my_components</code> directory. The JavaScript, CSS, and template files will be named <code>my_script.js</code>, <code>my_style.css</code>, and <code>my_template.html</code>, respectively.</p> <h6 id=django_components.management.commands.startcomponent.Command--overwriting-an-existing-component>Overwriting an Existing Component<a class=headerlink href=#django_components.management.commands.startcomponent.Command--overwriting-an-existing-component title="Permanent link">¤</a></h6> <p>If you want to overwrite an existing component, you can use the <code>--force</code> option:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-3-1 name=__codelineno-3-1 href=#__codelineno-3-1></a>python<span class=w> </span>manage.py<span class=w> </span>startcomponent<span class=w> </span>my_component<span class=w> </span>--force
</code></pre></div> <p>This will overwrite the existing <code>my_component</code> if it exists.</p> <h6 id=django_components.management.commands.startcomponent.Command--simulating-component-creation>Simulating Component Creation<a class=headerlink href=#django_components.management.commands.startcomponent.Command--simulating-component-creation title="Permanent link">¤</a></h6> <p>If you want to simulate the creation of a component without actually creating any files, you can use the <code>--dry-run</code> option:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-4-1 name=__codelineno-4-1 href=#__codelineno-4-1></a>python<span class=w> </span>manage.py<span class=w> </span>startcomponent<span class=w> </span>my_component<span class=w> </span>--dry-run
</code></pre></div> <p>This will simulate the creation of <code>my_component</code> without creating any files.</p> <div class="doc doc-children"> </div> </div> </div> </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 "> <p><span class=doc-section-title>Classes:</span></p> <ul> <li class="doc-section-item field-body"> <b><code><a class="autorefs autorefs-internal" title=django_components.middleware.ComponentDependencyMiddleware href=#django_components.middleware.ComponentDependencyMiddleware>ComponentDependencyMiddleware</a></code></b> – <div class=doc-md-description> <p>Middleware that inserts CSS/JS dependencies for all rendered</p> </div> </li> </ul> <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=nf>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=typing.Callable href=https://docs.python.org/3.12/library/typing.html#typing.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> <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/dependencies.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-766>766</a></span>
<span class=normal><a href=#__codelineno-0-767>767</a></span>
<span class=normal><a href=#__codelineno-0-768>768</a></span>
<span class=normal><a href=#__codelineno-0-769>769</a></span>
<span class=normal><a href=#__codelineno-0-770>770</a></span>
<span class=normal><a href=#__codelineno-0-771>771</a></span></pre></div></td><td class=code><div><pre><span></span><code><a id=__codelineno-0-766 name=__codelineno-0-766></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>get_response</span><span class=p>:</span> <span class=s2>&quot;Callable[[HttpRequest], HttpResponse]&quot;</span><span class=p>)</span> <span class=o>-&gt;</span> <span class=kc>None</span><span class=p>:</span>
<a id=__codelineno-0-767 name=__codelineno-0-767></a> <span class=bp>self</span><span class=o>.</span><span class=n>get_response</span> <span class=o>=</span> <span class=n>get_response</span>
<a id=__codelineno-0-768 name=__codelineno-0-768></a>
<a id=__codelineno-0-769 name=__codelineno-0-769></a> <span class=c1># NOTE: Required to work with async</span>
<a id=__codelineno-0-770 name=__codelineno-0-770></a> <span class=k>if</span> <span class=n>iscoroutinefunction</span><span class=p>(</span><span class=bp>self</span><span class=o>.</span><span class=n>get_response</span><span class=p>):</span>
<a id=__codelineno-0-771 name=__codelineno-0-771></a> <span class=n>markcoroutinefunction</span><span class=p>(</span><span class=bp>self</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/dependencies.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-773>773</a></span>
<span class=normal><a href=#__codelineno-0-774>774</a></span>
<span class=normal><a href=#__codelineno-0-775>775</a></span>
<span class=normal><a href=#__codelineno-0-776>776</a></span>
<span class=normal><a href=#__codelineno-0-777>777</a></span>
<span class=normal><a href=#__codelineno-0-778>778</a></span></pre></div></td><td class=code><div><pre><span></span><code><a id=__codelineno-0-773 name=__codelineno-0-773></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>get_response</span><span class=p>:</span> <span class=s2>&quot;Callable[[HttpRequest], HttpResponse]&quot;</span><span class=p>)</span> <span class=o>-&gt;</span> <span class=kc>None</span><span class=p>:</span>
<a id=__codelineno-0-774 name=__codelineno-0-774></a> <span class=bp>self</span><span class=o>.</span><span class=n>get_response</span> <span class=o>=</span> <span class=n>get_response</span>
<a id=__codelineno-0-775 name=__codelineno-0-775></a>
<a id=__codelineno-0-776 name=__codelineno-0-776></a> <span class=c1># NOTE: Required to work with async</span>
<a id=__codelineno-0-777 name=__codelineno-0-777></a> <span class=k>if</span> <span class=n>iscoroutinefunction</span><span class=p>(</span><span class=bp>self</span><span class=o>.</span><span class=n>get_response</span><span class=p>):</span>
<a id=__codelineno-0-778 name=__codelineno-0-778></a> <span class=n>markcoroutinefunction</span><span class=p>(</span><span class=bp>self</span><span class=p>)</span>
</code></pre></div></td></tr></table></div> </details> <div class="doc doc-children"> </div> </div> </div> </div> </div> </div> <div class="doc doc-object doc-module"> <h2 id=django_components.node class="doc doc-heading"> <code class="doc-symbol doc-symbol-heading doc-symbol-module"></code> <span class="doc doc-object-name doc-module-name">node</span> <a href=#django_components.node class=headerlink title="Permanent link">¤</a></h2> <div class="doc doc-contents "> <p><span class=doc-section-title>Classes:</span></p> <ul> <li class="doc-section-item field-body"> <b><code><a class="autorefs autorefs-internal" title=django_components.node.BaseNode href=#django_components.node.BaseNode>BaseNode</a></code></b> – <div class=doc-md-description> <p>Shared behavior for our subclasses of Django's <code>Node</code></p> </div> </li> </ul> <div class="doc doc-children"> <div class="doc doc-object doc-class"> <h3 id=django_components.node.BaseNode class="doc doc-heading"> <code class="doc-symbol doc-symbol-heading doc-symbol-class"></code> <span class="doc doc-object-name doc-class-name">BaseNode</span> <a href=#django_components.node.BaseNode 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=nf>BaseNode</span><span class=p>(</span>
<a id=__codelineno-0-2 name=__codelineno-0-2 href=#__codelineno-0-2></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-3 name=__codelineno-0-3 href=#__codelineno-0-3></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>

22
dev/reference/django_components/middleware/index.html
View file

File diff suppressed because one or more lines are too long