https://github.com/davidortinau/Plugin.Maui.DebugOverlay

https://github.com/davidortinau/Plugin.Maui.DebugOverlay

Last synced: 30 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/davidortinau/Plugin.Maui.DebugOverlay
• Owner: davidortinau
• License: mit
• Created: 2024-07-27T17:56:52.000Z (5 months ago)
• Default Branch: main
• Last Pushed: 2024-07-28T17:27:23.000Z (5 months ago)
• Last Synced: 2024-10-11T22:24:42.634Z (2 months ago)
• Language: C#
• Size: 383 KB
• Stars: 13
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-dotnet-maui - Plugin.Maui.DebugOverlay - square)](https://github.com/davidortinau/Plugin.Maui.DebugOverlay/stargazers)|[](https://github.com/davidortinau/Plugin.Maui.DebugOverlay/commits) (Plugins)

README

        
![](nuget.png)

# 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](images/mac_screenshot.png)

## Install Plugin

[![NuGet](https://img.shields.io/nuget/v/Plugin.Maui.DebugOverlay.svg?label=NuGet)](https://www.nuget.org/packages/Plugin.Maui.DebugOverlay/)

Available on [NuGet](http://www.nuget.org/packages/Plugin.Maui.DebugOverlay).

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.

```csharp

.UseDebugRibbon(Colors.Orange)

```

For exmaple:

```csharp

public static MauiApp CreateMauiApp()

	{

		var builder = MauiApp.CreateBuilder();

		builder

			.UseMauiApp()

			.UseDebugRibbon(Colors.Orange)

			.ConfigureFonts(fonts =>

			{

				fonts.AddFont("OpenSans-Regular.ttf", "OpenSansRegular");

				fonts.AddFont("OpenSans-Semibold.ttf", "OpenSansSemibold");

			});

		builder.Services.AddTransient();

		return builder.Build();

	}

``` 

It will only display in Debug.