Merge pull request #208 from reactivemarbles/AddNewControlsToAvaloniaUI

Add UI extension methods for Avalonia controls

Author: ChrisPulman

src/CrissCross.Avalonia.UI/Extensions/ColorExtensions.cs

@@ -0,0 +1,152 @@
+// Copyright (c) 2019-2025 ReactiveUI Association Incorporated. All rights reserved.
+// ReactiveUI Association Incorporated licenses this file to you under the MIT license.
+// See the LICENSE file in the project root for full license information.
+
+using Avalonia.Media;
+
+namespace CrissCross.Avalonia.UI.Extensions;
+
+/// <summary>
+/// Adds an extension for <see cref="Color"/> that allows manipulation with HSL and HSV color spaces.
+/// </summary>
+public static class ColorExtensions
+{
+    private const float ByteMax = (float)byte.MaxValue;
+
+    /// <summary>
+    /// Creates a <see cref="SolidColorBrush"/> from a <see cref="Color"/>.
+    /// </summary>
+    /// <param name="color">Input color.</param>
+    /// <returns>Brush converted to color.</returns>
+    public static SolidColorBrush ToBrush(this Color color) => new(color);
+
+    /// <summary>
+    /// Creates a <see cref="SolidColorBrush"/> from a <see cref="Color"/> with defined brush opacity.
+    /// </summary>
+    /// <param name="color">Input color.</param>
+    /// <param name="opacity">Degree of opacity.</param>
+    /// <returns>Brush converted to color with modified opacity.</returns>
+    public static SolidColorBrush ToBrush(this Color color, double opacity) => new(color, opacity);
+
+    /// <summary>
+    /// Gets <see cref="Color"/> luminance based on HSL space.
+    /// </summary>
+    /// <param name="color">Input color.</param>
+    /// <returns>Luminance value.</returns>
+    public static double GetLuminance(this Color color)
+    {
+        var hsl = color.ToHsl();
+        return hsl.L;
+    }
+
+    /// <summary>
+    /// Gets <see cref="Color"/> brightness based on HSV space.
+    /// </summary>
+    /// <param name="color">Input color.</param>
+    /// <returns>Brightness value.</returns>
+    public static double GetBrightness(this Color color)
+    {
+        var hsv = color.ToHsv();
+        return hsv.V;
+    }
+
+    /// <summary>
+    /// Gets <see cref="Color"/> hue based on HSV space.
+    /// </summary>
+    /// <param name="color">Input color.</param>
+    /// <returns>Hue value.</returns>
+    public static double GetHue(this Color color)
+    {
+        var hsv = color.ToHsv();
+        return hsv.H;
+    }
+
+    /// <summary>
+    /// Gets <see cref="Color"/> saturation based on HSV space.
+    /// </summary>
+    /// <param name="color">Input color.</param>
+    /// <returns>Saturation value.</returns>
+    public static double GetSaturation(this Color color)
+    {
+        var hsv = color.ToHsv();
+        return hsv.S;
+    }
+
+    /// <summary>
+    /// Allows to change the luminance by a factor based on the HSL color space.
+    /// </summary>
+    /// <param name="color">Input color.</param>
+    /// <param name="factor">The value of the luminance change factor from 100 to -100.</param>
+    /// <returns>Updated <see cref="Color"/>.</returns>
+    public static Color UpdateLuminance(this Color color, float factor)
+    {
+        ArgumentOutOfRangeException.ThrowIfGreaterThan(factor, 100f);
+        ArgumentOutOfRangeException.ThrowIfLessThan(factor, -100f);
+
+        var hsl = color.ToHsl();
+        var newL = Math.Clamp(hsl.L + (factor / 100.0), 0.0, 1.0);
+        return HslColor.ToRgb(hsl.H, hsl.S, newL, hsl.A);
+    }
+
+    /// <summary>
+    /// Allows to change the saturation by a factor based on the HSL color space.
+    /// </summary>
+    /// <param name="color">Input color.</param>
+    /// <param name="factor">The value of the saturation change factor from 100 to -100.</param>
+    /// <returns>Updated <see cref="Color"/>.</returns>
+    public static Color UpdateSaturation(this Color color, float factor)
+    {
+        ArgumentOutOfRangeException.ThrowIfGreaterThan(factor, 100f);
+        ArgumentOutOfRangeException.ThrowIfLessThan(factor, -100f);
+
+        var hsl = color.ToHsl();
+        var newS = Math.Clamp(hsl.S + (factor / 100.0), 0.0, 1.0);
+        return HslColor.ToRgb(hsl.H, newS, hsl.L, hsl.A);
+    }
+
+    /// <summary>
+    /// Allows to change the brightness by a factor based on the HSV color space.
+    /// </summary>
+    /// <param name="color">Input color.</param>
+    /// <param name="factor">The value of the brightness change factor from 100 to -100.</param>
+    /// <returns>Updated <see cref="Color"/>.</returns>
+    public static Color UpdateBrightness(this Color color, float factor)
+    {
+        ArgumentOutOfRangeException.ThrowIfGreaterThan(factor, 100f);
+        ArgumentOutOfRangeException.ThrowIfLessThan(factor, -100f);
+
+        var hsv = color.ToHsv();
+        var newV = Math.Clamp(hsv.V + (factor / 100.0), 0.0, 1.0);
+        return HsvColor.ToRgb(hsv.H, hsv.S, newV, hsv.A);
+    }
+
+    /// <summary>
+    /// Converts a hex string to a Color.
+    /// </summary>
+    /// <param name="hex">The hex string.</param>
+    /// <returns>The color, or null if parsing fails.</returns>
+    public static Color? FromHex(string hex)
+    {
+        if (Color.TryParse(hex, out var color))
+        {
+            return color;
+        }
+
+        return null;
+    }
+
+    /// <summary>
+    /// Converts a Color to a hex string.
+    /// </summary>
+    /// <param name="color">The color.</param>
+    /// <returns>The hex string representation.</returns>
+    public static string ToHex(this Color color) => color.ToString();
+
+    /// <summary>
+    /// Converts a Color to a hex string without alpha.
+    /// </summary>
+    /// <param name="color">The color.</param>
+    /// <returns>The hex string representation without alpha.</returns>
+    public static string ToHexWithoutAlpha(this Color color) =>
+        $"#{color.R:X2}{color.G:X2}{color.B:X2}";
+}

