Docs: MudColorPicker: Added XML Documentation for Public Members

src/MudBlazor/Base/MudBaseButton.cs

@@ -75,7 +75,7 @@ public abstract class MudBaseButton : MudComponentBase
         public string? Rel { get; set; }
 
         /// <summary>
-        /// Whether the user can interact with this button.
+        /// Allows the user to interact with this button.
         /// </summary>
         /// <remarks>
         /// Defaults to <c>false</c>.
@@ -95,7 +95,7 @@ public abstract class MudBaseButton : MudComponentBase
         public string? Title { get; set; }
 
         /// <summary>
-        /// Whether a click event is bubbled up to the parent component.
+        /// Allows the click event to bubble up to the parent component.
         /// </summary>
         /// <remarks>
         /// Defaults to <c>false</c>.
@@ -105,7 +105,7 @@ public abstract class MudBaseButton : MudComponentBase
         public bool ClickPropagation { get; set; }
 
         /// <summary>
-        /// Whether a shadow is displayed.
+        /// Displays a shadow.
         /// </summary>
         /// <remarks>
         /// Defaults to <c>true</c>.
@@ -115,7 +115,7 @@ public abstract class MudBaseButton : MudComponentBase
         public bool DropShadow { get; set; } = true;
 
         /// <summary>
-        /// Whether a ripple effect is shown when the user clicks the button.
+        /// Shows a ripple effect when the user clicks the button.
         /// </summary>
         /// <remarks>
         /// Defaults to <c>true</c>.

src/MudBlazor/Base/MudBaseInput.cs

@@ -19,7 +19,7 @@ public abstract class MudBaseInput<T> : MudFormComponent<T, string>
     {
         private bool _isDirty;
         /// <summary>
-        /// Whether validation has been performed during a validation cycle.
+        /// Prevents validation from occurring more than once during a validation cycle.
         /// </summary>
         /// <remarks>
         /// This field is set to <c>true</c> to prevent validation from occurring more than once during a validation cycle.  Each change in the <see cref="Value"/> will reset this field to <c>false</c>.
@@ -42,7 +42,7 @@ protected MudBaseInput()
         }
 
         /// <summary>
-        /// Whether the component can receive input.
+        /// Allows the component to receive input.
         /// </summary>
         /// <remarks>
         /// Defaults to <c>false</c>.
@@ -55,7 +55,7 @@ protected MudBaseInput()
         private bool ParentDisabled { get; set; }
 
         /// <summary>
-        /// Whether the input can be changed by the user.
+        /// Prevents the input from being changed by the user.
         /// </summary>
         /// <remarks>
         /// Defaults to <c>false</c>.  When <c>true</c>, the user can copy text in the control, but cannot change the <see cref="Value" />.
@@ -68,7 +68,7 @@ protected MudBaseInput()
         private bool ParentReadOnly { get; set; }
 
         /// <summary>
-        /// Whether this input fills the full width of its container.
+        /// Fills the full width of the parent container.
         /// </summary>
         /// <remarks>
         /// Defaults to <c>false</c>.
@@ -78,7 +78,7 @@ protected MudBaseInput()
         public bool FullWidth { get; set; }
 
         /// <summary>
-        /// Whether the <see cref="Value"/> is changed as soon as input is received.
+        /// Changes the <see cref="Value"/> as soon as input is received.
         /// </summary>
         /// <remarks>
         /// Defaults to <c>false</c>.  When <c>true</c>, the <see cref="Value"/> property will be updated any time user input occurs.  Otherwise, <see cref="Value"/> is updated when the user presses <c>Enter</c> or the input loses focus.
@@ -88,7 +88,7 @@ protected MudBaseInput()
         public bool Immediate { get; set; }
 
         /// <summary>
-        /// Whether the input has an underline.
+        /// Displays an underline for the input.
         /// </summary>
         /// <remarks>
         /// Defaults to <c>true</c>.
@@ -108,7 +108,7 @@ protected MudBaseInput()
         public string? HelperText { get; set; }
 
         /// <summary>
-        /// Whether the <see cref="HelperText"/> is only shown when this input has focus.
+        /// Displays the <see cref="HelperText"/> only when this input has focus.
         /// </summary>
         /// <remarks>
         /// Defaults to <c>false</c>.
@@ -148,7 +148,7 @@ protected MudBaseInput()
         public Adornment Adornment { get; set; } = Adornment.None;
 
         /// <summary>
-        /// Whether validation only occurs when the user changes the <see cref="Value"/>.
+        /// Limits validation to when the user changes the <see cref="Value"/>.
         /// </summary>
         /// <remarks>
         /// Defaults to <c>false</c>. When <c>true</c>, validation only occurs if the user has changed the input value at least once.
