Skip to content

API documentation for Sidebar #1225

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 2 commits into from
Dec 27, 2025
Merged

API documentation for Sidebar #1225

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
83d334a
Enhance ScriptLoader properties with metadata attributes
gvreddy04 Dec 27, 2025
eabc595
Add metadata attributes to Sidebar and NavItem APIs
gvreddy04 Dec 27, 2025
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
51 changes: 36 additions & 15 deletions blazorbootstrap/Components/ScriptLoader/ScriptLoader.razor.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,53 +71,74 @@ public void OnLoadJS()

/// <summary>
/// Gets or sets a value indicating whether the script should be loaded asynchronously.
/// </summary>
/// <remarks>
/// <para>
/// Default value is <see langword="false" />.
/// </remarks>
/// </para>
/// </summary>
[AddedVersion("1.11.0")]
[DefaultValue(false)]
[Description("Gets or sets a value indicating whether the script should be loaded asynchronously.")]
[Parameter]
public bool Async { get; set; }

/// <summary>
/// Gets or sets a value indicating whether the script is meant to be executed
/// after the document has been parsed, but before firing DOMContentLoaded event..
/// </summary>
/// <remarks>
/// after the document has been parsed, but before firing DOMContentLoaded event.
/// <para>
/// Default value is <see langword="false" />.
/// </remarks>
/// </para>
/// </summary>
[AddedVersion("1.11.0")]
[DefaultValue(false)]
[Description("Gets or sets a value indicating whether the script is meant to be executed after the document has been parsed, but before firing DOMContentLoaded event.")]
[Parameter]
public bool Defer { get; set; }

/// <summary>
/// An event that is fired when a script loading error occurs.
/// </summary>
[AddedVersion("1.11.0")]
[Description("An event that is fired when a script loading error occurs.")]
[Parameter]
public EventCallback<string> OnError { get; set; }

/// <summary>
/// An event that is fired when a script has been successfully loaded.
/// </summary>
[AddedVersion("1.11.0")]
[Description("An event that is fired when a script has been successfully loaded.")]
[Parameter]
public EventCallback OnLoad { get; set; }

/// <summary>
/// Gets or sets the ID of the script element.
/// </summary>
/// <remarks>
/// <para>
/// Default value is <see langword="null" />.
/// </remarks>
/// </para>
/// </summary>
[AddedVersion("1.11.0")]
[DefaultValue(null)]
[Description("Gets or sets the ID of the script element.")]
[Parameter]
public string? ScriptId { get; set; }

/// <summary>
/// Gets or sets the URI of the external script to load.
/// </summary>
/// <remarks>
/// <para>
/// Default value is <see langword="null" />.
/// </remarks>
[Parameter]
/// </para>
/// </summary>
[AddedVersion("1.11.0")]
[DefaultValue(null)]
[Description("Gets or sets the URI of the external script to load.")]
[EditorRequired]
public string? Source { get; set; } = default!;
[Parameter]
public string? Source { get; set; }

// NOTE: Hiding base Class and Style properties to prevent their usage in this component.
private new string? Class { get; set; }

private new string? Style { get; set; }

