feat: Make component folder configurable

Author: fsbraun

djangocms_frontend/component_pool.py

@@ -1,7 +1,7 @@
 from collections import defaultdict
+from collections.abc import Iterator
 import importlib
 import os
-from collections.abc import Iterator
 import warnings
 
 from django import forms
@@ -15,16 +15,16 @@
 from djangocms_frontend.component_base import CMSFrontendComponent
 
 
-def find_cms_component_templates() -> list[tuple[str, str]]:
+def find_cms_component_templates(subfolder: str) -> list[tuple[str, str]]:
     templates = []
     for app in apps.get_app_configs():
-        app_template_dir = os.path.join(app.path, "templates", app.label, "cms_components")
+        app_template_dir = os.path.join(app.path, "templates", app.label, subfolder)
         if os.path.exists(app_template_dir):
             for root, _, files in os.walk(app_template_dir):
                 for file in files:
                     if file.endswith(".html") or file.endswith(".htm"):
                         relative_path = os.path.relpath(os.path.join(root, file), app_template_dir)
-                        templates.append((app.module.__name__, f"{app.label}/cms_components/{relative_path}"))
+                        templates.append((app.module.__name__, f"{app.label}/{subfolder}/{relative_path}"))
     return templates
 
 
@@ -43,7 +43,7 @@ class CMSAutoComponentDiscovery:
 
     def __init__(self, register_to):
         self.default_field_context.update(settings.COMPONENT_FIELDS)
-        templates = find_cms_component_templates()
+        templates = find_cms_component_templates(settings.COMPONENT_FOLDER)
         auto_components = self.scan_templates_for_component_declaration(templates)
         for component in auto_components:
             register_to.register(component)

djangocms_frontend/settings.py

@@ -77,7 +77,7 @@
 FORM_OPTIONS = getattr(django_settings, "DJANGOCMS_FRONTEND_FORM_OPTIONS", {})
 
 COMPONENT_FIELDS = getattr(django_settings, "DJANGOCMS_FRONTEND_COMPONENT_FIELDS", {})
-
+COMPONENT_FOLDER = getattr(django_settings, "DJANGOCMS_FRONTEND_COMPONENT_FOLDER", "cms_components")
 framework = getattr(django_settings, "DJANGOCMS_FRONTEND_FRAMEWORK", "bootstrap5")
 theme = getattr(django_settings, "DJANGOCMS_FRONTEND_THEME", "djangocms_frontend")
 

djangocms_frontend/templatetags/frontend.py

@@ -317,6 +317,7 @@ def render_tag(self, context, instance, attribute, **kwargs):
             instance = context.get("instance", None)  # Use instance from context
 
         if is_registering_component(context) and attribute:
+            # Autodetect inline field and add it to the component
             update_component_properties(context, "frontend_editable_fields", attribute, append=True)
         elif is_inline_editing_active(context) and isinstance(instance, CMSPlugin) and instance.pk:
             # Only allow inline field to be rendered if inline editing is active and the instance is a CMSPlugin

docs/source/reference.rst

@@ -28,6 +28,24 @@ in your project's ``settings.py``.
         ]
 
 
+.. py:attribute:: settings.DJANGOCMS_FRONTEND_COMPONENT_FOLDER
+
+    Defaults to ``"cms_components"``
+
+    The subfolder where the component templates are discovered. This is used by the
+    :ref:`template components <template_components>` to find the templates
+    for the components.
+
+    The folder needs to be created in your app's ``templates/<app_name>/`` directory.
+    If you want to use a different folder, set this to the folder name of your choice.
+
+    For example, if you want to use ``"my_components"``, add the following line to your project's settings::
+
+        DJANGOCMS_FRONTEND_COMPONENT_FOLDER = "my_components"
+
+    This causes djangocms-frontend to search for templates on the following paths: ``templates/<app_name>/my_components/``,
+    where ``<app_name>`` is the name of any installed app.
+
 .. py:attribute:: settings.DJANGOCMS_FRONTEND_COMPONENT_FIELDS
 
     Defaults to ``{}``

tests/test_app/templates/test_app/cms_components/ui/button.html

@@ -106,3 +106,18 @@ def test_multiple_cms_component_tags_error(self):
         invalid_template = "{% load cms_tags %}{% cms_component 'Hero' %}{% cms_component 'Footer' %}"
         with self.assertRaises(TemplateSyntaxError):
             Template(invalid_template)
+
+    def test_component_folder_selection(self):
+        from djangocms_frontend.component_pool import find_cms_component_templates
+
+        all_components = find_cms_component_templates("cms_components")
+        private_components = find_cms_component_templates("my_components")
+        no_components = find_cms_component_templates("no_components")
+
+        assert set(all_components) == {
+            ("tests.test_app", "test_app/cms_components/hero.html"),
+            ("tests.test_app", "test_app/cms_components/with_slots.html"),
+            ("tests.test_app", "test_app/cms_components/ui/button.html"),
+        }
+        assert private_components == [("tests.test_app", "test_app/my_components/test_component.htm")]
+        assert no_components == []