Update docs

Author: fsbraun

djangocms_frontend/templatetags/cms_component.py

@@ -64,7 +64,7 @@ def _to_tuple_if_needed(value: str) -> str | tuple[str, str]:
     """
     match = re.match(r"^(.*?)\s*<([^>]+)>\s?$", value)
     if match:
-        return [match.group(2).strip(), match.group(1).strip()]
+        return (match.group(2).strip(), match.group(1).strip())
     return value
 
 

docs/source/tutorial/custom_components.rst

@@ -5,7 +5,7 @@ Building Custom Frontend Components
 ####################################
 
 .. index::
-    single: custom frontend components
+    single: Custom frontend components
 
 .. versionadded:: 2.0
 

docs/source/tutorial/template_components.rst

@@ -250,6 +250,33 @@ Simply replace ``{{ title }}`` and/or ``{{ slogan }}`` with ``{% inline_field "t
     template files, you need to restart the server manually to see the changes.
 
 
+A little helper: the ``split`` filter
+-------------------------------------
+
+.. index::
+    single: ``split`` filter
+
+Some component properties require a list of values, such as the ``parent_classes`` or ``child_classes``.
+You can use the ``split`` filter to convert a string into a list. For example, if you want to allow the
+**Hero component** to be a child of the **Container or Column component**, you can set the ``parent_classes``
+like this::
+
+    {% cms_component "Hero" name=_("My Hero Component") parent_classes="ContainerPlugin|ColumnPlugin"|split %}
+
+``split`` splits a string by the pipe character (``|``) and returns a list of strings. If you prefer to use a different
+separator, you can pass it as an argument to the filter, like this::
+
+    {% cms_component "Hero" name=_("My Hero Component") parent_classes="ContainerPlugin,ColumnPlugin"|split:"," %}
+
+Additionally, ``split`` can be used to create tuples as needed for the ``choices`` parameter of
+``forms.ChoiceField``. For example, if you want to create a choice field with two options, you can use the
+following code::
+
+    {% field "color" forms.ChoiceField choices="Red <red>|Green <green>|Default <blue>"|split name=_("Color") %}
+
+The verbose choice label is appended by the actual value of the field between angle brackets (``<...>``).
+
+
 Limitations of template components
 ----------------------------------