topshelfcraft/environment-label

...so you don't forget where you are.

Environment Label

...so you don't forget where you are., _(*1)

A Top Shelf Craft creation
in collaboration with Kind, _(*2)

TL;DR.

The Environment Label plugin adds a nice coloured banner to your CraftCMS control panel so you'll never forget what environment you're using., _(*3)

The colors and text of the environment label are configurable via the plugin config file., _(*4)

, _(*5)

Installation

Visit the Plugin Store in your Craft control panel, search for Environment Label, and click to Install the plugin., _(*6)

You can also install the package via Composer., _(*7)

composer require topshelfcraft/environment-label

Then, navigate to the Plugins section of the control panel, find Environment Label in the list, and click the Install button., _(*8)

Configuration

You can use a plugin config file to tweak the appearance and text of the environment label for each installation., _(*9)

Simply add an environment-label.php file to your config directory., _(*10)

<?php

return [
    'showLabel' => true,
    'labelText' => "My Label Text",
    'labelColor' => '#cc5643',
    'textColor' => '#ffffff',
    'targetSelector' => '#global-header:before',
];

The text of the label will be rendered as a Twig template, so you can also include template variables to make the text dynamic:, _(*11)

<?php

return [
    'labelText' => "Editing as: {{ currentUser }}",
);

Settings in the Control Panel

You can also make basic changes to the text and appearance of the environment label via the plugin Settings page., _(*12)

, _(*13)

, _(*14)

This is provided as a convenience for easily testing out the plugin, but for full customizability, you should use a plugin config file as described above., _(*15)

(Settings specified in the plugin config file will override any changes made via the Settings page in the control panel.), _(*16)

Twig template globals

Environment Label makes itself available via a Twig template global variable, so you can create your own environment label rendering in your public templates:, _(*17)

{{ environmentLabel.renderedText }}
{{ environmentLabel.labelColor }}
{{ environmentLabel.textColor }}

What are the system requirements?

Craft 5.0+ and PHP 8.2+, _(*18)

I've found a bug.

No you haven't., _(*19)

Yes, I believe I have.

Well, alright. Please open a GitHub Issue, and if you're feeling ambitious, submit a PR to the 5.x.dev branch., _(*20)

Contributors:

• Plugin development: Michael Rog / @michaelrog
• Craft 2 plugin development: Tom Davies / @metadaptive
• Icon: NAS, via The Noun Project