Clarify how a downstream theme could support this about readthedocs-sphinx-search HOT 6 OPEN

Oh nice - pinging @12rambau and @drammock who may also have thoughts, and probably more time than me since I'm the one with an infant now 🙂

from readthedocs-sphinx-search.

I just wanted to chime in into this conversation to let you know that are working on a new "js client" that will include all the Read the Docs Addons integrations: flyout, analytics, search as you type, etc.

This is not ready for users/authors to start using/integrating it yet; but I wanted to comment here in case you want to chime in there and follow the conversation/design.

• Repository: https://github.com/readthedocs/readthedocs-client
• How to communicate with the js client discussion: readthedocs/addons#13
• Initial test for the pattern (using WebElements) that all the addons (e.g. Search) may follow: readthedocs/addons#37

It will be super helpful for us getting feedback from you so we can build something that's easy to integrate for theme authors and easy to use for writers 😉 . Note that this is a work-in-progress work and things will change a lot, but having feedback at this early stage could be helpful for us.

from readthedocs-sphinx-search.

@choldgraf The docs say that it attachs to an input element with the search role. So I think you just need to add role="search" to it. The code looks for an input below that:

There's definitely a chance that this will conflict with our hotkey integration in the extension, but we are definitely interested in making it work nicely.

from readthedocs-sphinx-search.

Sorry I did have clarified - the "input" thing is what I wasn't sure about. Because our buttons are just buttons, there is no input field inside them. Does that mean that this won't work w the extension? Or that we'd need to nest an empty and visible input field or something?

from readthedocs-sphinx-search.

@choldgraf presumably the input is the text field that the search term goes in after the popup is launched? Changing the integration to trigger on other actions shouldn't be hard, but might take a small change to the code. We can definitely look into this next week.

from readthedocs-sphinx-search.

Ya - there is an input field on the page, it is just not nested inside the search button. It exists in a standalone spot and is simply revealed when the search button is pressed.

from readthedocs-sphinx-search.