Search does not restore hidden header when using header.autohide

[Mario-Hofstaetter]

• I've read the contribution guidelines and agree with them

I've found a bug and checked that ...

• ... the problem doesn't occur with the default MkDocs template
• ... the documentation does not mention anything about my problem
  • Only mentions the feature is still 'experimental'
• ... the problem is not in any of my customizations (CSS, JS, template)
• ... there are no open or closed issues that are related to my problem
  • Searched for autohide

Description

When using header.autohide , the header is hidden after scrolling down a bit.

However, if Search is invoked by keyboard shortcut keys [F] or [S], the header will not reappear and the search bar will be cut off at the top, showing the search results but not the input box.

Sometimes / at some point the header and search box will re-appear.

Please see this gif:

Expected behavior

When invoking search, the auto-hidden header should be displayed again.

Actual behavior

Header is not always displayed when starting searching.

Steps to reproduce the bug

1. Use - header.autohide
2. Open long page and scroll down until header is auto hidden
3. Hit S to trigger search bar and type something, header is not displayed

Package versions

• Docker Image: squidfunk/mkdocs-material:6.2.5

• Python: Python 3.8.1

• MkDocs: mkdocs, version 1.1.2 from /usr/local/lib/python3.8/site-packages/mkdocs (Python 3.8)

• Material: Version: 6.2.5

Project configuration

Truncated config used when creating the gif shown above:

nav:
  - Übersicht: 
    - Startseite:               index.md
    - Exporter:
      - node_exporter (Linux):  Prometheus/Exporters/node_exporter.md
site_dir: /site
site_name: Monitoring Docs
theme:
  features:
    - header.autohide
    - navigation.tabs
  name: material

System information

• OS: Windows 10 Version 20H2 Build 19042.746
• Browser: Firefox 84.0.2

[squidfunk]

Thanks for reporting and providing the screen recording! That's indeed unintended, the header should show up.

[squidfunk]

Fixed in be1f9c1. I refactored the autohiding logic, which as you discovered is still experimental. This means that there might be other edge cases to consider, so the implementation might still not be complete. Nonetheless, header + search now behave as follows:

Ohne.Titel.mp4

It's still not perfect in a way that the page sometimes jumps when focusing the search on the hidden header, but that would need some serious refactoring, as we'd have to delay the focus event until the header is visible. I will consider this for some later refactoring, but for now, I think this should work well enough.

[squidfunk]

Released as part of 6.2.6.