chore: add net9.0 support and improve documentation and type definitions

Author: Json-exe

Blazor.Cropper/Blazor.Cropper.csproj

@@ -19,7 +19,7 @@
         <RootNamespace>Json_exe.Blazor.Cropper</RootNamespace>
         <PackageIcon>Json_exe.Blazor.Cropper-Logo.png</PackageIcon>
         <GenerateDocumentationFile>true</GenerateDocumentationFile>
-        <TargetFramework>net8.0</TargetFramework>
+        <TargetFrameworks>net8.0;net9.0</TargetFrameworks>
     </PropertyGroup>
 
 

Blazor.Cropper/CropperJsInterop.cs

@@ -11,7 +11,7 @@ namespace Json_exe.Blazor.Cropper;
 // This class can be registered as scoped DI service and then injected into Blazor
 // components for use.
 
-public class CropperJsInterop : IAsyncDisposable
+internal sealed class CropperJsInterop : IAsyncDisposable
 {
     private readonly Lazy<Task<IJSObjectReference>> _moduleTask;
     private IJSObjectReference _cropModule = null!;

Blazor.Cropper/CropperWrapper.razor.cs

@@ -44,6 +44,7 @@ public partial class CropperWrapper : IAsyncDisposable
 
     private ElementReference ElementRef { get; set; }
 
+    /// <inheritdoc />
     protected override async Task OnAfterRenderAsync(bool firstRender)
     {
         if (firstRender)
@@ -250,6 +251,7 @@ public async Task DestroyBlobs()
         await CropperJsInterop.DestroyBlobs();
     }
 
+    /// <inheritdoc />
     public async ValueTask DisposeAsync()
     {
         if (CropperJsInterop != null) await CropperJsInterop.DisposeAsync();

Blazor.Cropper/DependencyInjectionExtension.cs

@@ -2,8 +2,16 @@
 
 namespace Json_exe.Blazor.Cropper;
 
+/// <summary>
+/// Provides extension methods for dependency injection related to the Cropper component.
+/// </summary>
 public static class DependencyInjectionExtension
 {
+    /// <summary>
+    /// Registers the required services for the CropperWrapper in the dependency injection container.
+    /// </summary>
+    /// <param name="services">The service collection in which to register the services.</param>
+    /// <returns>The IServiceCollection instance for chaining further configuration.</returns>
     public static IServiceCollection AddCropper(this IServiceCollection services)
     {
         services.AddScoped<CropperJsInterop>();

Blazor.Cropper/Model/CropperEvents.cs

@@ -1,5 +1,9 @@
 namespace Json_exe.Blazor.Cropper.Model;
 
+/// <summary>
+/// Represents an event triggered during the zooming process in the cropper tool.
+/// This class provides information about the current and previous zoom ratios.
+/// </summary>
 public sealed class ZoomEvent
 {
     /// <summary>
@@ -12,4 +16,8 @@ public sealed class ZoomEvent
     public double OldRatio { get; set; }
 }
 
+/// <summary>
+/// Represents an event that occurs during the cropping process within the cropper tool.
+/// This class extends CropData to include positional and dimension details of the crop.
+/// </summary>
 public sealed record CropEvent : CropData;

Blazor.Cropper/Model/CropperException.cs

@@ -1,7 +1,23 @@
 namespace Json_exe.Blazor.Cropper.Model;
 
+/// <summary>
+/// Represents an exception that occurs in the Cropper functionality within the Blazor component.
+/// </summary>
+/// <remarks>
+/// This exception is thrown when an error specific to CropperJS operations happens. It can encapsulate
+/// a custom error message and an optional inner exception to provide more detailed error context.
+/// </remarks>
 public sealed class CropperException : Exception
 {
+    /// <summary>
+    /// Represents an exception that occurs specifically within the Cropper functionality in Blazor.
+    /// </summary>
+    /// <remarks>
+    /// This exception is used to capture and handle errors that arise from operations performed
+    /// by the Cropper functionality, such as invoking JS interops or working with cropper-specific
+    /// data. It supports providing a detailed error message and an optional inner exception for
+    /// further context.
+    /// </remarks>
     public CropperException(string? message, Exception? innerException) : base(message, innerException)
     {
     }

Blazor.Cropper/Model/CropperObjects.cs

@@ -2,64 +2,111 @@
 
 namespace Json_exe.Blazor.Cropper.Model;
 
+/// <summary>
+/// Represents the cropping data of an image, including position, size, rotation, and scaling factors.
+/// </summary>
 public record CropData
 {
-    public double X { get; set; }
-    public double Y { get; set; }
-    public double Width { get; set; }
-    public double Height { get; set; }
-    public double Rotate { get; set; }
-    public double ScaleX { get; set; }
-    public double ScaleY { get; set; }
+    /// <summary>
+    /// The horizontal position of the cropping area on the source image.
+    /// </summary>
+    public double X { get; init; }
+
+    /// <summary>
+    /// The vertical position of the cropping area on the source image.
+    /// </summary>
+    public double Y { get; init; }
+
+    /// <summary>
+    /// The width dimension of the object, typically used to define size or scale in rendering or cropping contexts.
+    /// </summary>
+    public double Width { get; init; }
+
+    /// <summary>
+    /// The destination height of the output canvas.
+    /// </summary>
+    public double Height { get; init; }
+
+    /// <summary>
+    /// The rotation angle of the cropped image, in degrees.
+    /// </summary>
+    public double Rotate { get; init; }
+
+    /// <summary>
+    /// The horizontal scaling factor applied to the image during cropping.
+    /// </summary>
+    public double ScaleX { get; init; }
+
+    /// <summary>
+    /// The vertical scaling factor applied to the image during cropping.
+    /// </summary>
+    public double ScaleY { get; init; }
 }
 
+/// <summary>
+/// Represents configurable options for customizing the output canvas of a cropped image,
+/// including canvas dimensions, color settings, and image smoothing properties.
+/// Read more at: https://github.com/fengyuanchen/cropperjs/blob/v1/README.md#getcroppedcanvasoptions
+/// </summary>
 public sealed class CropCanvasOptions
 {
     /// <summary>
     /// The destination width of the output canvas.
     /// </summary>
     public double Width { get; set; }
+
     /// <summary>
     /// The destination height of the output canvas.
     /// </summary>
     public double Height { get; set; }
+
     /// <summary>
     /// The minimum destination width of the output canvas.
     /// </summary>
     public double MinWidth { get; set; } = 0;
+
     /// <summary>
     /// The minimum destination height of the output canvas.
     /// </summary>
     public double MinHeight { get; set; } = 0;
+
     /// <summary>
     /// The maximum destination width of the output canvas.
     /// </summary>
     [JsonNumberHandling(JsonNumberHandling.AllowNamedFloatingPointLiterals)]
     public double MaxWidth { get; set; } = double.PositiveInfinity;
+
     /// <summary>
     /// The maximum destination height of the output canvas.
     /// </summary>
     [JsonNumberHandling(JsonNumberHandling.AllowNamedFloatingPointLiterals)]
     public double MaxHeight { get; set; } = double.PositiveInfinity;
+
     /// <summary>
     /// A color to fill any alpha values in the output canvas.
     /// </summary>
     public string FillColor { get; set; } = "transparent";
+
     /// <summary>
     /// Set to change if images are smoothed or not.
     /// </summary>
     public bool ImageSmoothingEnabled { get; set; } = true;
+
     /// <summary>
     /// Set the quality of image smoothing.
     /// </summary>
     [JsonConverter(typeof(JsonStringEnumConverter))]
     public ImageSmoothingQuality ImageSmoothingQuality { get; set; } = ImageSmoothingQuality.low;
+
     /// <summary>
     /// Set to true to use rounded values.
     /// </summary>
     public bool Rounded { get; set; } = false;
 }
 
+/// <summary>
+/// Defines the quality levels for image smoothing when rendering a cropped image on a canvas.
+/// </summary>
 public enum ImageSmoothingQuality
 {
     low,

Blazor.Cropper/Model/CropperOptions.cs

@@ -2,6 +2,9 @@
 
 namespace Json_exe.Blazor.Cropper.Model;
 
+/// <summary>
+/// Represents the configuration options for a cropper instance. Read more at https://github.com/fengyuanchen/cropperjs/blob/v1/README.md#options
+/// </summary>
 public class CropperOptions
 {
     [JsonPropertyName("viewMode")] public int ViewMode { get; set; } = 0;
@@ -42,14 +45,22 @@ public class CropperOptions
 
     [JsonPropertyName("toggleDragModeOnDblclick")]
     public bool ToggleDragModeOnDblclick { get; set; } = true;
-    [JsonPropertyName("minContainerWidth")] public double MinContainerWidth { get; set; } = 200;
-    [JsonPropertyName("minContainerHeight")] public double MinContainerHeight { get; set; } = 100;
+
+    [JsonPropertyName("minContainerWidth")]
+    public double MinContainerWidth { get; set; } = 200;
+
+    [JsonPropertyName("minContainerHeight")]
+    public double MinContainerHeight { get; set; } = 100;
+
     [JsonPropertyName("minCanvasWidth")] public double MinCanvasWidth { get; set; } = 0;
     [JsonPropertyName("minCanvasHeight")] public double MinCanvasHeight { get; set; } = 0;
     [JsonPropertyName("minCropBoxWidth")] public double MinCropBoxWidth { get; set; } = 0;
     [JsonPropertyName("minCropBoxHeight")] public double MinCropBoxHeight { get; set; } = 0;
 }
 
+/// <summary>
+/// Specifies the drag mode for a cropper instance, determining how the crop box or canvas can be manipulated by user interactions.
+/// </summary>
 public enum DragMode
 {
     crop,