feat: extensions (#1009)

* feat: extensions

* refactor: remove support for passing in extensions as instances

docs/reference/.nav.yml

@@ -4,6 +4,7 @@ nav:
   - Commands: commands.md
   - Components: components.md
   - Exceptions: exceptions.md
+  - Extension hooks: extension_hooks.md
   - Middlewares: middlewares.md
   - Settings: settings.md
   - Signals: signals.md

docs/reference/api.md

@@ -11,6 +11,10 @@
     options:
       show_if_no_docstring: true
 
+::: django_components.ComponentExtension
+    options:
+      show_if_no_docstring: true
+
 ::: django_components.ComponentFileEntry
     options:
       show_if_no_docstring: true
@@ -51,6 +55,38 @@
     options:
       show_if_no_docstring: true
 
+::: django_components.OnComponentClassCreatedContext
+    options:
+      show_if_no_docstring: true
+
+::: django_components.OnComponentClassDeletedContext
+    options:
+      show_if_no_docstring: true
+
+::: django_components.OnComponentDataContext
+    options:
+      show_if_no_docstring: true
+
+::: django_components.OnComponentInputContext
+    options:
+      show_if_no_docstring: true
+
+::: django_components.OnComponentRegisteredContext
+    options:
+      show_if_no_docstring: true
+
+::: django_components.OnComponentUnregisteredContext
+    options:
+      show_if_no_docstring: true
+
+::: django_components.OnRegistryCreatedContext
+    options:
+      show_if_no_docstring: true
+
+::: django_components.OnRegistryDeletedContext
+    options:
+      show_if_no_docstring: true
+
 ::: django_components.RegistrySettings
     options:
       show_if_no_docstring: true

docs/reference/extension_hooks.md

@@ -0,0 +1,152 @@
+<!-- Autogenerated by reference.py -->
+
+# Extension Hooks
+
+Overview of all the extension hooks available in Django Components.
+
+Read more on [Extensions](../../concepts/advanced/extensions).
+
+
+::: django_components.extension.ComponentExtension.on_component_class_created
+    options:
+      show_root_heading: true
+      show_signature: true
+      separate_signature: true
+      show_symbol_type_heading: false
+      show_symbol_type_toc: false
+      show_if_no_docstring: true
+      show_labels: false
+
+**Available data:**
+
+name | type | description
+--|--|--
+`component_cls` | [`Type[Component]`](../api#django_components.Component) | The created Component class
+
+::: django_components.extension.ComponentExtension.on_component_class_deleted
+    options:
+      show_root_heading: true
+      show_signature: true
+      separate_signature: true
+      show_symbol_type_heading: false
+      show_symbol_type_toc: false
+      show_if_no_docstring: true
+      show_labels: false
+
+**Available data:**
+
+name | type | description
+--|--|--
+`component_cls` | [`Type[Component]`](../api#django_components.Component) | The to-be-deleted Component class
+
+::: django_components.extension.ComponentExtension.on_component_data
+    options:
+      show_root_heading: true
+      show_signature: true
+      separate_signature: true
+      show_symbol_type_heading: false
+      show_symbol_type_toc: false
+      show_if_no_docstring: true
+      show_labels: false
+
+**Available data:**
+
+name | type | description
+--|--|--
+`component` | [`Component`](../api#django_components.Component) | The Component instance that is being rendered
+`component_cls` | [`Type[Component]`](../api#django_components.Component) | The Component class
+`component_id` | `str` | The unique identifier for this component instance
+`context_data` | `Dict` | Dictionary of context data from `Component.get_context_data()`
+`css_data` | `Dict` | Dictionary of CSS data from `Component.get_css_data()`
+`js_data` | `Dict` | Dictionary of JavaScript data from `Component.get_js_data()`
+
+::: django_components.extension.ComponentExtension.on_component_input
+    options:
+      show_root_heading: true
+      show_signature: true
+      separate_signature: true
+      show_symbol_type_heading: false
+      show_symbol_type_toc: false
+      show_if_no_docstring: true
+      show_labels: false
+
+**Available data:**
+
+name | type | description
+--|--|--
+`args` | `List` | List of positional arguments passed to the component
+`component` | [`Component`](../api#django_components.Component) | The Component instance that received the input and is being rendered
+`component_cls` | [`Type[Component]`](../api#django_components.Component) | The Component class
+`component_id` | `str` | The unique identifier for this component instance
+`context` | [`Context`](https://docs.djangoproject.com/en/5.1/ref/templates/api/#django.template.Context) | The Django template Context object
+`kwargs` | `Dict` | Dictionary of keyword arguments passed to the component
+`slots` | `Dict` | Dictionary of slot definitions
+
+::: django_components.extension.ComponentExtension.on_component_registered
+    options:
+      show_root_heading: true
+      show_signature: true
+      separate_signature: true
+      show_symbol_type_heading: false
+      show_symbol_type_toc: false
+      show_if_no_docstring: true
+      show_labels: false
+
+**Available data:**
+
+name | type | description
+--|--|--
+`component_cls` | [`Type[Component]`](../api#django_components.Component) | The registered Component class
+`name` | `str` | The name the component was registered under
+`registry` | [`ComponentRegistry`](../api#django_components.ComponentRegistry) | The registry the component was registered to
+
+::: django_components.extension.ComponentExtension.on_component_unregistered
+    options:
+      show_root_heading: true
+      show_signature: true
+      separate_signature: true
+      show_symbol_type_heading: false
+      show_symbol_type_toc: false
+      show_if_no_docstring: true
+      show_labels: false
+
+**Available data:**
+
+name | type | description
+--|--|--
+`component_cls` | [`Type[Component]`](../api#django_components.Component) | The unregistered Component class
+`name` | `str` | The name the component was registered under
+`registry` | [`ComponentRegistry`](../api#django_components.ComponentRegistry) | The registry the component was unregistered from
+
+::: django_components.extension.ComponentExtension.on_registry_created
+    options:
+      show_root_heading: true
+      show_signature: true
+      separate_signature: true
+      show_symbol_type_heading: false
+      show_symbol_type_toc: false
+      show_if_no_docstring: true
+      show_labels: false
+
+**Available data:**
+
+name | type | description
+--|--|--
+`registry` | [`ComponentRegistry`](../api#django_components.ComponentRegistry) | The created ComponentRegistry instance
+
+::: django_components.extension.ComponentExtension.on_registry_deleted
+    options:
+      show_root_heading: true
+      show_signature: true
+      separate_signature: true
+      show_symbol_type_heading: false
+      show_symbol_type_toc: false
+      show_if_no_docstring: true
+      show_labels: false
+
+**Available data:**
+
+name | type | description
+--|--|--
+`registry` | [`ComponentRegistry`](../api#django_components.ComponentRegistry) | The to-be-deleted ComponentRegistry instance
+

docs/reference/settings.md

@@ -42,6 +42,7 @@ defaults = ComponentsSettings(
     debug_highlight_components=False,
     debug_highlight_slots=False,
     dynamic_component_name="dynamic",
+    extensions=[],
     libraries=[],  # E.g. ["mysite.components.forms", ...]
     multiline_tags=True,
     reload_on_file_change=False,
@@ -146,6 +147,16 @@ defaults = ComponentsSettings(
       show_if_no_docstring: true
       show_labels: false
 
+::: django_components.app_settings.ComponentsSettings.extensions
+    options:
+      show_root_heading: true
+      show_signature: true
+      separate_signature: true
+      show_symbol_type_heading: false
+      show_symbol_type_toc: false
+      show_if_no_docstring: true
+      show_labels: false
+
 ::: django_components.app_settings.ComponentsSettings.forbidden_static_files
     options:
       show_root_heading: true

docs/reference/template_tags.md

@@ -67,7 +67,7 @@ If you insert this tag multiple times, ALL JS scripts will be duplicately insert
 
 
 
-<a href="https://github.com/django-components/django-components/tree/master/src/django_components/templatetags/component_tags.py#L1549" target="_blank">See source code</a>
+<a href="https://github.com/django-components/django-components/tree/master/src/django_components/templatetags/component_tags.py#L1568" target="_blank">See source code</a>