mirror of
https://github.com/django-components/django-components.git
synced 2025-08-04 14:28:18 +00:00
docs: update auto-gen'd docs to show signals reference page (#926)
This commit is contained in:
parent
914576e681
commit
6ccc2fe0f4
5 changed files with 164 additions and 103 deletions
41
docs/reference/signals.md
Normal file
41
docs/reference/signals.md
Normal file
|
@ -0,0 +1,41 @@
|
|||
<!-- Autogenerated by reference.py -->
|
||||
|
||||
# Signals
|
||||
|
||||
Below are the signals that are sent by or during the use of django-components.
|
||||
|
||||
## template_rendered
|
||||
|
||||
Django's [`template_rendered`](https://docs.djangoproject.com/en/5.1/ref/signals/#template-rendered) signal.
|
||||
This signal is sent when a template is rendered.
|
||||
|
||||
Django-components triggers this signal when a component is rendered. If there are nested components,
|
||||
the signal is triggered for each component.
|
||||
|
||||
Import from django as `django.test.signals.template_rendered`.
|
||||
|
||||
```python
|
||||
from django.test.signals import template_rendered
|
||||
|
||||
# Setup a callback function
|
||||
def my_callback(sender, **kwargs):
|
||||
...
|
||||
|
||||
template_rendered.connect(my_callback)
|
||||
|
||||
class MyTable(Component):
|
||||
template = """
|
||||
<table>
|
||||
<tr>
|
||||
<th>Header</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Cell</td>
|
||||
</tr>
|
||||
"""
|
||||
|
||||
# This will trigger the signal
|
||||
MyTable().render()
|
||||
```
|
||||
|
||||
|
Loading…
Add table
Add a link
Reference in a new issue