feat: allow tenant switching to be disabled (#19110)

* feat: allow tenant switching to be disabled

* cleanup

* Update 03-tenancy.md

---------

Co-authored-by: Dan Harrin <git@danharrin.com>

Author: ZANX3Y

docs/07-users/03-tenancy.md

@@ -466,6 +466,23 @@ Action::make('lockSession')
     ->postToUrl()
 ```
 
+### Disabling the tenant switcher
+
+By default, users can switch between tenants using the tenant menu. If you want to keep the tenant menu visible but prevent users from switching tenants, you can use the `tenantSwitcher()` method in the [configuration](../panel-configuration):
+
+```php
+use Filament\Panel;
+
+public function panel(Panel $panel): Panel
+{
+    return $panel
+        // ...
+        ->tenantSwitcher(false);
+}
+```
+
+This keeps the tenant menu visible, showing the current tenant name and any custom menu items, but hides the list of other tenants. This is useful when you want to display tenant information without allowing switching, or when switching should be controlled through other means.
+
 ### Hiding the tenant menu
 
 You can hide the tenant menu by using the `tenantMenu(false)`

packages/panels/resources/views/components/tenant-menu.blade.php

@@ -11,12 +11,12 @@
 
     $items = $this->getTenantMenuItems();
 
-    $canSwitchTenants = count($tenants = array_filter(
+    $canSwitchTenants = filament()->hasTenantSwitcher() && filled($tenants = array_filter(
         filament()->getUserTenants(filament()->auth()->user()),
         fn (\Illuminate\Database\Eloquent\Model $tenant): bool => ! $tenant->is($currentTenant),
     ));
 
-    $isSearchable = filled($canSwitchTenants) ? (filament()->isTenantMenuSearchable() ?? (count($tenants) >= 10)) : false;
+    $isSearchable = $canSwitchTenants && (filament()->isTenantMenuSearchable() ?? (count($tenants) >= 10));
 
     $itemsBeforeAndAfterTenantSwitcher = collect($items)
         ->groupBy(fn (Action $item): bool => $canSwitchTenants && ($item->getSort() < 0), preserveKeys: true)

packages/panels/src/Facades/Filament.php

@@ -159,6 +159,7 @@
  * @method static bool isServing()
  * @method static bool isSidebarCollapsibleOnDesktop()
  * @method static bool isSidebarFullyCollapsibleOnDesktop()
+ * @method static bool hasTenantSwitcher()
  * @method static ?bool isTenantMenuSearchable()
  * @method static void serving(Closure $callback)
  * @method static void setCurrentPanel(Panel | string | null $panel = null)

packages/panels/src/FilamentManager.php

@@ -480,6 +480,11 @@ public function getTenantMenuItems(): array
         return $this->getCurrentOrDefaultPanel()->getTenantMenuItems();
     }
 
+    public function hasTenantSwitcher(): bool
+    {
+        return $this->getCurrentOrDefaultPanel()->hasTenantSwitcher();
+    }
+
     public function isTenantMenuSearchable(): ?bool
     {
         return $this->getCurrentOrDefaultPanel()->isTenantMenuSearchable();

packages/panels/src/Panel/Concerns/HasTenancy.php

@@ -23,6 +23,8 @@ trait HasTenancy
 
     protected bool | Closure $hasTenantMenu = true;
 
+    protected bool | Closure $hasTenantSwitcher = true;
+
     protected bool | Closure | null $isTenantMenuSearchable = null;
 
     protected ?string $tenantRoutePrefix = null;
@@ -71,6 +73,13 @@ public function tenantMenuItems(array $items): static
         return $this;
     }
 
+    public function tenantSwitcher(bool | Closure $condition = true): static
+    {
+        $this->hasTenantSwitcher = $condition;
+
+        return $this;
+    }
+
     public function searchableTenantMenu(bool | Closure | null $condition = true): static
     {
         $this->isTenantMenuSearchable = $condition;
@@ -349,6 +358,11 @@ protected function getTenantRegistrationMenuItem(Action | Closure | MenuItem | n
         ]) ?? $action;
     }
 
+    public function hasTenantSwitcher(): bool
+    {
+        return (bool) $this->evaluate($this->hasTenantSwitcher);
+    }
+
     public function isTenantMenuSearchable(): ?bool
     {
         return $this->evaluate($this->isTenantMenuSearchable);