src/CrissCross.Avalonia.UI/Extensions/ContentDialogServiceExtensions.cs

@@ -0,0 +1,27 @@
+// Copyright (c) 2019-2025 ReactiveUI Association Incorporated. All rights reserved.
+// ReactiveUI Association Incorporated licenses this file to you under the MIT license.
+// See the LICENSE file in the project root for full license information.
+
+using CrissCross.Avalonia.UI.Controls;
+
+namespace CrissCross.Avalonia.UI.Extensions;
+
+/// <summary>
+/// Extensions for <see cref="IContentDialogService"/>.
+/// </summary>
+public static class ContentDialogServiceExtensions
+{
+    /// <summary>
+    /// Shows the content dialog asynchronously.
+    /// </summary>
+    /// <param name="contentDialogService">The content dialog service.</param>
+    /// <param name="dialog">The dialog to show.</param>
+    /// <returns>A task that represents the asynchronous operation. The task result contains the dialog result.</returns>
+    public static Task<ContentDialogResult> ShowAsync(
+        this IContentDialogService contentDialogService,
+        ContentDialog dialog)
+    {
+        ArgumentNullException.ThrowIfNull(contentDialogService);
+        return contentDialogService.ShowAsync(dialog, CancellationToken.None);
+    }
+}

src/CrissCross.Avalonia.UI/Extensions/ControlExtensions.cs

