Add New Enum Description Converter

samples/CommunityToolkit.Maui.Sample/AppShell.xaml.cs

@@ -1,4 +1,5 @@
 using System.Collections.ObjectModel;
+
 using CommunityToolkit.Maui.Sample.Pages;
 using CommunityToolkit.Maui.Sample.Pages.Alerts;
 using CommunityToolkit.Maui.Sample.Pages.Behaviors;
@@ -58,6 +59,7 @@ public partial class AppShell : Shell
 		CreateViewModelMapping<CompareConverterPage, CompareConverterViewModel, ConvertersGalleryPage, ConvertersGalleryViewModel>(),
 		CreateViewModelMapping<DateTimeOffsetConverterPage, DateTimeOffsetConverterViewModel, ConvertersGalleryPage, ConvertersGalleryViewModel>(),
 		CreateViewModelMapping<DoubleToIntConverterPage, DoubleToIntConverterViewModel, ConvertersGalleryPage, ConvertersGalleryViewModel>(),
+		CreateViewModelMapping<EnumDescriptionConverterPage, EnumDescriptionConverterViewModel, ConvertersGalleryPage, ConvertersGalleryViewModel>(),
 		CreateViewModelMapping<EnumToBoolConverterPage, EnumToBoolConverterViewModel, ConvertersGalleryPage, ConvertersGalleryViewModel>(),
 		CreateViewModelMapping<EnumToIntConverterPage, EnumToIntConverterViewModel, ConvertersGalleryPage, ConvertersGalleryViewModel>(),
 		CreateViewModelMapping<ImageResourceConverterPage, ImageResourceConverterViewModel, ConvertersGalleryPage, ConvertersGalleryViewModel>(),

samples/CommunityToolkit.Maui.Sample/CommunityToolkit.Maui.Sample.csproj

@@ -32,8 +32,7 @@
     <WindowsSdkPackageVersion>10.0.19041.56</WindowsSdkPackageVersion>
   </PropertyGroup>
 
-  <PropertyGroup Condition="'$(Configuration)' == 'Release'
-      AND $([MSBuild]::GetTargetPlatformIdentifier('$(TargetFramework)')) != 'windows'">
+  <PropertyGroup Condition="'$(Configuration)' == 'Release'&#xD;&#xA;      AND $([MSBuild]::GetTargetPlatformIdentifier('$(TargetFramework)')) != 'windows'">
     <!-- Windows error NETSDK1102: Optimizing assemblies for size is not supported for the selected publish configuration. -->
     <PublishAot>false</PublishAot>
     <PublishTrimmed>true</PublishTrimmed>
@@ -87,6 +86,18 @@
     <ProjectReference Include="..\..\src\CommunityToolkit.Maui.Maps\CommunityToolkit.Maui.Maps.csproj" />
   </ItemGroup>
 
+  <ItemGroup>
+    <Compile Update="Pages\Converters\EnumDescriptionConverterPage.xaml.cs">
+      <DependentUpon>EnumDescriptionConverterPage.xaml</DependentUpon>
+    </Compile>
+  </ItemGroup>
+
+  <ItemGroup>
+    <MauiXaml Update="Pages\Converters\EnumDescriptionConverterPage.xaml">
+      <Generator>MSBuild:Compile</Generator>
+    </MauiXaml>
+  </ItemGroup>
+
   <PropertyGroup Condition="$([MSBuild]::GetTargetPlatformIdentifier('$(TargetFramework)'))=='windows' and $(Configuration) == 'Release'">
     <RuntimeIdentifier>win-x64</RuntimeIdentifier>
   </PropertyGroup>

samples/CommunityToolkit.Maui.Sample/MauiProgram.cs

@@ -1,5 +1,7 @@
 using System.Diagnostics.CodeAnalysis;
+
 using CommunityToolkit.Maui.ApplicationModel;
+using CommunityToolkit.Maui.Converters;
 using CommunityToolkit.Maui.Core;
 using CommunityToolkit.Maui.Markup;
 using CommunityToolkit.Maui.Media;
@@ -27,9 +29,11 @@
 using CommunityToolkit.Maui.Sample.Views.Popups;
 using CommunityToolkit.Maui.Storage;
 using CommunityToolkit.Maui.Views;
+
 using Microsoft.Extensions.Http.Resilience;
 using Microsoft.Extensions.Logging;
 using Microsoft.Maui.LifecycleEvents;
+
 using Polly;
 
 #if WINDOWS10_0_17763_0_OR_GREATER
@@ -193,6 +197,7 @@ static void RegisterViewsAndViewModels(in IServiceCollection services)
 		services.AddTransientWithShellRoute<CompareConverterPage, CompareConverterViewModel>();
 		services.AddTransientWithShellRoute<DateTimeOffsetConverterPage, DateTimeOffsetConverterViewModel>();
 		services.AddTransientWithShellRoute<DoubleToIntConverterPage, DoubleToIntConverterViewModel>();
