Skip to content

Improve Spinner parameter docs and metadata #1228

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
gvreddy04 merged 1 commit into from
Jan 1, 2026
Merged

Improve Spinner parameter docs and metadata #1228

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
66 changes: 42 additions & 24 deletions blazorbootstrap/Components/Spinner/Spinner.razor.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,63 +63,81 @@ protected override void OnInitialized()
($"{Type.ToSpinnerTypeClass()}-{Size.ToSpinnerSizeClass()}", Type is (SpinnerType.Border or SpinnerType.Grow)));

/// <summary>
/// Gets or sets the color of the spinner.
/// </summary>
/// <remarks>
/// Gets or sets the color of the <see cref="Spinner" />.
/// <para>
/// Default value is <see cref="SpinnerColor.None" />.
/// </remarks>
/// </para>
/// </summary>
[AddedVersion("2.0.0")]
[DefaultValue(null)]
[Description("")]
[Parameter]
public SpinnerColor Color { get; set; } = SpinnerColor.None;

/// <summary>
/// Gets or sets the size of the spinner.
/// </summary>
/// <remarks>
/// Gets or sets the size of the <see cref="Spinner" />.
/// <para>
/// Default value is <see cref="SpinnerSize.Medium" />.
/// </remarks>
/// </para>
/// </summary>
[AddedVersion("2.0.0")]
[DefaultValue(SpinnerSize.Medium)]
[Description("Gets or sets the color of the <b>Spinner</b>.")]
[Parameter]
public SpinnerSize Size { get; set; } = SpinnerSize.Medium;

/// <summary>
/// Gets the width, height, and circles information for the spinner SVG.
/// Gets the width, height, and circles information for the <see cref="Spinner" /> SVG.
/// </summary>
private (int Width, int Height, List<SpinnerCircle> Circles) SpinnerSvg => GetSpinnerSvgInfo();

/// <summary>
/// Gets or sets the title text used as an accessibility attribute.
/// <para>
/// Default value is <see langword="null"/>.
/// </para>
/// </summary>
/// <remarks>
/// Default value is null.
/// </remarks>
[AddedVersion("2.0.0")]
[DefaultValue(null)]
[Description("Gets or sets the title text used as an accessibility attribute.")]
[Parameter]
public string? Title { get; set; }

/// <summary>
/// Gets or sets the type of the spinner.
/// </summary>
/// <remarks>
/// Gets or sets the type of the <see cref="Spinner" />.
/// <para>
/// Default value is <see cref="SpinnerType.Border" />.
/// </remarks>
/// </para>
/// </summary>
[AddedVersion("2.0.0")]
[DefaultValue(SpinnerType.Border)]
[Description("Gets or sets the type of the <b>Spinner</b>.")]
[Parameter]
public SpinnerType Type { get; set; } = SpinnerType.Border;

/// <summary>
/// Gets or sets whether the spinner is visible or not.
/// Gets or sets whether the <see cref="Spinner" /> is visible or not.
/// <para>
/// Default value is <see langword="true"/>.
/// </para>
/// </summary>
/// <remarks>
/// Default value is true.
/// </remarks>
[AddedVersion("2.0.0")]
[DefaultValue(true)]
[Description("Gets or sets whether the <b>Spinner</b> is visible or not.")]
[Parameter]
public bool Visible { get; set; } = true;

/// <summary>
/// Gets or sets the visually hidden text.
/// </summary>
/// <remarks>
/// <para>
/// Default value is 'Loading...'.
/// </remarks>
/// </para>
/// </summary>
[AddedVersion("2.0.0")]
[DefaultValue("Loading...")]
[Description("Gets or sets the visually hidden text.")]
[Parameter]
public string? VisuallyHiddenText { get; set; } = "Loading...";
public string VisuallyHiddenText { get; set; } = "Loading...";

#endregion
}
Loading