@@ -261,7 +261,7 @@ protected MudBaseInput()
         public string? Label { get; set; }
 
         /// <summary>
-        /// Whether this input automatically receives focus.
+        /// Automatically receives focus.
         /// </summary>
         /// <remarks>
         /// Defaults to <c>false</c>.  When <c>true</c>, the input will receive focus automatically.
@@ -285,7 +285,7 @@ protected MudBaseInput()
         public string? Text { get; set; }
 
         /// <summary>
-        /// Whether the text cannot be updated via a bound value.
+        /// Prevents the text from being updated via a bound value.
         /// </summary>
         /// <remarks>
         /// Defaults to <c>true</c>.  Applies only to Blazor Server (BSS) applications.  When <c>false</c>, the input's text can be updated programmatically while the input has focus.
@@ -315,7 +315,7 @@ protected MudBaseInput()
         public virtual string? Pattern { get; set; }
 
         /// <summary>
-        /// Whether the label is allowed to appear inside the input if no <see cref="Value"/> is specified.
+        /// Shows the label inside the input if no <see cref="Value"/> is specified.
         /// </summary>
         /// <remarks>
         /// Defaults to <c>false</c>.  When <c>true</c>, the label will not move into the input when the input is empty.
@@ -349,7 +349,7 @@ protected MudBaseInput()
         public EventCallback<KeyboardEventArgs> OnKeyDown { get; set; }
 
         /// <summary>
-        /// Whether the default key-down action occurs.
+        /// Allows the default key-down action to occur.
         /// </summary>
         /// <remarks>
         /// When <c>true</c>, the browser will not perform its default behavior when a key-down occurs.  This is typically used when a key-down needs to override a browser's default behavior.
@@ -365,7 +365,7 @@ protected MudBaseInput()
         public EventCallback<KeyboardEventArgs> OnKeyUp { get; set; }
 
         /// <summary>
-        /// Whether the default key-up action occurs.
+        /// Prevents the default key-up action.
         /// </summary>
         /// <remarks>
         /// When <c>true</c>, the browser will not perform its default behavior when a key-up occurs.  This is typically used when a key-up needs to override the browser's default behavior.

src/MudBlazor/Base/MudBaseSelectItem.cs

@@ -14,15 +14,18 @@ public abstract class MudBaseSelectItem : MudComponentBase
         private NavigationManager UriHelper { get; set; } = null!;
 
         /// <summary>
-        /// Whether the user can interact with this item.
+        /// PRevents the user from interacting with this item.
         /// </summary>
         [Parameter]
         [Category(CategoryTypes.General.Behavior)]
         public bool Disabled { get; set; }
 
         /// <summary>
-        /// Whether to show a ripple effect when the user clicks the button. Default is true.
+        /// Shows a ripple effect when the user clicks the button.
         /// </summary>
+        /// <remarks>
+        /// Defaults to <c>true</c>.
+        /// </remarks>
         [Parameter]
         [Category(CategoryTypes.General.Appearance)]
         public bool Ripple { get; set; } = true;
@@ -35,7 +38,7 @@ public abstract class MudBaseSelectItem : MudComponentBase
         public string? Href { get; set; }
 
         /// <summary>
-        /// Whether a full page load occurs during navigation.
+        /// Performs a full page load during navigation.
         /// </summary>
         /// <remarks>
         /// Defaults to <c>false</c>. When <c>true</c>, client-side routing is bypassed and the browser is forced to load the new page from the server.

src/MudBlazor/Base/MudBooleanInput.cs

@@ -18,7 +18,7 @@ public class MudBooleanInput<T> : MudFormComponent<T?, bool?>
         public MudBooleanInput() : base(new BoolConverter<T?>()) { }
 
         /// <summary>
-        /// Whether the user can interact with this input.
+        /// PRevents the user from interacting with this input.
         /// </summary>
         /// <remarks>
         /// Defaults to <c>false</c>.
@@ -33,7 +33,7 @@ public class MudBooleanInput<T> : MudFormComponent<T?, bool?>
         protected bool GetDisabledState() => Disabled || ParentDisabled;
 
         /// <summary>
-        /// Whether the use can change the input.
+        /// Prevents the user from changing the input.
         /// </summary>
         /// <remarks>
         /// Defaults to <c>false</c>.  When <c>true</c>, the user can copy the input but cannot change it.
@@ -63,7 +63,7 @@ public class MudBooleanInput<T> : MudFormComponent<T?, bool?>
         }
 
         /// <summary>
-        /// Whether the parent component also handles the click event.
+        /// Prevents the parent component from receiving click events.
         /// </summary>
         /// <remarks>
         /// Defaults to <c>true</c>.  When <c>true</c>, the click will not bubble up to parent components.

src/MudBlazor/Base/MudComponentBase.cs

