mirrors/django-components
1
0
Fork 0
mirror of https://github.com/django-components/django-components.git synced 2025-09-19 12:19:44 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

Deployed 93cea3d5 to dev with MkDocs 1.6.1 and mike 2.1.3

Browse source
This commit is contained in:
github-actions 2025-08-13 15:38:52 +00:00
parent 1f702da6b0
commit c588f3ea44
7 changed files with 77 additions and 77 deletions
Download patch file Download diff file Expand all files Collapse all files

4
dev/getting_started/adding_js_and_css/index.html
View file

File diff suppressed because one or more lines are too long

8
dev/reference/api/index.html
View file

@ -761,7 +761,7 @@
<a id=__codelineno-1-5 name=__codelineno-1-5 href=#__codelineno-1-5></a> <span class=k>assert</span> <span class=bp>self</span><span class=o>.</span><span class=n>kwargs</span><span class=p>[</span><span class=s2>&quot;page&quot;</span><span class=p>]</span> <span class=o>==</span> <span class=mi>123</span>
<a id=__codelineno-1-6 name=__codelineno-1-6 href=#__codelineno-1-6></a> <span class=k>assert</span> <span class=bp>self</span><span class=o>.</span><span class=n>kwargs</span><span class=p>[</span><span class=s2>&quot;per_page&quot;</span><span class=p>]</span> <span class=o>==</span> <span class=mi>10</span>
</code></pre></div> </div> </div> <div class="doc doc-object doc-attribute"> <h3 id=django_components.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-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.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-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.forms.widgets.Media>Media</span></span><span class=p>]</span> <span class=o>=</span> <span class=kc>None</span>
</code></pre></div> <div class="doc doc-contents "> <p><a href=https://github.com/django-components/django-components/tree/master/src/django_components/component.py#L1746 target=_blank>See source code</a></p> <p>Normalized definition of JS and CSS media files associated with this component. <code>None</code> if <a href=../api#django_components.Component.Media><code>Component.Media</code></a> is not defined.</p> <p>This field is generated from <a href=../api#django_components.Component.media_class><code>Component.media_class</code></a>.</p> <p>Read more on <a href=../../concepts/fundamentals/defining_js_css_html_files/#accessing-components-media-files>Accessing component's HTML / JS / CSS</a>.</p> <p><strong>Example:</strong></p> <div class=highlight><pre><span></span><code><a id=__codelineno-0-1 name=__codelineno-0-1 href=#__codelineno-0-1></a><span class=k>class</span><span class=w> </span><span class=nc>MyComponent</span><span class=p>(</span><span class=n>Component</span><span class=p>):</span>
</code></pre></div> <div class="doc doc-contents "> <p><a href=https://github.com/django-components/django-components/tree/master/src/django_components/component.py#L1746 target=_blank>See source code</a></p> <p>Normalized definition of JS and CSS media files associated with this component. <code>None</code> if <a href=../api#django_components.Component.Media><code>Component.Media</code></a> is not defined.</p> <p>This field is generated from <a href=../api#django_components.Component.media_class><code>Component.media_class</code></a>.</p> <p>Read more on <a href=../../concepts/fundamentals/secondary_js_css_files/#accessing-media-files>Accessing component's Media JS / CSS</a>.</p> <p><strong>Example:</strong></p> <div class=highlight><pre><span></span><code><a id=__codelineno-0-1 name=__codelineno-0-1 href=#__codelineno-0-1></a><span class=k>class</span><span class=w> </span><span class=nc>MyComponent</span><span class=p>(</span><span class=n>Component</span><span class=p>):</span>
<a id=__codelineno-0-2 name=__codelineno-0-2 href=#__codelineno-0-2></a> <span class=k>class</span><span class=w> </span><span class=nc>Media</span><span class=p>:</span>
<a id=__codelineno-0-3 name=__codelineno-0-3 href=#__codelineno-0-3></a> <span class=n>js</span> <span class=o>=</span> <span class=s2>&quot;path/to/script.js&quot;</span>
<a id=__codelineno-0-4 name=__codelineno-0-4 href=#__codelineno-0-4></a> <span class=n>css</span> <span class=o>=</span> <span class=s2>&quot;path/to/style.css&quot;</span>
@ -771,7 +771,7 @@
<a id=__codelineno-0-8 name=__codelineno-0-8 href=#__codelineno-0-8></a><span class=c1># &lt;script src=&quot;/static/path/to/script.js&quot;&gt;&lt;/script&gt;</span>
<a id=__codelineno-0-9 name=__codelineno-0-9 href=#__codelineno-0-9></a><span class=c1># &lt;link href=&quot;/static/path/to/style.css&quot; media=&quot;all&quot; rel=&quot;stylesheet&quot;&gt;</span>
</code></pre></div> </div> </div> <div class="doc doc-object doc-attribute"> <h3 id=django_components.Component.media_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">media_class</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.media_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>media_class</span><span class=p>:</span> <span class=n><a class="autorefs autorefs-external" title=typing.Type href=https://docs.python.org/3.12/library/typing.html#typing.Type>Type</a></span><span class=p>[</span><span class=n><span title=django.forms.widgets.Media>Media</span></span><span class=p>]</span> <span class=o>=</span> <span class=n><span title=django.forms.widgets.Media>Media</span></span>
</code></pre></div> <div class="doc doc-contents "> <p><a href=https://github.com/django-components/django-components/tree/master/src/django_components/component.py#L1770 target=_blank>See source code</a></p> <p>Set the <a href=https://docs.djangoproject.com/en/5.2/topics/forms/media/#assets-as-a-static-definition>Media class</a> that will be instantiated with the JS and CSS media files from <a href=../api#django_components.Component.Media><code>Component.Media</code></a>.</p> <p>This is useful when you want to customize the behavior of the media files, like customizing how the JS or CSS files are rendered into <code>&lt;script&gt;</code> or <code>&lt;link&gt;</code> HTML tags.</p> <p>Read more in <a href=../../concepts/fundamentals/defining_js_css_html_files/#customize-how-paths-are-rendered-into-html-tags-with-media_class>Defining HTML / JS / CSS files</a>.</p> <p><strong>Example:</strong></p> <div class=highlight><pre><span></span><code><a id=__codelineno-0-1 name=__codelineno-0-1 href=#__codelineno-0-1></a><span class=k>class</span><span class=w> </span><span class=nc>MyTable</span><span class=p>(</span><span class=n>Component</span><span class=p>):</span>
</code></pre></div> <div class="doc doc-contents "> <p><a href=https://github.com/django-components/django-components/tree/master/src/django_components/component.py#L1770 target=_blank>See source code</a></p> <p>Set the <a href=https://docs.djangoproject.com/en/5.2/topics/forms/media/#assets-as-a-static-definition>Media class</a> that will be instantiated with the JS and CSS media files from <a href=../api#django_components.Component.Media><code>Component.Media</code></a>.</p> <p>This is useful when you want to customize the behavior of the media files, like customizing how the JS or CSS files are rendered into <code>&lt;script&gt;</code> or <code>&lt;link&gt;</code> HTML tags.</p> <p>Read more in <a href=../../concepts/fundamentals/secondary_js_css_files/#media-class>Media class</a>.</p> <p><strong>Example:</strong></p> <div class=highlight><pre><span></span><code><a id=__codelineno-0-1 name=__codelineno-0-1 href=#__codelineno-0-1></a><span class=k>class</span><span class=w> </span><span class=nc>MyTable</span><span class=p>(</span><span class=n>Component</span><span class=p>):</span>
<a id=__codelineno-0-2 name=__codelineno-0-2 href=#__codelineno-0-2></a> <span class=k>class</span><span class=w> </span><span class=nc>Media</span><span class=p>:</span>
<a id=__codelineno-0-3 name=__codelineno-0-3 href=#__codelineno-0-3></a> <span class=n>js</span> <span class=o>=</span> <span class=s2>&quot;path/to/script.js&quot;</span>
<a id=__codelineno-0-4 name=__codelineno-0-4 href=#__codelineno-0-4></a> <span class=n>css</span> <span class=o>=</span> <span class=s2>&quot;path/to/style.css&quot;</span>
@ -2579,7 +2579,7 @@
</code></pre></div> <div class="doc doc-contents "> <p><a href=https://github.com/django-components/django-components/tree/master/src/django_components/app_settings.py#L238 target=_blank>See source code</a></p> <p>Specify the app-level directories that contain your components.</p> <p>Defaults to <code>["components"]</code>. That is, for each Django app, we search <code>&lt;app&gt;/components/</code> for components.</p> <p>The paths must be relative to app, e.g.:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-0-1 name=__codelineno-0-1 href=#__codelineno-0-1></a><span class=n>COMPONENTS</span> <span class=o>=</span> <span class=n>ComponentsSettings</span><span class=p>(</span>
<a id=__codelineno-0-2 name=__codelineno-0-2 href=#__codelineno-0-2></a> <span class=n>app_dirs</span><span class=o>=</span><span class=p>[</span><span class=s2>&quot;my_comps&quot;</span><span class=p>],</span>
<a id=__codelineno-0-3 name=__codelineno-0-3 href=#__codelineno-0-3></a><span class=p>)</span>
</code></pre></div> <p>To search for <code>&lt;app&gt;/my_comps/</code>.</p> <p>These locations are searched during <a href=../../concepts/fundamentals/autodiscovery>autodiscovery</a>, or when you <a href=../../concepts/fundamentals/defining_js_css_html_files>define HTML, JS, or CSS as separate files</a>.</p> <p>Set to empty list to disable app-level components:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-1-1 name=__codelineno-1-1 href=#__codelineno-1-1></a><span class=n>COMPONENTS</span> <span class=o>=</span> <span class=n>ComponentsSettings</span><span class=p>(</span>
</code></pre></div> <p>To search for <code>&lt;app&gt;/my_comps/</code>.</p> <p>These locations are searched during <a href=../../concepts/fundamentals/autodiscovery>autodiscovery</a>, or when you <a href=../../concepts/fundamentals/html_js_css_files>define HTML, JS, or CSS as separate files</a>.</p> <p>Set to empty list to disable app-level components:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-1-1 name=__codelineno-1-1 href=#__codelineno-1-1></a><span class=n>COMPONENTS</span> <span class=o>=</span> <span class=n>ComponentsSettings</span><span class=p>(</span>
<a id=__codelineno-1-2 name=__codelineno-1-2 href=#__codelineno-1-2></a> <span class=n>app_dirs</span><span class=o>=</span><span class=p>[],</span>
<a id=__codelineno-1-3 name=__codelineno-1-3 href=#__codelineno-1-3></a><span class=p>)</span>
</code></pre></div> </div> </div> <div class="doc doc-object doc-attribute"> <h3 id=django_components.ComponentsSettings.autodiscover class="doc doc-heading"> <code class="doc-symbol doc-symbol-heading doc-symbol-attribute"></code> <span class="doc doc-object-name doc-attribute-name">autodiscover</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.ComponentsSettings.autodiscover 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>autodiscover</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/functions.html#bool>bool</a></span><span class=p>]</span> <span class=o>=</span> <span class=kc>None</span>
@ -2603,7 +2603,7 @@
<a id=__codelineno-0-2 name=__codelineno-0-2 href=#__codelineno-0-2></a> <span class=n>debug_highlight_slots</span><span class=o>=</span><span class=kc>True</span><span class=p>,</span>
<a id=__codelineno-0-3 name=__codelineno-0-3 href=#__codelineno-0-3></a><span class=p>)</span>
</code></pre></div> </div> </div> <div class="doc doc-object doc-attribute"> <h3 id=django_components.ComponentsSettings.dirs class="doc doc-heading"> <code class="doc-symbol doc-symbol-heading doc-symbol-attribute"></code> <span class="doc doc-object-name doc-attribute-name">dirs</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.ComponentsSettings.dirs 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>dirs</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.Sequence href=https://docs.python.org/3.12/library/typing.html#typing.Sequence>Sequence</a></span><span class=p>[</span><span class=n><a class="autorefs autorefs-external" title=typing.Union href=https://docs.python.org/3.12/library/typing.html#typing.Union>Union</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=os.PathLike href=https://docs.python.org/3.12/library/os.html#os.PathLike>PathLike</a></span><span class=p>,</span> <span class=n><a class="autorefs autorefs-external" title=typing.Tuple href=https://docs.python.org/3.12/library/typing.html#typing.Tuple>Tuple</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/stdtypes.html#str>str</a></span><span class=p>],</span> <span class=n><a class="autorefs autorefs-external" title=typing.Tuple href=https://docs.python.org/3.12/library/typing.html#typing.Tuple>Tuple</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=os.PathLike href=https://docs.python.org/3.12/library/os.html#os.PathLike>PathLike</a></span><span class=p>]]]]</span> <span class=o>=</span> <span class=kc>None</span>
</code></pre></div> <div class="doc doc-contents "> <p><a href=https://github.com/django-components/django-components/tree/master/src/django_components/app_settings.py#L211 target=_blank>See source code</a></p> <p>Specify the directories that contain your components.</p> <p>Defaults to <code>[Path(settings.BASE_DIR) / "components"]</code>. That is, the root <code>components/</code> app.</p> <p>Directories must be full paths, same as with <a href=https://docs.djangoproject.com/en/5.2/ref/settings/#std-setting-STATICFILES_DIRS>STATICFILES_DIRS</a>.</p> <p>These locations are searched during <a href=../../concepts/fundamentals/autodiscovery>autodiscovery</a>, or when you <a href=../../concepts/fundamentals/defining_js_css_html_files>define HTML, JS, or CSS as separate files</a>.</p> <div class=highlight><pre><span></span><code><a id=__codelineno-0-1 name=__codelineno-0-1 href=#__codelineno-0-1></a><span class=n>COMPONENTS</span> <span class=o>=</span> <span class=n>ComponentsSettings</span><span class=p>(</span>
</code></pre></div> <div class="doc doc-contents "> <p><a href=https://github.com/django-components/django-components/tree/master/src/django_components/app_settings.py#L211 target=_blank>See source code</a></p> <p>Specify the directories that contain your components.</p> <p>Defaults to <code>[Path(settings.BASE_DIR) / "components"]</code>. That is, the root <code>components/</code> app.</p> <p>Directories must be full paths, same as with <a href=https://docs.djangoproject.com/en/5.2/ref/settings/#std-setting-STATICFILES_DIRS>STATICFILES_DIRS</a>.</p> <p>These locations are searched during <a href=../../concepts/fundamentals/autodiscovery>autodiscovery</a>, or when you <a href=../../concepts/fundamentals/html_js_css_files>define HTML, JS, or CSS as separate files</a>.</p> <div class=highlight><pre><span></span><code><a id=__codelineno-0-1 name=__codelineno-0-1 href=#__codelineno-0-1></a><span class=n>COMPONENTS</span> <span class=o>=</span> <span class=n>ComponentsSettings</span><span class=p>(</span>
<a id=__codelineno-0-2 name=__codelineno-0-2 href=#__codelineno-0-2></a> <span class=n>dirs</span><span class=o>=</span><span class=p>[</span><span class=n>BASE_DIR</span> <span class=o>/</span> <span class=s2>&quot;components&quot;</span><span class=p>],</span>
<a id=__codelineno-0-3 name=__codelineno-0-3 href=#__codelineno-0-3></a><span class=p>)</span>
</code></pre></div> <p>Set to empty list to disable global components directories:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-1-1 name=__codelineno-1-1 href=#__codelineno-1-1></a><span class=n>COMPONENTS</span> <span class=o>=</span> <span class=n>ComponentsSettings</span><span class=p>(</span>