#endregion
}
96 changes: 68 additions & 28 deletions blazorbootstrap/Components/Sidebar/Sidebar.razor.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,8 @@ public void bsWindowResize(int width)
/// Refresh the sidebar data.
/// </summary>
/// <returns>Task</returns>
[AddedVersion("1.4.0")]
[Description("Refresh the sidebar data.")]
public async Task RefreshDataAsync(bool firstRender = false)
{
if (requestInProgress)
Expand All @@ -80,6 +82,8 @@ public async Task RefreshDataAsync(bool firstRender = false)
/// <summary>
/// Toggles sidebar.
/// </summary>
[AddedVersion("1.4.0")]
[Description("Toggles sidebar.")]
public void ToggleSidebar()
{
collapseSidebar = !collapseSidebar;
Expand Down Expand Up @@ -128,89 +132,125 @@ private string GetNavMenuCssClass()

/// <summary>
/// Gets or sets the badge text.
/// <para>
/// Default value is <see langword="null" />.
/// </para>
/// </summary>
/// <remarks>
/// Default value is null.
/// </remarks>
[AddedVersion("1.4.0")]
[DefaultValue(null)]
[Description("Gets or sets the badge text.")]
[Parameter]
public string? BadgeText { get; set; }

/// <summary>
/// Gets or sets the custom icon name.
/// </para>
/// Default value is <see langword="null" />.
/// <para>
/// </summary>
/// <remarks>
/// Default value is null.
/// </remarks>
[AddedVersion("1.4.0")]
[DefaultValue(null)]
[Description("Gets or sets the custom icon name.")]
[Parameter]
public string? CustomIconName { get; set; }

/// <summary>
/// Gets or sets the data provider.
/// <para>
/// Default value is <see langword="null" />.
/// </para>
/// </summary>
/// <remarks>
/// Default value is null.
/// </remarks>
[Parameter]
[AddedVersion("1.4.0")]
[DefaultValue(null)]
[Description("Gets or sets the data provider.")]
[EditorRequired]
public SidebarDataProviderDelegate? DataProvider { get; set; } = default!;
[Parameter]
public SidebarDataProviderDelegate? DataProvider { get; set; }

/// <summary>
/// Gets or sets the Href.
/// </summary>
/// <remarks>
/// <para>
/// Default value is <see cref="string.Empty" />.
/// </remarks>
/// </para>
/// </summary>
[AddedVersion("3.0.0")]
[DefaultValue("Empty string")]
[Description("Gets or sets the Href.")]
[Parameter]
public string? Href { get; set; } = string.Empty;
public string Href { get; set; } = string.Empty;

/// <summary>
/// Gets or sets the IconName.
/// </summary>
/// <remarks>
/// <para>
/// Default value is <see cref="IconName.None" />.
/// </remarks>
/// </para>
/// </summary>
[AddedVersion("1.4.0")]
[DefaultValue(IconName.None)]
[Description("Gets or sets the IconName.")]
[Parameter]
public IconName IconName { get; set; } = IconName.None;

/// <summary>
/// Gets or sets the sidebar logo.
/// <para>
/// Default value is <see langword="null" />.
/// </para>
/// </summary>
/// <remarks>
/// Default value is null.
/// </remarks>
[AddedVersion("1.4.0")]
[DefaultValue(null)]
[Description("Gets or sets the sidebar logo.")]
[Parameter]
public string? ImageSrc { get; set; }

/// <summary>
/// Gets or sets the width of the image in pixels.
/// You can change the unit by setting <see cref="WidthUnit" />.
/// <remarks>Default value is 0.</remarks>
/// <para>
/// Default value is 0.
/// </para>
/// </summary>
[AddedVersion("3.4.0")]
[DefaultValue(0)]
[Description("Gets or sets the width of the image in pixels. You can change the unit by setting <b>WidthUnit</b>.")]
[Parameter]
public float ImageWidth { get; set; } = 0;

private string? navMenuCssClass => GetNavMenuCssClass();

/// <summary>
/// Gets or sets the sidebar title.
/// <para>
/// Default value is <see langword="null" />.
/// </para>
/// </summary>
/// <remarks>
/// Default value is null.
/// </remarks>
[AddedVersion("1.4.0")]
[DefaultValue(null)]
[Description("Gets or sets the sidebar title.")]
[Parameter]
public string? Title { get; set; } = default!;
public string? Title { get; set; }

/// <summary>
/// Gets or sets the sidebar width.
/// <para>
/// Default value is 270.
/// </para>
/// </summary>
/// <remarks>Default value is 270.</remarks>
[AddedVersion("3.0.0")]
[DefaultValue(270)]
[Description("Gets or sets the sidebar width.")]
[Parameter]
public float Width { get; set; } = 270;

/// <summary>
/// Gets or sets the sidebar width unit.
/// <para>
/// Default value is <see cref="Unit.Px" />.
/// </para>
/// </summary>
/// <remarks>Default value is <see cref="Unit.Px" />.</remarks>
[AddedVersion("3.0.0")]
[DefaultValue(Unit.Px)]
[Description("Gets or sets the sidebar width unit.")]
[Parameter]
public Unit WidthUnit { get; set; } = Unit.Px;

Expand Down
26 changes: 25 additions & 1 deletion blazorbootstrap/Models/NavItem.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,15 @@ public class NavItem
/// <summary>
/// Gets or sets an additional CSS class.
/// </summary>
[AddedVersion("1.10.3")]
[Description("Gets or sets an additional CSS class.")]
public string? Class { get; set; }

/// <summary>
/// Gets or sets the name of the custom icon to display.
/// </summary>
[AddedVersion("1.4.0")]
[Description("Gets or sets the name of the custom icon to display.")]
public string? CustomIconName { get; set; }

/// <summary>
Expand All @@ -27,51 +31,71 @@ public class NavItem
/// <summary>
/// Gets or sets the HyperText Reference (href).
/// </summary>
[AddedVersion("1.4.0")]
[Description("Gets or sets the HyperText Reference (href).")]
public string? Href { get; set; }

/// <summary>
/// Gets or sets the icon color.
/// </summary>
[AddedVersion("1.4.0")]
[Description("Gets or sets the icon color.")]
public IconColor IconColor { get; set; }

/// <summary>
/// Gets or sets the icon name.
/// </summary>
[AddedVersion("1.4.0")]
[Description("Gets or sets the icon name.")]
public IconName IconName { get; set; }

/// <summary>
/// Gets or sets the Id.
/// </summary>
[AddedVersion("1.4.0")]
[Description("Gets or sets the Id.")]
public string? Id { get; set; }

/// <summary>
/// Gets or sets the item level.
/// </summary>
public int Level { get; set; } = 0;
[AddedVersion("1.4.0")]
[Description("Gets or sets the item level.")]
public int Level { get; set; }

/// <summary>
/// Gets or sets the URL matching behavior.
/// </summary>
[AddedVersion("2.1.0")]
[Description("Gets or sets the URL matching behavior.")]
public NavLinkMatch Match { get; set; }

/// <summary>
/// Gets or sets the parent Id.
/// </summary>
[AddedVersion("1.4.0")]
[Description("Gets or sets the parent Id.")]
public string? ParentId { get; set; }

/// <summary>
/// Gets or sets the sequence.
/// </summary>
[AddedVersion("1.4.0")]
[Description("Gets or sets the sequence.")]
public int Sequence { get; set; }

/// <summary>
/// Gets or sets the target.
/// </summary>
[AddedVersion("1.4.0")]
[Description("Gets or sets the target.")]
public Target Target { get; set; }

/// <summary>
/// Gets or sets the navigation link text.
/// </summary>
[AddedVersion("1.4.0")]
[Description("Gets or sets the navigation link text.")]
public string? Text { get; set; }

#endregion
Expand Down
Loading