@@ -66,7 +66,7 @@ public abstract class MudComponentBase : ComponentBaseWithState, IMudStateHasCha
         public Dictionary<string, object?> UserAttributes { get; set; } = new Dictionary<string, object?>();
 
         /// <summary>
-        /// Whether <see cref="JSRuntime" /> is available.
+        /// Indicates that JavaScript interop is available.
         /// </summary>
         protected bool IsJSRuntimeAvailable { get; set; }
 

src/MudBlazor/Base/MudFormComponent.cs

@@ -44,7 +44,7 @@ protected MudFormComponent(Converter<T, U> converter)
         internal bool SubscribeToParentForm { get; set; } = true;
 
         /// <summary>
-        /// Whether an input is required.
+        /// Requires an input value.
         /// </summary>
         /// <remarks>
         /// Defaults to <c>false</c>.  When <c>true</c>, an error with the text in <see cref="RequiredError"/> will be shown during validation if no input was given.
@@ -71,7 +71,7 @@ protected MudFormComponent(Converter<T, U> converter)
         public string? ErrorText { get; set; }
 
         /// <summary>
-        /// Whether an error is displayed.
+        /// Displays an error.
         /// </summary>
         /// <remarks>
         /// Defaults to <c>false</c>.  When <c>true</c>, the text in <see cref="ErrorText"/> is displayed.
@@ -156,7 +156,7 @@ protected virtual void OnConversionErrorOccurred(string error)
         }
 
         /// <summary>
-        /// Whether a problem has occurred during conversion.
+        /// Indicates a problem has occurred during conversion.
         /// </summary>
         /// <remarks>
         /// When <c>true</c>, the <see cref="Converter"/> was unable to convert values, usually due to invalid input.
@@ -173,7 +173,7 @@ protected virtual void OnConversionErrorOccurred(string error)
         public string? ConversionErrorMessage => _converter.GetErrorMessage;
 
         /// <summary>
-        /// Whether an error, conversion error, or validation error is active.
+        /// Indicates any error, conversion error, or validation error with this input.
         /// </summary>
         /// <remarks>
         /// When <c>true</c>, the <see cref="Error"/> property is <c>true</c>, or <see cref="ConversionError"/> is <c>true</c>, or one or more <see cref="ValidationErrors"/> exists.
@@ -203,7 +203,7 @@ protected virtual void OnConversionErrorOccurred(string error)
         }
 
         /// <summary>
-        /// Whether the user has interacted with this input, or focus has been released.
+        /// Indicates the user has interacted with this input or focus has been released.
         /// </summary>
         /// <remarks>
         /// Defaults to <c>false</c>.  When <c>true</c>, the user has performed input, or focus has moved away from this input.  This property is typically used to show the <see cref="RequiredError"/> text only after the user has interacted with this input.
@@ -671,7 +671,7 @@ internal void EditFormValidate()
         public Expression<Func<T>>? For { get; set; }
 
         /// <summary>
-        /// Whether the <see cref="For"/> property is <c>null</c>.
+        /// Indicates if the <see cref="For"/> property is <c>null</c>.
         /// </summary>
         [MemberNotNullWhen(false, nameof(For))]
         public bool IsForNull => For is null;

src/MudBlazor/Components/Alert/MudAlert.razor.cs

@@ -45,12 +45,6 @@ private HorizontalAlignment ConvertHorizontalAlignment(HorizontalAlignment conte
             };
         }
 
-        /// <summary>
-        /// Gets or sets whether Right-to-Left (RTL) mode is enabled.
-        /// </summary>
-        /// <remarks>
-        /// Defaults to <c>false</c>. When <c>true</c>, text will be displayed right-to-left.
-        /// </remarks>
         [CascadingParameter(Name = "RightToLeft")]
         public bool RightToLeft { get; set; }
 

src/MudBlazor/Components/Autocomplete/MudAutocomplete.razor.cs

@@ -117,7 +117,7 @@ public partial class MudAutocomplete<T> : MudBaseInput<T>
         public Origin TransformOrigin { get; set; } = Origin.TopCenter;
 
         /// <summary>
-        /// Whether compact padding will be used.
+        /// Uses compact padding.
         /// </summary>
         /// <remarks>
         /// Defaults to <c>false</c>.
@@ -181,7 +181,7 @@ public partial class MudAutocomplete<T> : MudBaseInput<T>
         }
 
         /// <summary>
-        /// Whether to show the progress indicator during searches.
+        /// Shows the progress indicator during searches.
         /// </summary>
         /// <remarks>
         /// Defaults to <c>false</c>.  The progress indicator uses the color specified in the <see cref="ProgressIndicatorColor"/> property.
