EnvironmentBanner.Umbraco 1.0.2

.NET 8.0 This package targets .NET 8.0. The package is compatible with this framework or higher. 
dotnet add package EnvironmentBanner.Umbraco --version 1.0.2
                    


                    

                
NuGet\Install-Package EnvironmentBanner.Umbraco -Version 1.0.2
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package. 
<PackageReference Include="EnvironmentBanner.Umbraco" Version="1.0.2" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
<PackageVersion Include="EnvironmentBanner.Umbraco" Version="1.0.2" />
                    


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="EnvironmentBanner.Umbraco" />
                    


                            Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package. 
paket add EnvironmentBanner.Umbraco --version 1.0.2
                    


                    

                
#r "nuget: EnvironmentBanner.Umbraco, 1.0.2"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package. 
#:package EnvironmentBanner.Umbraco@1.0.2
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package. 
#addin nuget:?package=EnvironmentBanner.Umbraco&version=1.0.2
                    


                            Install as a Cake Addin
                        

                    

                
#tool nuget:?package=EnvironmentBanner.Umbraco&version=1.0.2
                    


                            Install as a Cake Tool

Umbraco Environment Banner

The Umbraco Environment Banner package allows for configuration and display of a banner at the top of every page on an Umbraco MVC website which indicates the environment along with other useful information about that environment. Additionally, a custom message can be displayed in the banner along with configuration of the foreground and background color.

Configuration

The banner is configured using the following environment variables:

"EnvironmentBanner": { "ForegroundColor": "#FFFFFF", "BackgroundColor": "#FF0000", "BannerCopy": "My Description goes here." }

Adding the banner to a view

To add the banner to one or more pages on the site, add the following code snippet in the appropriate view based on which pages you wish the banner to appear on:

<environment exclude="Production"> @await Component.InvokeAsync("EnvironmentBanner") </environment>

Note: The snippet above will exclude the banner from the production environment, which is the most common use case.
Exclude the <environment> tag if you wish to include the banner in all environments.

Overriding the View

To override the display of the banner, create a file in the following location: \Views\EnvironmentBanner.cshtml.

The following properties are available:

  • BackgroundColor
  • BannerCopy
  • DatabaseConnection
  • EnvironmentName
  • PageNodeId
  • PageLastUpdated
  • ServerTime
  • TextColor
  • UmbracoVersion
Product Compatible and additional computed target framework versions.
.NET net8.0 is compatible.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed.  net9.0 was computed.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  net10.0 was computed.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
1.0.2 147 9/27/2024
1.0.1 130 9/25/2024
1.0.0 119 9/22/2024