4
dev/reference/settings/index.html
View file

@ -51,7 +51,7 @@
</code></pre></div> <div class="doc doc-contents first"> <p><a href=https://github.com/django-components/django-components/tree/master/src/django_components/app_settings.py#L238 target=_blank>See source code</a></p> <p>Specify the app-level directories that contain your components.</p> <p>Defaults to <code>["components"]</code>. That is, for each Django app, we search <code>&lt;app&gt;/components/</code> for components.</p> <p>The paths must be relative to app, e.g.:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-0-1 name=__codelineno-0-1 href=#__codelineno-0-1></a><span class=n>COMPONENTS</span> <span class=o>=</span> <span class=n>ComponentsSettings</span><span class=p>(</span>
<a id=__codelineno-0-2 name=__codelineno-0-2 href=#__codelineno-0-2></a> <span class=n>app_dirs</span><span class=o>=</span><span class=p>[</span><span class=s2>&quot;my_comps&quot;</span><span class=p>],</span>
<a id=__codelineno-0-3 name=__codelineno-0-3 href=#__codelineno-0-3></a><span class=p>)</span>
</code></pre></div> <p>To search for <code>&lt;app&gt;/my_comps/</code>.</p> <p>These locations are searched during <a href=../../concepts/fundamentals/autodiscovery>autodiscovery</a>, or when you <a href=../../concepts/fundamentals/defining_js_css_html_files>define HTML, JS, or CSS as separate files</a>.</p> <p>Set to empty list to disable app-level components:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-1-1 name=__codelineno-1-1 href=#__codelineno-1-1></a><span class=n>COMPONENTS</span> <span class=o>=</span> <span class=n>ComponentsSettings</span><span class=p>(</span>
</code></pre></div> <p>To search for <code>&lt;app&gt;/my_comps/</code>.</p> <p>These locations are searched during <a href=../../concepts/fundamentals/autodiscovery>autodiscovery</a>, or when you <a href=../../concepts/fundamentals/html_js_css_files>define HTML, JS, or CSS as separate files</a>.</p> <p>Set to empty list to disable app-level components:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-1-1 name=__codelineno-1-1 href=#__codelineno-1-1></a><span class=n>COMPONENTS</span> <span class=o>=</span> <span class=n>ComponentsSettings</span><span class=p>(</span>
<a id=__codelineno-1-2 name=__codelineno-1-2 href=#__codelineno-1-2></a> <span class=n>app_dirs</span><span class=o>=</span><span class=p>[],</span>
<a id=__codelineno-1-3 name=__codelineno-1-3 href=#__codelineno-1-3></a><span class=p>)</span>
</code></pre></div> </div> </div> <div class="doc doc-object doc-attribute"> <h2 id=django_components.app_settings.ComponentsSettings.autodiscover class="doc doc-heading"> <span class="doc doc-object-name doc-attribute-name">autodiscover</span> <a href=#django_components.app_settings.ComponentsSettings.autodiscover 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>autodiscover</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/functions.html#bool>bool</a></span><span class=p>]</span> <span class=o>=</span> <span class=kc>None</span>
@ -75,7 +75,7 @@
<a id=__codelineno-0-2 name=__codelineno-0-2 href=#__codelineno-0-2></a> <span class=n>debug_highlight_slots</span><span class=o>=</span><span class=kc>True</span><span class=p>,</span>
<a id=__codelineno-0-3 name=__codelineno-0-3 href=#__codelineno-0-3></a><span class=p>)</span>
</code></pre></div> </div> </div> <div class="doc doc-object doc-attribute"> <h2 id=django_components.app_settings.ComponentsSettings.dirs class="doc doc-heading"> <span class="doc doc-object-name doc-attribute-name">dirs</span> <a href=#django_components.app_settings.ComponentsSettings.dirs 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>dirs</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.Sequence href=https://docs.python.org/3.12/library/typing.html#typing.Sequence>Sequence</a></span><span class=p>[</span><span class=n><a class="autorefs autorefs-external" title=typing.Union href=https://docs.python.org/3.12/library/typing.html#typing.Union>Union</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=os.PathLike href=https://docs.python.org/3.12/library/os.html#os.PathLike>PathLike</a></span><span class=p>,</span> <span class=n><a class="autorefs autorefs-external" title=typing.Tuple href=https://docs.python.org/3.12/library/typing.html#typing.Tuple>Tuple</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/stdtypes.html#str>str</a></span><span class=p>],</span> <span class=n><a class="autorefs autorefs-external" title=typing.Tuple href=https://docs.python.org/3.12/library/typing.html#typing.Tuple>Tuple</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=os.PathLike href=https://docs.python.org/3.12/library/os.html#os.PathLike>PathLike</a></span><span class=p>]]]]</span> <span class=o>=</span> <span class=kc>None</span>
</code></pre></div> <div class="doc doc-contents first"> <p><a href=https://github.com/django-components/django-components/tree/master/src/django_components/app_settings.py#L211 target=_blank>See source code</a></p> <p>Specify the directories that contain your components.</p> <p>Defaults to <code>[Path(settings.BASE_DIR) / "components"]</code>. That is, the root <code>components/</code> app.</p> <p>Directories must be full paths, same as with <a href=https://docs.djangoproject.com/en/5.2/ref/settings/#std-setting-STATICFILES_DIRS>STATICFILES_DIRS</a>.</p> <p>These locations are searched during <a href=../../concepts/fundamentals/autodiscovery>autodiscovery</a>, or when you <a href=../../concepts/fundamentals/defining_js_css_html_files>define HTML, JS, or CSS as separate files</a>.</p> <div class=highlight><pre><span></span><code><a id=__codelineno-0-1 name=__codelineno-0-1 href=#__codelineno-0-1></a><span class=n>COMPONENTS</span> <span class=o>=</span> <span class=n>ComponentsSettings</span><span class=p>(</span>
</code></pre></div> <div class="doc doc-contents first"> <p><a href=https://github.com/django-components/django-components/tree/master/src/django_components/app_settings.py#L211 target=_blank>See source code</a></p> <p>Specify the directories that contain your components.</p> <p>Defaults to <code>[Path(settings.BASE_DIR) / "components"]</code>. That is, the root <code>components/</code> app.</p> <p>Directories must be full paths, same as with <a href=https://docs.djangoproject.com/en/5.2/ref/settings/#std-setting-STATICFILES_DIRS>STATICFILES_DIRS</a>.</p> <p>These locations are searched during <a href=../../concepts/fundamentals/autodiscovery>autodiscovery</a>, or when you <a href=../../concepts/fundamentals/html_js_css_files>define HTML, JS, or CSS as separate files</a>.</p> <div class=highlight><pre><span></span><code><a id=__codelineno-0-1 name=__codelineno-0-1 href=#__codelineno-0-1></a><span class=n>COMPONENTS</span> <span class=o>=</span> <span class=n>ComponentsSettings</span><span class=p>(</span>
<a id=__codelineno-0-2 name=__codelineno-0-2 href=#__codelineno-0-2></a> <span class=n>dirs</span><span class=o>=</span><span class=p>[</span><span class=n>BASE_DIR</span> <span class=o>/</span> <span class=s2>&quot;components&quot;</span><span class=p>],</span>
<a id=__codelineno-0-3 name=__codelineno-0-3 href=#__codelineno-0-3></a><span class=p>)</span>
</code></pre></div> <p>Set to empty list to disable global components directories:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-1-1 name=__codelineno-1-1 href=#__codelineno-1-1></a><span class=n>COMPONENTS</span> <span class=o>=</span> <span class=n>ComponentsSettings</span><span class=p>(</span>

