feat(blazorui): add Params implementation for BitCard #11806 (#11808)

Author: msynk

src/BlazorUI/Bit.BlazorUI.SourceGenerators/Component/ComponentSourceGenerator.cs

@@ -48,6 +48,8 @@ namespace {namespaceName}
  public partial class {className}
  {{
 ");
+ builder.AppendLine(" private HashSet<string> __assignedParameters = new();");
+ builder.AppendLine("");
  foreach (var par in twoWayParameters)
  {
  var sym = par.PropertySymbol;
@@ -59,6 +61,7 @@ public partial class {className}
  [global::System.Diagnostics.CodeAnalysis.ExcludeFromCodeCoverage]
  public override async Task SetParametersAsync(ParameterView parameters)
  {{");
+ builder.AppendLine($" __assignedParameters.Clear();");
  foreach (var par in twoWayParameters)
  {
  builder.AppendLine($" {par.PropertySymbol.Name}HasBeenSet = false;");
@@ -82,6 +85,7 @@ public override async Task SetParametersAsync(ParameterView parameters)
  var varName = $"@{paramName.ToLower()}";
  var paramType = sym.Type.ToDisplayString();
  builder.AppendLine($" case nameof({paramName}):");
+ builder.AppendLine($" __assignedParameters.Add(nameof({paramName})); ");
  if (par.IsTwoWayBound)
  {
  builder.AppendLine($" {paramName}HasBeenSet = true;");
@@ -140,6 +144,15 @@ public override async Task SetParametersAsync(ParameterView parameters)
  }
  builder.AppendLine(@" }");
 
+ builder.AppendLine("");
+
+ builder.AppendLine($@" [global::System.Diagnostics.DebuggerNonUserCode]
+ [global::System.Diagnostics.CodeAnalysis.ExcludeFromCodeCoverage]
+ public bool HasNotBeenSet(string name)
+ {{");
+ builder.AppendLine(" return __assignedParameters.Contains(name) is false;");
+ builder.AppendLine(" }");
+
  if (twoWayParameters.Length > 0) builder.AppendLine("");
  foreach (var par in twoWayParameters)
  {

src/BlazorUI/Bit.BlazorUI/Components/Surfaces/Card/BitCard.razor.cs

@@ -1,10 +1,17 @@
-namespace Bit.BlazorUI;
+using System.Diagnostics.CodeAnalysis;
+
+namespace Bit.BlazorUI;
 
 /// <summary>
 /// A Card provides a container to wrap around a specific content. Keeping a card to a single subject keeps the design clean.
 /// </summary>
 public partial class BitCard : BitComponentBase
 {
+ [CascadingParameter(Name = BitCardParams.ParamName)]
+ public BitCardParams? CascadingParameters { get; set; }
+
+
+
  /// <summary>
  /// The color kind of the background of the card.
  /// </summary>
@@ -75,4 +82,11 @@ protected override void RegisterCssClasses()
 
  ClassBuilder.Register(() => NoShadow ? "bit-crd-nsd" : string.Empty);
  }
+
+ [DynamicDependency(DynamicallyAccessedMemberTypes.All, typeof(BitCardParams))]
+ protected override void OnParametersSet()
+ {
+ CascadingParameters?.UpdateParameters(this);
+ base.OnParametersSet();
+ }
 }

src/BlazorUI/Bit.BlazorUI/Components/Surfaces/Card/BitCardParams.cs

@@ -0,0 +1,101 @@
+namespace Bit.BlazorUI;
+
+/// <summary>
+/// The parameters for <see cref="BitCard"/> component.
+/// </summary>
+public class BitCardParams : IBitComponentParams
+{
+ /// <summary>
+ /// Represents the parameter name used to identify the BitCard cascading parameters within BitParams.
+ /// </summary>
+ /// <remarks>
+ /// This constant is typically used when referencing or accessing the BitCard value in
+ /// parameterized APIs or configuration settings. Using this constant helps ensure consistency and reduces the risk
+ /// of typographical errors.
+ /// </remarks>
+ public const string ParamName = $"{nameof(BitParams)}.{nameof(BitCard)}";
+
+
+
+ public string Name => ParamName;
+
+
+
+ /// <summary>
+ /// The color kind of the background of the card.
+ /// </summary>
+ public BitColorKind? Background { get; set; }
+
+ /// <summary>
+ /// The color kind of the border of the card.
+ /// </summary>
+ public BitColorKind? Border { get; set; }
+
+ /// <summary>
+ /// Makes the card height 100% of its parent container.
+ /// </summary>
+ public bool? FullHeight { get; set; }
+
+ /// <summary>
+ /// Makes the card width and height 100% of its parent container.
+ /// </summary>
+ public bool? FullSize { get; set; }
+
+ /// <summary>
+ /// Makes the card width 100% of its parent container.
+ /// </summary>
+ public bool? FullWidth { get; set; }
+
+ /// <summary>
+ /// Removes the default shadow around the card.
+ /// </summary>
+ public bool? NoShadow { get; set; }
+
+
+
+ /// <summary>
+ /// Updates the properties of the specified <see cref="BitCard"/> instance with any values that have been set on
+ /// this object, if those properties have not already been set on the <see cref="BitCard"/>.
+ /// </summary>
+ /// <remarks>
+ /// Only properties that have a value set and have not already been set on the <paramref name="bitCard"/> will be updated. 
+ /// This method does not overwrite existing values on <paramref name="bitCard"/>.
+ /// </remarks>
+ /// <param name="bitCard">
+ /// The <see cref="BitCard"/> instance whose properties will be updated. Cannot be null.
+ /// </param>
+ public void UpdateParameters(BitCard bitCard)
+ {
+ if (bitCard is null) return;
+
+ if (Background.HasValue && bitCard.HasNotBeenSet(nameof(Background)))
+ {
+ bitCard.Background = Background.Value;
+ }
+
+ if (Border.HasValue && bitCard.HasNotBeenSet(nameof(Border)))
+ {
+ bitCard.Border = Border.Value;
+ }
+
+ if (FullHeight.HasValue && bitCard.HasNotBeenSet(nameof(FullHeight)))
+ {
+ bitCard.FullHeight = FullHeight.Value;
+ }
+
+ if (FullSize.HasValue && bitCard.HasNotBeenSet(nameof(FullSize)))
+ {
+ bitCard.FullSize = FullSize.Value;
+ }
+
+ if (FullWidth.HasValue && bitCard.HasNotBeenSet(nameof(FullWidth)))
+ {
+ bitCard.FullWidth = FullWidth.Value;
+ }
+
+ if (NoShadow.HasValue && bitCard.HasNotBeenSet(nameof(NoShadow)))
+ {
+ bitCard.NoShadow = NoShadow.Value;
+ }
+ }
+}

src/BlazorUI/Bit.BlazorUI/Utils/Params/BitParams.cs

@@ -1,4 +1,6 @@
-namespace Bit.BlazorUI;
+using System.Diagnostics.CodeAnalysis;
+
+namespace Bit.BlazorUI;
 
 /// <summary>
 /// Provides cascading parameter values for the bit BlazorUI components.
@@ -38,13 +40,16 @@ public override Task SetParametersAsync(ParameterView parameters)
 
 
 
+ [DynamicDependency(DynamicallyAccessedMemberTypes.All, typeof(IBitComponentParams))]
  protected override void BuildRenderTree(RenderTreeBuilder builder)
  {
  var seq = 0;
  var values = new List<BitCascadingValue>();
 
  foreach (var compParams in Parameters ?? [])
  {
+ if (compParams is null) continue;
+
  values.Add(new(compParams, compParams.Name, true));
  }
 

src/BlazorUI/Bit.BlazorUI/Utils/Params/IBitComponentParams.cs

@@ -1,6 +1,12 @@
 namespace Bit.BlazorUI;
 
+/// <summary>
+/// Defines the contract for parameters used by a bit BlazorUI component.
+/// </summary>
 public interface IBitComponentParams
 {
+ /// <summary>
+ /// Gets the name associated with the current instance of BitComponentParams.
+ /// </summary>
  string Name { get; }
 }