search

python / python-docs-theme

Sphinx theme for Python documentation
Other
75 stars 58 forks source link

Dark theme: "Hide Search Matches" shown on mobile #117

Closed hugovk closed 1 year ago

hugovk commented 1 year ago
  1. Using the new dark theme (#44) in mobile layout: https://docs.python.org/dev/
  2. Search for something (e.g. "turtle")
image
  1. Click a result
image

Actual result: "Hide Search Matches" is shown subscript to the right of the search box

image

Expected result: It's either shown more neatly, or, like desktop view, isn't shown at all:

image

cc @septatrix

septatrix commented 1 year ago

Okay I found the culprit/fix to restore the previous behaviour (not shown at all). Do we want that or would it actually be desirable to show it?

septatrix commented 1 year ago

Given that it is only ever added to either the mobile UI or the desktop UI I feel like it is probably less confusing to suppress it again, aye?

rik commented 1 year ago

Besides the UI glitch, I was actually glad to discover this "bug" as I'm not fond of matches being highlighted.

I wish it was available on the wide screen UI too.

septatrix commented 1 year ago

The problem is that the toggle is only added to the #searchbox element of which there can be only one. So either it would not be visible in one of the two layouts or we would have to do some pretty crazy CSS shenanigans to reuse the same search box in the desktop and mobile layout.

hugovk commented 1 year ago

I wish it was available on the wide screen UI too.

You can press esc to remove the highlights.

Given that it is only ever added to either the mobile UI or the desktop UI I feel like it is probably less confusing to suppress it again, aye?

Yeah, no strong opinion from me, if in doubt let's go for the previous behaviour. Thank you!

hugovk commented 1 year ago

@septatrix Would you be able to restore the previous behaviour? For me, this is the only one of the reported issues I'd like fixed before deploying this more widely. And I've heard lots of good feedback about the dark theme!

septatrix commented 1 year ago

@septatrix Would you be able to restore the previous behaviour? For me, this is the only one of the reported issues I'd like fixed before deploying this more widely. And I've heard lots of good feedback about the dark theme!

Done, #124 restores the previous behaviour