2
dev/search/search_index.json
View file

File diff suppressed because one or more lines are too long

134
dev/sitemap.xml
View file

@ -2,270 +2,270 @@
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
<url>
<loc>https://django-components.github.io/django-components/latest/</loc>
<lastmod>2025-08-05</lastmod>
<lastmod>2025-08-13</lastmod>
</url>
<url>
<loc>https://django-components.github.io/django-components/latest/migrating_from_safer_staticfiles/</loc>
<lastmod>2025-08-05</lastmod>
<lastmod>2025-08-13</lastmod>
</url>
<url>
<loc>https://django-components.github.io/django-components/latest/release_notes/</loc>
<lastmod>2025-08-05</lastmod>
<lastmod>2025-08-13</lastmod>
</url>
<url>
<loc>https://django-components.github.io/django-components/latest/concepts/advanced/component_caching/</loc>
<lastmod>2025-08-05</lastmod>
<lastmod>2025-08-13</lastmod>
</url>
<url>
<loc>https://django-components.github.io/django-components/latest/concepts/advanced/component_context_scope/</loc>
<lastmod>2025-08-05</lastmod>
<lastmod>2025-08-13</lastmod>
</url>
<url>
<loc>https://django-components.github.io/django-components/latest/concepts/advanced/component_libraries/</loc>
<lastmod>2025-08-05</lastmod>
<lastmod>2025-08-13</lastmod>
</url>
<url>
<loc>https://django-components.github.io/django-components/latest/concepts/advanced/component_registry/</loc>
<lastmod>2025-08-05</lastmod>
<lastmod>2025-08-13</lastmod>
</url>
<url>
<loc>https://django-components.github.io/django-components/latest/concepts/advanced/extensions/</loc>
<lastmod>2025-08-05</lastmod>
<lastmod>2025-08-13</lastmod>
</url>
<url>
<loc>https://django-components.github.io/django-components/latest/concepts/advanced/hooks/</loc>
<lastmod>2025-08-05</lastmod>
<lastmod>2025-08-13</lastmod>
</url>
<url>
<loc>https://django-components.github.io/django-components/latest/concepts/advanced/html_fragments/</loc>
<lastmod>2025-08-05</lastmod>
<lastmod>2025-08-13</lastmod>
</url>
<url>
<loc>https://django-components.github.io/django-components/latest/concepts/advanced/provide_inject/</loc>
<lastmod>2025-08-05</lastmod>
<lastmod>2025-08-13</lastmod>
</url>
<url>
<loc>https://django-components.github.io/django-components/latest/concepts/advanced/rendering_js_css/</loc>
<lastmod>2025-08-05</lastmod>
<lastmod>2025-08-13</lastmod>
</url>
<url>
<loc>https://django-components.github.io/django-components/latest/concepts/advanced/tag_formatters/</loc>
<lastmod>2025-08-05</lastmod>
<lastmod>2025-08-13</lastmod>
</url>
<url>
<loc>https://django-components.github.io/django-components/latest/concepts/advanced/template_tags/</loc>
<lastmod>2025-08-05</lastmod>
<lastmod>2025-08-13</lastmod>
</url>
<url>
<loc>https://django-components.github.io/django-components/latest/concepts/advanced/testing/</loc>
<lastmod>2025-08-05</lastmod>
<lastmod>2025-08-13</lastmod>
</url>
<url>
<loc>https://django-components.github.io/django-components/latest/concepts/fundamentals/autodiscovery/</loc>
<lastmod>2025-08-05</lastmod>
<lastmod>2025-08-13</lastmod>
</url>
<url>
<loc>https://django-components.github.io/django-components/latest/concepts/fundamentals/component_defaults/</loc>
<lastmod>2025-08-05</lastmod>
<lastmod>2025-08-13</lastmod>
</url>
<url>
<loc>https://django-components.github.io/django-components/latest/concepts/fundamentals/component_views_urls/</loc>
<lastmod>2025-08-05</lastmod>
<lastmod>2025-08-13</lastmod>
</url>
<url>
<loc>https://django-components.github.io/django-components/latest/concepts/fundamentals/html_attributes/</loc>
<lastmod>2025-08-05</lastmod>
<lastmod>2025-08-13</lastmod>
</url>
<url>
<loc>https://django-components.github.io/django-components/latest/concepts/fundamentals/html_js_css_files/</loc>
<lastmod>2025-08-05</lastmod>
<lastmod>2025-08-13</lastmod>
</url>
<url>
<loc>https://django-components.github.io/django-components/latest/concepts/fundamentals/html_js_css_variables/</loc>
<lastmod>2025-08-05</lastmod>
<lastmod>2025-08-13</lastmod>
</url>
<url>
<loc>https://django-components.github.io/django-components/latest/concepts/fundamentals/http_request/</loc>
<lastmod>2025-08-05</lastmod>
<lastmod>2025-08-13</lastmod>
</url>
<url>
<loc>https://django-components.github.io/django-components/latest/concepts/fundamentals/render_api/</loc>
<lastmod>2025-08-05</lastmod>
<lastmod>2025-08-13</lastmod>
</url>
<url>
<loc>https://django-components.github.io/django-components/latest/concepts/fundamentals/rendering_components/</loc>
<lastmod>2025-08-05</lastmod>
<lastmod>2025-08-13</lastmod>
</url>
<url>
<loc>https://django-components.github.io/django-components/latest/concepts/fundamentals/secondary_js_css_files/</loc>
<lastmod>2025-08-05</lastmod>
<lastmod>2025-08-13</lastmod>
</url>
<url>
<loc>https://django-components.github.io/django-components/latest/concepts/fundamentals/single_file_components/</loc>
<lastmod>2025-08-05</lastmod>
<lastmod>2025-08-13</lastmod>
</url>
<url>
<loc>https://django-components.github.io/django-components/latest/concepts/fundamentals/slots/</loc>
<lastmod>2025-08-05</lastmod>
<lastmod>2025-08-13</lastmod>
</url>
<url>
<loc>https://django-components.github.io/django-components/latest/concepts/fundamentals/subclassing_components/</loc>
<lastmod>2025-08-05</lastmod>
<lastmod>2025-08-13</lastmod>
</url>
<url>
<loc>https://django-components.github.io/django-components/latest/concepts/fundamentals/template_tag_syntax/</loc>
<lastmod>2025-08-05</lastmod>
<lastmod>2025-08-13</lastmod>
</url>
<url>
<loc>https://django-components.github.io/django-components/latest/concepts/fundamentals/typing_and_validation/</loc>
<lastmod>2025-08-05</lastmod>
<lastmod>2025-08-13</lastmod>
</url>
<url>
<loc>https://django-components.github.io/django-components/latest/getting_started/adding_js_and_css/</loc>
<lastmod>2025-08-05</lastmod>
<lastmod>2025-08-13</lastmod>
</url>
<url>
<loc>https://django-components.github.io/django-components/latest/getting_started/adding_slots/</loc>
<lastmod>2025-08-05</lastmod>
<lastmod>2025-08-13</lastmod>
</url>
<url>
<loc>https://django-components.github.io/django-components/latest/getting_started/components_in_templates/</loc>
<lastmod>2025-08-05</lastmod>
<lastmod>2025-08-13</lastmod>
</url>
<url>
<loc>https://django-components.github.io/django-components/latest/getting_started/parametrising_components/</loc>
<lastmod>2025-08-05</lastmod>
<lastmod>2025-08-13</lastmod>
</url>
<url>
<loc>https://django-components.github.io/django-components/latest/getting_started/rendering_components/</loc>
<lastmod>2025-08-05</lastmod>
<lastmod>2025-08-13</lastmod>
</url>
<url>
<loc>https://django-components.github.io/django-components/latest/getting_started/your_first_component/</loc>
<lastmod>2025-08-05</lastmod>
<lastmod>2025-08-13</lastmod>
</url>
<url>
<loc>https://django-components.github.io/django-components/latest/guides/devguides/dependency_mgmt/</loc>
<lastmod>2025-08-05</lastmod>
<lastmod>2025-08-13</lastmod>
</url>
<url>
<loc>https://django-components.github.io/django-components/latest/guides/devguides/slot_rendering/</loc>
<lastmod>2025-08-05</lastmod>
<lastmod>2025-08-13</lastmod>
</url>
<url>
<loc>https://django-components.github.io/django-components/latest/guides/devguides/slots_and_blocks/</loc>
<lastmod>2025-08-05</lastmod>
<lastmod>2025-08-13</lastmod>
</url>
<url>
<loc>https://django-components.github.io/django-components/latest/guides/other/troubleshooting/</loc>
<lastmod>2025-08-05</lastmod>
<lastmod>2025-08-13</lastmod>
</url>
<url>
<loc>https://django-components.github.io/django-components/latest/guides/setup/caching/</loc>
<lastmod>2025-08-05</lastmod>
<lastmod>2025-08-13</lastmod>
</url>
<url>
<loc>https://django-components.github.io/django-components/latest/guides/setup/development_server/</loc>
<lastmod>2025-08-05</lastmod>
<lastmod>2025-08-13</lastmod>
</url>
<url>
<loc>https://django-components.github.io/django-components/latest/overview/code_of_conduct/</loc>
<lastmod>2025-08-05</lastmod>
<lastmod>2025-08-13</lastmod>
</url>
<url>
<loc>https://django-components.github.io/django-components/latest/overview/community/</loc>
<lastmod>2025-08-05</lastmod>
<lastmod>2025-08-13</lastmod>
</url>
<url>
<loc>https://django-components.github.io/django-components/latest/overview/compatibility/</loc>
<lastmod>2025-08-05</lastmod>
<lastmod>2025-08-13</lastmod>
</url>
<url>
<loc>https://django-components.github.io/django-components/latest/overview/contributing/</loc>
<lastmod>2025-08-05</lastmod>
<lastmod>2025-08-13</lastmod>
</url>
<url>
<loc>https://django-components.github.io/django-components/latest/overview/development/</loc>
<lastmod>2025-08-05</lastmod>
<lastmod>2025-08-13</lastmod>
</url>
<url>
<loc>https://django-components.github.io/django-components/latest/overview/installation/</loc>
<lastmod>2025-08-05</lastmod>
<lastmod>2025-08-13</lastmod>
</url>
<url>
<loc>https://django-components.github.io/django-components/latest/overview/license/</loc>
<lastmod>2025-08-05</lastmod>
<lastmod>2025-08-13</lastmod>
</url>
<url>
<loc>https://django-components.github.io/django-components/latest/overview/migrating/</loc>
<lastmod>2025-08-05</lastmod>
<lastmod>2025-08-13</lastmod>
</url>
<url>
<loc>https://django-components.github.io/django-components/latest/overview/performance/</loc>
<lastmod>2025-08-05</lastmod>
<lastmod>2025-08-13</lastmod>
</url>
<url>
<loc>https://django-components.github.io/django-components/latest/overview/security_notes/</loc>
<lastmod>2025-08-05</lastmod>
<lastmod>2025-08-13</lastmod>
</url>
<url>
<loc>https://django-components.github.io/django-components/latest/overview/welcome/</loc>
<lastmod>2025-08-05</lastmod>
<lastmod>2025-08-13</lastmod>
</url>
<url>
<loc>https://django-components.github.io/django-components/latest/reference/api/</loc>
<lastmod>2025-08-05</lastmod>
<lastmod>2025-08-13</lastmod>
</url>
<url>
<loc>https://django-components.github.io/django-components/latest/reference/commands/</loc>
<lastmod>2025-08-05</lastmod>
<lastmod>2025-08-13</lastmod>
</url>
<url>
<loc>https://django-components.github.io/django-components/latest/reference/components/</loc>
<lastmod>2025-08-05</lastmod>
<lastmod>2025-08-13</lastmod>
</url>
<url>
<loc>https://django-components.github.io/django-components/latest/reference/exceptions/</loc>
<lastmod>2025-08-05</lastmod>
<lastmod>2025-08-13</lastmod>
</url>
<url>
<loc>https://django-components.github.io/django-components/latest/reference/extension_commands/</loc>
<lastmod>2025-08-05</lastmod>
<lastmod>2025-08-13</lastmod>
</url>
<url>
<loc>https://django-components.github.io/django-components/latest/reference/extension_hooks/</loc>
<lastmod>2025-08-05</lastmod>
<lastmod>2025-08-13</lastmod>
</url>
<url>
<loc>https://django-components.github.io/django-components/latest/reference/extension_urls/</loc>
<lastmod>2025-08-05</lastmod>
<lastmod>2025-08-13</lastmod>
</url>
<url>
<loc>https://django-components.github.io/django-components/latest/reference/settings/</loc>
<lastmod>2025-08-05</lastmod>
<lastmod>2025-08-13</lastmod>
</url>
<url>
<loc>https://django-components.github.io/django-components/latest/reference/signals/</loc>
<lastmod>2025-08-05</lastmod>
<lastmod>2025-08-13</lastmod>
</url>
<url>
<loc>https://django-components.github.io/django-components/latest/reference/tag_formatters/</loc>
<lastmod>2025-08-05</lastmod>
<lastmod>2025-08-13</lastmod>
</url>
<url>
<loc>https://django-components.github.io/django-components/latest/reference/template_tags/</loc>
<lastmod>2025-08-05</lastmod>
<lastmod>2025-08-13</lastmod>
</url>
<url>
<loc>https://django-components.github.io/django-components/latest/reference/template_variables/</loc>
<lastmod>2025-08-05</lastmod>
<lastmod>2025-08-13</lastmod>
</url>
<url>
<loc>https://django-components.github.io/django-components/latest/reference/testing_api/</loc>
<lastmod>2025-08-05</lastmod>
<lastmod>2025-08-13</lastmod>
</url>
<url>
<loc>https://django-components.github.io/django-components/latest/reference/urls/</loc>
<lastmod>2025-08-05</lastmod>
<lastmod>2025-08-13</lastmod>
</url>
</urlset>

BIN
dev/sitemap.xml.gz
View file

Binary file not shown.

2
versions.json
View file

@ -1,7 +1,7 @@
[
{
"version": "dev",
"title": "dev (0df269a)",
"title": "dev (93cea3d)",
"aliases": []
},
{