Skip to content
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.

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

Add group labels to sidebar #547

Merged
merged 19 commits into from
Dec 31, 2023
Merged

Add group labels to sidebar #547

merged 19 commits into from
Dec 31, 2023

Conversation

garrettmflynn
Copy link
Member

Updated based on @oruebel User Test comments.

@CodyCBakerPhD
Copy link
Collaborator

The overall look is great and does help visually navigate that ever growing sidebar

My only major concern with this PR is the initial landing page when first launching the app - it's just a blank white screen - and a very long one at that (notice the size of the scroll bar in the screenshot below)

image

If you want to minimize information display initially presented to the user after launch, I'd at least add the GUIDE logo, or maybe a collage of all the logos, just so it doesn't feel so empty (and/or 'glitchy' - I think most users would expect something to be in the main visual space of an app they just launched - a blank white space is reminiscent of that linux bug where it just fails to render anything that should be there)

If you don't care about minimizing initial display of info I'd say just start off on the first tab (Conversions)

Also, having the 'settings' pinned as a kind of frozen tab leads to a weird visual effect where it looks like the 'Documentation' (which I'm above proposing rename to 'Help') group has only two tabs, showing the actual third only after scrolling, which by all appearances should have scrolled down past the 'settings'

So I'd propose putting 'Settings' under a group 'Configuration' there at the bottom

@garrettmflynn
Copy link
Member Author

Alright, I've updated the labels for each of the groups and fixed the initialization so the home page is reached on first load.

@rly
Copy link
Collaborator

rly commented Dec 29, 2023

The scrollbar not going down to Settings is good, but I think it is still visually confusing in the default smallish window size. The style is too similar to the menu items above it. And the "Configuration" header for a one item menu seems unnecessary. How about removing "Configuration" and either A) changing the background color of the Settings button or B) using a thicker, darker line to help distinguish the Settings button from the rest of the menu?

@CodyCBakerPhD
Copy link
Collaborator

A darker background color would be sufficient for me

The extra 'Configuration' group is what I was imagining if and only if the group itself is becomes unpinned

But if you want to keep it pinned, then yeah, no need for a group label but does need a visual distinguisher from the other sections of the tab

@garrettmflynn
Copy link
Member Author

Got it. I've removed the header.

Since we don't use a darker gray elsewhere in the application, I've darkened the borders separating the main sidebar body from the header and footer. Is this sufficient?

@rly
Copy link
Collaborator

rly commented Dec 29, 2023

It looks all right to me. Thanks for the adjustments. Is there a reason the default window size is the size that it is? If we don't plan to add new items to the menu, it would be nice if the default window height were large enough that a scroll bar in the menu is not necessary by default. Maybe 800px instead?

https://github.com/NeurodataWithoutBorders/nwb-guide/blob/main/src/main/main.ts#L234-L238

I see that a 1366x768 screen resolution is still fairly common, but I would guess that it is rare among computers that would be working with converting and processing neurophysiology data.

@CodyCBakerPhD
Copy link
Collaborator

Certainly looks better, but I'd also be in favor of Ryans suggestion if it is possible to force minimal size of window to be large enough to fit the 7 tabs of the app; maybe circle back around to the better solution when/if we ever add more workflows

On that note, a mild inconsistency I just noticed; one group is 'Workflow' (singular), other is 'Resources' (plural) - should we make it 'Workflows' to be consistent (and since there is more than one workflow)?

@garrettmflynn
Copy link
Member Author

Got it. Added those changes!

@CodyCBakerPhD
Copy link
Collaborator

While the default window size now starts off as Ryan requested, I am able to manually shrink the window to the previous default size, which is just below where it needs to be to prevent this cutoff

If it's possible to constrain the absolute minimal size to above that cutoff that would be great, but let me know if that's too difficult to force

@garrettmflynn
Copy link
Member Author

garrettmflynn commented Dec 30, 2023 via email

@CodyCBakerPhD
Copy link
Collaborator

If it doesn’t interfere with functionality, shouldn’t we provide the flexibility to adjust the window size based on user requirements?

I'm not saying freeze the entire window size - users can definitely adjust as they desire - simply bump the amount of 'smallest it can be' ever so slightly because the current minimum is just tantalizingly below what would be necessary to avoid the complexity of any scrolling on that subwindow altogether

@garrettmflynn
Copy link
Member Author

garrettmflynn commented Dec 30, 2023 via email

@garrettmflynn
Copy link
Member Author

Updated. Didn't catch that SODA initialized the browse window at the minimum size (since they had the same numbers declared twice). I've pulled the height and minHeight values out into a single variable (same for width) so it's more obvious and accomplishes your desired behavior.

@CodyCBakerPhD
Copy link
Collaborator

LGTM

@CodyCBakerPhD CodyCBakerPhD enabled auto-merge (squash) December 31, 2023 03:14
@CodyCBakerPhD CodyCBakerPhD merged commit 249089d into main Dec 31, 2023
11 checks passed
@CodyCBakerPhD CodyCBakerPhD deleted the sidebar-labels branch December 31, 2023 03:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants