Plugin.Maui.DebugOverlay 1.0.0-preview3

.NET 8.0 This package targets .NET 8.0. The package is compatible with this framework or higher.
This is a prerelease version of Plugin.Maui.DebugOverlay. 
dotnet add package Plugin.Maui.DebugOverlay --version 1.0.0-preview3
                    


                    

                
NuGet\Install-Package Plugin.Maui.DebugOverlay -Version 1.0.0-preview3
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="Plugin.Maui.DebugOverlay" Version="1.0.0-preview3" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
<PackageVersion Include="Plugin.Maui.DebugOverlay" Version="1.0.0-preview3" />
                    


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="Plugin.Maui.DebugOverlay" />
                    


                            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 Plugin.Maui.DebugOverlay --version 1.0.0-preview3
                    


                    

                
#r "nuget: Plugin.Maui.DebugOverlay, 1.0.0-preview3"
#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 Plugin.Maui.DebugOverlay@1.0.0-preview3
#: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=Plugin.Maui.DebugOverlay&version=1.0.0-preview3&prerelease
                    


                            Install as a Cake Addin
                        

                    

                
#tool nuget:?package=Plugin.Maui.DebugOverlay&version=1.0.0-preview3&prerelease
                    


                            Install as a Cake Tool

alternate text is missing from this package README image

Plugin.Maui.DebugOverlay

Plugin.Maui.DebugOverlay provides a simple ribbon to indicate the app is running in Debug mode.

screenshot of a mac app with the ribbon

Install Plugin

NuGet

Available on NuGet.

Install with the dotnet CLI: dotnet add package Plugin.Maui.DebugOverlay, or through the NuGet Package Manager in Visual Studio.

Supported Platforms

Platform Minimum Version Supported
iOS 11+
macOS 10.15+
Android 5.0 (API 21)
Windows 11 and 10 version 1809+

Usage

Enable the plugin in your MauiProgram.cs and provide your preferred color.

.UseDebugRibbon(Colors.Orange)

For exmaple:

public static MauiApp CreateMauiApp()
	{
		var builder = MauiApp.CreateBuilder();
		builder
			.UseMauiApp<App>()
			.UseDebugRibbon(Colors.Orange)
			.ConfigureFonts(fonts =>
			{
				fonts.AddFont("OpenSans-Regular.ttf", "OpenSansRegular");
				fonts.AddFont("OpenSans-Semibold.ttf", "OpenSansSemibold");
			});

		builder.Services.AddTransient<MainPage>();

		return builder.Build();
	}

It will only display in Debug.

Product Compatible and additional computed target framework versions.
.NET net8.0 is compatible.  net8.0-android was computed.  net8.0-android34.0 is compatible.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-ios17.2 is compatible.  net8.0-maccatalyst was computed.  net8.0-maccatalyst17.2 is compatible.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed.  net8.0-windows10.0.19041 is compatible.  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.0-preview3 159 7/28/2024
1.0.0-preview1 76 7/28/2024