Add element visibility condition (baserow#4188)

Co-authored-by: peter_baserow <peter@baserow.io>

Author: jrmi

backend/src/baserow/contrib/builder/api/domains/serializers.py

@@ -26,6 +26,7 @@
 from baserow.contrib.builder.pages.handler import PageHandler
 from baserow.contrib.builder.pages.models import Page
 from baserow.core.app_auth_providers.registries import app_auth_provider_type_registry
+from baserow.core.formula.serializers import FormulaSerializerField
 from baserow.core.services.registries import service_type_registry
 from baserow.core.user_sources.models import UserSource
 from baserow.core.user_sources.registries import user_source_type_registry
@@ -100,6 +101,10 @@ class PublicElementSerializer(serializers.ModelSerializer):
     def get_type(self, instance):
         return element_type_registry.get_by_model(instance.specific_class).type
 
+    visibility_condition = FormulaSerializerField(
+        help_text=Element._meta.get_field("visibility_condition").help_text,
+    )
+
     style_background_file = UserFileField(
         allow_null=True,
         help_text="The background image file",
@@ -118,6 +123,7 @@ class Meta:
             "place_in_container",
             "css_classes",
             "visibility",
+            "visibility_condition",
             "styles",
             "style_border_top_color",
             "style_border_top_size",

backend/src/baserow/contrib/builder/api/elements/serializers.py

@@ -50,6 +50,10 @@ class ElementSerializer(serializers.ModelSerializer):
     def get_type(self, instance):
         return element_type_registry.get_by_model(instance.specific_class).type
 
+    visibility_condition = FormulaSerializerField(
+        help_text=Element._meta.get_field("visibility_condition").help_text,
+    )
+
     style_background_file = UserFileField(
         allow_null=True,
         help_text="The background image file",
@@ -67,6 +71,7 @@ class Meta:
             "place_in_container",
             "css_classes",
             "visibility",
+            "visibility_condition",
             "styles",
             "style_border_top_color",
             "style_border_top_size",
@@ -132,6 +137,10 @@ class CreateElementSerializer(serializers.ModelSerializer):
         validators=[image_file_validation],
     )
 
+    visibility_condition = FormulaSerializerField(
+        help_text=Element._meta.get_field("visibility_condition").help_text,
+    )
+
     class Meta:
         model = Element
         fields = (
@@ -142,6 +151,7 @@ class Meta:
             "place_in_container",
             "css_classes",
             "visibility",
+            "visibility_condition",
             "styles",
             "style_border_top_color",
             "style_border_top_size",
@@ -181,11 +191,16 @@ class UpdateElementSerializer(serializers.ModelSerializer):
         validators=[image_file_validation],
     )
 
+    visibility_condition = FormulaSerializerField(
+        help_text=Element._meta.get_field("visibility_condition").help_text,
+    )
+
     class Meta:
         model = Element
         fields = (
             "css_classes",
             "visibility",
+            "visibility_condition",
             "styles",
             "style_border_top_color",
             "style_border_top_size",

backend/src/baserow/contrib/builder/elements/handler.py

@@ -49,6 +49,7 @@ class ElementHandler:
         "parent_element_id",
         "place_in_container",
         "visibility",
+        "visibility_condition",
         "css_classes",
         "styles",
         "style_border_top_color",
@@ -82,6 +83,7 @@ class ElementHandler:
         "place_in_container",
         "css_classes",
         "visibility",
+        "visibility_condition",
         "styles",
         "style_border_top_color",
         "style_border_top_size",

backend/src/baserow/contrib/builder/elements/models.py

@@ -160,6 +160,10 @@ class ROLE_TYPES(models.TextChoices):
         db_index=True,
     )
 
+    visibility_condition = FormulaField(
+        help_text="Change element visibility depending on a formula value"
+    )
+
     styles = models.JSONField(
         default=dict,
         help_text="The theme overrides for this element",

backend/src/baserow/contrib/builder/migrations/0066_element_visibility_condition.py

@@ -0,0 +1,24 @@
+# Generated by Django 5.0.14 on 2025-11-09 10:09
+
+from django.db import migrations
+
+import baserow.core.formula.field
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("builder", "0065_aiagentworkflowaction"),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name="element",
+            name="visibility_condition",
+            field=baserow.core.formula.field.FormulaField(
+                blank=True,
+                default="",
+                help_text="Change element visibility depending on a formula value",
+                null=True,
+            ),
+        ),
+    ]

backend/src/baserow/contrib/builder/types.py

@@ -1,6 +1,7 @@
 from typing import List, Optional, TypedDict
 
 from baserow.contrib.builder.pages.types import PagePathParams, PageQueryParams
+from baserow.core.formula import BaserowFormulaObject
 from baserow.core.integrations.types import IntegrationDictSubClass
 from baserow.core.services.types import ServiceDictSubClass
 from baserow.core.user_sources.types import UserSourceDictSubClass
@@ -15,6 +16,7 @@ class ElementDict(TypedDict):
     place_in_container: str
     css_classes: str
     visibility: str
+    visibility_condition: BaserowFormulaObject
     role_type: str
     roles: list
     styles: dict

backend/src/baserow/core/formula/field.py

@@ -57,6 +57,9 @@ def _transform_db_value_to_dict(
 
         # If the column type is "text", then we haven't yet migrated the schema.
         if self.db_type(connection) == "text":
+            if value is None:
+                return BaserowFormulaObject.create("")
+
             if isinstance(value, int):
                 # A small hack for our backend tests: if we
                 # receive an integer, we convert it to a string.

backend/tests/baserow/contrib/builder/api/domains/test_domain_public_views.py

@@ -408,6 +408,7 @@ def test_get_elements_of_public_builder(api_client, data_fixture):
         "place_in_container": None,
         "css_classes": "",
         "visibility": "all",
+        "visibility_condition": {"formula": "", "mode": "simple", "version": "0.1"},
         "styles": {},
         "style_border_top_color": "border",
         "style_border_top_size": 0,

backend/tests/baserow/contrib/builder/test_builder_application_type.py

@@ -35,6 +35,9 @@
 from baserow.core.action.registries import action_type_registry
 from baserow.core.actions import CreateApplicationActionType
 from baserow.core.db import specific_iterator
+from baserow.core.formula import BaserowFormulaObject
+from baserow.core.formula.field import BASEROW_FORMULA_VERSION_INITIAL
+from baserow.core.formula.types import BASEROW_FORMULA_MODE_SIMPLE
 from baserow.core.registries import ImportExportConfig, application_type_registry
 from baserow.core.storage import ExportZipFile
 from baserow.core.trash.handler import TrashHandler
@@ -248,6 +251,11 @@ def test_builder_application_export(data_fixture):
                 "parent_element_id": None,
                 "place_in_container": None,
                 "visibility": "all",
+                "visibility_condition": BaserowFormulaObject(
+                    formula="",
+                    mode=BASEROW_FORMULA_MODE_SIMPLE,
+                    version=BASEROW_FORMULA_VERSION_INITIAL,
+                ),
                 "css_classes": "",
                 "styles": {},
                 "style_border_top_color": "border",
@@ -296,6 +304,11 @@ def test_builder_application_export(data_fixture):
                 "place_in_container": None,
                 "css_classes": "",
                 "visibility": "all",
+                "visibility_condition": BaserowFormulaObject(
+                    formula="",
+                    mode=BASEROW_FORMULA_MODE_SIMPLE,
+                    version=BASEROW_FORMULA_VERSION_INITIAL,
+                ),
                 "styles": {},
                 "style_border_top_color": "border",
                 "style_border_top_size": 0,
@@ -432,6 +445,11 @@ def test_builder_application_export(data_fixture):
                         "place_in_container": None,
                         "css_classes": "",
                         "visibility": "all",
+                        "visibility_condition": BaserowFormulaObject(
+                            formula="",
+                            mode=BASEROW_FORMULA_MODE_SIMPLE,
+                            version=BASEROW_FORMULA_VERSION_INITIAL,
+                        ),
                         "styles": {},
                         "style_border_top_color": "border",
                         "style_border_top_size": 0,
@@ -470,6 +488,11 @@ def test_builder_application_export(data_fixture):
                         "place_in_container": None,
                         "css_classes": "",
                         "visibility": "all",
+                        "visibility_condition": BaserowFormulaObject(
+                            formula="",
+                            mode=BASEROW_FORMULA_MODE_SIMPLE,
+                            version=BASEROW_FORMULA_VERSION_INITIAL,
+                        ),
                         "styles": {},
                         "style_border_top_color": "border",
                         "style_border_top_size": 0,
@@ -507,6 +530,11 @@ def test_builder_application_export(data_fixture):
                         "place_in_container": None,
                         "css_classes": "",
                         "visibility": "all",
+                        "visibility_condition": BaserowFormulaObject(
+                            formula="",
+                            mode=BASEROW_FORMULA_MODE_SIMPLE,
+                            version=BASEROW_FORMULA_VERSION_INITIAL,
+                        ),
                         "styles": {},
                         "style_border_top_color": "border",
                         "style_border_top_size": 0,
@@ -546,6 +574,11 @@ def test_builder_application_export(data_fixture):
                         "place_in_container": "0",
                         "css_classes": "",
                         "visibility": "all",
+                        "visibility_condition": BaserowFormulaObject(
+                            formula="",
+                            mode=BASEROW_FORMULA_MODE_SIMPLE,
+                            version=BASEROW_FORMULA_VERSION_INITIAL,
+                        ),
                         "styles": {},
                         "style_border_top_color": "border",
                         "style_border_top_size": 0,

changelog/entries/unreleased/feature/2566_element_can_be_visually_hidden_on_complex_conditions.json

@@ -0,0 +1,8 @@
+{
+    "type": "feature",
+    "message": "Element can be visually hidden on complex conditions",
+    "domain": "builder",
+    "issue_number": 2566,
+    "bullet_points": [],
+    "created_at": "2025-11-09"
+}