readthedocs / readthedocs-sphinx-search

Deprecated: Enable search-as-you-type feature for docs hosted by RTD.
https://readthedocs-sphinx-search.readthedocs.io/
MIT License
33 stars 16 forks source link

Use `CTRL+f` to open the search box? #87

Closed humitos closed 1 year ago

humitos commented 3 years ago

In https://github.com/readthedocs/readthedocs-sphinx-search/pull/31 we added / as a hotfix to open the search box which is good.

Today I found that Stripe docs goes a step further here and uses CTRL+f which I thought immediately it was a bad decision because "I want to use just the regular search of my browser", but then I saw it says that you can hit CTRL+f again to switch to the default search feature :100:

Screenshot_2021-03-15_10-35-25

NOTE the message and checkbox at the bottom right

You can try it by yourself at https://stripe.com/docs/api/events/types

astrojuanlu commented 3 years ago

I'm generally very annoyed when a website intercepts Ctrl+F or any other usual keyboard shortcut like Ctrl+Tab. I wonder if there's some user research available out there.

stsewd commented 3 years ago

I'm generally very annoyed when a website intercepts Ctrl+F or any other usual keyboard shortcut like Ctrl+Tab. I wonder if there's some user research available out there.

same, was just reading the stripe docs, and hijacking my ctrl-f is annoying, didn't even read the "pressing ctrl-f again" suggestion, I just assumed it wasn't possible to have my firefox's search back...

astrojuanlu commented 2 years ago

https://twitter.com/killedbygoogle/status/1465196733567320068

Can we close this as won't-fix? 😄

choldgraf commented 2 years ago

In my opinion, this could be a decision that individual themes make, rather than this extension. For example, in the PyData theme we use ctrl + k to open up the search bar, and it'd be nice if we could automatically hook into this extension instead if it were activated.

So you could document how other themes could use this extension + activate it via a keyboard shortcut as they wish.

humitos commented 1 year ago

Moved the conversation to https://github.com/readthedocs/readthedocs-client/issues/43