mirror of
https://github.com/django-components/django-components.git
synced 2025-08-04 14:28:18 +00:00
docs: move extension command- and url-related API to own API pages (#1093)
* docs: move extension command- and url-related API to own API pages * refactor: fix linters
This commit is contained in:
parent
0ed46e4d30
commit
3555411f1e
15 changed files with 312 additions and 97 deletions
|
@ -1,14 +1,17 @@
|
|||
<!-- Autogenerated by reference.py -->
|
||||
|
||||
# Extension Hooks
|
||||
# Extension hooks
|
||||
|
||||
Overview of all the extension hooks available in Django Components.
|
||||
|
||||
Read more on [Extensions](../../concepts/advanced/extensions).
|
||||
|
||||
|
||||
## Hooks
|
||||
|
||||
::: django_components.extension.ComponentExtension.on_component_class_created
|
||||
options:
|
||||
heading_level: 3
|
||||
show_root_heading: true
|
||||
show_signature: true
|
||||
separate_signature: true
|
||||
|
@ -25,6 +28,7 @@ name | type | description
|
|||
|
||||
::: django_components.extension.ComponentExtension.on_component_class_deleted
|
||||
options:
|
||||
heading_level: 3
|
||||
show_root_heading: true
|
||||
show_signature: true
|
||||
separate_signature: true
|
||||
|
@ -41,6 +45,7 @@ name | type | description
|
|||
|
||||
::: django_components.extension.ComponentExtension.on_component_data
|
||||
options:
|
||||
heading_level: 3
|
||||
show_root_heading: true
|
||||
show_signature: true
|
||||
separate_signature: true
|
||||
|
@ -62,6 +67,7 @@ name | type | description
|
|||
|
||||
::: django_components.extension.ComponentExtension.on_component_input
|
||||
options:
|
||||
heading_level: 3
|
||||
show_root_heading: true
|
||||
show_signature: true
|
||||
separate_signature: true
|
||||
|
@ -84,6 +90,7 @@ name | type | description
|
|||
|
||||
::: django_components.extension.ComponentExtension.on_component_registered
|
||||
options:
|
||||
heading_level: 3
|
||||
show_root_heading: true
|
||||
show_signature: true
|
||||
separate_signature: true
|
||||
|
@ -102,6 +109,7 @@ name | type | description
|
|||
|
||||
::: django_components.extension.ComponentExtension.on_component_unregistered
|
||||
options:
|
||||
heading_level: 3
|
||||
show_root_heading: true
|
||||
show_signature: true
|
||||
separate_signature: true
|
||||
|
@ -120,6 +128,7 @@ name | type | description
|
|||
|
||||
::: django_components.extension.ComponentExtension.on_registry_created
|
||||
options:
|
||||
heading_level: 3
|
||||
show_root_heading: true
|
||||
show_signature: true
|
||||
separate_signature: true
|
||||
|
@ -136,6 +145,7 @@ name | type | description
|
|||
|
||||
::: django_components.extension.ComponentExtension.on_registry_deleted
|
||||
options:
|
||||
heading_level: 3
|
||||
show_root_heading: true
|
||||
show_signature: true
|
||||
separate_signature: true
|
||||
|
@ -150,3 +160,45 @@ name | type | description
|
|||
--|--|--
|
||||
`registry` | [`ComponentRegistry`](../api#django_components.ComponentRegistry) | The to-be-deleted ComponentRegistry instance
|
||||
|
||||
## Objects
|
||||
|
||||
::: django_components.extension.OnComponentClassCreatedContext
|
||||
options:
|
||||
heading_level: 3
|
||||
show_if_no_docstring: true
|
||||
|
||||
::: django_components.extension.OnComponentClassDeletedContext
|
||||
options:
|
||||
heading_level: 3
|
||||
show_if_no_docstring: true
|
||||
|
||||
::: django_components.extension.OnComponentDataContext
|
||||
options:
|
||||
heading_level: 3
|
||||
show_if_no_docstring: true
|
||||
|
||||
::: django_components.extension.OnComponentInputContext
|
||||
options:
|
||||
heading_level: 3
|
||||
show_if_no_docstring: true
|
||||
|
||||
::: django_components.extension.OnComponentRegisteredContext
|
||||
options:
|
||||
heading_level: 3
|
||||
show_if_no_docstring: true
|
||||
|
||||
::: django_components.extension.OnComponentUnregisteredContext
|
||||
options:
|
||||
heading_level: 3
|
||||
show_if_no_docstring: true
|
||||
|
||||
::: django_components.extension.OnRegistryCreatedContext
|
||||
options:
|
||||
heading_level: 3
|
||||
show_if_no_docstring: true
|
||||
|
||||
::: django_components.extension.OnRegistryDeletedContext
|
||||
options:
|
||||
heading_level: 3
|
||||
show_if_no_docstring: true
|
||||
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue