Status Block
Security covered
This module provides a customizable block that displays site information such as the version, theme, and a custom message, with optional color-coding for different environments. You can configure which items appear, reorder them, and move less frequently used items into a dropdown to keep the display compact. Developers can also extend it to display custom data.
Status Block
Customizable block showing site state (version, theme, custom message)
with environment color coding, sortable items, a "More" section,
CSS variables, and plugin extensibility.
Features
-
Included data:
- Current project version
- Active theme
- Custom message (editable in the block settings)
- Current Environment
-
Environment color coding: each environment (e.g., dev/stage/prod) can have its own color
so team members can quickly identify the environment. -
Configurable display:
- Choose which data items are visible in the bar.
- Move less-frequently used items into a "More" dropdown to keep the bar compact.
- Reorder items via a drag-and-drop UI in the block configuration.
-
Styling and theming:
- CSS customization through CSS variables to adapt colors, spacing, and typography to your theme.
- The block is shipped with a minimal, theme-friendly stylesheet and JavaScript for the UI behavior.
-
Extensibility for developers:
-
Implement new data widgets using the module’s plugin system to show custom metrics or links
(deploy info, monitoring links, feature flags, etc.).
-
Implement new data widgets using the module’s plugin system to show custom metrics or links
-
UX notes:
-
The block is fixed-positioned by default so it stays visible while browsing pages;
you still place it in a region when adding the block so Drupal can manage visibility and permissions.
-
The block is fixed-positioned by default so it stays visible while browsing pages;
Requirements
- No additional requirements beyond Drupal core.
Installation
- Install it using composer and enable it with drush :
drush en status_block
Configuration
- Enable the module on Extend (Admin > Extend).
- Go to Structure > Block layout.
- Select the theme where you want the bar to appear.
- Add block > choose the "Status bar" block (or the block label provided by the module).
- Place the block in any region (the block is fixed-positioned, so the chosen region only controls visibility and context).
-
Open the block configuration to:
- Select which data items to show.
- Reorder items via drag-and-drop.
- Move items into or out of the "More" dropdown.
- Edit the custom message content.
- Configure environment names and colors.
- Set visibility and role/permission restrictions so only intended users see the bar.
- Save and visit a page in the selected theme to confirm the bar is visible and styled as expected.
- Grant the "view status blocks" to the relevant roles