RFC: Menu: only expand active hierarchy

[robhoes]

Before this change, the entire menu tree below the selected top-level heading
was expanded.

This change adds some triangles on menu items at level 2 and below to indicate
which ones can be or are expanded. I didn't put them on the top level, because
I felt that it looked too cluttered and didn't add much value.

Fixes #88

Here is an example of what this looks like: https://robhoes.github.io/hugo-theme-learn/en/shortcodes/children.

Would it be desirable to add a configuration option for this, perhaps just for the new marks in the menu?

[coliff]

This works great. It's very helpful for larger docs sites. I'd like to see this merged. 👍

An option to enable/disable this feature would be desirable. For smaller sites I'd probably prefer this option to be turned off/disabled.

[matalo33]

Agree, this is an excellent addition. However I believe it should be enabled only with a toggle and set to off by default to avoid breaking people's existing websites who don't expect this behaviour.

@robhoes would you be able to wrap this in a config toggle?

[robhoes]

Thanks guys. Yes, I'll have a look at adding a toggle. I need to see how to do it for the CSS bit though, which would probably need a slightly bigger change.

[matalo33]

I had another read of this yesterday and spotted you already have a toggle named alwaysopen. Was testing toggling this on and off and it seemed to work for me even with leaving the css changes in place, but life got in the way before I finished.

[robhoes]

Oh interesting. Then we just need to make that the default somehow, and also make it hide the new markers.

[matalo33]

My view on this, and I'm happy to help implement if you like...

• Default setting should be off (don't want to affect behaviour of existing websites)
• Ready to discuss this further, but personally I don't like the chevrons :). (The site I run had this implemented for a while now in a theme override rather than in the theme master, and it was too hacky to port over. It doesn't have the chevrons and I kinda prefer it). Do you think we could add a feature flag around the chevrons? Instead of true/false the feature variable could even contain the name of the font-awesome icon to display so that people could chose their own.

[frangrolemund]

FWIW, agree 100% with some sort of way to manage menu expansion - especially for large docsets. Not a fan of the auto-chevrons either, but one option you could consider that worked for my project are a pair of site parameters that operate like the pre variable, but define the open/close prefixes for these expandable items. That way they're easy to omit and they sort of flow with the rest of the layout because they come before, not after the title.

[chapmanc]

Any movement on this ? Would love to get this in ? @robhoes @matalo33

[robhoes]

Sorry, I got stuck with other work. I'll see if I can update the PR soon to take into account the feedback above.

[n-rodriguez]

Hi there! Any news?

[oldenboom]

Please see issue #355 for a pull request against master to solve this issue.

[robhoes]

Sorry for my lack of engagement on this, and thanks @oldenboom for picking this up. I'll close this PR now in favour of yours.

[jmrichardson]

Hi, I would like to implement this but not sure how to do it. Any help would be appreciated. Thanks.

[Nightshadelink]

@jmrichardson see the changes here https://github.com/matcornic/hugo-theme-learn/pull/195/files

Red lines represent deletions. Green ones represent additions.

[oldenboom]

@jmrichardson the changes suggested by @Nightshadelink won't match with the latest branch of this theme. This one will:
https://github.com/matcornic/hugo-theme-learn/pull/355/files
I've implemented this on https://www.spelenboek.nl/

[jmrichardson]

Thanks, yes, I just cloned your repo from here https://github.com/oldenboom/hugo-theme-learn and it works. Thanks.