@@ -231,7 +231,7 @@ public partial class MudAutocomplete<T> : MudBaseInput<T>
         public int MinCharacters { get; set; } = 0;
 
         /// <summary>
-        /// Whether to reset the selected value if the user deletes the text.
+        /// Reset the selected value if the user deletes the text.
         /// </summary>
         /// <remarks>
         /// Defaults to <c>false</c>.
@@ -241,7 +241,7 @@ public partial class MudAutocomplete<T> : MudBaseInput<T>
         public bool ResetValueOnEmptyText { get; set; }
 
         /// <summary>
-        /// Whether the text will be selected (highlighted) when the component receives focus.
+        /// Highlights the text when the component receives focus.
         /// </summary>
         /// <remarks>
         /// Defaults to <c>true</c>.
@@ -251,7 +251,7 @@ public partial class MudAutocomplete<T> : MudBaseInput<T>
         public bool SelectOnActivation { get; set; } = true;
 
         /// <summary>
-        /// Whether other items can be selected without resetting the Value.
+        /// Selects items without resetting the <c>Value</c>.
         /// </summary>
         /// <remarks>
         /// Defaults to <c>true</c>.  When <c>true</c>, selecting an option will trigger a <see cref="SearchFunc"/> with the current Text.  Otherwise, an empty string is passed which can make it easier to view and select other options without resetting the Value. When <c>false</c>, <c>T</c> must either be a <c>record</c> or override the <c>GetHashCode</c> and <c>Equals</c> methods.
@@ -361,7 +361,7 @@ public partial class MudAutocomplete<T> : MudBaseInput<T>
         public RenderFragment ProgressIndicatorInPopoverTemplate { get; set; }
 
         /// <summary>
-        /// Whether the <c>Text</c> property is overridden when an item is selected.
+        /// Overrides the <c>Text</c> property when an item is selected.
         /// </summary>
         /// <remarks>
         /// Defaults to <c>true</c>.  When <c>true</c>, selecting a value will update the Text property.  When <c>false</c>, incomplete values for Text are allowed.
@@ -371,7 +371,7 @@ public partial class MudAutocomplete<T> : MudBaseInput<T>
         public bool CoerceText { get; set; } = true;
 
         /// <summary>
-        /// Whether the <c>Value</c> property is set even if no match is found by <see cref="SearchFunc"/>.
+        /// Sets the <c>Value</c> property even if no match is found by <see cref="SearchFunc"/>.
         /// </summary>
         /// <remarks>
         /// Defaults to <c>false</c>.  When <c>true</c>, the user input will be applied to the Value property which allows it to be validated and show an error message.
@@ -397,7 +397,7 @@ public partial class MudAutocomplete<T> : MudBaseInput<T>
         public EventCallback<bool> OpenChanged { get; set; }
 
         /// <summary>
-        /// Whether pressing the <c>Tab</c> key updates the Value to the currently selected item.
+        /// Updates the Value to the currently selected item when pressing the <c>Tab</c> key.
         /// </summary>
         /// <remarks>
         /// Defaults to <c>false</c>.
@@ -407,7 +407,7 @@ public partial class MudAutocomplete<T> : MudBaseInput<T>
         public bool SelectValueOnTab { get; set; }
 
         /// <summary>
-        /// Whether a Clear icon button is displayed.
+        /// Displays the Clear icon button.
         /// </summary>
         /// <remarks>
         /// Defaults to <c>false</c>.  When <c>true</c>, an icon is displayed which, when clicked, clears the Text and Value.  Use the <c>ClearIcon</c> property to control the Clear button icon.
@@ -435,7 +435,7 @@ public partial class MudAutocomplete<T> : MudBaseInput<T>
         public EventCallback<int> ReturnedItemsCountChanged { get; set; }
 
         /// <summary>
-        /// Whether the search result drop-down is currently displayed.
+        /// Displays the search result drop-down.
         /// </summary>
         /// <remarks>
         /// When this property changes, the <see cref="OpenChanged"/> event will occur.

src/MudBlazor/Components/Avatar/MudAvatar.razor.cs

@@ -40,7 +40,7 @@ partial class MudAvatar : MudComponentBase, IDisposable
         public int Elevation { set; get; } = 0;
 
         /// <summary>
-        /// Whether rounded corners are disabled.
+        /// Disables rounded corners.
         /// </summary>
         /// <remarks>
         /// Defaults to <c>false</c>.
@@ -50,7 +50,7 @@ partial class MudAvatar : MudComponentBase, IDisposable
         public bool Square { get; set; }
 
         /// <summary>
-        /// Whether corners are rounded.
+        /// Shows rounded corners.
         /// </summary>
         /// <remarks>
         /// Defaults to <c>false</c>.  When <c>true</c>, the <c>border-radius</c> style is set to the theme's default value.