Skip to content

A Swiss Army knife for developers.

Preserve NavBar state on restart (#1056)

Etienne BAUDOUXfaf0429633ae
diff --git a/src/app/dev/DevToys.Blazor/Components/Menu/NavBar/NavBar.razor.cs b/src/app/dev/DevToys.Blazor/Components/Menu/NavBar/NavBar.razor.cs
index bcbec403d..4079d746e 100644
--- a/src/app/dev/DevToys.Blazor/Components/Menu/NavBar/NavBar.razor.cs
+++ b/src/app/dev/DevToys.Blazor/Components/Menu/NavBar/NavBar.razor.cs
@@ -114,6 +114,15 @@ public partial class NavBar<TElement, TSearchElement>
/// </summary>
public bool IsHiddenMode => _sidebarState.IsHidden;
+ /// <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!;
diff --git a/src/app/dev/DevToys.Blazor/Components/Menu/NavBar/NavBarState.cs b/src/app/dev/DevToys.Blazor/Components/Menu/NavBar/NavBarState.cs
index 89c3b5aad..068b328a8 100644
--- a/src/app/dev/DevToys.Blazor/Components/Menu/NavBar/NavBarState.cs
+++ b/src/app/dev/DevToys.Blazor/Components/Menu/NavBar/NavBarState.cs
@@ -2,7 +2,6 @@
internal sealed class NavBarState
{
- // TODO: Save state in settings and restore it, along with window size and location.
private NavBarSidebarStates _widthBasedState = NavBarSidebarStates.Expanded;
private NavBarSidebarStates _userPreferredState = NavBarSidebarStates.Expanded;
private int _width;
@@ -15,6 +14,8 @@ internal sealed class NavBarState
internal bool IsCollapsed { get; private set; }
+ internal NavBarSidebarStates UserPreferredState { get; set; }
+
internal event EventHandler? IsHiddenChanged;
internal bool WidthUpdated(int width, int hiddenThreshold, int collapsedThreshold)
@@ -45,11 +46,11 @@ internal sealed class NavBarState
}
// When resizing the window, let's automatically hide the expanded overlay, if opened.
- if ((_userPreferredState & NavBarSidebarStates.ExpandedOverlay) == NavBarSidebarStates.ExpandedOverlay)
+ if ((UserPreferredState & NavBarSidebarStates.ExpandedOverlay) == NavBarSidebarStates.ExpandedOverlay)
{
stateChanged = true;
useTransition = false;
- _userPreferredState &= ~NavBarSidebarStates.ExpandedOverlay;
+ UserPreferredState &= ~NavBarSidebarStates.ExpandedOverlay;
}
UpdateCssToApply(useTransition);
@@ -58,32 +59,32 @@ internal sealed class NavBarState
internal void ToggleSidebar()
{
- Guard.IsNotEqualTo((int)_userPreferredState, (int)NavBarSidebarStates.Hidden);
+ Guard.IsNotEqualTo((int)UserPreferredState, (int)NavBarSidebarStates.Hidden);
bool useTransition = true;
- bool userCurrentlyPreferExpanded = (_userPreferredState & NavBarSidebarStates.Expanded) == NavBarSidebarStates.Expanded;
+ bool userCurrentlyPreferExpanded = (UserPreferredState & NavBarSidebarStates.Expanded) == NavBarSidebarStates.Expanded;
switch (_widthBasedState)
{
// Based on the control's width, the default / automatic mode of the sidebar should be either collapsed or hidden.
case NavBarSidebarStates.Hidden:
case NavBarSidebarStates.Collapsed:
- if ((_userPreferredState & NavBarSidebarStates.ExpandedOverlay) == NavBarSidebarStates.ExpandedOverlay)
+ if ((UserPreferredState & NavBarSidebarStates.ExpandedOverlay) == NavBarSidebarStates.ExpandedOverlay)
{
// It looks like the sidebar is currently expanded overlay.
// User clicked on the toggle button, so let's collapse the sidebar.
- _userPreferredState = NavBarSidebarStates.Collapsed;
+ UserPreferredState = NavBarSidebarStates.Collapsed;
useTransition = false;
}
else if (userCurrentlyPreferExpanded)
{
// User preferred sidebar mode is expanded. Currently, it's collapsed
// or hidden due to the small width of the control. Let's expand overlay the sidebar.
- _userPreferredState |= NavBarSidebarStates.ExpandedOverlay;
+ UserPreferredState |= NavBarSidebarStates.ExpandedOverlay;
}
else
{
// User preferred sidebar mode is collapsed. Let's switch it to expanded, and let's show the overlay.
- _userPreferredState = NavBarSidebarStates.Expanded | NavBarSidebarStates.ExpandedOverlay;
+ UserPreferredState = NavBarSidebarStates.Expanded | NavBarSidebarStates.ExpandedOverlay;
}
break;
@@ -93,12 +94,12 @@ internal sealed class NavBarState
{
// Currently, user's preferred mode is expanded. But user just clicked on the
// toggle button, so let's switch to collapsed mode.
- _userPreferredState = NavBarSidebarStates.Collapsed;
+ UserPreferredState = NavBarSidebarStates.Collapsed;
}
else
{
// Opposite scenario.
- _userPreferredState = NavBarSidebarStates.Expanded;
+ UserPreferredState = NavBarSidebarStates.Expanded;
}
break;
@@ -112,16 +113,16 @@ internal sealed class NavBarState
internal void CloseExpandedOverlay()
{
- if ((_userPreferredState & NavBarSidebarStates.ExpandedOverlay) == NavBarSidebarStates.ExpandedOverlay)
+ if ((UserPreferredState & NavBarSidebarStates.ExpandedOverlay) == NavBarSidebarStates.ExpandedOverlay)
{
- _userPreferredState &= ~NavBarSidebarStates.ExpandedOverlay;
+ UserPreferredState &= ~NavBarSidebarStates.ExpandedOverlay;
UpdateCssToApply(useTransition: false);
}
}
internal void ForceExpand()
{
- if (_userPreferredState == NavBarSidebarStates.Collapsed
+ if (UserPreferredState == NavBarSidebarStates.Collapsed
|| _widthBasedState == NavBarSidebarStates.Collapsed
|| _widthBasedState == NavBarSidebarStates.Hidden)
{
@@ -131,7 +132,7 @@ internal sealed class NavBarState
private void UpdateCssToApply(bool useTransition = false)
{
- bool userRequestExpandOverlay = (_userPreferredState & NavBarSidebarStates.ExpandedOverlay) == NavBarSidebarStates.ExpandedOverlay;
+ bool userRequestExpandOverlay = (UserPreferredState & NavBarSidebarStates.ExpandedOverlay) == NavBarSidebarStates.ExpandedOverlay;
bool isCollapsed = !userRequestExpandOverlay;
var cssBuilder = new CssBuilder();
@@ -150,8 +151,8 @@ internal sealed class NavBarState
break;
case NavBarSidebarStates.Expanded:
- cssBuilder.AddClass("collapsed", when: _userPreferredState == NavBarSidebarStates.Collapsed);
- isCollapsed = _userPreferredState == NavBarSidebarStates.Collapsed;
+ cssBuilder.AddClass("collapsed", when: UserPreferredState == NavBarSidebarStates.Collapsed);
+ isCollapsed = UserPreferredState == NavBarSidebarStates.Collapsed;
break;
default:
diff --git a/src/app/dev/DevToys.Blazor/Pages/Index.razor.cs b/src/app/dev/DevToys.Blazor/Pages/Index.razor.cs
index c584f39f1..67ffba0e0 100644
--- a/src/app/dev/DevToys.Blazor/Pages/Index.razor.cs
+++ b/src/app/dev/DevToys.Blazor/Pages/Index.razor.cs
@@ -12,6 +12,14 @@ namespace DevToys.Blazor.Pages;
public partial class Index : MefComponentBase
{
+ /// <summary>
+ /// Whether the main window should be maximized.
+ /// </summary>
+ private static readonly SettingDefinition<NavBarSidebarStates> UserPreferredNavBarState
+ = new(
+ name: nameof(UserPreferredNavBarState),
+ defaultValue: NavBarSidebarStates.Expanded);
+
private const int TitleBarMarginLeftWhenCompactOverlayMode = 0;
private const int TitleBarMarginLeftWhenNavBarHidden = 90;
private const int TitleBarMarginLeftWhenNavBarNotHidden = 47;
@@ -30,6 +38,9 @@ public partial class Index : MefComponentBase
[Import]
internal IThemeListener ThemeListener { get; set; } = default!;
+ [Import]
+ internal ISettingsProvider SettingsProvider { get; set; } = default!;
+
[Import]
internal CommandLineLauncherService CommandLineLauncherService { get; set; } = default!;
@@ -59,6 +70,7 @@ public partial class Index : MefComponentBase
ContextMenuService.IsContextMenuOpenedChanged += ContextMenuService_IsContextMenuOpenedChanged;
WindowService.WindowActivated += WindowService_WindowActivated;
WindowService.WindowDeactivated += WindowService_WindowDeactivated;
+ WindowService.WindowClosing += WindowService_WindowClosing;
TitleBarInfoProvider.PropertyChanged += TitleBarMarginProvider_PropertyChanged;
TitleBarInfoProvider.TitleBarMarginRight = 40;
@@ -107,6 +119,11 @@ public partial class Index : MefComponentBase
StateHasChanged();
}
+ private void WindowService_WindowClosing(object? sender, EventArgs e)
+ {
+ SettingsProvider.SetSetting(UserPreferredNavBarState, _navBar.UserPreferredState);
+ }
+
private void OnBackButtonClicked()
{
ViewModel.GoBack();
@@ -190,6 +207,8 @@ public partial class Index : MefComponentBase
{
if (firstRender)
{
+ _navBar.UserPreferredState = SettingsProvider.GetSetting(UserPreferredNavBarState);
+
// Focus on the Search Box.
_navBar.TryFocusSearchBoxAsync();