+		services.AddTransientWithShellRoute<EnumDescriptionConverterPage, EnumDescriptionConverterViewModel>();
 		services.AddTransientWithShellRoute<EnumToBoolConverterPage, EnumToBoolConverterViewModel>();
 		services.AddTransientWithShellRoute<EnumToIntConverterPage, EnumToIntConverterViewModel>();
 		services.AddTransientWithShellRoute<ImageResourceConverterPage, ImageResourceConverterViewModel>();

samples/CommunityToolkit.Maui.Sample/Pages/Converters/EnumDescriptionConverterPage.xaml

@@ -0,0 +1,70 @@
+<?xml version="1.0" encoding="utf-8" ?>
+<pages:BasePage
+    x:Class="CommunityToolkit.Maui.Sample.Pages.Converters.EnumDescriptionConverterPage"
+    xmlns="http://schemas.microsoft.com/dotnet/2021/maui"
+    xmlns:x="http://schemas.microsoft.com/winfx/2009/xaml"
+    xmlns:pages="clr-namespace:CommunityToolkit.Maui.Sample.Pages"
+    xmlns:toolkit="http://schemas.microsoft.com/dotnet/2022/maui/toolkit"
+    xmlns:vm="clr-namespace:CommunityToolkit.Maui.Sample.ViewModels.Converters"
+    Title="EnumDescriptionConverter"
+    x:DataType="vm:EnumDescriptionConverterViewModel"
+    x:TypeArguments="vm:EnumDescriptionConverterViewModel">
+
+    <pages:BasePage.Resources>
+        <ResourceDictionary>
+            <toolkit:EnumDescriptionConverter x:Key="EnumDescriptionConverter" />
+        </ResourceDictionary>
+    </pages:BasePage.Resources>
+
+    <pages:BasePage.Content>
+        <VerticalStackLayout Padding="20" Spacing="20">
+            <Label VerticalOptions="Center">
+                <Label.FormattedText>
+                    <FormattedString>
+                        <Span Text="The" />
+                        <Span FontAttributes="Bold" Text=" EnumDescriptionConverter " />
+                        <Span Text="converts Enum values into readable text so they display nicely in the UI." />
+                    </FormattedString>
+                </Label.FormattedText>
+            </Label>
+            <Label Text="When an Enum value is passed in, the converter looks for attributes that provide a more user-friendly name. If one is found, it uses that value; otherwise it simply uses the Enum’s name.. " VerticalOptions="Center" />
+            <Label Text="This ensures that Enum values can be displayed clearly while still working correctly even when no attributes are defined. " VerticalOptions="Center" />
+            <Label Text="There is no description needed for one word enum members that are spelled the way you want to display them." />
+
+
+            <Border
+                Margin="0,20,0,0"
+                Padding="15,10"
+                Background="LightGray"
+                StrokeShape="RoundRectangle 8">
+                <HorizontalStackLayout Spacing="10">
+                    <Label
+                        FontSize="16"
+                        Text="Without Converter:"
+                        TextColor="DarkRed" />
+                    <Label
+                        FontAttributes="Bold"
+                        FontSize="16"
+                        Text="{Binding SelectedMode}"
+                        TextColor="DarkRed" />
+                </HorizontalStackLayout>
+            </Border>
+            <Border
+                Padding="15,10"
+                Background="LightGray"
+                StrokeShape="RoundRectangle 8">
+                <HorizontalStackLayout Spacing="10">
+                    <Label
+                        FontSize="16"
+                        Text="With Converter:"
+                        TextColor="DarkRed" />
+                    <Label
+                        FontAttributes="Bold"
+                        FontSize="16"
+                        Text="{Binding SelectedMode, Converter={StaticResource EnumDescriptionConverter}}"
+                        TextColor="DarkRed" />
+                </HorizontalStackLayout>
+            </Border>
+        </VerticalStackLayout>
+    </pages:BasePage.Content>
+</pages:BasePage>

samples/CommunityToolkit.Maui.Sample/Pages/Converters/EnumDescriptionConverterPage.xaml.cs

@@ -0,0 +1,12 @@
+using CommunityToolkit.Maui.Sample.ViewModels.Converters;
+
+namespace CommunityToolkit.Maui.Sample.Pages.Converters;
+
+public partial class EnumDescriptionConverterPage : BasePage<EnumDescriptionConverterViewModel>
+{
+	public EnumDescriptionConverterPage(EnumDescriptionConverterViewModel enumDescriptionConverterViewModel)
+		: base(enumDescriptionConverterViewModel)
+	{
+		InitializeComponent();
+	}
+}

