Dynamic Visibility & Customization

The EZY Portal menu is not static; it adapts based on the environment, tenant configuration, and user-defined layouts.

1. Conditional Visibility (Static)

Many items are hidden automatically if they are not relevant to the current environment:

hiddenInSingleTenant: Items like “Tenants” are hidden if the portal is running in a single-tenant mode.
hiddenInSystemTenant: Items like “Company Settings” are hidden when logged into the main System/Master tenant.
hiddenWhenUnlimited: Billing-related items are hidden if the portal has an unlimited license.
requireAiEnabled: AI-related settings only appear if the AI feature flag is enabled in the portal configuration.
requireUnlimited: Certain high-end features (like custom AI credentials for tenants) require an “Unlimited” or “On-Premise” license.

2. User-Defined Customization

The Menu Layout feature (available to Tenant Admins) allows for complete control over the sidebar:

Reordering: Drag-and-drop items to change their display order.
Visibility: Manually hide items that are not needed by the organization.
Grouping: Create custom folders/groups to organize menu items.
External User Visibility: Specific controls to hide/show items for “External Users”.

3. Micro-Service Integration

As new micro-services are registered in the Portal, they automatically inject their own menu items. These items:

Are sorted by the menuOrder defined in the micro-service registry.
Support deep linking and multi-level submenus.
Inherit the same role-based and conditional visibility rules as static items.

4. System Admin “Promoted” Mode

In multi-tenant environments, when a System Admin logs in and the navigation is minimal (only Dashboard + Settings), the portal automatically “promotes” the Settings groups (General, System, AI, etc.) to the top-level of the sidebar for quicker access.

:::tip TODO

Provide code snippets or configuration examples for visibility flags.
Add a step-by-step guide on how to use the Menu Layout customizer. :::