@@ -0,0 +1,100 @@
+// Copyright (c) 2019-2025 ReactiveUI Association Incorporated. All rights reserved.
+// ReactiveUI Association Incorporated licenses this file to you under the MIT license.
+// See the LICENSE file in the project root for full license information.
+
+using Avalonia;
+using Avalonia.Controls;
+using Avalonia.VisualTree;
+
+namespace CrissCross.Avalonia.UI.Extensions;
+
+/// <summary>
+/// Extension methods for <see cref="Control"/>.
+/// </summary>
+public static class ControlExtensions
+{
+    /// <summary>
+    /// Finds a parent of the given type.
+    /// </summary>
+    /// <typeparam name="T">The type of parent to find.</typeparam>
+    /// <param name="control">The control to start from.</param>
+    /// <returns>The parent of the specified type, or null if not found.</returns>
+    public static T? FindParent<T>(this Control control)
+        where T : Control
+    {
+        ArgumentNullException.ThrowIfNull(control);
+
+        var parent = control.Parent;
+        while (parent is not null)
+        {
+            if (parent is T typedParent)
+            {
+                return typedParent;
+            }
+
+            parent = parent.Parent;
+        }
+
+        return null;
+    }
+
+    /// <summary>
+    /// Finds a child of the given type.
+    /// </summary>
+    /// <typeparam name="T">The type of child to find.</typeparam>
+    /// <param name="control">The control to start from.</param>
+    /// <returns>The child of the specified type, or null if not found.</returns>
+    public static T? FindChild<T>(this Control control)
+        where T : Control
+    {
+        ArgumentNullException.ThrowIfNull(control);
+
+        if (control is not Panel panel)
+        {
+            return null;
+        }
+
+        foreach (var child in panel.Children)
+        {
+            if (child is T typedChild)
+            {
+                return typedChild;
+            }
+
+            if (child is Control childControl)
+            {
+                var result = childControl.FindChild<T>();
+                if (result is not null)
+                {
+                    return result;
+                }
+            }
+        }
+
+        return null;
+    }
+
+    /// <summary>
+    /// Gets the bounds of the control relative to the root visual.
+    /// </summary>
+    /// <param name="control">The control.</param>
+    /// <returns>The bounds in screen coordinates.</returns>
+    public static Rect GetBoundsRelativeToRoot(this Control control)
+    {
+        ArgumentNullException.ThrowIfNull(control);
+
+        var root = control.GetVisualRoot();
+        if (root is null)
+        {
+            return default;
+        }
+
+        var transform = control.TransformToVisual((Visual)root);
+        if (transform.HasValue)
+        {
+            return new Rect(control.Bounds.Size).TransformToAABB(transform.Value);
+        }
+
+        return default;
+    }
+}

src/CrissCross.Avalonia.UI/Extensions/NavigationServiceExtensions.cs

@@ -0,0 +1,61 @@
+// Copyright (c) 2019-2025 ReactiveUI Association Incorporated. All rights reserved.
+// ReactiveUI Association Incorporated licenses this file to you under the MIT license.
+// See the LICENSE file in the project root for full license information.
+
+namespace CrissCross.Avalonia.UI.Extensions;
+
+/// <summary>
+/// Extensions for <see cref="INavigationService"/>.
+/// </summary>
+public static class NavigationServiceExtensions
+{
+    /// <summary>
+    /// Lets you navigate to the selected page based on it's type.
+    /// </summary>
+    /// <typeparam name="T">Type of the page.</typeparam>
+    /// <param name="navigationService">The navigation service.</param>
+    /// <returns><see langword="true"/> if the operation succeeds. <see langword="false"/> otherwise.</returns>
+    public static bool Navigate<T>(this INavigationService navigationService)
+    {
+        ArgumentNullException.ThrowIfNull(navigationService);
+        return navigationService.Navigate(typeof(T));
+    }
+
+    /// <summary>
+    /// Lets you navigate to the selected page based on it's type.
+    /// </summary>
+    /// <typeparam name="T">Type of the page.</typeparam>
+    /// <param name="navigationService">The navigation service.</param>
+    /// <param name="dataContext">DataContext <see cref="object"/>.</param>
+    /// <returns><see langword="true"/> if the operation succeeds. <see langword="false"/> otherwise.</returns>
+    public static bool Navigate<T>(this INavigationService navigationService, object? dataContext)
+    {
+        ArgumentNullException.ThrowIfNull(navigationService);
+        return navigationService.Navigate(typeof(T), dataContext);
+    }
+
+    /// <summary>
+    /// Synchronously adds an element to the navigation stack and navigates current navigation Frame to the page represented by the element.
+    /// </summary>
+    /// <typeparam name="T">Type of control to be synchronously added to the navigation stack.</typeparam>
+    /// <param name="navigationService">The navigation service.</param>
+    /// <returns><see langword="true"/> if the operation succeeds. <see langword="false"/> otherwise.</returns>
+    public static bool NavigateWithHierarchy<T>(this INavigationService navigationService)
+    {
+        ArgumentNullException.ThrowIfNull(navigationService);
+        return navigationService.NavigateWithHierarchy(typeof(T));
+    }
+
+    /// <summary>
+    /// Synchronously adds an element to the navigation stack and navigates current navigation Frame to the page represented by the element.
+    /// </summary>
+    /// <typeparam name="T">Type of control to be synchronously added to the navigation stack.</typeparam>
+    /// <param name="navigationService">The navigation service.</param>
+    /// <param name="dataContext">DataContext <see cref="object"/>.</param>
+    /// <returns><see langword="true"/> if the operation succeeds. <see langword="false"/> otherwise.</returns>
+    public static bool NavigateWithHierarchy<T>(this INavigationService navigationService, object? dataContext)
+    {
+        ArgumentNullException.ThrowIfNull(navigationService);
+        return navigationService.NavigateWithHierarchy(typeof(T), dataContext);
+    }
+}