feat: Add isVisible() component flag to skip rendering entirely

Author: jissereitsma

Component/ComponentViewModel.php

@@ -19,6 +19,7 @@ class ComponentViewModel implements ComponentViewModelInterface
     protected bool $lazyLoad = false;
     protected bool $lazyUpdate = false;
     protected bool $allowRendering = true;
+    protected bool $visible = true;
 
     public function setComponent(ComponentInterface $component): void
     {
@@ -186,6 +187,11 @@ public function isAllowRendering(): bool
         return $this->allowRendering;
     }
 
+    public function isVisible(): bool
+    {
+        return $this->visible;
+    }
+
     public function getJsData(): array
     {
         return [

Component/ComponentViewModelInterface.php

@@ -45,6 +45,7 @@ public function getComponentName(): string;
     public function isLazyLoad(): bool;
 
     public function isAllowRendering(): bool;
+    public function isVisible(): bool;
 
     public function getJsComponentName(): ?string;
 

Observer/AssignAdditionalBlockVariables.php

@@ -68,6 +68,10 @@ private function addComponent(Template $block, ComponentInterface $component): T
         $block->setViewModel($viewModel);
         $block->setViewModelInstance($viewModel);
 
+        if (false === $viewModel->isVisible()) {
+            $block->setTemplate('Loki_Components::utils/not-visible.phtml'); // @phpstan-ignore bitExpertMagento.setTemplateDisallowedForBlock
+        }
+
         if (false === $viewModel->isAllowRendering()) {
             $block->setTemplate('Loki_Components::utils/not-rendered.phtml'); // @phpstan-ignore bitExpertMagento.setTemplateDisallowedForBlock
             $block->setNotRendered(true);