mirrors/django-components
1
0
Fork 0
mirror of https://github.com/django-components/django-components.git synced 2025-09-26 15:39:08 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Deployed ccf02fa to dev with MkDocs 1.6.1 and mike 2.1.3

Browse source
This commit is contained in:
github-actions 2025-05-11 13:00:41 +00:00
parent 7f8d53a0f5
commit de0b7dfc14
35 changed files with 159 additions and 167 deletions
Download patch file Download diff file Expand all files Collapse all files

2
dev/reference/extension_urls/index.html
View file

@ -10,7 +10,7 @@
<a id=__codelineno-0-5 name=__codelineno-0-5 href=#__codelineno-0-5></a> <span class=n>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><span class=p>,</span>
<a id=__codelineno-0-6 name=__codelineno-0-6 href=#__codelineno-0-6></a> <span class=n>extra</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=n><a class="autorefs autorefs-external" href=https://docs.python.org/3.12/library/stdtypes.html#dict>dict</a></span><span class=p>(),</span>
<a id=__codelineno-0-7 name=__codelineno-0-7 href=#__codelineno-0-7></a><span class=p>)</span>
</code></pre></div> <div class="doc doc-contents first"> <p class="doc doc-class-bases">Bases: <code>object</code></p> <p><a href=https://github.com/django-components/django-components/tree/master/src/django_components/util/routing.py#L21 target=_blank>See source code</a></p> <p>Framework-agnostic route definition.</p> <p>This is similar to Django's <code>URLPattern</code> object created with <a href=https://docs.djangoproject.com/en/5.1/ref/urls/#path><code>django.urls.path()</code></a>.</p> <p>The <code>URLRoute</code> must either define a <code>handler</code> function or have a list of child routes <code>children</code>. If both are defined, an error will be raised.</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=n>URLRoute</span><span class=p>(</span><span class=s2>&quot;/my/path&quot;</span><span class=p>,</span> <span class=n>handler</span><span class=o>=</span><span class=n>my_handler</span><span class=p>,</span> <span class=n>name</span><span class=o>=</span><span class=s2>&quot;my_name&quot;</span><span class=p>,</span> <span class=n>extra</span><span class=o>=</span><span class=p>{</span><span class=s2>&quot;kwargs&quot;</span><span class=p>:</span> <span class=p>{</span><span class=s2>&quot;my_extra&quot;</span><span class=p>:</span> <span class=s2>&quot;my_value&quot;</span><span class=p>}})</span>
</code></pre></div> <div class="doc doc-contents first"> <p class="doc doc-class-bases">Bases: <code>object</code></p> <p><a href=https://github.com/django-components/django-components/tree/master/src/django_components/util/routing.py#L21 target=_blank>See source code</a></p> <p>Framework-agnostic route definition.</p> <p>This is similar to Django's <code>URLPattern</code> object created with <a href=https://docs.djangoproject.com/en/5.2/ref/urls/#path><code>django.urls.path()</code></a>.</p> <p>The <code>URLRoute</code> must either define a <code>handler</code> function or have a list of child routes <code>children</code>. If both are defined, an error will be raised.</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=n>URLRoute</span><span class=p>(</span><span class=s2>&quot;/my/path&quot;</span><span class=p>,</span> <span class=n>handler</span><span class=o>=</span><span class=n>my_handler</span><span class=p>,</span> <span class=n>name</span><span class=o>=</span><span class=s2>&quot;my_name&quot;</span><span class=p>,</span> <span class=n>extra</span><span class=o>=</span><span class=p>{</span><span class=s2>&quot;kwargs&quot;</span><span class=p>:</span> <span class=p>{</span><span class=s2>&quot;my_extra&quot;</span><span class=p>:</span> <span class=s2>&quot;my_value&quot;</span><span class=p>}})</span>
</code></pre></div> <p>Is equivalent to:</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>django</span><span class=o>.</span><span class=n>urls</span><span class=o>.</span><span class=n>path</span><span class=p>(</span><span class=s2>&quot;/my/path&quot;</span><span class=p>,</span> <span class=n>my_handler</span><span class=p>,</span> <span class=n>name</span><span class=o>=</span><span class=s2>&quot;my_name&quot;</span><span class=p>,</span> <span class=n>kwargs</span><span class=o>=</span><span class=p>{</span><span class=s2>&quot;my_extra&quot;</span><span class=p>:</span> <span class=s2>&quot;my_value&quot;</span><span class=p>})</span>
</code></pre></div> <p>With children:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-2-1 name=__codelineno-2-1 href=#__codelineno-2-1></a><span class=n>URLRoute</span><span class=p>(</span>
<a id=__codelineno-2-2 name=__codelineno-2-2 href=#__codelineno-2-2></a> <span class=s2>&quot;/my/path&quot;</span><span class=p>,</span>