samples/CommunityToolkit.Maui.Sample/ViewModels/Converters/ConvertersGalleryViewModel.cs

@@ -11,6 +11,7 @@ public partial class ConvertersGalleryViewModel() : BaseGalleryViewModel(
 	SectionModel.Create<CompareConverterViewModel>(nameof(CompareConverter), "A converter that compares two IComparable objects and returns a boolean value or one of two specified objects."),
 	SectionModel.Create<DateTimeOffsetConverterViewModel>(nameof(DateTimeOffsetConverter), "A converter that allows to convert from a DateTimeOffset type to a DateTime type"),
 	SectionModel.Create<DoubleToIntConverterViewModel>(nameof(DoubleToIntConverter), "A converter that allows users to convert an incoming double value to an int."),
+	SectionModel.Create<EnumDescriptionConverterViewModel>(nameof(EnumDescriptionConverter), "A converter that converts Enum values into readable text so they display nicely in the UI"),
 	SectionModel.Create<EnumToBoolConverterViewModel>(nameof(EnumToBoolConverter), "A converter that allows you to convert an Enum to boolean value"),
 	SectionModel.Create<EnumToIntConverterViewModel>(nameof(EnumToIntConverter), "A converter that allows you to convert an Enum to its underlying int value"),
 	SectionModel.Create<IndexToArrayItemConverterViewModel>(nameof(IndexToArrayItemConverter), "A converter that allows users to convert a int value binding to an item in an array."),

samples/CommunityToolkit.Maui.Sample/ViewModels/Converters/EnumDescriptionConverterViewModel.cs

@@ -0,0 +1,32 @@
+using System;
+using System.Collections.Generic;
+using System.ComponentModel;
+using System.ComponentModel.DataAnnotations;
+using System.Text;
+
+using CommunityToolkit.Mvvm.ComponentModel;
+
+namespace CommunityToolkit.Maui.Sample.ViewModels.Converters;
+
+public partial class EnumDescriptionConverterViewModel : BaseViewModel
+{
+    [ObservableProperty]
+	public partial ModeName SelectedMode { get; set; }
+
+	public EnumDescriptionConverterViewModel()
+	{
+		SelectedMode = ModeName.DarkMode;
+	}
+}
+
+public enum ModeName
+{
+	//  No Description needed for one word enum members that
+	//  are spelled the way you want to display them
+
+	[Description("Light Mode")] // Can Use Description attribute
+	LightMode,
+	[Display(Name = "Dark Mode")] // Or Display attribute with Name property
+	DarkMode,
+	System
+}

src/CommunityToolkit.Maui.SourceGenerators/Generators/EnumDescriptionGenerator.cs

@@ -0,0 +1,146 @@
+// CommunityToolkit.Maui.Analyzers/EnumDescriptionGenerator.cs
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Text;
+
+using CommunityToolkit.Maui.SourceGenerators.Helpers;
+using CommunityToolkit.Maui.SourceGenerators.Models;
+
+using Microsoft.CodeAnalysis;
+using Microsoft.CodeAnalysis.CSharp;
+using Microsoft.CodeAnalysis.CSharp.Syntax;
+using Microsoft.CodeAnalysis.Text;
+
+namespace CommunityToolkit.Maui.Analyzers;
+
+[Generator]
+public class EnumDescriptionGenerator : IIncrementalGenerator
+{
+	// Using fields instead of const to avoid naming rule violations
+	static readonly string displayAttributeName = "System.ComponentModel.DataAnnotations.DisplayAttribute";
+	static readonly string descriptionAttributeName = "System.ComponentModel.DescriptionAttribute";
+
+   static EnumDescriptionModel? CreateEnumDescriptionModel(INamedTypeSymbol? enumSymbol)
+   {
+	   if (enumSymbol is null || enumSymbol.TypeKind != TypeKind.Enum || !EnumDescriptionGeneratorHelper.IsAccessibleFromNamespace(enumSymbol))
+	   {
+		   return null;
+	   }
+
+	   string ns = enumSymbol.ContainingNamespace.ToDisplayString();
+	   string enumName = enumSymbol.Name;
+	   string enumQualifiedName = enumSymbol.ToDisplayString(SymbolDisplayFormat.FullyQualifiedFormat);
+
+	   var members = new List<EnumMemberModel>();
+	   foreach (IFieldSymbol member in enumSymbol.GetMembers().OfType<IFieldSymbol>())
+	   {
+		   if (member.ConstantValue is null)
+		   {
+			   continue;
+		   }
+
+		   string? description = EnumDescriptionGeneratorHelper.GetDescriptionFromDescriptionAttribute(member, descriptionAttributeName);
+		   string? displayName = null;
+		   string? resourceType = null;
+		   if (EnumDescriptionGeneratorHelper.TryGetDisplayInfo(member, displayAttributeName, out var dn, out var rt))
+		   {
+			   displayName = dn;
+			   resourceType = rt?.ToDisplayString();
+		   }
+
+		   members.Add(new EnumMemberModel(
+			   member.Name,
+			   description,
+			   displayName,
+			   resourceType
+		   ));
+	   }
+
+	   return new EnumDescriptionModel(enumName, ns, enumQualifiedName, members);
+   }
+
+	public void Initialize(IncrementalGeneratorInitializationContext context)
+	{
+       IncrementalValuesProvider<EnumDescriptionModel?> enumModels = context.SyntaxProvider
+		   .CreateSyntaxProvider(
+			   predicate: static (node, _) => node is EnumDeclarationSyntax,
+			   transform: static (ctx, _) => EnumDescriptionGenerator.CreateEnumDescriptionModel(ctx.SemanticModel.GetDeclaredSymbol(ctx.Node) as INamedTypeSymbol))
+		   .Where(static model => model is not null);
+
+       context.RegisterSourceOutput(enumModels, (spc, model) =>
+	   {
+		   if (model is null)
+		   {
+			   return;
+		   }
+
+		   string code = GenerateCode(model);
+		   string hintName = $"{model.QualifiedName.Replace(".", "_")}.g.cs";
+		   spc.AddSource(hintName, SourceText.From(code, Encoding.UTF8));
+	   });
+	}
+
+   static string GenerateCode(EnumDescriptionModel model)
+	{
+       string ns = model.Namespace;
+	   string enumName = model.EnumName;
+	   string enumQualifiedName = model.QualifiedName;
+	   // Remove 'global::' prefix if present
+	   string cleanedQualifiedName = enumQualifiedName.StartsWith("global::", StringComparison.Ordinal)
+		   ? enumQualifiedName.Substring(8)
+		   : enumQualifiedName;
+	   // Replace invalid characters for identifiers
+	   string baseClassName = cleanedQualifiedName.Replace(".", "_").Replace("+", "_");
+	   string initializerClassName = $"{baseClassName}_DescriptionInitializer";
+
+		var sb = new StringBuilder();
+		sb.AppendLine("// <auto-generated />");
+		sb.AppendLine("#nullable enable");
+		sb.AppendLine("using CommunityToolkit.Maui.Converters;");
+		sb.AppendLine();
+
+		if (!string.IsNullOrEmpty(ns))
+		{
+			sb.AppendLine($"namespace {ns};");
+			sb.AppendLine();
+		}
+
+		sb.AppendLine($"internal static class {initializerClassName}");
+		sb.AppendLine("{");
+		sb.AppendLine("    [global::System.Runtime.CompilerServices.ModuleInitializer]");
+		sb.AppendLine("    internal static void Initialize()");
+		sb.AppendLine("    {");
+		sb.AppendLine("        var dict = new global::System.Collections.Generic.Dictionary<string, string>();");
+		sb.AppendLine("        var resolvers = new global::System.Collections.Generic.Dictionary<string, global::System.Func<global::System.Globalization.CultureInfo?, string>>();");
+
+       foreach (var member in model.Members)
+	   {
+		   string fallbackDescription = member.Description ?? member.Name;
+		   if (member.DisplayName is not null && !string.IsNullOrWhiteSpace(member.DisplayName))
+		   {
+			   if (member.ResourceType is not null)
+			   {
+				   // Cannot safely resolve localized resource access at compile-time
+				   sb.AppendLine($"        dict[\"{member.Name}\"] = \"{EnumDescriptionGeneratorHelper.EscapeString(fallbackDescription)}\";");
+				   continue;
+			   }
+			   sb.AppendLine($"        dict[\"{member.Name}\"] = \"{EnumDescriptionGeneratorHelper.EscapeString(member.DisplayName)}\";");
+			   continue;
+		   }
+		   sb.AppendLine($"        dict[\"{member.Name}\"] = \"{EnumDescriptionGeneratorHelper.EscapeString(fallbackDescription)}\";");
+	   }
+
+		sb.AppendLine();
+		sb.AppendLine($"        EnumDescriptionRegistry.Register(typeof({enumQualifiedName}), dict);");
+		sb.AppendLine("        if (resolvers.Count > 0)");
+		sb.AppendLine("        {");
+		sb.AppendLine($"            EnumDescriptionRegistry.Register(typeof({enumQualifiedName}), resolvers);");
+		sb.AppendLine("        }");
+		sb.AppendLine("    }");
+		sb.AppendLine("}");
+
+		return sb.ToString();
+	}
+
+}