search

jothepro / doxygen-awesome-css

Custom CSS theme for doxygen html-documentation with lots of customization parameters.
https://jothepro.github.io/doxygen-awesome-css/
MIT License
981 stars 112 forks source link

[FR] Collapsible Navbar for Small Screens #40

Closed briederer closed 2 years ago

briederer commented 3 years ago

I would like to request the feature of a collapsible navbar on small screens. Although the whole styling looks great, the top section of the created webpages are a bit crowded on smartphones in my opinion.

It would therefore be great to have the option to have a collapsible navigation at the top of the page like it is seen on several other websites.

However, there is no urgent need to implement this :smiley:

jothepro commented 3 years ago

Definitely would be cool, I agree!

But: I consider this project a thin layer of theming, that should stay as thin as possible. While it would be possible to mess around in the DOM with JS to achieve a collapsible menu, I think it's more sustainable to implement such a feature in Doxygen itself.

AFAIK @doxygen is working on native sidebar only support for the next version of Doxygen: https://github.com/doxygen/doxygen/issues/6658#issuecomment-835467288 I've asked for a collapsible (hamburger) menu in this case, because without it navigation on small screens would become hard or nearly impossible: https://github.com/doxygen/doxygen/issues/6658#issuecomment-837401688 This would then allow to get rid of the top section entirely and rely on a collapsible sidebar navigation.

I don't know for sure if this will be a thing in the next release of Doxygen though. Maybe you should propose or contribute your idea in the Doxygen repository: https://github.com/doxygen/doxygen

... That being said, now that I think about it, implementing a drop-in JS component like the dark mode thing for a collapsible sidebar shouldn't be too hard? I'll keep this issue open, let's see what the future brings 😋

jothepro commented 2 years ago

It seems like doxygen 1.9.2 introduced a collapsible navbar on mobile. Pls close this issue if that's what you needed.

Be warned that this does not yet work well with this custom CSS: https://github.com/jothepro/doxygen-awesome-css/issues/47

briederer commented 2 years ago

Thanks for the info. I'll look into it :smile: