A Swiss Army knife for developers.
C# blazorcross-platformcsharpdesktopdesktop-appdesktop-applicationdeveloper-toolsextensiblefluentfluent-designlinuxmacosmicasyntax-highlightingtypescriptwindowswindows-10windows-11winui
using System.Collections.ObjectModel;
using DevToys.Blazor.Core.Services;
using Microsoft.AspNetCore.Components.Web;
namespace DevToys.Blazor.Components;
public partial class NavBar<TElement, TSearchElement>
: JSStyledComponentBase
where TElement : class
where TSearchElement : class
{
private readonly NavBarState _sidebarState = new();
private AutoSuggestBox<TSearchElement> _autoSuggestBox = default!;
private TElement? _selectedItem;
public string NavId { get; } = NewId();
protected override string? JavaScriptFile => "./_content/DevToys.Blazor/Components/Menu/NavBar/NavBar.razor.js";
[Parameter]
public RenderFragment<TElement> NavBarItemTitleTemplate { get; set; } = default!;
[Parameter]
public RenderFragment<TElement> NavBarItemIconTemplate { get; set; } = default!;
/// <summary>
/// Gets or sets the minimum width at which the sidebar should get hidden.
/// </summary>
[Parameter]
public int NavBarWidthSidebarHiddenThreshold { get; set; } = NavBarThresholds.NavBarWidthSidebarHiddenThreshold;
/// <summary>
/// Gets or sets the minimum width at which the sidebar should collapse.
/// </summary>
[Parameter]
public int NavBarWidthSidebarCollapseThreshold { get; set; } = NavBarThresholds.NavBarWidthSidebarCollapseThreshold;
[Parameter]
public ReadOnlyObservableCollection<TElement>? MenuItemsSource { get; set; }
[Parameter]
public ReadOnlyObservableCollection<TElement>? FooterMenuItemsSource { get; set; }
[Parameter]
public TElement? SelectedItem { get; set; }
[Parameter]
public EventCallback<TElement> SelectedItemChanged { get; set; }
[Parameter]
public EventCallback<ListBoxItemBuildingContextMenuEventArgs> OnBuildingContextMenu { get; set; }
[Parameter]
public bool CanGoBack { get; set; }
[Parameter]
public EventCallback OnBackButtonClicked { get; set; }
/// <summary>
/// Gets or sets the content to be rendered inside the component.
/// </summary>
[Parameter]
public RenderFragment? Content { get; set; }
/// <summary>
/// Gets or sets the header to be rendered inside the component, to the left.
/// </summary>
[Parameter]
public RenderFragment? HeaderLeft { get; set; }
/// <summary>
/// Gets or sets the header to be rendered inside the component, to the right.
/// </summary>
[Parameter]
public RenderFragment? HeaderRight { get; set; }
/// <summary>
/// Gets or sets the footer to be rendered inside the component.
/// </summary>
[Parameter]
public RenderFragment? Footer { get; set; }
/// <summary>
/// Raised when the NavBar goes and leave the hidden state.
/// </summary>
[Parameter]
public EventCallback<bool> OnHiddenStateChanged { get; set; }
/// <summary>
/// Raised when the text in the search bar changed.
/// </summary>
[Parameter]
public EventCallback<string> SearchQueryChanged { get; set; }
/// <summary>
/// Raised when the user press Enter in the search box or explicitly select an item in the search result list.
/// </summary>
[Parameter]
public EventCallback<TSearchElement?> SearchQuerySubmitted { get; set; }
/// <summary>
/// Gets or sets the placeholder to display in the search bar.
/// </summary>
[Parameter]
public string SearchBarPlaceholder { get; set; } = string.Empty;
/// <summary>
/// Gets or sets the list of items to display in the search bar's drop down list.
/// </summary>
[Parameter]
public ICollection<TSearchElement>? SearchResultItems { get; set; }
/// <summary>
/// Gets or sets the template of search bar result item to use.
/// </summary>
[Parameter]
public RenderFragment<TSearchElement> SearchResultItemTemplate { get; set; } = default!;
/// <summary>
/// Gets whether the <see cref="NavBar{TElement, TSearchElement}"/>'s side bar is hidden or not.
/// </summary>
public bool IsHiddenMode => _sidebarState.IsHidden;
/// <summary>
/// Gets whether the <see cref="NavBar{TElement, TSearchElement}"/>'s side bar is collapsed or not.
/// </summary>
public bool IsCollapsedMode => _sidebarState.IsCollapsed;
/// <summary>
/// Gets or sets the user preferred side bar state.
/// </summary>
internal NavBarSidebarStates UserPreferredState
{
get => _sidebarState.UserPreferredState;
set => _sidebarState.UserPreferredState = value;
}
[Inject]
internal IWindowService WindowService { get; set; } = default!;
public NavBar()
{
_sidebarState.OnStateChanged += SidebarState_OnStateChanged;
}
internal ValueTask<bool> TryFocusSearchBoxAsync()
{
if (!WindowService.IsCompactOverlayMode && !_sidebarState.IsCollapsed && !_sidebarState.IsHidden)
{
return _autoSuggestBox.FocusAsync();
}
return new ValueTask<bool>(false);
}
protected override async Task OnAfterRenderAsync(bool firstRender)
{
await base.OnAfterRenderAsync(firstRender);
if (firstRender)
{
using (await Semaphore.WaitAsync(CancellationToken.None))
{
await (await JSModule).InvokeVoidWithErrorHandlingAsync("registerResizeHandler", Id, NavId, Reference);
await (await JSModule).InvokeVoidWithErrorHandlingAsync("registerKeyboardShortcut", Id, Reference);
}
}
}
protected override void OnParametersSet()
{
if (_selectedItem != SelectedItem)
{
// When the selected item changed,
// we need to close the expanded overlay, if it's opened.
_selectedItem = SelectedItem;
_sidebarState.CloseExpandedOverlay();
}
base.OnParametersSet();
}
public override ValueTask DisposeAsync()
{
_sidebarState.OnStateChanged -= SidebarState_OnStateChanged;
return base.DisposeAsync();
}
[JSInvokable]
public void OnComponentResize(int width)
{
bool stateChanged = _sidebarState.WidthUpdated(width, NavBarWidthSidebarHiddenThreshold, NavBarWidthSidebarCollapseThreshold);
if (stateChanged)
{
StateHasChanged();
}
}
[JSInvokable]
public void OnFindRequested()
{
OnSearchButtonClick();
}
private void OnToggleSidebarClick()
{
if (WindowService.IsCompactOverlayMode)
{
return;
}
_sidebarState.ToggleSidebar();
}
private void OnCloseExpandedOverlaySidebarClick(MouseEventArgs ev)
{
_sidebarState.CloseExpandedOverlay();
}
private void OnSearchButtonClick()
{
if (WindowService.IsCompactOverlayMode)
{
return;
}
_sidebarState.ForceExpand();
Task.Delay(200)
.ContinueWith(t =>
{
InvokeAsync(() =>
{
_autoSuggestBox.FocusAsync();
});
});
}
private Task OnItemSelectedAsync(TElement item)
{
SelectedItem = item;
return SelectedItemChanged.InvokeAsync(item);
}
private Task OnBuildingContextMenuAsync(ListBoxItemBuildingContextMenuEventArgs args)
{
Guard.IsNotNull(args.ItemValue);
Guard.IsAssignableToType<TElement>(args.ItemValue);
return OnBuildingContextMenu.InvokeAsync(args);
}
private void SidebarState_OnStateChanged(object? sender, EventArgs e)
{
if (OnHiddenStateChanged.HasDelegate)
{
OnHiddenStateChanged.InvokeAsync(_sidebarState.IsHidden);
}
}
}