epj.RadialDial.Maui
1.0.3
dotnet add package epj.RadialDial.Maui --version 1.0.3
NuGet\Install-Package epj.RadialDial.Maui -Version 1.0.3
<PackageReference Include="epj.RadialDial.Maui" Version="1.0.3" />
paket add epj.RadialDial.Maui --version 1.0.3
#r "nuget: epj.RadialDial.Maui, 1.0.3"
// Install epj.RadialDial.Maui as a Cake Addin #addin nuget:?package=epj.RadialDial.Maui&version=1.0.3 // Install epj.RadialDial.Maui as a Cake Tool #tool nuget:?package=epj.RadialDial.Maui&version=1.0.3
epj.RadialDial.Maui
Radial Dial component for .NET MAUI
Summary
A simple multi-purpose component that can be used as a circular dial or gauge as well as a progress ring or progress indicator. The control was developed using SkiaSharp.
Note: The scale of the dial currently only shows dashes and no text labels for the scale units.
Platforms
The following platforms are currently supported:
Platform | Supported |
---|---|
Android | Yes |
iOS | Yes |
Windows | Yes |
MacCatalyst | Maybe (not tested) |
For use in Desktop applications, the TouchInputEnabled
property needs to be set dynamically.
Highlights
- Touch Input
- Snap value to full integer
- Adjustable Scale (unit labels are currently not featured yet, but the scale steps can be defined)
- Show/Hide Scale
- NEW Color Gradient for Dial
- NEW Pixel Scaling support
Preview
This is just a preview, the styling of the control can be customized. The number label is not included. <div> <img align="top" src="sample1.png" width="240"/> <img align="top" src="sample2.png" width="240"/> <img align="top" src="sample3.png" width="240"/> </div> <br/> <img src="radialdial_sample.gif" width="400"/>
Usage
Important: Register Library
In MauiProgram.cs, add a call to UseRadialDial() on the builder object:
using epj.RadialDial.Maui;
namespace RadialDialSample;
public static class MauiProgram
{
public static MauiApp CreateMauiApp()
{
var builder = MauiApp.CreateBuilder();
builder
.UseMauiApp<App>()
.ConfigureFonts(fonts =>
{
fonts.AddFont("OpenSans-Regular.ttf", "OpenSansRegular");
fonts.AddFont("OpenSans-Semibold.ttf", "OpenSansSemibold");
})
.UseRadialDial(); //add this
return builder.Build();
}
}
XAML
<?xml version="1.0" encoding="utf-8" ?>
<ContentPage xmlns="http://schemas.microsoft.com/dotnet/2021/maui"
xmlns:x="http://schemas.microsoft.com/winfx/2009/xaml"
xmlns:maui="clr-namespace:epj.RadialDial.Maui;assembly=epj.RadialDial.Maui"
x:Class="RadialDialSample.MainPage">
<VerticalStackLayout
VerticalOptions="Center"
Spacing="20">
<maui:RadialDial
TouchInputEnabled="True"
StrokeWidth="50"
DialColor="Orange"
BaseColor="LightSkyBlue"
ScaleColor="DarkGray"
Min="0"
Max="60"
ShowScale="True"
InternalPadding="10"
ScaleDistance="10"
ScaleLength="24"
ScaleThickness="8"
ScaleUnits="5"/>
</VerticalStackLayout>
</ContentPage>
Color Gradient
In order to use the Color Gradient for the Dial, set UseGradient="True"
and provide the colors to the GradientColors
list as follows:
<maui:RadialDial
TouchInputEnabled="True"
BaseColor="LightSkyBlue"
Min="0"
Max="60"
InternalPadding="10"
UseGradient="True">
<maui:RadialDial.GradientColors>
<Color>DarkGreen</Color>
<Color>YellowGreen</Color>
<Color>Yellow</Color>
<Color>OrangeRed</Color>
</maui:RadialDial.GradientColors>
</maui:RadialDial>
Note: Enabling the Color Gradient will override the DialColor
property.
Properties
Most of these properties are bindable for MVVM goodness. If something is missing, please open an issue.
Type | Property | Description | Default Value |
---|---|---|---|
Float | Value | The current value of the dial (two-way bindable) | 10 |
Integer | Min | The minimum value of the dial | 0 |
Integer | Max | The maximum value of the dial | 60 |
Float | DialWidth | Thickness of the Dial | 200.0 |
Float | InternalPadding | Padding of the Canvas | 20.0 |
Boolean | TouchInputEnabled | Enable/Disable touch events | true |
Boolean | SnapToNearestInteger | Uses full integer steps for Value when enabled | true |
Boolean | ShowScale | Whether or not to display the scale units | true |
Integer | ScaleUnits | Defines to show a scale unit for every n steps, e.g. every five steps | 5 |
Float | ScaleThickness | Thickness of a scale unit | 10.0 |
Float | ScaleDistance | Offset between scale and dial | 20.0 |
Float | ScaleLength | Length of a scale unit | 30.0 |
Color | DialColor | The main color of the dial | Red |
Color | BaseColor | The color for the base of the dial | LightGray |
Color | ScaleColor | The color of the scale on the dial | LightGray |
Boolean | UseGradient | Set to true in order to enable Color Gradient |
false |
List<Color> | GradientColors | List of Colors used for Gradient (from first to last) | <empty> |
Boolean | IgnorePixelScaling | When set to true no pixel scaling will occur |
false |
Tips & Tricks
- Although the scale is on the outside of the dial by default, you can also draw it inside the dial by adjusting the values for InternalPadding, StrokeWidth and ScaleDistance
- Note About Pixel Scaling: By default, when false, the canvas is resized to 1 canvas pixel per display pixel. When true, the canvas is resized to device independent pixels, and then stretched to fill the view. Although performance is improved and all objects are the same size on different display densities, blurring and pixelation may occur.
Notes
- Uses SkiaSharp for MAUI
- Inspired by https://github.com/codechem/CC.CircularSlider.Forms
Product | Versions 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. |
-
net8.0
- Microsoft.Maui.Controls (>= 8.0.61)
- SkiaSharp.Views.Maui.Controls (>= 2.88.8)
- SkiaSharp.Views.Maui.Core (>= 2.88.8)
-
net8.0-android34.0
- Microsoft.Maui.Controls (>= 8.0.61)
- SkiaSharp.Views.Maui.Controls (>= 2.88.8)
- SkiaSharp.Views.Maui.Core (>= 2.88.8)
-
net8.0-ios17.2
- Microsoft.Maui.Controls (>= 8.0.61)
- SkiaSharp.Views.Maui.Controls (>= 2.88.8)
- SkiaSharp.Views.Maui.Core (>= 2.88.8)
-
net8.0-maccatalyst17.2
- Microsoft.Maui.Controls (>= 8.0.61)
- SkiaSharp.Views.Maui.Controls (>= 2.88.8)
- SkiaSharp.Views.Maui.Core (>= 2.88.8)
-
net8.0-windows10.0.19041
- Microsoft.Maui.Controls (>= 8.0.61)
- SkiaSharp.Views.Maui.Controls (>= 2.88.8)
- SkiaSharp.Views.Maui.Core (>= 2.88.8)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.