Types of indicators and integrations
This documentation needs review. See "Help improve this page" in the sidebar.
The Environment Indicator module provides flexible ways to visually and functionally differentiate between Drupal environments (e.g., development, staging, production). It supports multiple types of indicators and integrations, allowing site builders to tailor the environment display to their specific needs.
All indicator settings—color, label, and version identifier—are configured globally per environment. Most integrations can be toggled on or off independently, although some combinations (e.g., enabling the toolbar sub-module) may override others.
Available Indicator Types
1. Page Top Indicator
-
Location: Injected into the
#page_toprender array. -
Appearance: Displays a prominent banner at the top of the page.
-
Environment Switcher integration: Yes
-
Customizable: Foreground/background color, text label, version identifier.
2. Core Toolbar Integration
(Available as a sub-module: environment_indicator_toolbar)
-
Location: Adds an indicator item to the Drupal admin toolbar, showing the environment name and optional version identifier.
-
Appearance: Toolbar background and text color are styled per environment configuration.
-
Environment Switcher integration: Yes
-
Customizable: Foreground/background color, text label, version identifier.
-
Note: Requires the core
toolbarmodule to be enabled. If using the Gin admin theme, additional integration is available to ensure compatibility and proper placement. Enabling this sub-module currently disables the Page Top indicator.
3. Favicon Integration
-
Function: Replaces the site’s favicon with a color-coded version reflecting the current environment.
-
Use case: Helps distinguish between environments when multiple tabs are open.
-
Toggle: Can be enabled or disabled independently of other indicators.
-
Environment Switcher integration: No
Coming Soon: Navigation Integration
An additional integration is planned to add environment indicators within the Drupal admin navigation experience. Stay tuned for updates as this feature is developed.
Help improve this page
You can:
- Log in, click Edit, and edit this page
- Log in, click Discuss, update the Page status value, and suggest an improvement
- Log in and create a Documentation issue with your suggestion